@scayle/storefront-nuxt 8.44.2 → 8.45.1

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

@@ -1,19 +1,19 @@
-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';
 /**
  * Represents shop-specific configuration relating to the SCAYLE Checkout.
  *
- * @see https://scayle.dev/en/checkout-guide/authentication-accounts/general#create-api-client
+ * @see https://scayle.dev/en/core-documentation/checkout-guide/authentication-accounts/authetication/headless/authenticate#creating-api-clients
  */
 export type CheckoutShopConfig = CheckoutShopConfigType;
 /**
  * Representation of options to configure how the storefront core manages sessions
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/sessions#configuration
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/sessions#session-configuration
  */
 export type SessionConfig = SessionType;
 /**
@@ -30,7 +30,7 @@ type CustomDriverName = string & {
  * @template Driver The storage driver.
  * @template DriverOptions The driver options.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/caching#storefront-storage-cache-configuration
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/storage#configuration-of-storage-mounts
  */
 export type StorageEntity<Driver extends SupportedDriverName | CustomDriverName | unknown = unknown, DriverOptions = Driver extends keyof BuiltinDriverOptions ? BuiltinDriverOptions[Driver] : unknown> = {
     driver: Driver;
@@ -41,7 +41,7 @@ export type StorageEntity<Driver extends SupportedDriverName | CustomDriverName
  * Storefront Core utilizes pre-configured and reusable mount points built on top of Unstorage
  * and the Nitro Storage Layer, providing various caching capabilities.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#storage
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/storage
  */
 export interface StorageConfig {
     /**
@@ -50,7 +50,7 @@ export interface StorageConfig {
      * Should no dedicated `StorageType` / `StorageEntity` be configured,
      * Storefront Core will use an In-Memory driver as default for this storage mountpoints.
      *
-     * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/caching#storefront-storage-cache-configuration
+     * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/storage#configuration-of-storage-mounts
      */
     cache?: StorageType;
     /**
@@ -59,7 +59,7 @@ export interface StorageConfig {
      * Should no dedicated `StorageType` / `StorageEntity` be configured,
      * Storefront Core will use an In-Memory driver as default for this storage mountpoints.
      *
-     * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/caching#storefront-storage-cache-configuration
+     * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/storage#configuration-of-storage-mounts
      */
     session?: StorageType;
 }
@@ -67,14 +67,14 @@ export interface StorageConfig {
  * Represents the Storefront API configuration used authenticate with it.
  *
  * @see https://scayle.dev/en/api-guides/storefront-api/getting-started/authentication
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#storefront-api
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/configuration#storefront-api
  */
 export type SapiConfig = SapiConfigType;
 /**
  * Representation of Application-specific keys,
  * defining how keys are generated for baskets and wishlists.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/authentication#app-keys-for-baskets-and-wishlists
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/sessions#app-keys-for-baskets-and-wishlists
  */
 export interface AppKeys {
     /** The wishlist key used as prefix to generate user-specific wishlist identifier. */
@@ -89,7 +89,7 @@ export interface AppKeys {
  * Extending this interface allows to add custom metadata to each shop's settings
  * in a Storefront application.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#additional-shop-data
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/configuration#additional-shop-data
  */
 export interface AdditionalShopConfig {
 }
@@ -117,97 +117,15 @@ 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.
  *
- * @see https://scayle.dev/en/checkout-guide/integration/webcomponent#tracking
+ * @see https://scayle.dev/en/core-documentation/storefront/checkout-guide/implementation/webcomponent#tracking
  */
 export interface CheckoutEvent {
     /** Action. */
@@ -228,7 +146,7 @@ export interface CheckoutEvent {
      * This field is optional and is only used when tracking specific actions
      * like `add_to_cart` or `remove_from_cart`.
      *
-     * @see https://scayle.dev/en/checkout-guide/integration/tracking#application-integration
+     * @see https://scayle.dev/en/core-documentation/storefront/checkout-guide/tracking
      */
     event?: {
         /** Event name. */
@@ -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;