@scayle/storefront-nuxt 7.69.1 → 7.70.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @scayle/storefront-nuxt
 
+## 7.70.0
+
+### Minor Changes
+
+- `rpcContext.campaignKey` will now be set to the key of the first active campaign matching `$shopConfig.storeCampaignKeyword`. When `$shopConfig.storeCampaignKeyword` is set, campaign keys not starting with `$shopConfig.storeCampaignKeyword` will be ignored.
+
+  This behavior, is now similar to the nuxt 2 implementation.
+
+- It is now also possible to extend the RPCContext using the `storefront:context:created` nitro runtime hook.
+
+  ```ts
+  import { defineNitroPlugin } from "nitropack/runtime/plugin";
+  // Augment RpxContext type
+  declare module "@scayle/storefront-nuxt" {
+    interface AdditionalRpcContext {
+      myNewProp: string;
+    }
+  }
+
+  // Set new value on rpcContext
+  export default defineNitroPlugin((nitroApp) => {
+    nitroApp.hooks.hook("storefront:context:created", (rpcContext) => {
+      rpcContext.myNewProp = "My campaign key";
+    });
+  });
+  ```
+
+### Patch Changes
+
+- Add campaignKey dependency to nitro
+- Updated dependencies
+  - @scayle/storefront-core@7.51.0
+
 ## 7.69.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,8 +1,9 @@
-export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, M as ModuleOptions, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.747e8a0a.mjs';
+export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, M as ModuleOptions, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.c7df291d.mjs';
 export { rpcCall } from './rpc.mjs';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';
+import '@nuxt/schema';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import 'nuxt/app';

package/dist/index.d.ts

@@ -1,8 +1,9 @@
-export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, M as ModuleOptions, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.747e8a0a.js';
+export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, M as ModuleOptions, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.c7df291d.js';
 export { rpcCall } from './rpc.js';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';
+import '@nuxt/schema';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import 'nuxt/app';

package/dist/module.d.mts

@@ -1,6 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { M as ModuleOptions } from './shared/storefront-nuxt.747e8a0a.mjs';
-export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.747e8a0a.mjs';
+import { M as ModuleOptions } from './shared/storefront-nuxt.c7df291d.mjs';
+export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.c7df291d.mjs';
 export { LogLevel } from '@scayle/storefront-core';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';

package/dist/module.d.ts

@@ -1,6 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { M as ModuleOptions } from './shared/storefront-nuxt.747e8a0a.js';
-export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.747e8a0a.js';
+import { M as ModuleOptions } from './shared/storefront-nuxt.c7df291d.js';
+export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.c7df291d.js';
 export { LogLevel } from '@scayle/storefront-core';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "7.69.0",
+  "version": "7.69.1",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -40,7 +40,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "7.69.0";
+const PACKAGE_VERSION = "7.69.1";
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,
@@ -153,7 +153,7 @@ const module = defineNuxtModule({
       route: `${apiBasePath}/up`,
       handler: resolve("./runtime/api/up")
     });
-    const template = addTypeTemplate({
+    addTypeTemplate({
       filename: "types/storefront-bootstrap.d.ts",
       getContents: () => `// Auto-generated
         import type { RuntimeConfig } from '@nuxt/schema'
@@ -173,9 +173,6 @@ const module = defineNuxtModule({
         }
         export {}`
     });
-    nuxt.hook("prepare:types", ({ references }) => {
-      references.push({ path: template.dst });
-    });
     addServerPlugin(resolve("./runtime/nitro/plugins/nitroLogger"));
     addServerPlugin(
       resolve("./runtime/nitro/plugins/nitroRuntimeStorageConfig")
@@ -187,6 +184,7 @@ const module = defineNuxtModule({
       const runtimePaths = [
         "handler",
         "error/handler",
+        "campaignKey",
         "context",
         "createLog",
         "log",

package/dist/rpc.d.mts

@@ -1,6 +1,7 @@
 import { RpcMethodName, RpcMethodParameters, RpcMethodReturnType, RpcContext } from '@scayle/storefront-core';
 import { NuxtApp } from 'nuxt/app';
-import { P as PublicShopConfig } from './shared/storefront-nuxt.747e8a0a.mjs';
+import { P as PublicShopConfig } from './shared/storefront-nuxt.c7df291d.mjs';
+import '@nuxt/schema';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 

package/dist/rpc.d.ts

@@ -1,6 +1,7 @@
 import { RpcMethodName, RpcMethodParameters, RpcMethodReturnType, RpcContext } from '@scayle/storefront-core';
 import { NuxtApp } from 'nuxt/app';
-import { P as PublicShopConfig } from './shared/storefront-nuxt.747e8a0a.js';
+import { P as PublicShopConfig } from './shared/storefront-nuxt.c7df291d.js';
+import '@nuxt/schema';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 

package/dist/runtime/campaignKey.d.ts

@@ -0,0 +1,6 @@
+import type { StorefrontAPIClient, CachedType, Campaign, Log } from '@scayle/storefront-core';
+export declare const isCampaignActive: (campaign?: Campaign) => boolean;
+export declare const campaignHasNotEnded: (campaign: Campaign) => boolean;
+export declare const campaignKeyMatchesKeyword: (campaign: Campaign, keyword?: string) => boolean;
+export declare const sortCampaignsByDateAscending: (a: Campaign, b: Campaign) => number;
+export declare const fetchCampaignKey: (bapiClient: StorefrontAPIClient, cached: CachedType, storeCampaignKeyword: string | undefined, log: Log) => Promise<string | undefined>;

package/dist/runtime/campaignKey.mjs

@@ -0,0 +1,44 @@
+export const isCampaignActive = (campaign) => {
+  if (!campaign) {
+    return false;
+  }
+  const timeNow = Date.now();
+  const campaignStart = new Date(campaign.start_at).getTime();
+  const hasStarted = timeNow >= campaignStart;
+  const campaignEnd = new Date(campaign.end_at).getTime();
+  const hasEnded = timeNow >= campaignEnd;
+  return hasStarted && !hasEnded;
+};
+export const campaignHasNotEnded = (campaign) => {
+  return new Date(campaign.end_at).getTime() > Date.now();
+};
+export const campaignKeyMatchesKeyword = (campaign, keyword) => {
+  if (!keyword) {
+    return true;
+  }
+  return campaign.key.toLowerCase().startsWith(keyword.toLowerCase());
+};
+export const sortCampaignsByDateAscending = (a, b) => {
+  return new Date(a.start_at).getTime() - new Date(b.start_at).getTime();
+};
+export const fetchCampaignKey = async (bapiClient, cached, storeCampaignKeyword, log) => {
+  try {
+    const { campaigns } = await cached(async () => {
+      const { entities } = await bapiClient.campaigns.get();
+      return {
+        campaigns: entities.filter((campaign) => {
+          return campaignHasNotEnded(campaign) && campaignKeyMatchesKeyword(campaign, storeCampaignKeyword);
+        }).sort(sortCampaignsByDateAscending)
+      };
+    }, {
+      cacheKeyPrefix: storeCampaignKeyword ? `fetch-campaignKey-${storeCampaignKeyword}` : "fetch-campaignKey",
+      ttl: 5 * 60
+    })();
+    return campaigns.find(isCampaignActive)?.key;
+  } catch (error) {
+    log.error(
+      "Failed to get or process the campaigns from SAPI.",
+      error
+    );
+  }
+};

package/dist/runtime/context.mjs

@@ -8,6 +8,8 @@ import {
   generateBasketKey,
   generateWishlistKey
 } from "@scayle/storefront-core/dist/utils/keys";
+import { useNitroApp } from "nitropack/runtime/app";
+import { fetchCampaignKey } from "./campaignKey.mjs";
 async function getWishlistKey(appKeys, session, $log, $shopConfig) {
   return session.data.user ? await generateWishlistKey({
     keyTemplate: appKeys.wishlistKey,
@@ -81,16 +83,18 @@ export const buildContext = async (context) => {
   const bapiConfig = $shopConfig.bapi ?? $storefront.bapi;
   const appKeys = $shopConfig.appKeys ?? $storefront.appKeys;
   const idpConfig = $shopConfig.idp ?? $storefront.idp;
+  const bapiClient = new StorefrontAPIClient({
+    host: bapiConfig.host,
+    shopId: $shopConfig.shopId,
+    auth: {
+      type: "token",
+      token: bapiConfig.token
+    }
+  });
+  const cached = new Cached($cache, $log, "", $storefront.cache?.enabled ?? true).execute;
   const baseContext = {
-    cached: new Cached($cache, $log, "", $storefront.cache?.enabled ?? true).execute,
-    bapiClient: new StorefrontAPIClient({
-      host: bapiConfig.host,
-      shopId: $shopConfig.shopId,
-      auth: {
-        type: "token",
-        token: bapiConfig.token
-      }
-    }),
+    cached,
+    bapiClient,
     auth: {
       resetPasswordUrl: $shopConfig.auth?.resetPasswordUrl
     },
@@ -129,13 +133,22 @@ export const buildContext = async (context) => {
     shopId: $shopConfig.shopId,
     domain: $shopConfig.domain,
     withParams: $storefront.withParams,
-    campaignKey: $shopConfig.storeCampaignKeyword,
+    storeCampaignKeyword: $shopConfig.storeCampaignKeyword,
+    campaignKey: await fetchCampaignKey(
+      bapiClient,
+      cached,
+      $shopConfig.storeCampaignKeyword,
+      $log
+    ),
     runtimeConfiguration: config,
     ip: getRequestIP(event, { xForwardedFor: true }),
     headers: createAndPurifyHeaders(getRequestHeaders(event))
   };
-  return Object.defineProperties({}, {
+  const rpcContext = Object.defineProperties({}, {
     ...Object.getOwnPropertyDescriptors(baseContext),
     ...Object.getOwnPropertyDescriptors(await sessionProperties(context))
   });
+  const nitro = useNitroApp();
+  await nitro.hooks?.callHook("storefront:context:created", rpcContext);
+  return rpcContext;
 };

package/dist/shared/{storefront-nuxt.747e8a0a.d.mts → storefront-nuxt.c7df291d.d.mts}

@@ -1,4 +1,5 @@
-import { HashAlgorithm, IDPConfig, WithParams, ShopUser, LogLevel } from '@scayle/storefront-core';
+import { HookResult } from '@nuxt/schema';
+import { RpcContext, HashAlgorithm, IDPConfig, WithParams, ShopUser, LogLevel } from '@scayle/storefront-core';
 import { CompressionEncodings } from '@scayle/unstorage-compression-driver';
 import { BuiltinDriverName, BuiltinDriverOptions } from 'unstorage';
 
@@ -173,5 +174,10 @@ declare module '@nuxt/schema' {
         storefront: ModulePublicRuntimeConfig;
     }
 }
+declare module 'nitropack' {
+    interface NitroRuntimeHooks {
+        'storefront:context:created': (context: RpcContext) => HookResult;
+    }
+}
 
 export type { AppKeys as A, BapiConfig as B, CheckoutShopConfig as C, ModuleOptions as M, OauthConfig as O, PublicShopConfig as P, RedisConfig as R, StorageProvider as S, SessionConfig as a, CacheConfig as b, StorageEntity as c, StorageConfig as d, RedirectsConfig as e, AdditionalShopConfig as f, ShopConfig as g, ShopConfigIndexed as h, StorefrontConfig as i, CheckoutEvent as j, ModulePublicRuntimeConfig as k };

package/dist/shared/{storefront-nuxt.747e8a0a.d.ts → storefront-nuxt.c7df291d.d.ts}

@@ -1,4 +1,5 @@
-import { HashAlgorithm, IDPConfig, WithParams, ShopUser, LogLevel } from '@scayle/storefront-core';
+import { HookResult } from '@nuxt/schema';
+import { RpcContext, HashAlgorithm, IDPConfig, WithParams, ShopUser, LogLevel } from '@scayle/storefront-core';
 import { CompressionEncodings } from '@scayle/unstorage-compression-driver';
 import { BuiltinDriverName, BuiltinDriverOptions } from 'unstorage';
 
@@ -173,5 +174,10 @@ declare module '@nuxt/schema' {
         storefront: ModulePublicRuntimeConfig;
     }
 }
+declare module 'nitropack' {
+    interface NitroRuntimeHooks {
+        'storefront:context:created': (context: RpcContext) => HookResult;
+    }
+}
 
 export type { AppKeys as A, BapiConfig as B, CheckoutShopConfig as C, ModuleOptions as M, OauthConfig as O, PublicShopConfig as P, RedisConfig as R, StorageProvider as S, SessionConfig as a, CacheConfig as b, StorageEntity as c, StorageConfig as d, RedirectsConfig as e, AdditionalShopConfig as f, ShopConfig as g, ShopConfigIndexed as h, StorefrontConfig as i, CheckoutEvent as j, ModulePublicRuntimeConfig as k };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.69.1",
+  "version": "7.70.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -63,7 +63,7 @@
     "@nuxt/kit": "3.11.1",
     "@opentelemetry/api": "1.8.0",
     "@scayle/h3-session": "0.4.0",
-    "@scayle/storefront-core": "7.50.1",
+    "@scayle/storefront-core": "7.51.0",
     "@scayle/unstorage-compression-driver": "0.1.3",
     "@vueuse/core": "10.9.0",
     "consola": "3.2.3",
@@ -90,13 +90,14 @@
     "dprint": "0.45.1",
     "eslint": "9.2.0",
     "eslint-formatter-gitlab": "5.1.0",
+    "fishery": "2.2.2",
     "h3": "1.11.1",
     "node-mocks-http": "1.14.1",
     "nuxi": "3.11.1",
     "nuxt": "3.11.1",
     "publint": "0.2.7",
     "vitest": "1.6.0",
-    "vue-tsc": "2.0.17"
+    "vue-tsc": "2.0.19"
   },
   "peerDependencies": {
     "h3": "^1.10.0",