@scayle/storefront-nuxt 8.44.2 → 8.45.0

package/CHANGELOG.md

@@ -1,5 +1,76 @@
 # @scayle/storefront-nuxt
 
+## 8.45.0
+
+### Minor Changes
+
+- The API routes structure was updated for multi-shop environments. The `apiBasePath` option was removed from per-shop configuration but remains configurable at the module level.
+
+  NOTE: Update your `nuxt.config.ts` to ensure `routeRules` for `/api/**` uses the manually set `apiBasePath` value to prevent caching issues with session-related RPC's and potentially failing requests!
+
+  **Before (per-shop apiBasePath):**
+
+  ```typescript
+  // This configuration is no longer supported
+  runtimeConfig: {
+    storefront: {
+      shops: {
+        1001: {
+          shopId: 1001,
+          path: 'de',
+          apiBasePath: '/custom-api', // ❌ No longer supported
+          // ... other shop config
+        },
+        1002: {
+          shopId: 1002,
+          path: 'en',
+          apiBasePath: '/different-api', // ❌ No longer supported
+          // ... other shop config
+        }
+      }
+    }
+  }
+  ```
+
+  **After (module-level apiBasePath):**
+
+  ```typescript
+  // nuxt.config.ts
+  export default defineNuxtConfig({
+    storefront: {
+      apiBasePath: '/custom-api', // ✅ Configure globally for all shops
+    },
+    runtimeConfig: {
+      storefront: {
+        shops: {
+          1001: {
+            shopId: 1001,
+            path: 'de',
+            // ✅ apiBasePath removed from shop config
+            // ... other shop config
+          },
+          1002: {
+            shopId: 1002,
+            path: 'en',
+            // ✅ apiBasePath removed from shop config
+            // ... other shop config
+          },
+        },
+      },
+    },
+  })
+  ```
+
+  Additionally, the types for the Storefront module options and Storefront runtime configuration have been cleaned up to properly reflect which settings can be set at runtime and which cannot. This clarifies the distinction between configuration that is static (set at build/module level) and configuration that is dynamic (set at runtime), improving type safety and developer experience.
+
+### Patch Changes
+
+**Dependencies**
+
+**@scayle/storefront-core v8.45.0**
+
+- No changes in this release.
+
 ## 8.44.2
 
 ### Patch Changes

package/dist/module.d.mts

@@ -1,6 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { HookResult } from '@nuxt/schema';
-import { ModuleBaseOptions } from '../dist/runtime/types/module.js';
 export * from '../dist/runtime/types/module.js';
 
 /**
@@ -52,7 +51,17 @@ declare module '@nuxt/schema' {
  *
  * @returns The Nuxt module.
  */
-declare const _default: _nuxt_schema.NuxtModule<ModuleBaseOptions, ModuleBaseOptions, false>;
+declare const _default: _nuxt_schema.NuxtModule<{
+    rpcDir?: string | undefined;
+    rpcMethodNames?: string[] | undefined;
+    rpcMethodOverrides?: ("getProductById" | "getProductsByIds" | "getProductsByReferenceKeys" | "getProductsCount" | "fetchAllFiltersForCategory" | "getFilters" | "getProductsByCategory" | "oauthForgetPassword" | "oauthGuestLogin" | "oauthLogin" | "oauthRegister" | "oauthRevokeToken" | "refreshAccessToken" | "updatePasswordByHash" | "addItemToBasket" | "addItemsToBasket" | "getBasket" | "removeItemFromBasket" | "clearBasket" | "mergeBaskets" | "updateBasketItem" | "getApplicablePromotionsByCode" | "updatePromotions" | "getBrands" | "getBrandById" | "getRootCategories" | "getCategoryByPath" | "getCategoriesByPath" | "getCategoryById" | "getCategoryTree" | "getCampaign" | "getCampaignKey" | "getOrderDataByCbd" | "getSearchSuggestions" | "resolveSearch" | "getShopConfiguration" | "getUser" | "fetchUser" | "refreshUser" | "getAccessToken" | "getWishlist" | "addItemToWishlist" | "removeItemFromWishlist" | "clearWishlist" | "getOrderById" | "getShopUserAddresses" | "updateShopUser" | "updatePassword" | "getCheckoutToken" | "getVariantById" | "fetchAllNavigationTrees" | "fetchNavigationTreeById" | "fetchNavigationTreeByName" | "getPromotions" | "getCurrentPromotions" | "getPromotionsByIds" | "getExternalIdpRedirect" | "handleIDPLoginCallback")[] | undefined;
+    apiBasePath?: string | undefined;
+}, {
+    rpcDir?: string | undefined;
+    rpcMethodNames?: string[] | undefined;
+    rpcMethodOverrides?: ("getProductById" | "getProductsByIds" | "getProductsByReferenceKeys" | "getProductsCount" | "fetchAllFiltersForCategory" | "getFilters" | "getProductsByCategory" | "oauthForgetPassword" | "oauthGuestLogin" | "oauthLogin" | "oauthRegister" | "oauthRevokeToken" | "refreshAccessToken" | "updatePasswordByHash" | "addItemToBasket" | "addItemsToBasket" | "getBasket" | "removeItemFromBasket" | "clearBasket" | "mergeBaskets" | "updateBasketItem" | "getApplicablePromotionsByCode" | "updatePromotions" | "getBrands" | "getBrandById" | "getRootCategories" | "getCategoryByPath" | "getCategoriesByPath" | "getCategoryById" | "getCategoryTree" | "getCampaign" | "getCampaignKey" | "getOrderDataByCbd" | "getSearchSuggestions" | "resolveSearch" | "getShopConfiguration" | "getUser" | "fetchUser" | "refreshUser" | "getAccessToken" | "getWishlist" | "addItemToWishlist" | "removeItemFromWishlist" | "clearWishlist" | "getOrderById" | "getShopUserAddresses" | "updateShopUser" | "updatePassword" | "getCheckoutToken" | "getVariantById" | "fetchAllNavigationTrees" | "fetchNavigationTreeById" | "fetchNavigationTreeByName" | "getPromotions" | "getCurrentPromotions" | "getPromotionsByIds" | "getExternalIdpRedirect" | "handleIDPLoginCallback")[] | undefined;
+    apiBasePath?: string | undefined;
+}, false>;
 
 export { _default as default };
 export type { ModuleHooks };

package/dist/module.json

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

package/dist/module.mjs

@@ -1,5 +1,5 @@
 import { existsSync } from 'node:fs';
-import { defineNuxtModule, createResolver, extendViteConfig, addTypeTemplate, addPlugin, addImportsDir } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addServerTemplate, addTypeTemplate, extendViteConfig, addPlugin, addImportsDir } from '@nuxt/kit';
 import { rpcMethods } from '@scayle/storefront-core';
 import { defu } from 'defu';
 import { genExport, genImport, genSafeVariableName } from 'knitwork';
@@ -54,7 +54,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.44.2";
+const PACKAGE_VERSION = "8.45.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -228,49 +228,73 @@ const module = defineNuxtModule({
   },
   // Default configuration options of the Nuxt module
   defaults: {
-    // TODO: Nuxt is making us give a default for each options
-    // How do we mark some as required?
-    session: {
-      cookieName: "$session",
-      sameSite: "lax"
-      // TODO: If we give a default value here, nuxt will generate the runtime type incorrectly
-      // secret needs to be typed as string | string[]
-      // secret: 'current-secret',
-      // if we set maxAge explicitly to undefined `useRuntimeConfig` will set it default to '' which leads to no sessions not being saved
-      // maxAge: undefined,
-    },
-    shopSelector: "domain",
-    oauth: {
-      apiHost: "",
-      clientId: "",
-      clientSecret: ""
-    },
-    idp: {
-      enabled: false,
-      idpKeys: [],
-      idpRedirectURL: ""
-    },
-    appKeys: {
-      wishlistKey: "wishlist_{shopId}_{userId}",
-      basketKey: "basket_{shopId}_{userId}",
-      hashAlgorithm: "sha256"
-    },
-    legacy: {
-      enableSessionMigration: false
-    },
-    /**
-     * The internal access header.
-     *
-     * @hidden
-     */
-    internalAccessHeader: ""
+    rpcDir: void 0,
+    rpcMethodNames: void 0,
+    rpcMethodOverrides: void 0,
+    apiBasePath: "/api"
   },
   async setup(options, nuxt) {
     const { resolve } = createResolver(import.meta.url);
     const { resolve: appResolve } = createResolver(nuxt.options.rootDir);
+    addServerTemplate({
+      filename: "#internal/storefront-options.mjs",
+      getContents: () => `
+        export const apiBasePath = '${options.apiBasePath}'
+        export const rpcMethodNames = ${options.rpcMethodNames ? JSON.stringify(options.rpcMethodNames, null, 2) : "undefined"}
+        export const rpcMethodOverrides = ${options.rpcMethodOverrides ? JSON.stringify(options.rpcMethodOverrides, null, 2) : "undefined"}
+      `
+    });
+    addTypeTemplate({
+      filename: "types/storefront-options.d.ts",
+      getContents: () => `
+        declare module '#internal/storefront-options.mjs' {
+          export const apiBasePath: string
+          export const rpcMethodNames: string[] | undefined
+          export const rpcMethodOverrides: string[] | undefined
+        }
+      `
+    });
+    const runtimeConfigDefaults = {
+      // TODO: Nuxt is making us give a default for each options
+      // How do we mark some as required?
+      session: {
+        cookieName: "$session",
+        sameSite: "lax"
+        // TODO: If we give a default value here, nuxt will generate the runtime type incorrectly
+        // secret needs to be typed as string | string[]
+        // secret: 'current-secret',
+        // if we set maxAge explicitly to undefined `useRuntimeConfig` will set it default to '' which leads to no sessions not being saved
+        // maxAge: undefined,
+      },
+      shopSelector: "domain",
+      oauth: {
+        apiHost: "",
+        clientId: "",
+        clientSecret: ""
+      },
+      idp: {
+        enabled: false,
+        idpKeys: [],
+        idpRedirectURL: ""
+      },
+      appKeys: {
+        wishlistKey: "wishlist_{shopId}_{userId}",
+        basketKey: "basket_{shopId}_{userId}",
+        hashAlgorithm: "sha256"
+      },
+      legacy: {
+        enableSessionMigration: false
+      },
+      internalAccessHeader: "",
+      shops: {},
+      sapi: {
+        host: "",
+        token: ""
+      }
+    };
     nuxt.options.runtimeConfig.storefront = defu(
       nuxt.options.runtimeConfig.storefront,
-      options
+      runtimeConfigDefaults
     );
     nuxt.options.runtimeConfig.public.storefront = defu(nuxt.options.runtimeConfig.public.storefront, {
       log: {

package/dist/runtime/context.d.ts

@@ -3,14 +3,15 @@ import type { RuntimeConfig } from '@nuxt/schema';
 import type { H3Event } from 'h3';
 import type { Log, RpcContext, Cache as CacheInterface } from '@scayle/storefront-core';
 import { StorefrontAPIClient } from '@scayle/storefront-core';
-import type { ShopConfig, StorefrontConfig } from '../module.js';
+import type { ShopConfig } from '../module.js';
+import type { StorefrontRuntimeConfigType } from './utils/zodSchema.js';
 /**
  * Interface defining the options for the context builder.
  */
 export interface ContextBuilderOptions {
     $cache: CacheInterface;
     $shopConfig: ShopConfig;
-    $storefront: StorefrontConfig;
+    $storefront: StorefrontRuntimeConfigType;
     $log: Log;
     sessionId?: string;
     session?: Session;

package/dist/runtime/context.js

@@ -10,6 +10,7 @@ import { useNitroApp } from "nitropack/runtime";
 import { getCachedFunction } from "./cached.js";
 import { getApiBasePath } from "./server/middleware/bootstrap-utils.js";
 import { fetchCampaignKey } from "./campaignKey.js";
+import * as moduleOptions from "#internal/storefront-options.mjs";
 async function getWishlistKey(appKeys, session, $log, $shopConfig) {
   return session.data.user ? await generateWishlistKey({
     keyTemplate: appKeys.wishlistKey,
@@ -69,7 +70,7 @@ export const buildContext = async (context) => {
   const callRpc = buildRpcCall(
     context.event,
     $shopConfig,
-    getApiBasePath($storefront, "/")
+    getApiBasePath(moduleOptions, "/")
   );
   const rpcContext = {
     cached,

package/dist/runtime/server/middleware/bootstrap-utils.d.ts

@@ -1,6 +1,7 @@
 import type { H3Event } from 'h3';
-import type { ModuleBaseOptions, PublicShopConfig, ShopConfig, ShopConfigIndexed } from '../../../module.js';
+import type { ModuleOptions, PublicShopConfig, ShopConfig, ShopConfigIndexed } from '../../../module.js';
 import type { NitroRuntimeConfigApp } from 'nitropack';
+import type { StorefrontRuntimeConfigType } from '../../utils/zodSchema.js';
 /**
  * Represents the bootstrapped path information.
  */
@@ -39,7 +40,7 @@ export declare const getShopByPath: (event: H3Event, shops: ShopConfig[], appBas
  *
  * @returns The shops as an array.
  */
-export declare const convertShopsToList: (shops: ShopConfig[] | ShopConfigIndexed) => ShopConfig[];
+export declare const convertShopsToList: (shops: ShopConfig[] | ShopConfigIndexed | StorefrontRuntimeConfigType["shops"]) => ShopConfig[];
 /**
  * Gets the API base path.
  *
@@ -48,7 +49,7 @@ export declare const convertShopsToList: (shops: ShopConfig[] | ShopConfigIndexe
  *
  * @returns The API base path.
  */
-export declare function getApiBasePath(storefrontConfig: Pick<ModuleBaseOptions, 'apiBasePath'>, baseUrl: string): string;
+export declare function getApiBasePath(storefrontConfig: Pick<ModuleOptions, 'apiBasePath'>, baseUrl: string): string;
 /**
  * Retrieves the current shop configuration for a given request.
  *
@@ -58,7 +59,7 @@ export declare function getApiBasePath(storefrontConfig: Pick<ModuleBaseOptions,
  *
  * @returns The shop config for the current request if found or undefined.
  */
-export declare function getCurrentShopConfigForRequest(event: H3Event, storefrontConfig: Pick<ModuleBaseOptions, 'shops' | 'shopSelector'>, runtimeConfig: NitroRuntimeConfigApp): ShopConfig | undefined;
+export declare function getCurrentShopConfigForRequest(event: H3Event, storefrontConfig: Pick<StorefrontRuntimeConfigType, 'shops' | 'shopSelector'>, runtimeConfig: NitroRuntimeConfigApp): ShopConfig | undefined;
 /**
  * Transforms shop configuration data into a public representation, including active status.
  *

package/dist/runtime/server/middleware/bootstrap.js

@@ -15,6 +15,7 @@ import {
 } from "./bootstrap-utils.js";
 import { useRedirects } from "./redirects.js";
 import { useRuntimeConfig } from "#imports";
+import * as moduleOptions from "#internal/storefront-options.mjs";
 const generateSessionId = (event) => {
   let userId;
   if (event?.context.session?.data?.accessToken) {
@@ -147,7 +148,7 @@ export default defineEventHandler(async (event) => {
     return;
   }
   const $storefrontConfig = config.storefront;
-  if (path === `${$storefrontConfig.apiBasePath ?? "/api"}/up`) {
+  if (path === `${getApiBasePath(moduleOptions, "/")}/up`) {
     return;
   }
   const $shopConfig = getCurrentShopConfigForRequest(
@@ -163,7 +164,7 @@ export default defineEventHandler(async (event) => {
     return;
   }
   const apiBasePath = getApiBasePath(
-    $storefrontConfig,
+    moduleOptions,
     config.app.baseURL
   );
   if (!event.context.$rpcContext) {

package/dist/runtime/types/module.d.ts

@@ -1,7 +1,7 @@
-import type { HashAlgorithm, ShopUser, WithParams, rpcMethods, StorefrontHooks, RpcMethodName, RpcContext } from '@scayle/storefront-core';
+import type { HashAlgorithm, ShopUser, StorefrontHooks, RpcMethodName, RpcContext } from '@scayle/storefront-core';
 import type { CompressionEncodings } from '@scayle/unstorage-compression-driver';
 import type { BuiltinDriverName, BuiltinDriverOptions } from 'unstorage';
-import type { CheckoutShopConfigType, SessionType, StorageType, SapiConfigType, ShopConfigType, StorefrontConfigType, ShopSelectorType, ModulePublicRuntimeConfigType, RedirectType, IdpType } from '../utils/zodSchema.js';
+import type { CheckoutShopConfigType, SessionType, StorageType, SapiConfigType, ShopConfigType, StorefrontRuntimeConfigType, StorefrontPublicRuntimeConfigType, IdpType, ModuleOptionType } from '../utils/zodSchema.js';
 import type { HookResult } from '@nuxt/schema';
 export type { LogLevel } from '@scayle/storefront-core';
 /**
@@ -117,93 +117,11 @@ export interface PublicShopConfig extends Pick<ShopConfig, 'shopId' | 'domain' |
 /**
  * Storefront configuration.
  */
-export type StorefrontConfig = StorefrontConfigType & {
-    /**
-     * Default "with" parameters for Storefront API requests. These are used as defaults
-     * within composables like `useWishlist` and can be overridden if needed.  Some
-     * composables also enforce minimum "with" parameters.
-     *
-     * @example
-     * // Default `with` parameters for product listings.
-     * withParams: {
-     *   items: {
-     *     product: {
-     *       attributes: "all",
-     *       advancedAttributes: "all",
-     *       variants: {
-     *         attributes: "all",
-     *         advancedAttributes: "all",
-     *       },
-     *       images: "all",
-     *       categories: {
-     *         properties: "all"
-     *       },
-     *       priceRange: boolean
-     *     },
-     *     variant: {
-     *       attributes: "all",
-     *     },
-     *   },
-     * }
-     * @see https://scayle.dev/en/storefront-guide/support-and-resources/upgrade-guides/nuxt-3/storefront-core-changes#withparameters
-     */
-    withParams?: WithParams;
-};
-/**
- * Nuxt module options.
- */
-type ModuleOption = {
-    /**
-     * Shop selector.
-     *
-     * This determines how the application identifies and switches between different shops.
-     * It influences how the `domain` and `path` properties are used within the `shops` configuration.
-     *
-     * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#path-and-domain
-     */
-    shopSelector: ShopSelectorType;
-    /**
-     * Redirects configuration.
-     *
-     * This controls how the application handles URL redirects by leveraging the Storefront API,
-     * which is synchronized with the SCAYLE Panel. When enabled,
-     * the Storefront Core intercepts requests and checks for potential
-     * redirects via the Storefront API. If a match is found, a 30x HTTP response
-     * is returned with the target in the `Location` header and the appropriate
-     * status code.
-     *
-     * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/redirects
-     */
-    redirects?: RedirectType;
-    /**
-     * Shops configuration indexed by shop ID.
-     *
-     * Storefront applications typically support multiple shops for different regions or languages.
-     * This configuration specifies the shops to use from your SCAYLE tenant space.
-     *
-     * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#shops
-     */
-    shops: ShopConfigIndexed;
-};
 export type SupportedDriverName = BuiltinDriverName | 'scayleKv';
 /**
  * Module base options. Extends `StorefrontConfig` and `ModuleOption`.
  */
-export type ModuleBaseOptions = StorefrontConfig & ModuleOption & {
-    /**
-     * The RPC directory where the custom application RPCs are defined.
-     * The directory should have an `index.ts` file where all RPCs are exported using their name.
-     * By default this will be `./rpcMethods`.
-     */
-    rpcDir?: string;
-    /**
-     * The RPC method names which are exported from the `rpcDir`.
-     * Usually this can just be `Object.keys(rpcMethodsDir)`.
-     */
-    rpcMethodNames?: string[];
-    /** Specify explicitly overridden RPC methods that are provided by the Storefront Core package. */
-    rpcMethodOverrides?: Array<keyof typeof rpcMethods>;
-};
+export type ModuleOptions = ModuleOptionType;
 /**
  * Checkout event used for tracking with Google Tag Manager.
  *
@@ -237,11 +155,11 @@ export interface CheckoutEvent {
         status: 'successful' | 'error';
     };
 }
-export interface ModulePublicRuntimeConfig extends ModulePublicRuntimeConfigType {
+export interface ModulePublicRuntimeConfig extends StorefrontPublicRuntimeConfigType {
 }
 declare module '@nuxt/schema' {
     interface RuntimeConfig {
-        storefront: ModuleBaseOptions;
+        storefront: StorefrontRuntimeConfigType;
     }
     interface PublicRuntimeConfig {
         storefront: ModulePublicRuntimeConfig;