@scayle/storefront-core 8.34.1 → 8.36.0

package/CHANGELOG-V7.md

@@ -43,7 +43,7 @@ This changelog contains all changes of `@scayle/storefront-core` above v6.0.0 an
 
 ### Minor Changes
 
-- Set `sapiClient` in `RpcContext` as required to improve the updatability of RPC methods.
+- Set `sapiClient` in `RpcContext` as required to improve the upgradability of RPC methods.
 
 ## 7.67.1
 

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @scayle/storefront-core
 
+## 8.36.0
+
+### Minor Changes
+
+- Created a new RPC method `getCampaign` to retrieve the first active campaign.
+
+  More details can be found in the official SCAYLE Resource Center under [API Guides / Storefront API / Campaigns / List Campaigns](https://scayle.dev/en/api-guides/storefront-api/resources/campaigns/list-campaigns).
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.11.0
+
+## 8.35.0
+
+### Minor Changes
+
+- Removed optional key `fbook` from `ShopUser` interface
+- Renamed incorrectly formatted function `getBackurlFromBreadcrumbs` to `getBackURLFromBreadcrumbs`
+
+### Patch Changes
+
+- Renamed interface incorrectly named `IdenfitierFilterItemWithValues` to `IdentifierFilterItemWithValues`
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.10.0
+
 ## 8.34.1
 
 ### Patch Changes
@@ -337,7 +366,7 @@ No changes in this release.
   - `FilterItemWithValues`
   - `BooleanFilterItemWithValues`
   - `RangeFilterItemWithValues`
-  - `IdenfitierFilterItemWithValues`
+  - `IdentifierFilterItemWithValues`
   - `AttributesFilterValue`
 
 ## 8.20.1

package/dist/helpers/categoryHelper.d.ts

@@ -42,4 +42,4 @@ export declare const getBreadcrumbs: (categories: ProductCategory[] | Category,
  *
  * @returns The back URL or '/' if breadcrumbs is undefined or empty.
  */
-export declare const getBackurlFromBreadcrumbs: (breadcrumbs?: BreadcrumbItem[]) => string;
+export declare const getBackURLFromBreadcrumbs: (breadcrumbs?: BreadcrumbItem[]) => string;

package/dist/helpers/categoryHelper.mjs

@@ -39,6 +39,6 @@ export const getBreadcrumbsFromPath = (path = "", shopLocale = "") => {
 export const getBreadcrumbs = (categories, activeNode) => {
   return Array.isArray(categories) ? getBreadcrumbsFromProductCategories(categories) : getBreadcrumbsFromCategory(categories, activeNode);
 };
-export const getBackurlFromBreadcrumbs = (breadcrumbs) => {
+export const getBackURLFromBreadcrumbs = (breadcrumbs) => {
   return breadcrumbs?.[breadcrumbs?.length - 1].to ?? "/";
 };

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

@@ -1,4 +1,15 @@
+import type { Campaign } from '@scayle/storefront-api';
 import type { RpcHandler } from '../../types';
+/**
+ * Retrieves the active campaign.
+ *
+ * This RPC method retrieves the active campaign.
+ * It then returns the first active campaign.
+ *
+ * @param context The RPC Context
+ * @returns The current active campaign.
+ */
+export declare const getCampaign: RpcHandler<Campaign | undefined>;
 /**
  * Retrieves the active campaign key.
  *
@@ -6,11 +17,6 @@ import type { RpcHandler } from '../../types';
  * for an existing `campaignKey`. If not present, it fetches active campaigns from the SAPI
  * `list-campaigns` endpoint using the `sapiClient`, caching the result for 5 minutes.
  *
- * @see https://scayle.dev/en/api-guides/storefront-api/resources/campaigns/list-campaigns
- *
- * This function uses the Storefront cache (`cached()`) with a `get-campaignKey` key prefix to improve performance.
- * Cached entries are returned if found; otherwise, data is fetched and cached.
- *
  * @param context The RPC Context
  * @returns The current active campaign key.
  */

package/dist/rpc/methods/campaign.mjs

@@ -4,10 +4,7 @@ import {
   isCampaignActive
 } from "../../utils/campaign.mjs";
 import { defineRpcHandler } from "../../utils/index.mjs";
-export const getCampaignKey = defineRpcHandler(async (context) => {
-  if (context.campaignKey) {
-    return context.campaignKey;
-  }
+const getCampaigns = async (context) => {
   const { cached, sapiClient } = context;
   const { campaigns } = await cached(async () => {
     const { entities } = await sapiClient.campaigns.get();
@@ -17,8 +14,20 @@ export const getCampaignKey = defineRpcHandler(async (context) => {
       }).sort(sortCampaignsByDateAscending)
     };
   }, {
-    cacheKeyPrefix: "get-campaignKey",
+    cacheKeyPrefix: "get-campaigns",
     ttl: 5 * 60
   })();
-  return campaigns.find(isCampaignActive)?.key;
+  return campaigns;
+};
+export const getCampaign = defineRpcHandler(async (context) => {
+  const campaigns = await getCampaigns(context);
+  return campaigns.find(isCampaignActive);
+});
+export const getCampaignKey = defineRpcHandler(async (context) => {
+  if (context.campaignKey) {
+    return context.campaignKey;
+  }
+  const campaigns = await getCampaigns(context);
+  const campaign = campaigns.find(isCampaignActive);
+  return campaign?.key;
 });

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

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

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

@@ -1,6 +1,6 @@
 import type { AttributeWithBooleanValueFilter, AttributeWithValuesFilter, FiltersEndpointResponseData, ProductSearchQuery, ProductSortConfig, ProductsSearchEndpointParameters } from '@scayle/storefront-api';
 import type { Query } from './router';
-export type { FilterItemWithValues, BooleanFilterItemWithValues, AttributesFilterItemWithValues, RangeFilterItemWithValues, IdenfitierFilterItemWithValues, AttributesFilterValue, AttributeWithBooleanValueFilter, AttributeWithValuesFilter, AttributeKey, } from '@scayle/storefront-api';
+export type { FilterItemWithValues, BooleanFilterItemWithValues, AttributesFilterItemWithValues, RangeFilterItemWithValues, IdentifierFilterItemWithValues, AttributesFilterValue, AttributeWithBooleanValueFilter, AttributeWithValuesFilter, AttributeKey, } from '@scayle/storefront-api';
 /**
  * Parameters for filtering products.
  */
@@ -30,7 +30,7 @@ export interface FilterParams {
  */
 export type FetchFiltersParams = {
     includedFilters?: Array<string>;
-    /** where clause for prefiltering the filters */
+    /** where clause for pre-filtering the filters */
     where?: {
         /** The search term. */
         term?: ProductSearchQuery['term'];

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

@@ -30,7 +30,7 @@ export type ListOfPackages = {
     };
 }[];
 /**
- * When an item cannot be shipped within the regular delivery timeframe,
+ * When an item cannot be shipped within the regular delivery time frame,
  * and the warehouse is already aware of this, prior to the customer placing the
  * order (ie it is not an unintentionally delayed delivery).
  * This is generally the case when the item is out of stock and:
@@ -104,7 +104,7 @@ export interface OrderForwardAddress {
 export type OrderStatus = 'order_open' | 'payment_pending' | 'payment_reserved' | 'invoice_completed' | 'cancellation_pending' | 'cancellation_completed' | 'invoice_partially_completed';
 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 type ShippingStatusCode = 'shipping_open' | 'shipping_not_deliverable' | 'shipping_ordered' | 'shipping_delivered' | 'shipping_cancelled' | 'shipping_undeliverable' | 'shipping_returned' | 'shipping_partially_returned' | 'shipping_partially_undeliverable';
 export interface OrderItem<Product = Record<string, unknown>, Variant = Record<string, unknown>> {
     id?: string;
     /**
@@ -307,7 +307,7 @@ export interface Order<Product = Record<string, unknown>, Variant = Record<strin
          */
         withoutTax: CentAmount;
         /**
-         * The price is calculated including taxes and all applicable reductions such as discounts for sale and campaigns (should a campaign key be provdided on the request).
+         * The price is calculated including taxes and all applicable reductions such as discounts for sale and campaigns (should a campaign key be provided on the request).
          */
         withTax: CentAmount;
     };

package/dist/types/user.d.ts

@@ -166,8 +166,6 @@ export interface ShopUser {
     updatedAt: string;
     /** The user's email address. */
     email?: string;
-    /** Whether user has a connected facebook account*/
-    fbook?: boolean;
     /** The user's ID. */
     id: number;
     /** Whether the user is a guest. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.34.1",
+  "version": "8.36.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -56,12 +56,12 @@
     "ufo": "^1.5.3",
     "uncrypto": "^0.1.3",
     "utility-types": "^3.11.0",
-    "@scayle/storefront-api": "18.9.0",
+    "@scayle/storefront-api": "18.11.0",
     "@scayle/unstorage-scayle-kv-driver": "1.0.2"
   },
   "devDependencies": {
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.16.4",
+    "@types/node": "22.16.5",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "3.2.4",
     "dprint": "0.50.1",
@@ -77,7 +77,7 @@
     "@scayle/eslint-config-storefront": "4.6.1"
   },
   "volta": {
-    "node": "22.17.0"
+    "node": "22.17.1"
   },
   "scripts": {
     "clean": "rimraf ./dist",