@liquidcommerce/cloud-sdk 1.9.2 → 1.10.0

package/dist/types/interfaces/order.interface.d.ts

@@ -1,8 +1,4 @@
 import type { ENUM_CUSTOMER_PLACEMENT, ENUM_ORDER_FULFILLMENT_TYPE, ENUM_ORDER_PACKAGE_STATUS, ENUM_ORDER_STATUS, ENUM_ORDER_SYSTEM } from 'enums';
-export interface IAddressCoordinates {
-    latitude: number | null;
-    longitude: number | null;
-}
 export interface IOrderAddress {
     one: string;
     two: string | null;
@@ -30,6 +26,15 @@ export interface IOrderFulfillmentPackage {
     status: ENUM_ORDER_PACKAGE_STATUS;
     dateShipped: string | null;
 }
+export interface IOrderFulfillmentCancellation {
+    category: string | null;
+    subcategory: string | null;
+    notes: string | null;
+}
+export interface IOrderFulfillmentExpectationFormatted {
+    detail: string | null;
+    engraving: string | null;
+}
 export interface IOrderFulfillment {
     id: string;
     type: ENUM_ORDER_FULFILLMENT_TYPE;
@@ -37,15 +42,19 @@ export interface IOrderFulfillment {
     scheduledFor: string | null;
     updatedAt: string;
     itemIds: string[];
+    cancellation: IOrderFulfillmentCancellation;
+    expectationFormatted: IOrderFulfillmentExpectationFormatted;
     packages: IOrderFulfillmentPackage[];
     timeline: IOrderFulfillmentTimeline[];
 }
 export interface IOrderRetailerAddress extends IOrderAddress {
-    coordinates: IAddressCoordinates;
+    latitude: number | null;
+    longitude: number | null;
 }
 export interface IOrderRetailer {
     id: string;
     legacyId: string | null;
+    tdLinx: string | null;
     name: string;
     system: ENUM_ORDER_SYSTEM;
     timezone: string;
@@ -104,6 +113,7 @@ export interface IOrderItem {
     liquidId: string | null;
     legacyGrouping: string | null;
     legacyPid: string | null;
+    expectation: string | null;
     customerPlacement: ENUM_CUSTOMER_PLACEMENT;
     product: IOrderItemProduct;
     image: string | null;
@@ -183,8 +193,11 @@ export interface IOrderPaymentMethod {
 export interface IOrder {
     referenceId: string | null;
     legacyOrderNumber: string | null;
+    legacyStorefrontId: number | null;
     isHybrid: boolean;
     partnerId: string;
+    partnerName: string;
+    promoCode: string | null;
     createdAt: string;
     updatedAt: string;
     customer: IOrderCustomer;
@@ -195,3 +208,23 @@ export interface IOrder {
     retailers: IOrderRetailer[];
     items: IOrderItem[];
 }
+export interface IOrdersList {
+    startDate: string;
+    endDate: string;
+    page: number;
+    limit: number;
+    total: number;
+    orders: IOrder[];
+}
+export interface IOrdersListParams {
+    /** Start date for filtering orders (ISO 8601 format, e.g., '2025-01-01') */
+    startDate: string;
+    /** End date for filtering orders (ISO 8601 format, e.g., '2025-01-31') */
+    endDate: string;
+    /** Page number (default: 1) */
+    page?: number;
+    /** Number of items per page (default: 10, max: 100) */
+    limit?: number;
+    /** Filter orders by customer email address */
+    customerEmail?: string;
+}

package/dist/types/interfaces/retailer.interface.d.ts

@@ -1,5 +1,5 @@
 import type { DAYS_OF_WEEK, ENUM_MODALITIES, SHIPPING_CATEGORY_TYPE } from '../enums';
-import type { IAddress } from './address.interface';
+import type { IAddress, ICoords } from './address.interface';
 /**
  * The IRetailerTimes interface represents the working hours of a retailer.
  *
@@ -198,6 +198,6 @@ export interface IRetailer {
     engravingFee?: number;
     subtotal?: number;
     total?: number;
-    address?: IAddress;
+    address?: IAddress & ICoords;
     fulfillments: IRetailerFulfillments[];
 }

package/dist/types/services/order.service.d.ts

@@ -1,5 +1,5 @@
 import type { OrderAuthenticatedService } from '../core';
-import type { IOrder } from '../interfaces';
+import type { IOrder, IOrdersList, IOrdersListParams } from '../interfaces';
 import type { IApiResponseWithData } from '../types';
 export declare class OrderService {
     private client;
@@ -12,4 +12,12 @@ export declare class OrderService {
      * @throws {Error} If the fetch request fails.
      */
     fetch(identifier: string): Promise<IApiResponseWithData<IOrder>>;
+    /**
+     * Lists orders within a specified date range.
+     *
+     * @param {IOrdersListParams} params - The parameters for listing orders.
+     * @returns {Promise<IApiResponseWithData<IOrdersList>>} A promise that resolves to the paginated order list.
+     * @throws {Error} If the list request fails.
+     */
+    list(params: IOrdersListParams): Promise<IApiResponseWithData<IOrdersList>>;
 }

package/package.json

@@ -1,108 +1,98 @@
 {
- "name": "@liquidcommerce/cloud-sdk",
- "version": "1.9.2",
- "description": "LiquidCommerce Cloud SDK",
- "main": "./dist/index.cjs",
- "module": "./dist/index.esm.js",
- "browser": "./umd/liquidcommerce-cloud-sdk.js",
- "types": "./dist/types/index.d.ts",
- "packageManager": "pnpm@9.5.0",
- "exports": {
-  ".": {
-   "import": {
-    "types": "./dist/types/index.d.ts",
-    "default": "./dist/index.esm.js"
-   },
-   "require": {
-    "types": "./dist/types/index.d.ts",
-    "default": "./dist/index.cjs"
-   },
-   "node": {
-    "types": "./dist/types/index.d.ts",
-    "default": "./dist/liquidcommerce-cloud-sdk.ssr.js"
-   },
-   "browser": {
-    "types": "./dist/types/index.d.ts",
-    "default": "./umd/liquidcommerce-cloud-sdk.js"
-   }
+  "name": "@liquidcommerce/cloud-sdk",
+  "version": "1.10.0",
+  "description": "LiquidCommerce Cloud SDK",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.esm.js",
+  "browser": "./umd/liquidcommerce-cloud-sdk.js",
+  "types": "./dist/types/index.d.ts",
+  "packageManager": "pnpm@10.30.3",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/index.esm.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "node": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/liquidcommerce-cloud-sdk.ssr.js"
+      },
+      "browser": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./umd/liquidcommerce-cloud-sdk.js"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "umd"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "scripts": {
+    "build": "rollup -c --environment NODE_ENV:production",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
+    "dev": "rollup -c --environment NODE_ENV:development -w",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "pnpm biome lint --write",
+    "format": "biome format --write",
+    "check": "pnpm biome check --write .",
+    "fl": "pnpm check && pnpm tsc --noEmit",
+    "clean:all": "rm -rf node_modules dist umd && pnpm install && pnpm build",
+    "docs": "typedoc --out docs src",
+    "prepublishOnly": "pnpm run build"
+  },
+  "keywords": [
+    "liquidcommerce",
+    "ecommerce",
+    "alcohol",
+    "beverage",
+    "cloud-sdk"
+  ],
+  "author": "ReserveBar Tech",
+  "license": "",
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.5",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-replace": "^6.0.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/npm": "^13.1.5",
+    "@types/node": "^25.3.3",
+    "@vitest/coverage-v8": "^4.0.18",
+    "conventional-changelog": "^7.2.0",
+    "dotenv": "^17.3.1",
+    "husky": "^9.1.7",
+    "jest": "^30.2.0",
+    "rollup": "^4.59.0",
+    "rollup-plugin-livereload": "^2.0.5",
+    "rollup-plugin-serve": "^3.0.0",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "semantic-release": "^25.0.3",
+    "ts-jest": "^29.4.6",
+    "typedoc": "^0.28.17",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "pnpm": {
+    "peerDependencyRules": {
+      "ignoreMissing": []
+    }
+  },
+  "dependencies": {
+    "@stripe/stripe-js": "^7.9.0"
   }
- },
- "files": [
-  "dist",
-  "umd"
- ],
- "type": "module",
- "sideEffects": false,
- "scripts": {
-  "build": "rollup -c --environment NODE_ENV:production",
-  "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-  "dev": "rollup -c --environment NODE_ENV:development -w",
-  "test": "vitest run",
-  "test:watch": "vitest",
-  "test:coverage": "vitest run --coverage",
-  "lint": "eslint \"src/**/*.ts\"",
-  "format": "prettier --write \"src/**/*.ts\"",
-  "docs": "typedoc --out docs src",
-  "prepublishOnly": "pnpm run build"
- },
- "keywords": [
-  "liquidcommerce",
-  "ecommerce",
-  "alcohol",
-  "beverage",
-  "cloud-sdk"
- ],
- "author": "ReserveBar Tech",
- "license": "",
- "devDependencies": {
-  "@eslint/eslintrc": "^3.1.0",
-  "@eslint/js": "^9.9.1",
-  "@rollup/plugin-commonjs": "^26.0.1",
-  "@rollup/plugin-node-resolve": "^15.2.3",
-  "@rollup/plugin-replace": "^5.0.7",
-  "@semantic-release/changelog": "^6.0.3",
-  "@semantic-release/git": "^10.0.1",
-  "@semantic-release/github": "^10.1.7",
-  "@semantic-release/npm": "^12.0.1",
-  "@types/eslint__js": "^8.42.3",
-  "@types/node": "^20.0.0",
-  "@typescript-eslint/eslint-plugin": "^8.2.0",
-  "@typescript-eslint/parser": "^8.2.0",
-  "@vitest/coverage-v8": "^1.0.0",
-  "conventional-changelog-cli": "^5.0.0",
-  "dotenv": "^16.4.5",
-  "eslint": "^9.9.1",
-  "eslint-config-prettier": "^9.1.0",
-  "eslint-import-resolver-typescript": "^3.6.1",
-  "eslint-plugin-import": "^2.29.1",
-  "eslint-plugin-simple-import-sort": "^12.1.1",
-  "eslint-plugin-sonarjs": "^2.0.1",
-  "eslint-plugin-unicorn": "^55.0.0",
-  "husky": "^9.1.5",
-  "jest": "^29.7.0",
-  "prettier": "^3.3.3",
-  "rollup": "^4.21.0",
-  "rollup-plugin-livereload": "^2.0.5",
-  "rollup-plugin-serve": "^1.1.1",
-  "rollup-plugin-terser": "^7.0.2",
-  "rollup-plugin-typescript2": "^0.36.0",
-  "semantic-release": "^24.1.0",
-  "ts-jest": "^29.2.5",
-  "typedoc": "^0.26.6",
-  "typescript": "^5.5.4",
-  "typescript-eslint": "^8.2.0",
-  "vite": "^5.0.0",
-  "vitest": "^1.0.0"
- },
- "engines": {
-  "node": ">=20"
- },
- "pnpm": {
-  "peerDependencyRules": {
-   "ignoreMissing": []
-  }
- },
- "dependencies": {
-  "@stripe/stripe-js": "^7.3.1"
- }
 }