@scayle/storefront-core 8.35.0 → 8.36.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @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

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.35.0"}`).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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.35.0",
+  "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.10.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",