@scayle/storefront-core 8.32.1 → 8.33.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scayle/storefront-core
 
+## 8.33.0
+
+### Minor Changes
+
+- Added test factories for order and all related types.
+
+  It is now possible to build orders with factory functions for testing purposes.
+  This will reduce the amount of boilerplate code needed to create test data.
+
+### Patch Changes
+
+- Updated dependency `@scayle/storefront-api@18.9.0` to `@scayle/storefront-api@workspace:*`
+- Updated dependency `@scayle/unstorage-scayle-kv-driver@1.0.2` to `@scayle/unstorage-scayle-kv-driver@workspace:*`
+
 ## 8.32.1
 
 ## 8.32.0
@@ -19,23 +33,23 @@
 - Added `minReduction` and `maxReduction` filter parameters to `FetchProductsByCategoryParams.where` and `FetchFiltersParams.where` types, and updated the `getProductsByCategory` and `getFilters` RPC methods to accept and handle these new reduction-based filtering conditions.
 
   ```ts
-  const { data } = useRpc("getFilters", "getFiltersKey", () => ({
+  const { data } = useRpc('getFilters', 'getFiltersKey', () => ({
     where: {
       minReduction: 10,
       maxReduction: 20,
     },
-  }));
+  }))
 
   const { data } = useRpc(
-    "getProductsByCategory",
-    "getProductsByCategoryKey",
+    'getProductsByCategory',
+    'getProductsByCategoryKey',
     () => ({
       where: {
         minReduction: 10,
         maxReduction: 20,
       },
     }),
-  );
+  )
   ```
 
 ## 8.30.3
@@ -66,28 +80,28 @@ No changes in this release.
 
   ```ts
   export const existingHandlerWithoutParams = async (_context: RpcContext) => {
-    return "existing handler";
-  };
+    return 'existing handler'
+  }
 
   export const existingHandlerWithParams = async (
     { name }: { name: string },
     _context: RpcContext,
   ) => {
-    return name;
-  };
+    return name
+  }
 
   // will become
 
   export const existingHandlerWithoutParams = defineRpcHandler(
     async (_context: RpcContext) => {
-      return "existing handler";
+      return 'existing handler'
     },
-  );
+  )
   export const existingHandlerWithParams = defineRpcHandler(
     async ({ name }: { name: string }, _context: RpcContext) => {
-      return name;
+      return name
     },
-  );
+  )
   ```
 
 ### Patch Changes
@@ -104,15 +118,15 @@ No changes in this release.
 - Added an optional `hideEmptyCategories` parameter to `getCategoryTree`. When enabled, the product count for each category is retrieved, and categories (including their children) without any products are removed. Enabling this option may increase response times, especially for large category trees.
 
   ```ts
-  import { rpcMethods } from "@scayle/storefront-core";
+  import { rpcMethods } from '@scayle/storefront-core'
 
-  rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext);
+  rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext)
   ```
 
   or
 
   ```ts
-  import { useCategoryTree } from "#storefront/composables";
+  import { useCategoryTree } from '#storefront/composables'
 
   const { data: rootCategories, status } = useCategoryTree(
     {
@@ -120,8 +134,8 @@ No changes in this release.
         hideEmptyCategories: true,
       },
     },
-    "category-navigation-tree",
-  );
+    'category-navigation-tree',
+  )
   ```
 
 ### Patch Changes
@@ -553,12 +567,12 @@ To get the default campaign key, you can call the RPC method:
 ```typescript
 // Before
 async function rpcMethod(context) {
-  const campaignKey = { context };
+  const campaignKey = { context }
   // ...
 }
 // After
 async function rpcMethod(context) {
-  const campaignKey = await context.callRpc?.("getCampaignKey");
+  const campaignKey = await context.callRpc?.('getCampaignKey')
   // ...
 }
 ```
@@ -747,43 +761,43 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
 
     ```ts
     const BadgeLabel = {
-      NEW: "new",
-      SOLD_OUT: "sold_out",
-      ONLINE_EXCLUSIVE: "online_exclusive",
-      SUSTAINABLE: "sustainable",
-      PREMIUM: "premium",
-      DEFAULT: "",
-    } as const;
+      NEW: 'new',
+      SOLD_OUT: 'sold_out',
+      ONLINE_EXCLUSIVE: 'online_exclusive',
+      SUSTAINABLE: 'sustainable',
+      PREMIUM: 'premium',
+      DEFAULT: '',
+    } as const
 
     type BadgeLabelParamsKeys =
-      | "isNew"
-      | "isSoldOut"
-      | "isOnlineOnly"
-      | "isSustainable"
-      | "isPremium";
-    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>;
+      | 'isNew'
+      | 'isSoldOut'
+      | 'isOnlineOnly'
+      | 'isSustainable'
+      | 'isPremium'
+    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>
 
     const getBadgeLabel = (params: BadgeLabelParams = {}): string => {
       if (!params) {
-        return BadgeLabel.DEFAULT;
+        return BadgeLabel.DEFAULT
       }
       const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } =
-        params;
+        params
 
       if (isNew) {
-        return BadgeLabel.NEW;
+        return BadgeLabel.NEW
       } else if (isSoldOut) {
-        return BadgeLabel.SOLD_OUT;
+        return BadgeLabel.SOLD_OUT
       } else if (isOnlineOnly) {
-        return BadgeLabel.ONLINE_EXCLUSIVE;
+        return BadgeLabel.ONLINE_EXCLUSIVE
       } else if (isSustainable) {
-        return BadgeLabel.SUSTAINABLE;
+        return BadgeLabel.SUSTAINABLE
       } else if (isPremium) {
-        return BadgeLabel.PREMIUM;
+        return BadgeLabel.PREMIUM
       } else {
-        return BadgeLabel.DEFAULT;
+        return BadgeLabel.DEFAULT
       }
-    };
+    }
     ```
 
 - **\[💥 BREAKING\]** We've standardized our configuration to use `sapi` (Storefront API) throughout the codebase, replacing the deprecated `bapi` keyword. This change improves clarity and consistency by removing the `initBapi` function, replacing the `bapiClient` property with `sapiClient` within the `RPCContext`, and updating all code references accordingly. `BapiConfig` is not exported anymore and has been superseded by `SapiConfig`.
@@ -799,15 +813,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         storefront: {
           // ...
           bapi: {
-            host: "...",
-            token: "...",
+            host: '...',
+            token: '...',
           },
           // ...
         },
         // ...
       },
       // ...
-    };
+    }
     ```
 
   - _Legacy Environment Variables:_
@@ -827,15 +841,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         storefront: {
           // ...
           sapi: {
-            host: "...",
-            token: "...",
+            host: '...',
+            token: '...',
           },
           // ...
         },
         // ...
       },
       // ...
-    };
+    }
     ```
 
   - _New Environment Variables:_
@@ -853,19 +867,19 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
 
     ```ts
     const { data, fetching, fetch, error, status } = useUser(
-      "getUser",
+      'getUser',
       // ...
-    );
-    data.value.user.authentication.storefrontAccessToken;
+    )
+    data.value.user.authentication.storefrontAccessToken
     ```
 
   - _Current Usage of dedicated `getAccessToken` RPC method:_
 
     ```ts
     const { data: accessToken } = useRpc(
-      "getAccessToken",
+      'getAccessToken',
       // ...
-    );
+    )
     ```
 
 - **\[💥 BREAKING\]** We've enhanced security for basket and wishlist keys by switching the default hashing algorithm from MD5 to the more robust SHA256.
@@ -888,7 +902,7 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         // ...
       },
       // ...
-    });
+    })
     ```
 
 - **\[💥 BREAKING\]** The attribute `loginShopId` is removed from the `ShopUser` interface as the shop now uses session cookies.
@@ -897,23 +911,23 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
   - _Previous Usage of `searchProducts` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall("searchProducts");
+    const getSearchSuggestionsRpc = useRpcCall('searchProducts')
 
     data.value = await searchProducts({
       term: String(searchQuery.value),
       ...params,
-    });
+    })
     ```
 
   - _Current Usage of `getSearchSuggestions` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall("getSearchSuggestions");
+    const getSearchSuggestionsRpc = useRpcCall('getSearchSuggestions')
 
     data.value = await getSearchSuggestionsRpc({
       term: String(searchQuery.value),
       ...params,
-    });
+    })
     ```
 
 - **\[💥 BREAKING\]** Improved basket updating: Adding an item to your basket with a reduced quantity will now correctly update the basket contents.

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.32.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.33.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/test/factories/index.d.ts

@@ -1,2 +1,3 @@
 export * from '@scayle/storefront-api/dist/test/factories';
 export * from './user';
+export * from './order';

package/dist/test/factories/index.mjs

@@ -1,2 +1,3 @@
 export * from "@scayle/storefront-api/dist/test/factories";
 export * from "./user.mjs";
+export * from "./order.mjs";

package/dist/test/factories/order.d.ts

@@ -0,0 +1,8 @@
+import { Factory } from 'fishery';
+import type { Order, OrderItem, OrderAdvancedAttribute, OrderCategory } from '../../types/sapi/order';
+export declare const orderCategoryFactory: Factory<OrderCategory>;
+export declare const orderAdvancedAttributeFactory: Factory<OrderAdvancedAttribute>;
+export declare const orderProductFactory: Factory<Record<string, unknown>>;
+export declare const orderVariantFactory: Factory<Record<string, unknown>>;
+export declare const orderItemFactory: Factory<OrderItem<Record<string, unknown>, Record<string, unknown>>>;
+export declare const orderFactory: Factory<Order<Record<string, unknown>, Record<string, unknown>>>;

package/dist/test/factories/order.mjs

@@ -0,0 +1,362 @@
+import { Factory } from "fishery";
+import {
+  attributeGroupMultiFactory,
+  attributeGroupSingleFactory
+} from "@scayle/storefront-api/dist/test/factories";
+export const orderCategoryFactory = Factory.define(() => ({
+  categoryId: 1,
+  categoryName: "Frauen",
+  categoryHidden: false,
+  categoryUrl: "/frauen",
+  categorySlug: "frauen"
+}));
+export const orderAdvancedAttributeFactory = Factory.define(() => ({
+  key: "orderAttribute",
+  label: "Order advanced attribute",
+  values: [
+    {
+      fieldSet: [
+        [
+          {
+            value: "Order"
+          }
+        ]
+      ],
+      groupSet: [
+        {
+          fieldSet: [
+            [
+              {
+                value: "Attribute value"
+              }
+            ]
+          ],
+          groupSet: []
+        }
+      ]
+    }
+  ]
+}));
+export const orderProductFactory = Factory.define(() => ({
+  id: 1,
+  advancedAttributes: {
+    advColor: orderAdvancedAttributeFactory.build({ key: "advColor" }),
+    productName: orderAdvancedAttributeFactory.build({
+      key: "productName"
+    })
+  },
+  attributes: {
+    brand: attributeGroupSingleFactory.build({ key: "brand" }),
+    brandLogo: attributeGroupSingleFactory.build({ key: "brandLogo" }),
+    category: attributeGroupMultiFactory.build({ key: "category" }),
+    color: attributeGroupSingleFactory.build({ key: "color" }),
+    colorHex: attributeGroupSingleFactory.build({ key: "colorHex" }),
+    name: attributeGroupSingleFactory.build({ key: "name" }),
+    description: attributeGroupSingleFactory.build({
+      key: "description"
+    })
+  },
+  categories: [[orderCategoryFactory.build({ categoryId: 1 })]],
+  images: [
+    {
+      hash: "9f6c628a98106dcce2bc5a4ac1de9c14"
+    }
+  ],
+  masterKey: "480306626-1",
+  name: "Chelsea Boots",
+  createdAt: "2018-01-20T09:30:15+00:00",
+  updatedAt: "2018-01-20T09:30:15+00:00"
+}));
+export const orderVariantFactory = Factory.define(() => ({
+  id: 1,
+  attributes: {
+    size: attributeGroupSingleFactory.build({ key: "size" })
+  },
+  images: [
+    {
+      hash: "9f6c628a98106dcce2bc5a4ac1de9c14"
+    }
+  ],
+  referenceKey: "563843898",
+  stock: {
+    warehouseId: 1,
+    isSellableWithoutStock: false,
+    quantity: 18,
+    supplierId: 271
+  },
+  createdAt: "2018-01-20T09:30:15+00:00",
+  updatedAt: "2018-01-20T09:30:15+00:00",
+  lowestPriorPrice: {
+    withTax: 23,
+    relativeDifferenceToPrice: 24
+  }
+}));
+export const orderItemFactory = Factory.define(
+  () => ({
+    id: "1234",
+    availableQuantity: 20,
+    customData: {
+      key: "value"
+    },
+    deliveryForecast: {
+      subsequentDelivery: {
+        key: "christmas"
+      }
+    },
+    key: "ac834d23e689u678",
+    packageId: 1,
+    price: {
+      appliedReductions: [
+        {
+          amount: {
+            absoluteWithTax: 100,
+            relative: 0.5
+          },
+          category: "sale",
+          type: "relative"
+        }
+      ],
+      reference: {
+        size: "100",
+        unit: "ml",
+        withTax: 595
+      },
+      tax: {
+        vat: {
+          amount: 190,
+          rate: 0.19
+        }
+      },
+      undiscountedWithOutTax: 1e3,
+      undiscountedWithTax: 1190,
+      withoutTax: 1e3,
+      withTax: 1190
+    },
+    product: orderProductFactory.build(),
+    variant: orderVariantFactory.build(),
+    reservationKey: "6nq69bzzkd5xufxliwg8",
+    status: "available",
+    createdAt: "2018-01-20T09:30:15+00:00",
+    updatedAt: "2018-01-20T09:30:15+00:00"
+  })
+);
+export const orderFactory = Factory.define(
+  () => ({
+    id: 1,
+    detailedStatus: {
+      order: {
+        code: "order_open",
+        name: "Order open"
+      },
+      shipping: {
+        code: "shipping_open",
+        name: "Shipping open"
+      },
+      billing: {
+        code: "billing_open",
+        name: "Billing open"
+      }
+    },
+    address: {
+      billing: {
+        id: 998,
+        additional: "c/o SCAYLE",
+        city: "Hamburg",
+        countryCode: "DEU",
+        houseNumber: "12",
+        isDefault: {
+          billing: false,
+          shipping: false
+        },
+        recipient: {
+          firstName: "Anna",
+          gender: "m",
+          lastName: "Fischer",
+          type: "personal"
+        },
+        referenceKey: "InGidcPDmL8fGkv02a3sSAgAr7ySMBfa66iw4MriYgUNI3Boq369rBOZW3stlKLWSqIjB2dXCGNbCxoM5Xww4cI8cULUoGBFJHH0",
+        street: "Wolfgangsweg",
+        zipCode: "20459",
+        createdAt: "2018-11-29T05:20:13+01:00",
+        updatedAt: "2018-11-29T05:20:13+01:00"
+      },
+      forward: {
+        additional: "c/o SCAYLE",
+        city: "Hamburg",
+        countryCode: "DEU",
+        houseNumber: "12",
+        recipient: {
+          firstName: "Anna",
+          gender: "m",
+          lastName: "Fischer",
+          type: "personal"
+        },
+        street: "Wolfgangsweg",
+        zipCode: "20459",
+        createdAt: "2018-11-29T05:20:13+01:00",
+        updatedAt: "2018-11-29T05:20:13+01:00"
+      },
+      shipping: {
+        id: 998,
+        city: "Hamburg",
+        collectionPoint: {
+          customerKey: "bced-234-234",
+          description: "Pedro's Kiosk",
+          key: "12345-a",
+          type: "hermes_parcelshop"
+        },
+        countryCode: "DEU",
+        houseNumber: "10",
+        isDefault: {
+          billing: false,
+          shipping: true
+        },
+        recipient: {
+          firstName: "Anna",
+          gender: "m",
+          lastName: "Fischer",
+          type: "personal"
+        },
+        referenceKey: "InGidcPDmL8fGkv02a3sSAgAr7ySMBfa66iw4MriYgUNI3Boq369rBOZW3stlKLWSqIjB2dXCGNbCxoM5Xww4cI8cULUoGBFJHH0",
+        street: "Domstrasse",
+        zipCode: "20459",
+        createdAt: "2018-11-29T05:20:13+01:00",
+        updatedAt: "2018-11-29T05:20:13+01:00"
+      }
+    },
+    basketKey: "basket-c6v7k4eer1",
+    confirmedAt: "2018-01-20T11:30:15+00:00",
+    cost: {
+      appliedFees: [
+        {
+          amount: {
+            withoutTax: 168,
+            withTax: 200
+          },
+          category: "delivery",
+          key: "hermes",
+          option: "express"
+        },
+        {
+          amount: {
+            withoutTax: 168,
+            withTax: 200
+          },
+          category: "payment",
+          key: "computop_creditcard"
+        },
+        {
+          amount: {
+            withoutTax: 168,
+            withTax: 200
+          },
+          category: "payment",
+          key: "computop_creditcard",
+          option: "paybreak"
+        }
+      ],
+      appliedReductions: [
+        {
+          amount: {
+            absoluteWithTax: 100,
+            relative: 0.5
+          },
+          category: "voucher",
+          type: "absolute"
+        }
+      ],
+      tax: {},
+      withoutTax: 1168,
+      withTax: 1390
+    },
+    currencyCode: "EUR",
+    customData: {
+      score: {
+        generatedOn: "2018-05-20T19:45:15+00:00",
+        result: "green"
+      }
+    },
+    customer: {
+      id: 9876,
+      authentication: {
+        type: "password"
+      },
+      birthDate: "1981-02-02",
+      customData: {
+        score: {
+          generatedOn: "2018-05-20T19:45:15+00:00",
+          result: "green"
+        }
+      },
+      email: "anna.fischer@scayle.com",
+      firstName: "Anna",
+      gender: "f",
+      groups: ["employee"],
+      lastName: "Fischer",
+      phone: "0049/1234567890",
+      publicKey: "666",
+      referenceKey: "InGidcPDmL8fGkv02a3sSAgAr7ySMBfa66iw4MriYgUNI3Boq369rBOZW3stlKLWSqIjB2dXCGNbCxoM5Xww4cI8cULUoGBFJHH0",
+      status: {
+        isActive: true,
+        isGuestCustomer: false,
+        isTestCustomer: false
+      },
+      title: "Prof.",
+      type: "personal",
+      createdAt: "2018-01-20T09:30:15+00:00",
+      updatedAt: "2018-01-20T09:30:15+00:00"
+    },
+    invoicedAt: "2018-01-22T11:30:15+00:00",
+    items: [orderItemFactory.build()],
+    packages: [
+      {
+        id: 1,
+        carrierKey: "dhl",
+        deliveryDate: {
+          maximum: "2018-02-05",
+          minimum: "2018-02-02"
+        },
+        deliveryStatus: "open",
+        shipmentKey: "shpmnt-123"
+      }
+    ],
+    payment: [
+      {
+        amount: 1190,
+        data: {
+          CCBrand: "VISA",
+          CCExpiry: "202005",
+          IPCity: "charlottenburg",
+          IPLatitude: "52.5151",
+          IPLongitude: "13.3053",
+          IPState: "berlin",
+          IPZone: "276",
+          IPZoneA2: "de"
+        },
+        key: "computop_creditcard",
+        transactionKey: "creditcard-abcde"
+      }
+    ],
+    publicKey: "666",
+    referenceKey: "InGidcPDmL8fGkv02a3sSAgAr7ySMBfa66iw4MriYgUNI3Boq369rBOZW3stlKLWSqIjB2dXCGNbCxoM5Xww4cI8cULUoGBFJHH0",
+    shipping: {
+      policy: "least_packages"
+    },
+    shop: {
+      id: 139,
+      country: "DEU",
+      language: "de"
+    },
+    status: "invoice_completed",
+    vouchers: [
+      {
+        id: 198234,
+        code: "fashion2020",
+        type: "absolute",
+        value: 1e3
+      }
+    ],
+    createdAt: "2018-01-20T09:30:15+00:00",
+    updatedAt: "2018-01-20T09:30:15+00:00"
+  })
+);

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

@@ -1,5 +1,5 @@
 import type { Gender } from '../user';
-import type { CentAmount } from './product';
+import type { AdvancedAttribute, 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.
  */
@@ -445,3 +445,11 @@ export interface Order<Product = Record<string, unknown>, Variant = Record<strin
     createdAt: string;
     updatedAt: string;
 }
+export type OrderAdvancedAttribute = Omit<AdvancedAttribute, 'id' | 'type'>;
+export interface OrderCategory {
+    categoryHidden: boolean;
+    categoryId: number;
+    categoryName: string;
+    categorySlug: string;
+    categoryUrl: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.32.1",
+  "version": "8.33.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -49,32 +49,32 @@
     "fishery": "^2.2.3"
   },
   "dependencies": {
-    "@scayle/storefront-api": "18.9.0",
-    "@scayle/unstorage-scayle-kv-driver": "1.0.2",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
     "jose": "^6.0.8",
     "slugify": "^1.6.6",
     "ufo": "^1.5.3",
     "uncrypto": "^0.1.3",
-    "utility-types": "^3.11.0"
+    "utility-types": "^3.11.0",
+    "@scayle/storefront-api": "18.9.0",
+    "@scayle/unstorage-scayle-kv-driver": "1.0.2"
   },
   "devDependencies": {
-    "@scayle/eslint-config-storefront": "4.5.12",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.15.34",
+    "@types/node": "22.16.0",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "3.2.4",
     "dprint": "0.50.1",
     "eslint-formatter-gitlab": "6.0.1",
-    "eslint": "9.30.0",
+    "eslint": "9.30.1",
     "fishery": "2.3.1",
     "publint": "0.3.12",
     "rimraf": "6.0.1",
     "typescript": "5.8.3",
     "unbuild": "3.5.0",
     "unstorage": "1.16.0",
-    "vitest": "3.2.4"
+    "vitest": "3.2.4",
+    "@scayle/eslint-config-storefront": "4.5.12"
   },
   "volta": {
     "node": "22.17.0"