@reactionary/provider-commercetools 0.2.2 → 0.2.3

package/core/initialize.js

@@ -14,6 +14,7 @@ import { CommercetoolsCategoryProvider } from "../providers/category.provider.js
 import {
   CommercetoolsCheckoutProvider,
   CommercetoolsOrderProvider,
+  CommercetoolsOrderSearchProvider,
   CommercetoolsProfileProvider,
   CommercetoolsStoreProvider
 } from "../providers/index.js";
@@ -112,6 +113,14 @@ function withCommercetoolsCapabilities(configuration, capabilities) {
         commercetoolsClient
       );
     }
+    if (caps.orderSearch) {
+      client.orderSearch = new CommercetoolsOrderSearchProvider(
+        config,
+        cache,
+        context,
+        commercetoolsClient
+      );
+    }
     return client;
   };
 }

package/index.js

@@ -3,6 +3,7 @@ export * from "./core/initialize.js";
 export * from "./providers/cart.provider.js";
 export * from "./providers/identity.provider.js";
 export * from "./providers/inventory.provider.js";
+export * from "./providers/order-search.provider.js";
 export * from "./providers/price.provider.js";
 export * from "./providers/product.provider.js";
 export * from "./providers/product-search.provider.js";

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@reactionary/provider-commercetools",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "main": "index.js",
   "types": "src/index.d.ts",
   "dependencies": {
-    "@reactionary/core": "0.2.2",
+    "@reactionary/core": "0.2.3",
     "debug": "^4.4.3",
     "zod": "4.1.9",
     "@commercetools/ts-client": "^4.2.1",

package/providers/index.js

@@ -2,6 +2,7 @@ export * from "./cart.provider.js";
 export * from "./category.provider.js";
 export * from "./identity.provider.js";
 export * from "./inventory.provider.js";
+export * from "./order-search.provider.js";
 export * from "./price.provider.js";
 export * from "./product.provider.js";
 export * from "./profile.provider.js";

package/providers/order-search.provider.js

@@ -0,0 +1,170 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import {
+  OrderSearchProvider,
+  OrderSearchQueryByTermSchema,
+  OrderSearchResultSchema,
+  Reactionary,
+  success
+} from "@reactionary/core";
+import createDebug from "debug";
+const debug = createDebug("reactionary:commercetools:order-search");
+class CommercetoolsOrderSearchProvider extends OrderSearchProvider {
+  constructor(config, cache, context, client) {
+    super(cache, context);
+    this.config = config;
+    this.client = client;
+  }
+  async getClient() {
+    const client = await this.client.getClient();
+    return client.withProjectKey({ projectKey: this.config.projectKey }).me().orders();
+  }
+  async queryByTerm(payload) {
+    debug("queryByTerm", payload);
+    const client = await this.getClient();
+    const where = [];
+    if (payload.search) {
+      if (payload.search.term) {
+        debug("Search by term is not implemented yet in CommercetoolsOrderSearchProvider");
+      }
+      if (payload.search.partNumber) {
+        for (const partNumber of payload.search.partNumber) {
+          where.push(`lineItems(variant(sku="${partNumber}"))`);
+        }
+      }
+      if (payload.search.userId) {
+        where.push(`customerId="${payload.search.userId}"`);
+      }
+      if (payload.search.orderStatus) {
+        const orderStatusWhere = payload.search.orderStatus.map((x) => {
+          if (x === "AwaitingPayment") {
+            return `Open`;
+          }
+          if (x === "ReleasedToFulfillment") {
+            return `Confirmed`;
+          }
+          if (x === "Shipped") {
+            return `Completed`;
+          }
+          if (x === "Cancelled") {
+            return `Cancelled`;
+          }
+          return `orderState="${x}"`;
+        }).join(" OR ");
+        where.push(orderStatusWhere);
+      }
+      if (payload.search.startDate) {
+        where.push(`createdAt >= "${payload.search.startDate}"`);
+      }
+      if (payload.search.endDate) {
+        where.push(`createdAt <= "${payload.search.endDate}"`);
+      }
+    }
+    const response = await client.get({
+      queryArgs: {
+        where,
+        withTotal: true,
+        limit: payload.search.paginationOptions.pageSize,
+        offset: (payload.search.paginationOptions.pageNumber - 1) * payload.search.paginationOptions.pageSize
+      }
+    }).execute();
+    const responseBody = response.body;
+    const result = this.parsePaginatedResult(
+      responseBody,
+      payload
+    );
+    if (debug.enabled) {
+      debug(
+        `Search for term "${payload.search.term}" returned ${responseBody.results.length} orders (page ${payload.search.paginationOptions.pageNumber} of ${result.totalPages})`
+      );
+    }
+    return success(result);
+  }
+  parseAddress(remote) {
+    return {
+      countryCode: remote.country || "",
+      firstName: remote.firstName || "",
+      lastName: remote.lastName || "",
+      streetAddress: remote.streetName || "",
+      streetNumber: remote.streetNumber || "",
+      postalCode: remote.postalCode || "",
+      city: remote.city || "",
+      identifier: {
+        nickName: ""
+      },
+      region: ""
+    };
+  }
+  parseSingle(body) {
+    const identifier = { key: body.id };
+    const userId = {
+      userId: body.customerId || body.anonymousId || ""
+    };
+    const customerName = `${body.billingAddress?.firstName} ${body.billingAddress?.lastName}`;
+    const shippingAddress = this.parseAddress(body.shippingAddress);
+    const orderDate = body.createdAt;
+    let orderStatus = "AwaitingPayment";
+    if (body.paymentState === "Pending" && body.orderState === "Open") {
+      orderStatus = "AwaitingPayment";
+    } else if (body.paymentState === "Paid" && body.orderState === "Confirmed") {
+      orderStatus = "ReleasedToFulfillment";
+    }
+    if (body.shipmentState === "Ready" && body.orderState === "Confirmed") {
+      orderStatus = "ReleasedToFulfillment";
+    }
+    if ((body.shipmentState === "Shipped" || body.shipmentState === "Delivered") && body.orderState === "Completed") {
+      orderStatus = "Shipped";
+    }
+    const inventoryStatus = body.shipmentState;
+    const totalAmount = {
+      currency: body.totalPrice ? body.totalPrice.currencyCode : this.context.languageContext.currencyCode,
+      value: body.totalPrice ? body.totalPrice.centAmount / 100 : 0
+    };
+    const order = {
+      identifier,
+      userId,
+      customerName,
+      shippingAddress,
+      orderDate,
+      orderStatus,
+      inventoryStatus,
+      totalAmount
+    };
+    return order;
+  }
+  parsePaginatedResult(body, query) {
+    const identifier = {
+      ...query.search
+    };
+    const orders = body.results.map((o) => {
+      return this.parseSingle(o);
+    });
+    const result = {
+      identifier,
+      pageNumber: (Math.ceil(body.offset / body.limit) || 0) + 1,
+      pageSize: body.limit,
+      totalCount: body.total || 0,
+      totalPages: Math.ceil((body.total || 0) / body.limit || 0) + 1,
+      items: orders
+    };
+    return result;
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: OrderSearchQueryByTermSchema,
+    outputSchema: OrderSearchResultSchema
+  })
+], CommercetoolsOrderSearchProvider.prototype, "queryByTerm", 1);
+export {
+  CommercetoolsOrderSearchProvider
+};

package/schema/capabilities.schema.js

@@ -6,6 +6,7 @@ const CommercetoolsCapabilitiesSchema = CapabilitiesSchema.pick({
   cart: true,
   checkout: true,
   order: true,
+  orderSearch: true,
   inventory: true,
   price: true,
   category: true,

package/src/index.d.ts

@@ -3,6 +3,7 @@ export * from './core/initialize.js';
 export * from './providers/cart.provider.js';
 export * from './providers/identity.provider.js';
 export * from './providers/inventory.provider.js';
+export * from './providers/order-search.provider.js';
 export * from './providers/price.provider.js';
 export * from './providers/product.provider.js';
 export * from './providers/product-search.provider.js';

package/src/providers/index.d.ts

@@ -2,6 +2,7 @@ export * from './cart.provider.js';
 export * from './category.provider.js';
 export * from './identity.provider.js';
 export * from './inventory.provider.js';
+export * from './order-search.provider.js';
 export * from './price.provider.js';
 export * from './product.provider.js';
 export * from './profile.provider.js';

package/src/providers/order-search.provider.d.ts

@@ -0,0 +1,104 @@
+import type { RequestContext, Cache, OrderSearchQueryByTerm, OrderSearchResult, Result } from '@reactionary/core';
+import { OrderSearchProvider } from '@reactionary/core';
+import type { CommercetoolsConfiguration } from '../schema/configuration.schema.js';
+import type { CommercetoolsClient } from '../core/client.js';
+import type { Order as CTOrder, Address as CTAddress, OrderPagedQueryResponse } from '@commercetools/platform-sdk';
+export declare class CommercetoolsOrderSearchProvider extends OrderSearchProvider {
+    protected config: CommercetoolsConfiguration;
+    protected client: CommercetoolsClient;
+    constructor(config: CommercetoolsConfiguration, cache: Cache, context: RequestContext, client: CommercetoolsClient);
+    protected getClient(): Promise<import("@commercetools/platform-sdk").ByProjectKeyMeOrdersRequestBuilder>;
+    queryByTerm(payload: OrderSearchQueryByTerm): Promise<Result<OrderSearchResult>>;
+    protected parseAddress(remote: CTAddress): {
+        countryCode: string;
+        firstName: string;
+        lastName: string;
+        streetAddress: string;
+        streetNumber: string;
+        postalCode: string;
+        city: string;
+        identifier: {
+            nickName: string;
+        };
+        region: string;
+    };
+    protected parseSingle(body: CTOrder): {
+        identifier: {
+            key: string;
+        };
+        userId: {
+            userId: string;
+        };
+        customerName: string;
+        shippingAddress: {
+            countryCode: string;
+            firstName: string;
+            lastName: string;
+            streetAddress: string;
+            streetNumber: string;
+            postalCode: string;
+            city: string;
+            identifier: {
+                nickName: string;
+            };
+            region: string;
+        };
+        orderDate: string;
+        orderStatus: "AwaitingPayment" | "ReleasedToFulfillment" | "Shipped";
+        inventoryStatus: "NotAllocated" | "Allocated" | "Backordered" | "Preordered";
+        totalAmount: {
+            value: number;
+            currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWL";
+        };
+    };
+    protected parsePaginatedResult(body: OrderPagedQueryResponse, query: OrderSearchQueryByTerm): {
+        identifier: {
+            term: string;
+            filters: string[];
+            paginationOptions: {
+                pageNumber: number;
+                pageSize: number;
+            };
+            partNumber?: string[] | undefined;
+            orderStatus?: ("AwaitingPayment" | "ReleasedToFulfillment" | "Shipped" | "Cancelled")[] | undefined;
+            userId?: {
+                userId: string;
+            } | undefined;
+            startDate?: string | undefined;
+            endDate?: string | undefined;
+        };
+        pageNumber: number;
+        pageSize: number;
+        totalCount: number;
+        totalPages: number;
+        items: {
+            identifier: {
+                key: string;
+            };
+            userId: {
+                userId: string;
+            };
+            customerName: string;
+            orderDate: string;
+            orderStatus: "AwaitingPayment" | "ReleasedToFulfillment" | "Shipped" | "Cancelled";
+            inventoryStatus: "NotAllocated" | "Allocated" | "Backordered" | "Preordered";
+            totalAmount: {
+                value: number;
+                currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWL";
+            };
+            shippingAddress?: {
+                identifier: {
+                    nickName: string;
+                };
+                firstName: string;
+                lastName: string;
+                streetAddress: string;
+                streetNumber: string;
+                city: string;
+                region: string;
+                postalCode: string;
+                countryCode: string;
+            } | undefined;
+        }[];
+    };
+}

package/src/schema/capabilities.schema.d.ts

@@ -11,5 +11,6 @@ export declare const CommercetoolsCapabilitiesSchema: z.ZodObject<{
     profile: z.ZodOptional<z.ZodBoolean>;
     store: z.ZodOptional<z.ZodBoolean>;
     productSearch: z.ZodOptional<z.ZodBoolean>;
+    orderSearch: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$loose>;
 export type CommercetoolsCapabilities = z.infer<typeof CommercetoolsCapabilitiesSchema>;