@scayle/storefront-core 8.13.0 → 8.14.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @scayle/storefront-core
 
+## 8.14.1
+
+### Patch Changes
+
+- Update `getUniqueItemsFromOrder` and `getItemQuantityFromOrder` to accept order
+  `Product` and `Variant` generics to ensure correct types. Morover, both methods
+  are deprecated as they should be handled within Storefront project itself.
+
+## 8.14.0
+
+### Minor Changes
+
+- Expose `PackageDeliveryStatus` type. This new type clearly defines the allowed values for a package's delivery status. This improves code clarity and helps prevent typos. It's used to replace the inline string literal types in the `ListOfPackages` type.
+- Refactor the `Order` and `OrderItem` interfaces to be generic, allowing them to accept custom `Product` and `Variant` types. This allows to strongly type the `product` and `variant` data within orders and order items, leading to better type checking and potentially fewer runtime errors. This allows for compile-time checks and autocompletion when working with product and variant properties of `OrderItem` and items property of `Order`.
+
 ## 8.13.0
 
 ### Minor Changes

package/dist/api/customer.d.ts

@@ -113,7 +113,7 @@ export declare class CustomerAPIClient {
      *
      * @see https://scayle.dev/en/api-guides/customer-account-api/resources/order/get-order
      */
-    getOrder(shopId: number, orderId: number): Promise<Order>;
+    getOrder(shopId: number, orderId: number): Promise<Order<Record<string, unknown>, Record<string, unknown>>>;
     /**
      * Update contact details of a customer.
      *

package/dist/helpers/orderHelpers.d.ts

@@ -5,8 +5,10 @@ import type { Order } from '../types';
  * @param order The order object.
  *
  * @returns An array of unique order items.
+ *
+ * @deprecated getting unique items from order should be handled within the Storefront project itself.
  */
-export declare const getUniqueItemsFromOrder: (order: Order) => import("../types").OrderItem[] | undefined;
+export declare const getUniqueItemsFromOrder: <P, V>(order: Order<P, V>) => import("../types").OrderItem<P, V>[] | undefined;
 /**
  * Gets the quantity of a specific item in an order based on its variant ID.
  *
@@ -14,5 +16,7 @@ export declare const getUniqueItemsFromOrder: (order: Order) => import("../types
  * @param variantId The ID of the variant to count.
  *
  * @returns The quantity of the item in the order, or undefined if the order or items are undefined.
+ *
+ * @deprecated getting item quantity from order should be handled within the Storefront project itself.
  */
-export declare const getItemQuantityFromOrder: (order: Order, variantId: number) => number | undefined;
+export declare const getItemQuantityFromOrder: <P, V>(order: Order<P, V>, variantId: number) => number | undefined;

package/dist/rpc/methods/cbd.d.ts

@@ -12,4 +12,4 @@ import type { Order, RpcContext } from '../../types';
  */
 export declare const getOrderDataByCbd: ({ cbdToken }: {
     cbdToken: string;
-}, context: RpcContext) => Promise<ErrorResponse | Order>;
+}, context: RpcContext) => Promise<ErrorResponse | Order<Record<string, unknown>, Record<string, unknown>>>;

package/dist/rpc/methods/checkout/checkout.mjs

@@ -36,7 +36,7 @@ export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}
     carrier,
     basketId: context.basketKey,
     campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.13.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.14.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/checkout/order.d.ts

@@ -14,4 +14,4 @@ import type { Order } from '../../../types';
  */
 export declare const getOrderById: ({ orderId }: {
     orderId: number;
-}, context: import("../../../types").RpcContext) => Promise<ErrorResponse | Order>;
+}, context: import("../../../types").RpcContext) => Promise<ErrorResponse | Order<Record<string, unknown>, Record<string, unknown>>>;

package/dist/types/sapi/order.d.ts

@@ -4,6 +4,7 @@ import type { CentAmount } from './product';
  * Items are grouped by package, depending on the item's supplier configuration. The `packageId` references an entry in the packages list with delivery estimates and expected carrier.
  */
 export type PackageReference = number;
+export type PackageDeliveryStatus = 'open' | 'shipment_pending' | 'delegation_pending' | 'shipment_completed' | 'cancellation_completed';
 /**
  * The distribution of items across packages is calculated based on the supplierId. Once shipments are processed, the packages may be updated to reflect the actual shipments.
  */
@@ -20,7 +21,7 @@ export type ListOfPackages = {
         maximum: string;
         minimum: string;
     };
-    deliveryStatus: 'open' | 'shipment_pending' | 'delegation_pending' | 'shipment_completed' | 'cancellation_completed';
+    deliveryStatus: PackageDeliveryStatus;
     returnIdentCode?: null | string;
     shipmentKey?: string;
     tracking?: {
@@ -104,7 +105,7 @@ export type OrderStatus = 'order_open' | 'payment_pending' | 'payment_reserved'
 export type OrderStatusCode = 'order_created' | 'order_open' | 'order_pended' | 'order_confirmed' | 'order_delegated' | 'order_shipped' | 'order_invoiced' | 'order_aborted' | 'order_cancelled' | 'order_imported' | 'order_invoice_error';
 export type BillingStatusCode = 'billing_open' | 'billing_pending' | 'billing_payment_pending' | 'billing_completed' | 'billing_payment_cancelled' | 'billing_partially_refunded' | 'billing_refunded';
 export type ShippingStatusCode = 'shipping_open' | 'shipping_not_deliveable' | 'shipping_ordered' | 'shipping_delivered' | 'shipping_cancelled' | 'shipping_undeliverable' | 'shipping_returned' | 'shipping_partially_returned' | 'shipping_partially_undeliverable';
-export interface OrderItem {
+export interface OrderItem<Product = Record<string, unknown>, Variant = Record<string, unknown>> {
     id?: string;
     /**
      * The number of deliverable items available in the warehouse for immediate shipping.
@@ -117,9 +118,7 @@ export interface OrderItem {
     /**
      * customData allows the tenant to attach data to an item. The data will remain attached to the item from the basket through the process of order creation and delegation and may be displayed to the customer during the order lifecycle.
      */
-    customData?: {
-        [k: string]: unknown;
-    };
+    customData?: Record<string, unknown>;
     deliveryForecast?: DeliveryForecastFromWarehouse;
     /**
      * Whether the return shipment got triggered manually. Is missing in case there is no return shipment.
@@ -204,17 +203,13 @@ export interface OrderItem {
          */
         withTax: CentAmount;
     };
-    product: {
-        [k: string]: unknown;
-    };
+    product: Product;
     /**
      * Reference set in the checkout when an item was reserved successfully.
      */
     reservationKey?: string;
     status: 'available' | 'cancelled' | 'delivered' | 'undeliverable' | 'returned' | 'unavailable';
-    variant: {
-        [k: string]: unknown;
-    };
+    variant: Variant;
     /**
      * The warehouse id where the item are being picking from.
      */
@@ -223,7 +218,7 @@ export interface OrderItem {
     createdAt: string;
     updatedAt: string;
 }
-export interface Order {
+export interface Order<Product = Record<string, unknown>, Variant = Record<string, unknown>> {
     /**
      * The `id` can be applied as a parameter on the url to retrieve an individual order in the [Fetch Order by ID](#fetch-order-by-id) endpoint.
      */
@@ -318,9 +313,7 @@ export interface Order {
     };
     currencyCode: string;
     customData?: {
-        score?: {
-            [k: string]: unknown;
-        } | string | number | unknown[] | boolean;
+        score?: Record<string, unknown> | string | number | unknown[] | boolean;
         [k: string]: unknown;
     };
     customer?: {
@@ -337,9 +330,7 @@ export interface Order {
          * Additional data attached by the client to enhance the customer
          */
         customData?: {
-            score?: {
-                [k: string]: unknown;
-            } | string | number | unknown[] | boolean;
+            score?: Record<string, unknown> | string | number | unknown[] | boolean;
             [k: string]: unknown;
         };
         email?: string;
@@ -387,7 +378,7 @@ export interface Order {
         [k: string]: unknown;
     };
     invoicedAt?: string;
-    items?: OrderItem[];
+    items?: OrderItem<Product, Variant>[];
     loyaltyCard?: {
         cardNumber?: string;
         points: number;
@@ -399,9 +390,7 @@ export interface Order {
         /**
          * The `data` attribute will contain the data pushed to the Checkout by the Payment Provider in use (or internally generated, should the payment not be provided by an external PSP). This object's structure depends on the PSP itself, however, it will contain the minimum dataset necessary for further processing of the Order.
          */
-        data?: {
-            [k: string]: unknown;
-        };
+        data?: Record<string, unknown>;
         /**
          * Details about installments, included as a listing of the values involved in the Installments transaction.
          */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.13.0",
+  "version": "8.14.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",