[!WARNING] This project is under active development and is not ready for production use. Please proceed with caution. Use at your own risk.

@86d-app/wishlist

Customer wishlist and favorites module for 86d commerce platform.

Installation

npm install @86d-app/wishlist

Usage

import wishlist from "@86d-app/wishlist";

const module = wishlist({
  maxItems: "50",
});

Configuration

| Option | Type | Default | Description | |---|---|---|---| | maxItems | string | — | Maximum number of items per customer wishlist |

Store Endpoints

| Method | Path | Description | |---|---|---| | GET | /wishlist | List current customer's wishlist items (paginated) | | POST | /wishlist/add | Add an item to the wishlist | | DELETE | /wishlist/remove/:id | Remove an item by ID | | GET | /wishlist/check/:productId | Check if a product is in the wishlist |

Admin Endpoints

| Method | Path | Description | |---|---|---| | GET | /admin/wishlist | List all wishlist items (filterable by customer or product) | | GET | /admin/wishlist/summary | Wishlist analytics (total items, top products) | | DELETE | /admin/wishlist/:id/delete | Delete a wishlist item |

Controller API

interface WishlistController {
  addItem(params: {
    customerId: string;
    productId: string;
    productName: string;
    productImage?: string;
    note?: string;
  }): Promise<WishlistItem>;

  removeItem(id: string): Promise<void>;
  removeByProduct(customerId: string, productId: string): Promise<void>;
  getItem(id: string): Promise<WishlistItem>;
  isInWishlist(customerId: string, productId: string): Promise<boolean>;
  listByCustomer(customerId: string, params?: {
    limit?: number;
    offset?: number;
  }): Promise<{ items: WishlistItem[]; total: number }>;
  listAll(params?: {
    customerId?: string;
    productId?: string;
    limit?: number;
    offset?: number;
  }): Promise<{ items: WishlistItem[]; total: number }>;
  countByCustomer(customerId: string): Promise<number>;
  getSummary(): Promise<WishlistSummary>;
}

Types

interface WishlistItem {
  id: string;
  customerId: string;
  productId: string;
  productName: string;
  productImage?: string;
  note?: string;
  addedAt: Date;
}

interface WishlistSummary {
  totalItems: number;
  topProducts: Array<{
    productId: string;
    productName: string;
    count: number;
  }>;
}