@scayle/storefront-nuxt 8.10.1 → 8.10.3

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @scayle/storefront-nuxt
 
+## 8.10.3
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@8.8.0
+
+## 8.10.2
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@8.7.1
+
 ## 8.10.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-export { d as AdditionalShopConfig, A as AppKeys, h as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, i 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 } from './shared/storefront-nuxt.a816664e.mjs';
+export { d as AdditionalShopConfig, A as AppKeys, h as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, i 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 } from './shared/storefront-nuxt.b72fefd0.mjs';
 export { ModuleHooks } from './module.mjs';
 export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
 export { extendPromise } from '../dist/runtime/utils/promise.js';

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { d as AdditionalShopConfig, A as AppKeys, h as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, i 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 } from './shared/storefront-nuxt.a816664e.js';
+export { d as AdditionalShopConfig, A as AppKeys, h as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, i 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 } from './shared/storefront-nuxt.b72fefd0.js';
 export { ModuleHooks } from './module.js';
 export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
 export { extendPromise } from '../dist/runtime/utils/promise.js';

package/dist/module.d.mts

@@ -1,7 +1,7 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { HookResult } from '@nuxt/schema';
-import { M as ModuleBaseOptions } from './shared/storefront-nuxt.a816664e.mjs';
-export { d as AdditionalShopConfig, A as AppKeys, h as CheckoutEvent, C as CheckoutShopConfig, i 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 } from './shared/storefront-nuxt.a816664e.mjs';
+import { M as ModuleBaseOptions } from './shared/storefront-nuxt.b72fefd0.mjs';
+export { d as AdditionalShopConfig, A as AppKeys, h as CheckoutEvent, C as CheckoutShopConfig, i 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 } from './shared/storefront-nuxt.b72fefd0.mjs';
 export { LogLevel } from '@scayle/storefront-core';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
@@ -26,6 +26,36 @@ 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, type ModuleHooks, _default as default };

package/dist/module.d.ts

@@ -1,7 +1,7 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { HookResult } from '@nuxt/schema';
-import { M as ModuleBaseOptions } from './shared/storefront-nuxt.a816664e.js';
-export { d as AdditionalShopConfig, A as AppKeys, h as CheckoutEvent, C as CheckoutShopConfig, i 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 } from './shared/storefront-nuxt.a816664e.js';
+import { M as ModuleBaseOptions } from './shared/storefront-nuxt.b72fefd0.js';
+export { d as AdditionalShopConfig, A as AppKeys, h as CheckoutEvent, C as CheckoutShopConfig, i 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 } from './shared/storefront-nuxt.b72fefd0.js';
 export { LogLevel } from '@scayle/storefront-core';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
@@ -26,6 +26,36 @@ 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, type ModuleHooks, _default as default };

package/dist/module.json

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

package/dist/module.mjs

@@ -46,7 +46,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.10.1";
+const PACKAGE_VERSION = "8.10.3";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -232,6 +232,11 @@ const module = defineNuxtModule({
     legacy: {
       enableSessionMigration: false
     },
+    /**
+     * The internal access header.
+     *
+     * @hidden
+     */
     internalAccessHeader: ""
   },
   async setup(options, nuxt) {

package/dist/runtime/campaignKey.d.ts

@@ -1,5 +1,2 @@
-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 sortCampaignsByDateAscending: (a: Campaign, b: Campaign) => number;
+import type { StorefrontAPIClient, CachedType, Log } from '@scayle/storefront-core';
 export declare const fetchCampaignKey: (sapiClient: StorefrontAPIClient, cached: CachedType, log: Log) => Promise<string | undefined>;

package/dist/runtime/campaignKey.js

@@ -1,20 +1,8 @@
-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 sortCampaignsByDateAscending = (a, b) => {
-  return new Date(a.start_at).getTime() - new Date(b.start_at).getTime();
-};
+import {
+  isCampaignActive,
+  campaignHasNotEnded,
+  sortCampaignsByDateAscending
+} from "@scayle/storefront-core";
 export const fetchCampaignKey = async (sapiClient, cached, log) => {
   try {
     const { campaigns } = await cached(async () => {

package/dist/runtime/context.js

@@ -8,8 +8,8 @@ import {
   generateWishlistKey
 } from "@scayle/storefront-core/dist/utils/keys";
 import { useNitroApp } from "nitropack/runtime";
-import { fetchCampaignKey } from "./campaignKey.js";
 import { getCachedFunction } from "./cached.js";
+import { fetchCampaignKey } from "./campaignKey.js";
 async function getWishlistKey(appKeys, session, $log, $shopConfig) {
   return session.data.user ? await generateWishlistKey({
     keyTemplate: appKeys.wishlistKey,

package/dist/runtime/error/handler.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Resolves an error, providing a standardized error object with status code, message, and name.
+ *
+ * @param error The error to resolve. Can be a generic `Error` or an unknown error type.
+ *
+ * @returns A standardized error object with statusCode, statusMessage, and name.
+ */
 declare const resolveError: (error: Error | unknown) => {
     statusCode: 100 | 101 | 102 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 506 | 507 | 508 | 510 | 511 | 306 | 505;
     statusMessage: string;

package/dist/runtime/nitro/plugins/cacheRuntimeConfig.d.ts

@@ -1,2 +1,14 @@
+/**
+ * Nitro plugin to cache the runtime config.
+ *
+ * Caches the runtime config at startup to avoid reading it for every request.
+ *
+ * @see https://nitro.build/guide/configuration#runtime-configuration
+ * @see https://nitro.build/guide/plugins
+ *
+ * @param nitroApp The nitro app instance.
+ *
+ * @returns Nitro plugin function
+ */
 declare const _default: import("nitropack").NitroAppPlugin;
 export default _default;

package/dist/runtime/nitro/plugins/configValidation.d.ts

@@ -1,12 +1,51 @@
 import type { RuntimeConfig } from '@nuxt/schema';
 import type { ZodIssue } from 'zod';
+/**
+ * List of keys considered sensitive.
+ * These keys will have their values redacted in logs.
+ */
 export declare const sensitiveKeys: string[];
+/**
+ * Gets a value from a nested object using a path array.
+ *
+ * @param object The object to traverse.
+ * @param pathArray The array of keys representing the path to the value.
+ *
+ * @returns The value at the specified path, stringified.
+ */
 export declare const getValue: (object: Record<string | number, unknown>, pathArray: (string | number)[]) => string;
+/**
+ * Formats Zod errors for display, redacting sensitive values.
+ *
+ * @see https://zod.dev/ERROR_HANDLING?id=zodissue
+ *
+ * @param issues An array of Zod issues.
+ * @param issues[].code The error code.
+ * @param issues[].path The path to the error in the object.
+ * @param issues[].message The error message.
+ * @param issues[].unionErrors Errors from union types.
+ * @param runtimeConfig The runtime config object.
+ *
+ * @returns An array of formatted error messages.
+ */
 export declare const formatZodError: (issues: Array<ZodIssue>, runtimeConfig: RuntimeConfig) => (ZodIssue | {
     code: string;
     path: string;
     message: string;
     value?: string;
 })[];
+/**
+ * Nitro plugin to validate the runtime config against a Zod schema.
+ *
+ * Validates the runtime configuration using the `RuntimeConfigSchema` and logs
+ * success or failure messages to the console.  Throws an error if the
+ * validation fails.
+ *
+ * @see https://nitro.build/guide/plugins
+ *
+ * @returns Nitro plugin function
+ *
+ * @throws {Error} If runtimeConfig validations fails.
+ */
 declare const _default: import("nitropack").NitroAppPlugin;
 export default _default;

package/dist/runtime/nitro/plugins/nitroLogger.d.ts

@@ -4,5 +4,13 @@ declare module 'h3' {
         $log: Log;
     }
 }
+/**
+ * Nitro plugin to initialize and inject a logger instance into the request context.
+ *
+ * @param nitroApp The nitro app instance.
+ *
+ * @see https://nitro.build/guide/configuration#runtime-configuration
+ * @see https://nitro.build/guide/plugins
+ */
 declare const _default: import("nitropack").NitroAppPlugin;
 export default _default;

package/dist/runtime/nitro/plugins/nitroRuntimeStorageConfig.d.ts

@@ -1,2 +1,12 @@
+/**
+ * Nitro plugin to mount an [unstorage](https://unstorage.unjs.io/) storage.
+ *
+ * This plugin mounts the necessary storage instances based on the
+ * provided configuration for cache and session storage.
+ * It iterates through the shops and mounts their individual storage as well.
+ *
+ * @see https://nitro.build/guide/configuration#runtime-configuration
+ * @see https://nitro.build/guide/plugins
+ */
 declare const _default: import("nitropack").NitroAppPlugin;
 export default _default;

package/dist/runtime/nitro/plugins/nitroSetXPoweredByHeader.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Nitro plugin to set the `x-powered-by` header.
+ *
+ * @see https://nitro.build/guide/plugins
+ *
+ * @param nitroApp The nitro app instance.
+ */
 declare const _default: import("nitropack").NitroAppPlugin;
 export default _default;

package/dist/runtime/plugin/log.client.d.ts

@@ -1,4 +1,16 @@
 import type { Log } from '@scayle/storefront-core';
+/**
+ * Nuxt plugin to provide logging functionality for the client-environment (VueApp).
+ *
+ * This plugin initializes a client-side logger using `consola` and adds error handling to the Vue app.
+ * It provides `log` and `coreLog` instances.
+ *
+ * @see https://nuxt.com/docs/guide/directory-structure/plugins#providing-helpers
+ *
+ * @param nuxtApp The Nuxt app instance.
+ *
+ * @returns  helper on the `NuxtApp` containing the 'log' and 'coreLog' instances.
+ */
 declare const _default: import("#app/nuxt").Plugin<{
     log: Log;
     coreLog: Log;

package/dist/runtime/plugin/log.server.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Nuxt plugin to provide logging functionality for the server-environment (NuxtApp).
+ *
+ * This plugin makes logging functions available through the Nuxt app instance.
+ * It retrieves the log instance from the server context during server-side rendering.
+ * If `ssrContext` is missing, it logs a warning.
+ *
+ * @see https://nuxt.com/docs/guide/directory-structure/plugins#providing-helpers
+ *
+ * @returns A helper on the `NuxtApp` containing the `log` and
+ * `coreLog`instances, or undefined if ssrContext is missing.
+ */
 declare const _default: import("#app/nuxt").Plugin<{
     log: import("@scayle/storefront-core").Log;
     coreLog: import("@scayle/storefront-core").Log;

package/dist/runtime/plugin/shop.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Nuxt plugin to provide the current shop and available shops.
+ *
+ * This plugin makes the current shop and available shops accessible through the Nuxt app instance.
+ * It retrieves the shop data from the server context during server-side rendering and provides it to the client.
+ *
+ * @see https://nuxt.com/docs/guide/directory-structure/plugins#providing-helpers
+ *
+ * @returns A helper on the `NuxtApp` containing the `currentShop` and `availableShops`.
+ *
+ * @example
+ * ```typescript
+ *  const { currentShop, availableShop } = useNuxtApp()
+ * ```
+ */
 declare const _default: import("#app/nuxt").Plugin<{
     currentShop: import("../..").PublicShopConfig;
     availableShops: import("../..").PublicShopConfig[];

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

@@ -1,15 +1,77 @@
 import { type H3Event } from 'h3';
 import type { ModuleBaseOptions, PublicShopConfig, ShopConfig, ShopConfigIndexed } from '../../../module.js';
 import type { NitroRuntimeConfigApp } from 'nitropack';
+/**
+ * Represents the bootstrapped path information.
+ */
 type BootstrapPath = {
+    /** The bootstrapped path. */
     path: string;
+    /** The original request path. */
     originalPath: string;
 };
+/**
+ * Gets the bootstrap path from the URL.
+ *
+ * Handles the special case of Nuxt error pages to extract the correct path for bootstrapping.
+ *
+ * @param url The request URL.
+ * @param baseUrl The base URL of the application.
+ *
+ * @returns A `BootstrapPath` object containing the resolved path and original path.
+ */
 export declare function getBootstrapPath(url: URL, baseUrl: string): BootstrapPath;
+/**
+ * Gets the shop configuration based on the request path.
+ *
+ * @param event The H3 event object.
+ * @param shops An array of shop configurations.
+ * @param appBasePath The base path of the application.
+ *
+ * @returns The matching shop configuration, or undefined if not found.
+ */
 export declare const getShopByPath: (event: H3Event, shops: ShopConfig[], appBasePath: string) => ShopConfig | undefined;
+/**
+ * Converts the shops configuration to a list.
+ * Handles cases where shops are provided as an array or an indexed object.
+ *
+ * @param shops The shops configuration, either as an array or an indexed object.
+ *
+ * @returns The shops as an array.
+ */
 export declare const convertShopsToList: (shops: ShopConfig[] | ShopConfigIndexed) => ShopConfig[];
+/**
+ * Gets the API base path.
+ *
+ * @param storefrontConfig The storefront module configuration.
+ * @param baseUrl The base URL.
+ *
+ * @returns The API base path.
+ */
 export declare function getApiBasePath(storefrontConfig: ModuleBaseOptions, baseUrl: string): string;
+/**
+ * Retrieves the current shop configuration for a given request.
+ *
+ * @param event The H3 event object.
+ * @param storefrontConfig The storefront configuration containing shop details and selector.
+ * @param runtimeConfig The Nitro runtime configuration.
+ *
+ * @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;
+/**
+ * Transforms shop configuration data into a public representation, including active status.
+ *
+ * Selects specific properties from the provided shop configuration (`data`) to create a public version suitable
+ * for client-side use. Also determines if the shop is currently active based on the `currentShopId`.
+ *
+ * @param data The shop configuration data.
+ * @param currentShopId The ID of the currently active shop.
+ * @param apiBasePath The base path for the API.
+ * @param publicShopData  An optional array of additional shop configuration keys to include in the public data.
+ *
+ * @returns A public representation of the shop configuration, including an `isActive` flag.
+ */
 export declare function getPublicShopData(data: ShopConfig, currentShopId: number, apiBasePath: string, publicShopData?: (keyof ShopConfig)[]): PublicShopConfig & {
     isActive: boolean;
 };

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

@@ -1,7 +1,26 @@
 import type { ShopUser } from '@scayle/storefront-core';
+/**
+ * Interface for shop session data.
+ *
+ * user: The shop user.
+ * accessToken: The access token.
+ * refreshToken: The refresh token.
+ * shopId: The shop ID.
+ */
 export interface ShopSessionData {
+    /**
+     * The shop user object containing detailed information about the current user.
+     */
     user?: ShopUser;
+    /**
+     * The OAuth 2.0 access token.
+     * @see https://www.rfc-editor.org/rfc/rfc6749#section-1.4
+     */
     accessToken?: string;
+    /**
+     * The OAuth 2.0 refresh token.
+     * @see https://www.rfc-editor.org/rfc/rfc6749#section-1.5
+     */
     refreshToken?: string;
     shopId?: number;
 }
@@ -9,5 +28,19 @@ declare module '@scayle/h3-session' {
     interface SessionDataT extends ShopSessionData {
     }
 }
+/**
+ * Middleware handler for bootstrapping the application.
+ *
+ * This sets up the necessary context for incoming requests,
+ * including session management, caching, and routing.
+ * It handles redirects when enabled and logs errors encountered during the process.
+ * Internal Nuxt URLs, favicon requests, and the /api/up endpoint are skipped.
+ *
+ * @see https://h3.unjs.io/guide/event-handler
+ *
+ * @param event The [H3 event object](https://h3.unjs.io/guide/event).
+ *
+ * @throws {Error} If something went wrong.
+ */
 declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
 export default _default;

package/dist/runtime/server/middleware/redirects.d.ts

@@ -1,2 +1,15 @@
 import type { H3Event } from 'h3';
+/**
+ * Handles redirects based on the provided event.
+ *
+ * This middleware function checks for redirects configured in the SCAYLE Panel
+ * by checking with the Storefront API and performs a redirect if a match is found.
+ * It utilizes a cache to store redirect results and falls back to the
+ * Storefront API if no cached redirect is available.
+ *
+ * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/redirects#overview
+ * @see https://scayle.dev/en/user-guide/shops/storefront/redirects
+ *
+ * @param event The H3 event object.
+ */
 export declare function useRedirects(event: H3Event): Promise<void>;

package/dist/runtime/server/middleware/redirects.utils.d.ts

@@ -1,18 +1,28 @@
 /**
- * Get a normalized URL in absolute and relative forms for redirect lookup
- * @param url
- * @param queryParamWhitelist
+ * Gets normalized URLs (absolute and relative) for redirect lookup.
+ *
+ * Normalizes the provided URL by removing trailing slashes and optionally filtering query parameters
+ * based on a whitelist. This prepares the URL for use in redirect lookups.
+ *
+ * @param url The incoming URL.
+ * @param queryParamWhitelist A set of query parameters to include in the lookup URL. Other parameters will be removed.
+ *
+ * @returns An object containing the relative and absolute normalized URLs.
  */
 export declare function getRedirectLookupUrls(url: URL, queryParamWhitelist?: Set<string>): {
     relativeSourceUrl: string;
     absoluteSourceUrl: string;
 };
 /**
- * Construct a URL string given a source URL and target redirect
- * Query params are copied from source to target (if the params are not whitelisted)
- * and source is used as the base URL if target is a relative redirect.
- * @param source
- * @param target
- * @param queryParamWhitelist
+ * Constructs a target URL for redirection, handling relative and absolute URLs and query parameters.
+ *
+ * Copies query parameters from the source URL to the target URL, unless they are present in the
+ * `queryParamWhitelist`. If the target is a relative URL, it uses the source URL as the base.
+ *
+ * @param source The source URL.
+ * @param target The target redirect URL (can be relative or absolute).
+ * @param queryParamWhitelist A set of query parameters to exclude from the final redirect URL.
+ *
+ * @returns The decoded target URL string.
  */
 export declare function getTargetLocation(source: URL, target: string, queryParamWhitelist?: Set<string>): string;

package/dist/runtime/server/utils/cacheStorage.d.ts

@@ -6,16 +6,22 @@ export declare const STORAGE_MOUNT_BASE = "storefront";
 export declare const STORAGE_MOUNT_CACHE = "storefront-cache";
 export declare const STORAGE_MOUNT_SESSION = "storefront-session";
 /**
- * Create an unstorage-backed cache interface
- * @param prefix
- * @param shopId
- * @param log
+ * Creates an Unstorage-backed cache interface.
+ *
+ * @param prefix The cache key prefix.
+ * @param shopId The shop ID.
+ * @param log The logger instance.
+ *
+ * @returns An UnstorageCache instance.
  */
 export declare function useCacheStorage(prefix: string, shopId: number, log: Log): UnstorageCache;
 /**
- * Create an unstorage-backed session cache interface
- * @param sessionConfig
- * @param shopId
- * @param log
+ * Creates an Unstorage-backed session store interface.
+ *
+ * @param sessionConfig The session configuration.
+ * @param shopId The shop ID.
+ * @param log The logger instance.
+ *
+ * @returns A session store instance.
  */
 export declare function useSessionStorage(sessionConfig: SessionConfig, shopId: number, log: Log): SessionStore;

package/dist/runtime/utils/seo.d.ts

@@ -1,4 +1,15 @@
 import type { WithContext, BreadcrumbList } from 'schema-dts';
 import type { BreadcrumbItem } from '@scayle/storefront-core';
+/**
+ * Sanitizes a canonical URL by removing query parameters not present in the whitelist.
+ *
+ * This function parses the URL, filters the query parameters based on the provided whitelist,
+ * and then reconstructs the URL with only the allowed parameters.
+ *
+ * @param url The URL to sanitize.
+ * @param whitelistParams An array of query parameters to keep. Defaults to `CANONICAL_PARAMS_WHITELIST`.
+ *
+ * @returns The sanitized URL.
+ */
 export declare const sanitizeCanonicalURL: (url: string, whitelistParams?: string[]) => string;
 export declare const generateCategoryBreadcrumbSchema: (breadcrumbs: BreadcrumbItem[]) => WithContext<BreadcrumbList>;