@scayle/storefront-nuxt 8.23.0 → 8.24.1

package/dist/shared/{storefront-nuxt.d0683fc1.d.mts → storefront-nuxt.CRtTNUi9.d.mts}

@@ -1,7 +1,7 @@
-import { StorefrontHooks, RpcContext, RpcMethodName, HashAlgorithm, WithParams, rpcMethods, ShopUser } from '@scayle/storefront-core';
+import { WithParams, rpcMethods, StorefrontHooks, RpcContext, RpcMethodName, HashAlgorithm, ShopUser } from '@scayle/storefront-core';
 import { CompressionEncodings } from '@scayle/unstorage-compression-driver';
-import { BuiltinDriverOptions, BuiltinDriverName } from 'unstorage';
-import { CheckoutShopConfigType, SessionType, StorageType, SapiConfigType, ShopConfigType, IdpType, StorefrontConfigType, ModulePublicRuntimeConfigType, ShopSelectorType, RedirectType } from '../../dist/runtime/utils/zodSchema.js';
+import { BuiltinDriverName, BuiltinDriverOptions } from 'unstorage';
+import { StorefrontConfigType, ShopSelectorType, RedirectType, ShopConfigType, ModulePublicRuntimeConfigType, CheckoutShopConfigType, SessionType, StorageType, SapiConfigType, IdpType } from '../../dist/runtime/utils/zodSchema.js';
 import { HookResult } from '@nuxt/schema';
 
 /**

package/dist/test/factories.d.mts

@@ -1,5 +1,5 @@
 import { Factory } from 'fishery';
-import { M as ModuleBaseOptions, e as ShopConfig } from '../shared/storefront-nuxt.d0683fc1.mjs';
+import { M as ModuleBaseOptions, e as ShopConfig } from '../shared/storefront-nuxt.CRtTNUi9.mjs';
 import { RpcContext } from '@scayle/storefront-core';
 import { RouteLocationNormalizedLoadedGeneric } from 'vue-router';
 export * from '@scayle/storefront-core/dist/test/factories';

package/dist/test/factories.mjs

@@ -1,5 +1,5 @@
 import { Factory } from 'fishery';
-import { HashAlgorithm, StorefrontAPIClient, Log } from '@scayle/storefront-core';
+import { HashAlgorithm, Log, StorefrontAPIClient } from '@scayle/storefront-core';
 export * from '@scayle/storefront-core/dist/test/factories';
 
 const moduleOptionsFactory = Factory.define(({ transientParams }) => {

package/dist/types.d.mts

@@ -1,11 +1,18 @@
 import type { NuxtModule } from '@nuxt/schema'
 
-import type { default as Module, ModulePublicRuntimeConfig } from './module.js'
+import type { default as Module, ModuleHooks, ModulePublicRuntimeConfig } from './module.mjs'
 
 declare module '@nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
   interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 
 export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-export { type AdditionalShopConfig, type AppKeys, type CheckoutEvent, type CheckoutShopConfig, type ModulePublicRuntimeConfig, type PublicShopConfig, type SapiConfig, type SessionConfig, type ShopConfig, type ShopConfigIndexed, type StorageConfig, type StorageEntity, type StorefrontConfig, type SupportedDriverName } from './module.js'
+export { type AdditionalShopConfig, type AppKeys, type CheckoutEvent, type CheckoutShopConfig, type ModulePublicRuntimeConfig, type PublicShopConfig, type SapiConfig, type SessionConfig, type ShopConfig, type ShopConfigIndexed, type StorageConfig, type StorageEntity, type StorefrontConfig, type SupportedDriverName } from './shared/storefront-nuxt.CRtTNUi9.mjs'
+
+export { type LogLevel } from '@scayle/storefront-core'
+
+export { type ModuleBaseOptions, default } from './module.mjs'
+
+export { type ModuleHooks } from './module.mjs'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.23.0",
+  "version": "8.24.1",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -19,16 +19,15 @@
   "sideEffects": false,
   "exports": {
     "./rpc": {
-      "types": "./dist/rpc.d.ts",
+      "types": "./dist/rpc.d.mts",
       "import": "./dist/rpc.mjs"
     },
     "./dist/rpc": {
-      "types": "./dist/rpc.d.ts",
+      "types": "./dist/rpc.d.mts",
       "import": "./dist/rpc.mjs"
     },
     "./module": {
-      "types": "./dist/module.d.ts",
-      "require": "./dist/module.cjs",
+      "types": "./dist/module.d.mts",
       "import": "./dist/module.mjs"
     },
     "./composables": {
@@ -36,15 +35,15 @@
       "import": "./dist/runtime/composables/index.js"
     },
     "./dist/test/factories": {
-      "types": "./dist/test/factories.d.ts",
+      "types": "./dist/test/factories.d.mts",
       "import": "./dist/test/factories.mjs"
     },
     "./test/factories": {
-      "types": "./dist/test/factories.d.ts",
+      "types": "./dist/test/factories.d.mts",
       "import": "./dist/test/factories.mjs"
     },
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/index.d.mts",
       "default": "./dist/index.mjs"
     }
   },
@@ -52,7 +51,6 @@
     "#storefront/composables": "./dist/runtime/composables/index.js"
   },
   "main": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
   "files": [
     "CHANGELOG.md",
     "CHANGELOG-V7.md",
@@ -82,7 +80,7 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "0.6.0",
-    "@scayle/storefront-core": "8.23.0",
+    "@scayle/storefront-core": "8.24.1",
     "@scayle/unstorage-compression-driver": "^0.2.6",
     "@vercel/nft": "0.29.2",
     "@vueuse/core": "13.1.0",
@@ -104,7 +102,7 @@
     "@eslint/eslintrc": "3.3.1",
     "@nuxt/eslint": "1.3.0",
     "@nuxt/kit": "3.15.4",
-    "@nuxt/module-builder": "0.8.4",
+    "@nuxt/module-builder": "1.0.1",
     "@nuxt/schema": "3.15.4",
     "@nuxt/test-utils": "3.17.2",
     "@scayle/eslint-config-storefront": "4.5.0",

package/dist/index.d.ts

@@ -1,21 +0,0 @@
-export { d as AdditionalShopConfig, A as AppKeys, i as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, j as ModulePublicRuntimeConfig, P as PublicShopConfig, c as SapiConfig, S as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, b as StorageConfig, a as StorageEntity, g as StorefrontConfig, h as SupportedDriverName } from './shared/storefront-nuxt.d0683fc1.js';
-export { ModuleHooks } from './module.js';
-export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
-export { extendPromise } from '../dist/runtime/utils/promise.js';
-export * from '../dist/runtime/utils/seo.js';
-export * from '@scayle/storefront-core';
-export { LogLevel } from '@scayle/storefront-core';
-export { unwrap } from '@scayle/storefront-core/dist/utils/response';
-import '@scayle/unstorage-compression-driver';
-import 'unstorage';
-import '../dist/runtime/utils/zodSchema.js';
-import '@nuxt/schema';
-
-interface RpcMethodsStorefront {
-}
-declare module '@scayle/storefront-core' {
-    interface RpcMethodsStorefrontInternal extends RpcMethodsStorefront {
-    }
-}
-
-export type { RpcMethodsStorefront };

package/dist/module.cjs

@@ -1,5 +0,0 @@
-module.exports = function(...args) {
-  return import('./module.mjs').then(m => m.default.call(this, ...args))
-}
-const _meta = module.exports.meta = require('./module.json')
-module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -1,62 +0,0 @@
-import * as _nuxt_schema from '@nuxt/schema';
-import { HookResult } from '@nuxt/schema';
-import { M as ModuleBaseOptions } from './shared/storefront-nuxt.d0683fc1.js';
-export { d as AdditionalShopConfig, A as AppKeys, i as CheckoutEvent, C as CheckoutShopConfig, j as ModulePublicRuntimeConfig, P as PublicShopConfig, c as SapiConfig, S as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, b as StorageConfig, a as StorageEntity, g as StorefrontConfig, h as SupportedDriverName } from './shared/storefront-nuxt.d0683fc1.js';
-export { LogLevel } from '@scayle/storefront-core';
-import '@scayle/unstorage-compression-driver';
-import 'unstorage';
-import '../dist/runtime/utils/zodSchema.js';
-
-/**
- * Definition of a custom RPC import
- */
-interface CustomRpcImport {
-    /** The location from which to import the RPC method(s) */
-    source: string;
-    /** The specifiers to import as RPC methods */
-    names: string[];
-}
-/**
- * Build-time hooks used by the module
- */
-interface ModuleHooks {
-    'storefront:custom-rpc:extend': (customRpcImports: CustomRpcImport[]) => HookResult;
-}
-declare module '@nuxt/schema' {
-    interface NuxtHooks extends ModuleHooks {
-    }
-}
-/**
- * Defines the Storefront Nuxt module (`@scayle/storefront-nuxt`).
- *
- * @param options Module base options.
- * @param options.session The session configuration.
- * @param options.session.cookieName The name of the session cookie.
- * @param options.session.sameSite The SameSite attribute for the session cookie.
- * @param options.shopSelector The shop selector.
- * @param options.oauth The OAuth configuration.
- * @param options.oauth.apiHost The API host.
- * @param options.oauth.clientId The client ID.
- * @param options.oauth.clientSecret The client secret.
- * @param options.idp The IDP configuration.
- * @param options.idp.enabled Whether IDP is enabled.
- * @param options.idp.idpKeys The IDP keys.
- * @param options.idp.idpRedirectURL The IDP redirect URL.
- * @param options.appKeys The application keys configuration.
- * @param options.appKeys.wishlistKey The wishlist key.
- * @param options.appKeys.basketKey The basket key.
- * @param options.appKeys.hashAlgorithm The hash algorithm.
- * @param options.legacy The legacy configuration.
- * @param options.legacy.enableSessionMigration Whether session migration is enabled.
- * @param options.rpcMethodNames The RPC method names.
- * @param options.rpcDir The RPC directory.
- * @param options.rpcMethodOverrides RPC method overrides.
- * @param options.shops The shops configuration.
- * @param options.storage The storage configuration.
- *
- * @returns The Nuxt module.
- */
-declare const _default: _nuxt_schema.NuxtModule<ModuleBaseOptions, ModuleBaseOptions, false>;
-
-export { ModuleBaseOptions, _default as default };
-export type { ModuleHooks };

package/dist/rpc.d.ts

@@ -1 +0,0 @@
-export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';

package/dist/shared/storefront-nuxt.d0683fc1.d.ts

@@ -1,268 +0,0 @@
-import { StorefrontHooks, RpcContext, RpcMethodName, HashAlgorithm, WithParams, rpcMethods, ShopUser } from '@scayle/storefront-core';
-import { CompressionEncodings } from '@scayle/unstorage-compression-driver';
-import { BuiltinDriverOptions, BuiltinDriverName } from 'unstorage';
-import { CheckoutShopConfigType, SessionType, StorageType, SapiConfigType, ShopConfigType, IdpType, StorefrontConfigType, ModulePublicRuntimeConfigType, ShopSelectorType, RedirectType } from '../../dist/runtime/utils/zodSchema.js';
-import { HookResult } from '@nuxt/schema';
-
-/**
- * Represents shop-specific configuration relating to the SCAYLE Checkout.
- *
- * @see https://scayle.dev/en/checkout-guide/authentication-accounts/general#create-api-client
- */
-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
- */
-type SessionConfig = SessionType;
-/**
- * Representation of a custom [Unstorage](https://unstorage.unjs.io/) driver name.
- *
- * @see https://unstorage.unjs.io/guide/custom-driver
- */
-type CustomDriverName = string & {
-    _custom?: unknown;
-};
-/**
- * Representation of an [Unstorage](https://unstorage.unjs.io/) storage entity.
- *
- * @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
- */
-type StorageEntity<Driver extends SupportedDriverName | CustomDriverName | unknown = unknown, DriverOptions = Driver extends keyof BuiltinDriverOptions ? BuiltinDriverOptions[Driver] : unknown> = {
-    driver: Driver;
-    compression?: CompressionEncodings;
-} & DriverOptions;
-/**
- * Represents the storage configuration for [Unstorage](https://unstorage.unjs.io/), leveraging the Nitro caching system.
- * 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
- */
-interface StorageConfig {
-    /**
-     * The cache storage configuration.
-     *
-     * 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
-     */
-    cache?: StorageType;
-    /**
-     * The session storage configuration.
-     *
-     * 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
-     */
-    session?: StorageType;
-}
-/**
- * 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
- */
-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
- */
-interface AppKeys {
-    /** The wishlist key used as prefix to generate user-specific wishlist identifier. */
-    wishlistKey: string;
-    /** The basket key used as prefix to generate user-specific basket identifier. */
-    basketKey: string;
-    /** The hash algorithm used to generate user-specific basket and wishlist identifier. */
-    hashAlgorithm: HashAlgorithm;
-}
-/**
- * Provides a structure for additional shop configuration.
- * 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
- */
-interface AdditionalShopConfig {
-}
-/**
- * Shop configuration.
- */
-type ShopConfig = ShopConfigType & AdditionalShopConfig;
-/**
- * Shop configuration indexed by shop ID.
- */
-type ShopConfigIndexed = Record<string, ShopConfig>;
-/**
- * Public shop configuration. This configuration is accessible on the client-side.
- */
-interface PublicShopConfig extends Pick<ShopConfig, 'shopId' | 'domain' | 'locale' | 'currency' | 'currencyFractionDigits'> {
-    /** Checkout configuration. */
-    checkout: Pick<CheckoutShopConfig, 'host'>;
-    /** API base path. */
-    apiBasePath: string;
-    /** IDP configuration. */
-    idp?: IdpType;
-    /** Path. */
-    path?: string;
-}
-/**
- * Storefront configuration.
- */
-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;
-};
-type SupportedDriverName = BuiltinDriverName | 'scayleKv';
-/**
- * Module base options. Extends `StorefrontConfig` and `ModuleOption`.
- */
-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>;
-};
-/**
- * Checkout event used for tracking with Google Tag Manager.
- *
- * @see https://scayle.dev/en/checkout-guide/integration/webcomponent#tracking
- */
-interface CheckoutEvent {
-    /** Action. */
-    action?: 'authenticated';
-    /** Type. */
-    type?: 'tracking';
-    /** User. */
-    user: ShopUser;
-    /**
-     * The OAuth 2.0 access token for the authenticated user.
-     * This token can be used to access protected resources on behalf of the user.
-     *
-     * @see https://www.rfc-editor.org/rfc/rfc6749
-     */
-    accessToken: string;
-    /**
-     * Details about a specific event within the checkout process.
-     * 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
-     */
-    event?: {
-        /** Event name. */
-        event: 'login' | 'add_to_cart' | 'remove_from_cart';
-        /** Event status. */
-        status: 'successful' | 'error';
-    };
-}
-interface ModulePublicRuntimeConfig extends ModulePublicRuntimeConfigType {
-}
-declare module '@nuxt/schema' {
-    interface RuntimeConfig {
-        storefront: ModuleBaseOptions;
-    }
-    interface PublicRuntimeConfig {
-        storefront: ModulePublicRuntimeConfig;
-    }
-}
-declare module 'nitropack' {
-    /**
-     * Nitro runtime hooks.
-     *
-     * @see https://nitro.build/guide/plugins#nitro-runtime-hooks
-     */
-    interface NitroRuntimeHooks extends StorefrontHooks {
-        /** Storefront hook called after the RPC context created . */
-        'storefront:context:created': (context: RpcContext) => HookResult;
-        /** Storefront hook called before the RPC method is executed. */
-        'storefront:rpc:before': (rpcName: RpcMethodName, context: RpcContext, payload: unknown) => HookResult;
-        /** Storefront hook called after the RPC method is executed. */
-        'storefront:rpc:after': (rpcName: RpcMethodName, context: RpcContext, result: unknown) => HookResult;
-        /** Storefront hook called if an error occurs during RPC method execution. */
-        'storefront:rpc:error': (rpcName: RpcMethodName, context: RpcContext, error: unknown) => HookResult;
-    }
-}
-
-export type { AppKeys as A, CheckoutShopConfig as C, ModuleBaseOptions as M, PublicShopConfig as P, SessionConfig as S, StorageEntity as a, StorageConfig as b, SapiConfig as c, AdditionalShopConfig as d, ShopConfig as e, ShopConfigIndexed as f, StorefrontConfig as g, SupportedDriverName as h, CheckoutEvent as i, ModulePublicRuntimeConfig as j };

package/dist/test/factories.d.ts

@@ -1,25 +0,0 @@
-import { Factory } from 'fishery';
-import { M as ModuleBaseOptions, e as ShopConfig } from '../shared/storefront-nuxt.d0683fc1.js';
-import { RpcContext } from '@scayle/storefront-core';
-import { RouteLocationNormalizedLoadedGeneric } from 'vue-router';
-export * from '@scayle/storefront-core/dist/test/factories';
-import '@scayle/unstorage-compression-driver';
-import 'unstorage';
-import '../../dist/runtime/utils/zodSchema.js';
-import '@nuxt/schema';
-
-interface ModuleOptionsFactoryParams {
-    shops: ShopConfig[];
-}
-declare const moduleOptionsFactory: Factory<ModuleBaseOptions, ModuleOptionsFactoryParams, ModuleBaseOptions>;
-
-declare const shopConfigFactory: Factory<ShopConfig, any, ShopConfig>;
-
-interface RpcContextFactoryParams {
-    isLoggedIn: boolean;
-}
-declare const rpcContextFactory: Factory<RpcContext, RpcContextFactoryParams, RpcContext>;
-
-declare const routeFactory: Factory<RouteLocationNormalizedLoadedGeneric, any, RouteLocationNormalizedLoadedGeneric>;
-
-export { moduleOptionsFactory, routeFactory, rpcContextFactory, shopConfigFactory };

package/dist/types.d.ts

@@ -1,11 +0,0 @@
-import type { NuxtModule } from '@nuxt/schema'
-
-import type { default as Module, ModulePublicRuntimeConfig } from './module'
-
-declare module '@nuxt/schema' {
-  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
-}
-
-export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
-
-export { type AdditionalShopConfig, type AppKeys, type CheckoutEvent, type CheckoutShopConfig, type ModulePublicRuntimeConfig, type PublicShopConfig, type SapiConfig, type SessionConfig, type ShopConfig, type ShopConfigIndexed, type StorageConfig, type StorageEntity, type StorefrontConfig, type SupportedDriverName } from './module'