order3000 0.8.1 → 0.9.0

package/dist/client.cjs

@@ -126,6 +126,49 @@ class BaseResource {
   }
 }
 
+class BasketsResource extends BaseResource {
+  constructor(tokenManager, baseUrl) {
+    super(tokenManager, baseUrl, "/baskets");
+  }
+  /**
+   * Get the current basket for a session
+   * @param sessionId - The session identifier (from cookie)
+   * @returns The basket with all items, or null if no basket exists
+   */
+  async get(sessionId) {
+    return this.request(
+      "GET",
+      `?sessionId=${encodeURIComponent(sessionId)}`
+    );
+  }
+  /**
+   * Add an item to the basket
+   * Creates basket and guest customer if they don't exist
+   * @param request - The add to basket request
+   * @returns The response with basket item ID and item count
+   */
+  async add(request) {
+    return this.request("POST", "/items", request);
+  }
+  /**
+   * Remove an item from the basket.
+   *
+   * Since each basket item represents a single physical product,
+   * removing it removes the entire item. There is no partial removal.
+   *
+   * @param sessionId - The session identifier
+   * @param basketItemId - The basket item ID to remove
+   * @returns The response with item count
+   */
+  async remove(sessionId, basketItemId) {
+    const params = new URLSearchParams({ sessionId });
+    return this.request(
+      "DELETE",
+      `/items/${basketItemId}?${params.toString()}`
+    );
+  }
+}
+
 class EventsResource extends BaseResource {
   constructor(tokenManager, baseUrl) {
     super(tokenManager, baseUrl, "/events");
@@ -448,6 +491,7 @@ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { en
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 class Order3000Client {
   constructor(config) {
+    __publicField(this, "baskets");
     __publicField(this, "events");
     __publicField(this, "menus");
     __publicField(this, "orders");
@@ -463,6 +507,7 @@ class Order3000Client {
       tokenUrl,
       config.venueId
     );
+    this.baskets = new BasketsResource(this.tokenManager, this.baseUrl);
     this.events = new EventsResource(this.tokenManager, this.baseUrl);
     this.menus = new MenusResource(this.tokenManager, this.baseUrl);
     this.orders = new OrdersResource(this.tokenManager, this.baseUrl);

package/dist/client.d.cts

@@ -22,7 +22,7 @@ declare abstract class BaseResource {
     protected readonly baseUrl: string;
     protected readonly resourcePath: string;
     constructor(tokenManager: TokenManager, baseUrl: string, resourcePath: string);
-    protected request<T>(method: 'GET' | 'POST', path: string, data?: any): Promise<T>;
+    protected request<T>(method: 'GET' | 'POST' | 'DELETE', path: string, data?: unknown): Promise<T>;
 }
 
 interface components {
@@ -437,6 +437,7 @@ interface MenuDish {
     id: string;
     accessor: string;
     name: Record<string, string>;
+    shortName?: Record<string, string>;
     description: Record<string, string> | null;
     isVegetarian: boolean | null;
     isVegan: boolean | null;
@@ -448,6 +449,7 @@ interface MenuBeverage {
     id: string;
     accessor: string;
     name: Record<string, string>;
+    shortName?: Record<string, string>;
     description: Record<string, string> | null;
     assets?: MenuAsset[];
 }
@@ -474,6 +476,110 @@ interface GetMenuOptions {
     /** Expand related resources (items, assets) */
     expand?: ('items' | 'assets')[];
 }
+type BasketStatus = 'active' | 'abandoned' | 'converted';
+type Currency = 'EUR' | 'CHF';
+/**
+ * Unit of measurement for portion tracking.
+ */
+type Unit = 'grams' | 'kilograms' | 'liters' | 'milliliters' | 'pieces';
+/**
+ * Reference to a menu item within a basket item.
+ *
+ * Each menu item can have its own portion size (quantity + unit),
+ * allowing for precise tracking like "100g rice, 80g curry".
+ */
+interface BasketItemMenuItemRef {
+    menuItemId: string;
+    role: string | null;
+    quantity: number;
+    unit: Unit;
+}
+interface BasketItemMetadata {
+    type?: 'tiffinbox' | 'bowl' | 'sushi';
+    mode?: 2 | 3;
+    upsell?: {
+        tinOption: string;
+        rollOption: string;
+    };
+    price?: number;
+    [key: string]: unknown;
+}
+/**
+ * A basket item represents a single physical product in the basket.
+ *
+ * Each basket item can contain multiple menu items (e.g., a TiffinBox
+ * with rice, curry, and sides). The itemCount in the response is the
+ * COUNT of basket items, not a sum of quantities.
+ */
+interface BasketItem {
+    id: string;
+    metadata: BasketItemMetadata | null;
+    menuItems: BasketItemMenuItemRef[];
+}
+interface Basket {
+    id: string;
+    sessionId: string;
+    status: BasketStatus;
+    currency: Currency;
+    items: BasketItem[];
+    itemCount: number;
+    expiresAt: string;
+    createdAt: string | null;
+    updatedAt: string | null;
+}
+/**
+ * Request to add an item to the basket.
+ *
+ * Menu items can optionally include portion information (quantity/unit).
+ * If not provided, defaults to the menu item's configured portion size.
+ */
+interface AddToBasketRequest {
+    sessionId: string;
+    menuItems: Array<{
+        menuItemId: string;
+        role?: string;
+        quantity?: number;
+        unit?: Unit;
+    }>;
+    metadata?: BasketItemMetadata;
+}
+interface AddToBasketResponse {
+    basketItemId: string;
+    itemCount: number;
+}
+interface RemoveFromBasketResponse {
+    success: boolean;
+    basketItemId: string;
+    itemCount: number;
+}
+
+declare class BasketsResource extends BaseResource {
+    constructor(tokenManager: TokenManager, baseUrl: string);
+    /**
+     * Get the current basket for a session
+     * @param sessionId - The session identifier (from cookie)
+     * @returns The basket with all items, or null if no basket exists
+     */
+    get(sessionId: string): Promise<Basket | null>;
+    /**
+     * Add an item to the basket
+     * Creates basket and guest customer if they don't exist
+     * @param request - The add to basket request
+     * @returns The response with basket item ID and item count
+     */
+    add(request: AddToBasketRequest): Promise<AddToBasketResponse>;
+    /**
+     * Remove an item from the basket.
+     *
+     * Since each basket item represents a single physical product,
+     * removing it removes the entire item. There is no partial removal.
+     *
+     * @param sessionId - The session identifier
+     * @param basketItemId - The basket item ID to remove
+     * @returns The response with item count
+     */
+    remove(sessionId: string, basketItemId: string): Promise<RemoveFromBasketResponse>;
+}
 
 declare class EventsResource extends BaseResource {
     constructor(tokenManager: TokenManager, baseUrl: string);
@@ -675,6 +781,7 @@ interface Order3000ClientConfig {
     tokenUrl?: string;
 }
 declare class Order3000Client {
+    baskets: BasketsResource;
     events: EventsResource;
     menus: MenusResource;
     orders: OrdersResource;
@@ -685,4 +792,4 @@ declare class Order3000Client {
     constructor(config: Order3000ClientConfig);
 }
 
-export { type CropArea, type Event, type EventPoster, type EventRow, type GetMenuOptions, type ListEventsOptions, type ListEventsResponse, type Menu, type MenuAsset, type MenuBeverage, type MenuDish, type MenuItem, type MenuItemRow, type MenuItemType, Order3000Client, type Order3000ClientConfig, type Promotion, type RealtimeConfig, type RealtimeEvent, type RealtimeSubscription, type Schedule, type ScheduleOverride, type ScheduleOverrideRow, type ScheduleRow, type SubscriptionOptions, type TimeSlot };
+export { type AddToBasketRequest, type AddToBasketResponse, type Basket, type BasketItem, type BasketItemMenuItemRef, type BasketItemMetadata, type BasketStatus, type CropArea, type Currency, type Event, type EventPoster, type EventRow, type GetMenuOptions, type ListEventsOptions, type ListEventsResponse, type Menu, type MenuAsset, type MenuBeverage, type MenuDish, type MenuItem, type MenuItemRow, type MenuItemType, Order3000Client, type Order3000ClientConfig, type Promotion, type RealtimeConfig, type RealtimeEvent, type RealtimeSubscription, type RemoveFromBasketResponse, type Schedule, type ScheduleOverride, type ScheduleOverrideRow, type ScheduleRow, type SubscriptionOptions, type TimeSlot, type Unit };

package/dist/client.d.mts

@@ -22,7 +22,7 @@ declare abstract class BaseResource {
     protected readonly baseUrl: string;
     protected readonly resourcePath: string;
     constructor(tokenManager: TokenManager, baseUrl: string, resourcePath: string);
-    protected request<T>(method: 'GET' | 'POST', path: string, data?: any): Promise<T>;
+    protected request<T>(method: 'GET' | 'POST' | 'DELETE', path: string, data?: unknown): Promise<T>;
 }
 
 interface components {
@@ -437,6 +437,7 @@ interface MenuDish {
     id: string;
     accessor: string;
     name: Record<string, string>;
+    shortName?: Record<string, string>;
     description: Record<string, string> | null;
     isVegetarian: boolean | null;
     isVegan: boolean | null;
@@ -448,6 +449,7 @@ interface MenuBeverage {
     id: string;
     accessor: string;
     name: Record<string, string>;
+    shortName?: Record<string, string>;
     description: Record<string, string> | null;
     assets?: MenuAsset[];
 }
@@ -474,6 +476,110 @@ interface GetMenuOptions {
     /** Expand related resources (items, assets) */
     expand?: ('items' | 'assets')[];
 }
+type BasketStatus = 'active' | 'abandoned' | 'converted';
+type Currency = 'EUR' | 'CHF';
+/**
+ * Unit of measurement for portion tracking.
+ */
+type Unit = 'grams' | 'kilograms' | 'liters' | 'milliliters' | 'pieces';
+/**
+ * Reference to a menu item within a basket item.
+ *
+ * Each menu item can have its own portion size (quantity + unit),
+ * allowing for precise tracking like "100g rice, 80g curry".
+ */
+interface BasketItemMenuItemRef {
+    menuItemId: string;
+    role: string | null;
+    quantity: number;
+    unit: Unit;
+}
+interface BasketItemMetadata {
+    type?: 'tiffinbox' | 'bowl' | 'sushi';
+    mode?: 2 | 3;
+    upsell?: {
+        tinOption: string;
+        rollOption: string;
+    };
+    price?: number;
+    [key: string]: unknown;
+}
+/**
+ * A basket item represents a single physical product in the basket.
+ *
+ * Each basket item can contain multiple menu items (e.g., a TiffinBox
+ * with rice, curry, and sides). The itemCount in the response is the
+ * COUNT of basket items, not a sum of quantities.
+ */
+interface BasketItem {
+    id: string;
+    metadata: BasketItemMetadata | null;
+    menuItems: BasketItemMenuItemRef[];
+}
+interface Basket {
+    id: string;
+    sessionId: string;
+    status: BasketStatus;
+    currency: Currency;
+    items: BasketItem[];
+    itemCount: number;
+    expiresAt: string;
+    createdAt: string | null;
+    updatedAt: string | null;
+}
+/**
+ * Request to add an item to the basket.
+ *
+ * Menu items can optionally include portion information (quantity/unit).
+ * If not provided, defaults to the menu item's configured portion size.
+ */
+interface AddToBasketRequest {
+    sessionId: string;
+    menuItems: Array<{
+        menuItemId: string;
+        role?: string;
+        quantity?: number;
+        unit?: Unit;
+    }>;
+    metadata?: BasketItemMetadata;
+}
+interface AddToBasketResponse {
+    basketItemId: string;
+    itemCount: number;
+}
+interface RemoveFromBasketResponse {
+    success: boolean;
+    basketItemId: string;
+    itemCount: number;
+}
+
+declare class BasketsResource extends BaseResource {
+    constructor(tokenManager: TokenManager, baseUrl: string);
+    /**
+     * Get the current basket for a session
+     * @param sessionId - The session identifier (from cookie)
+     * @returns The basket with all items, or null if no basket exists
+     */
+    get(sessionId: string): Promise<Basket | null>;
+    /**
+     * Add an item to the basket
+     * Creates basket and guest customer if they don't exist
+     * @param request - The add to basket request
+     * @returns The response with basket item ID and item count
+     */
+    add(request: AddToBasketRequest): Promise<AddToBasketResponse>;
+    /**
+     * Remove an item from the basket.
+     *
+     * Since each basket item represents a single physical product,
+     * removing it removes the entire item. There is no partial removal.
+     *
+     * @param sessionId - The session identifier
+     * @param basketItemId - The basket item ID to remove
+     * @returns The response with item count
+     */
+    remove(sessionId: string, basketItemId: string): Promise<RemoveFromBasketResponse>;
+}
 
 declare class EventsResource extends BaseResource {
     constructor(tokenManager: TokenManager, baseUrl: string);
@@ -675,6 +781,7 @@ interface Order3000ClientConfig {
     tokenUrl?: string;
 }
 declare class Order3000Client {
+    baskets: BasketsResource;
     events: EventsResource;
     menus: MenusResource;
     orders: OrdersResource;
@@ -685,4 +792,4 @@ declare class Order3000Client {
     constructor(config: Order3000ClientConfig);
 }
 
-export { type CropArea, type Event, type EventPoster, type EventRow, type GetMenuOptions, type ListEventsOptions, type ListEventsResponse, type Menu, type MenuAsset, type MenuBeverage, type MenuDish, type MenuItem, type MenuItemRow, type MenuItemType, Order3000Client, type Order3000ClientConfig, type Promotion, type RealtimeConfig, type RealtimeEvent, type RealtimeSubscription, type Schedule, type ScheduleOverride, type ScheduleOverrideRow, type ScheduleRow, type SubscriptionOptions, type TimeSlot };
+export { type AddToBasketRequest, type AddToBasketResponse, type Basket, type BasketItem, type BasketItemMenuItemRef, type BasketItemMetadata, type BasketStatus, type CropArea, type Currency, type Event, type EventPoster, type EventRow, type GetMenuOptions, type ListEventsOptions, type ListEventsResponse, type Menu, type MenuAsset, type MenuBeverage, type MenuDish, type MenuItem, type MenuItemRow, type MenuItemType, Order3000Client, type Order3000ClientConfig, type Promotion, type RealtimeConfig, type RealtimeEvent, type RealtimeSubscription, type RemoveFromBasketResponse, type Schedule, type ScheduleOverride, type ScheduleOverrideRow, type ScheduleRow, type SubscriptionOptions, type TimeSlot, type Unit };

package/dist/client.mjs

@@ -124,6 +124,49 @@ class BaseResource {
   }
 }
 
+class BasketsResource extends BaseResource {
+  constructor(tokenManager, baseUrl) {
+    super(tokenManager, baseUrl, "/baskets");
+  }
+  /**
+   * Get the current basket for a session
+   * @param sessionId - The session identifier (from cookie)
+   * @returns The basket with all items, or null if no basket exists
+   */
+  async get(sessionId) {
+    return this.request(
+      "GET",
+      `?sessionId=${encodeURIComponent(sessionId)}`
+    );
+  }
+  /**
+   * Add an item to the basket
+   * Creates basket and guest customer if they don't exist
+   * @param request - The add to basket request
+   * @returns The response with basket item ID and item count
+   */
+  async add(request) {
+    return this.request("POST", "/items", request);
+  }
+  /**
+   * Remove an item from the basket.
+   *
+   * Since each basket item represents a single physical product,
+   * removing it removes the entire item. There is no partial removal.
+   *
+   * @param sessionId - The session identifier
+   * @param basketItemId - The basket item ID to remove
+   * @returns The response with item count
+   */
+  async remove(sessionId, basketItemId) {
+    const params = new URLSearchParams({ sessionId });
+    return this.request(
+      "DELETE",
+      `/items/${basketItemId}?${params.toString()}`
+    );
+  }
+}
+
 class EventsResource extends BaseResource {
   constructor(tokenManager, baseUrl) {
     super(tokenManager, baseUrl, "/events");
@@ -446,6 +489,7 @@ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { en
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 class Order3000Client {
   constructor(config) {
+    __publicField(this, "baskets");
     __publicField(this, "events");
     __publicField(this, "menus");
     __publicField(this, "orders");
@@ -461,6 +505,7 @@ class Order3000Client {
       tokenUrl,
       config.venueId
     );
+    this.baskets = new BasketsResource(this.tokenManager, this.baseUrl);
     this.events = new EventsResource(this.tokenManager, this.baseUrl);
     this.menus = new MenusResource(this.tokenManager, this.baseUrl);
     this.orders = new OrdersResource(this.tokenManager, this.baseUrl);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "order3000",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "order3000 node.js sdk",
   "main": "./dist/client.cjs",
   "module": "./dist/client.mjs",
@@ -29,9 +29,9 @@
     "prettier": "^3.7.4",
     "tsx": "^4.19.2",
     "typescript": "^5.9.3",
-    "@kolaveri/prettier-config": "1.0.6",
+    "@kolaveri/eslint-config": "1.0.9",
     "@kolaveri/tsconfig": "1.0.1",
-    "@kolaveri/eslint-config": "1.0.9"
+    "@kolaveri/prettier-config": "1.0.6"
   },
   "files": [
     "dist"