@scayle/storefront-nuxt 8.44.2 → 8.45.0

package/dist/runtime/utils/zodSchema.js

@@ -1,4 +1,7 @@
 import * as z from "zod/mini";
+import {
+  rpcMethods
+} from "@scayle/storefront-core";
 import { builtinDrivers } from "unstorage";
 export const RedirectsSchema = z.object({
   enabled: z.boolean(),
@@ -7,11 +10,11 @@ export const RedirectsSchema = z.object({
 });
 const SessionSchema = z.object({
   /**
-   * The sameSite policy to use for the session cookie
+   * The `sameSite` policy to use for the session cookie
    */
   sameSite: z.optional(z.enum(["lax", "strict", "none"])),
   /**
-   * The default maxAge (in seconds) set on the session cookie and default TTL for session store
+   * The default `maxAge` (in seconds) set on the session cookie and default TTL for session store
    */
   maxAge: z.optional(z.number()),
   /**
@@ -104,7 +107,9 @@ const ShopConfigSchema = z.object({
   isEnabled: z.optional(z.boolean()),
   sessionConfig: z.optional(SessionSchema),
   sapi: z.optional(SapiSchema),
-  /** @deprecated The `storage` option within `shopConfig` is deprecated. Consider using nuxt storage configuration instead.  */
+  /**
+   * @deprecated The `storage` option within `shopConfig` is deprecated. Consider using nuxt storage configuration instead.
+   */
   storage: z.optional(z.object({
     session: z.optional(StorageSchema),
     cache: z.optional(StorageSchema)
@@ -119,39 +124,63 @@ const CacheSchema = z.object({
   enabled: z.optional(z.boolean())
 });
 const ShopSelectorSchema = z.enum(["path", "domain", "path_or_default"]);
-const StorefrontConfigSchema = z.object({
+const StorefrontRuntimeConfigSchema = z.object({
+  /**
+   * 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: ShopSelectorSchema,
+  /**
+   * 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: z.optional(RedirectsSchema),
+  /**
+   * Configures the available shops in the Storefront Application. Each shop represents a specific region or language,
+   * with each shop identified by its unique shop ID from the SCAYLE tenant.
+   *
+   * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#shops
+   */
+  shops: z.record(z.string(), ShopConfigSchema),
   session: z.optional(SessionSchema),
-  /** @deprecated The `storage` option within `storefront` is deprecated. Consider using nuxt storage configuration instead.  */
+  /**
+   * @deprecated The `storage` option within `storefront` is deprecated. Consider using nuxt storage configuration instead.
+   */
   storage: z.optional(z.object({
     session: z.optional(StorageSchema),
     cache: z.optional(StorageSchema)
   })),
   oauth: OAuthSchema,
   appKeys: AppKeysSchema,
-  apiBasePath: z.optional(z.string()),
   cache: z.optional(CacheSchema),
   publicShopData: z.optional(z.array(z.string())),
   idp: z.optional(IdpSchema),
   sapi: SapiSchema,
-  /** Collection of feature flags regarding legacy features and functionalities */
+  /**
+   * Collection of feature flags regarding legacy features and functionalities.
+   */
   legacy: z.optional(LegacySchema),
-  /** Undocumented property intended for internal usage only */
+  /**
+   * @hidden
+   * Undocumented property intended for internal usage only
+   */
   internalAccessHeader: z.optional(z.string())
 });
-const ModuleOptionSchema = z.object(
-  {
-    shopSelector: ShopSelectorSchema,
-    redirects: z.optional(RedirectsSchema),
-    shops: z.record(z.string(), ShopConfigSchema)
-  }
-);
 const logLevel = z.enum([
   "debug",
   "info",
   "warn",
   "error"
 ]);
-const PublicRuntimeConfigSchema = z.object({
+const StorefrontPublicRuntimeConfigSchema = z.object({
   log: z.object({
     name: z.string(),
     level: logLevel,
@@ -164,8 +193,30 @@ const PublicRuntimeConfigSchema = z.object({
   }))
 });
 export const RuntimeConfigSchema = z.object({
-  storefront: z.intersection(ModuleOptionSchema, StorefrontConfigSchema),
+  storefront: StorefrontRuntimeConfigSchema,
   public: z.object({
-    storefront: PublicRuntimeConfigSchema
+    storefront: StorefrontPublicRuntimeConfigSchema
   })
 });
+const AvailableRpcMethods = z.enum(
+  Object.keys(rpcMethods)
+);
+const ModuleOptionSchema = z.object({
+  /**
+   * 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: z.optional(z.string()),
+  /**
+   * The RPC method names which are exported from the `rpcDir`.
+   * Usually this can just be `Object.keys(rpcMethodsDir)`.
+   */
+  rpcMethodNames: z.optional(z.array(z.string())),
+  /** Specify explicitly overridden RPC methods that are provided by the Storefront Core package. */
+  rpcMethodOverrides: z.optional(z.array(AvailableRpcMethods)),
+  /**
+   * The base path for API routes.
+   */
+  apiBasePath: z.optional(z.string())
+});

package/dist/test/factories.d.mts

@@ -1,6 +1,7 @@
 import * as fishery from 'fishery';
 import { Factory } from 'fishery';
-import { ModuleBaseOptions, ShopConfig } from '../../dist/runtime/types/module.js';
+import { StorefrontRuntimeConfigType } from '../../dist/runtime/utils/zodSchema.js';
+import { ShopConfig } from '../../dist/runtime/types/module.js';
 import * as hookable from 'hookable';
 import * as _scayle_storefront_core from '@scayle/storefront-core';
 import { RpcContext, StorefrontAPIClient, Log, RuntimeConfiguration, ContextWithoutSession, ContextWithSession } from '@scayle/storefront-core';
@@ -10,7 +11,23 @@ export * from '@scayle/storefront-core/test/factories';
 interface ModuleOptionsFactoryParams {
     shops: ShopConfig[];
 }
-declare const moduleOptionsFactory: Factory<ModuleBaseOptions, ModuleOptionsFactoryParams, ModuleBaseOptions, fishery.DeepPartialObject<ModuleBaseOptions>>;
+declare const moduleRuntimeOptionsFactory: Factory<StorefrontRuntimeConfigType, ModuleOptionsFactoryParams, StorefrontRuntimeConfigType, fishery.DeepPartialObject<StorefrontRuntimeConfigType>>;
+declare const moduleOptionsFactory: Factory<{
+    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;
+}, any, {
+    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;
+}, fishery.DeepPartialObject<{
+    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;
+}>>;
 
 declare const shopConfigFactory: Factory<ShopConfig, any, ShopConfig, fishery.DeepPartialObject<ShopConfig>>;
 
@@ -99,4 +116,4 @@ declare const rpcContextFactory: Factory<RpcContext, RpcContextFactoryParams, Rp
 
 declare const routeFactory: Factory<RouteLocationNormalizedLoadedGeneric, any, RouteLocationNormalizedLoadedGeneric, fishery.DeepPartialObject<RouteLocationNormalizedLoadedGeneric>>;
 
-export { moduleOptionsFactory, routeFactory, rpcContextFactory, shopConfigFactory };
+export { moduleOptionsFactory, moduleRuntimeOptionsFactory, routeFactory, rpcContextFactory, shopConfigFactory };

package/dist/test/factories.mjs

@@ -2,7 +2,7 @@ import { Factory } from 'fishery';
 import { HashAlgorithm, Log, StorefrontAPIClient } from '@scayle/storefront-core';
 export * from '@scayle/storefront-core/test/factories';
 
-const moduleOptionsFactory = Factory.define(({ transientParams }) => {
+const moduleRuntimeOptionsFactory = Factory.define(({ transientParams }) => {
   return {
     sapi: {
       host: "sapiHost",
@@ -27,6 +27,14 @@ const moduleOptionsFactory = Factory.define(({ transientParams }) => {
     }, {})
   };
 });
+const moduleOptionsFactory = Factory.define(() => {
+  return {
+    rpcDir: void 0,
+    rpcMethodNames: void 0,
+    rpcMethodOverrides: void 0,
+    apiBasePath: "/api"
+  };
+});
 
 const shopConfigFactory = Factory.define(() => {
   return {
@@ -112,4 +120,4 @@ const routeFactory = Factory.define(
   })
 );
 
-export { moduleOptionsFactory, routeFactory, rpcContextFactory, shopConfigFactory };
+export { moduleOptionsFactory, moduleRuntimeOptionsFactory, routeFactory, rpcContextFactory, shopConfigFactory };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.44.2",
+  "version": "8.45.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -90,7 +90,7 @@
     "utility-types": "^3.11.0",
     "vue-router": "^4.4.0",
     "zod": "^4.0.0",
-    "@scayle/storefront-core": "8.44.2",
+    "@scayle/storefront-core": "8.45.0",
     "@scayle/unstorage-compression-driver": "1.2.1"
   },
   "devDependencies": {