@scayle/storefront-nuxt 8.24.0 → 8.24.2

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @scayle/storefront-nuxt
 
+## 8.24.2
+
+### Patch Changes
+
+- Fix `.d.ts` validation errors reported by AreTheTypesWrong.
+- Fix an issue caused by Nitro 2.11.7 which caused the context to be lost between RPC requests.
+
+**Dependencies**
+
+- Updated dependency to @scayle/h3-session@0.6.1
+
+**@scayle/storefront-core v8.24.2**
+
+- Patch
+  - **\[Code Style\]** Refactored brands and navigation tree RPCs to avoid destructuring the RPC context within function signatures
+
+## 8.24.1
+
+### Patch Changes
+
+- Updated dependency `@scayle/storefront-core@8.23.0` to `@scayle/storefront-core@8.24.0`
+
+**Dependencies**
+
+**@scayle/storefront-core v8.24.1**
+
+- No changes in this release.
+
 ## 8.24.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -1,14 +1,10 @@
-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.CRtTNUi9.mjs';
+export * from '../dist/runtime/types/module.js';
 export { ModuleHooks } from './module.mjs';
 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 {

package/dist/module.d.mts

@@ -1,11 +1,7 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { HookResult } from '@nuxt/schema';
-import { M as ModuleBaseOptions } from './shared/storefront-nuxt.CRtTNUi9.mjs';
-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.CRtTNUi9.mjs';
-export { LogLevel } from '@scayle/storefront-core';
-import '@scayle/unstorage-compression-driver';
-import 'unstorage';
-import '../dist/runtime/utils/zodSchema.js';
+import { ModuleBaseOptions } from '../dist/runtime/types/module.js';
+export * from '../dist/runtime/types/module.js';
 
 /**
  * Definition of a custom RPC import
@@ -58,5 +54,5 @@ declare module '@nuxt/schema' {
  */
 declare const _default: _nuxt_schema.NuxtModule<ModuleBaseOptions, ModuleBaseOptions, false>;
 
-export { ModuleBaseOptions, _default as default };
+export { _default as default };
 export type { ModuleHooks };

package/dist/module.json

@@ -1,12 +1,12 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "8.24.0",
+  "version": "8.24.2",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"
   },
   "builder": {
     "@nuxt/module-builder": "1.0.1",
-    "unbuild": "2.0.0"
+    "unbuild": "3.5.0"
   }
 }

package/dist/module.mjs

@@ -7,6 +7,7 @@ import { builtinDrivers } from 'unstorage';
 import { createConsola } from 'consola';
 import { nodeFileTrace } from '@vercel/nft';
 import { getApiBasePath } from '../dist/runtime/server/middleware/bootstrap-utils.js';
+export * from '../dist/runtime/types/module.js';
 
 function stringToBoolean(value, defaultValue = false) {
   return value ? value.toLowerCase() === "true" : defaultValue;
@@ -53,7 +54,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.24.0";
+const PACKAGE_VERSION = "8.24.2";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -141,6 +142,9 @@ async function nitroSetup(nitroConfig, config) {
   nitroConfig.plugins.push(
     resolve("./runtime/nitro/plugins/nitroRuntimeStorageConfig")
   );
+  nitroConfig.plugins.push(
+    resolve("./runtime/nitro/plugins/internalFetch")
+  );
   if (stringToBoolean(process.env.SFC_PLUGIN_CONFIG_VALIDATION_ENABLED, true)) {
     logger.debug("Installing config validation plugin");
     nitroConfig.plugins.push(

package/dist/runtime/composables/core/useAvailableShops.d.ts

@@ -1,4 +1,4 @@
-import type { PublicShopConfig } from '../../../module.js';
+import type { PublicShopConfig } from '../../types/module.js';
 /**
  * Provides a reactive list of available shops.
  *

package/dist/runtime/composables/core/useCurrentShop.d.ts

@@ -1,5 +1,5 @@
 import type { Ref } from 'vue';
-import type { PublicShopConfig } from '../../../module.js';
+import type { PublicShopConfig } from '../../types/module.js';
 /**
  * Provides a reactive reference to the current shop configuration.
  *

package/dist/runtime/composables/core/useRpc.js

@@ -8,9 +8,9 @@ import { useCurrentShop } from "./useCurrentShop.js";
 import { toValue, isRef } from "vue";
 import { useRuntimeConfig } from "#app/nuxt";
 function getFetch(nuxtApp, log) {
-  const fetch = nuxtApp.ssrContext?.event.$fetch ?? $fetch;
-  if (nuxtApp.ssrContext?.event && !nuxtApp.ssrContext?.event.$fetch) {
-    log.error("event.$fetch was not found!");
+  const fetch = nuxtApp.ssrContext?.event.context.$fetchWithContext ?? $fetch;
+  if (nuxtApp.ssrContext?.event && !nuxtApp.ssrContext?.event.context.$fetchWithContext) {
+    log.error("event.$fetchWithContext was not found!");
   }
   return fetch;
 }

package/dist/runtime/context.js

@@ -31,7 +31,7 @@ async function getBasketKey(appKeys, session, $log, $shopConfig) {
   }) : session?.id;
 }
 function buildRpcCall(event, shopConfig, apiBasePath) {
-  const fetch = event.$fetch;
+  const fetch = event.context.$fetchWithContext;
   return async function rpcCall(method, params = void 0) {
     const data = await fetch(`${apiBasePath}/rpc/${method}`, {
       // @ts-expect-error Type '"POST"' is not assignable to type 'AvailableRouterMethod<`${string}/rpc/${N}`> | Uppercase<AvailableRouterMethod<`${string}/rpc/${N}`>> | undefined'.ts(2322)

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

@@ -0,0 +1,21 @@
+declare module 'h3' {
+    interface H3EventContext {
+        $fetchWithContext: typeof globalThis.$fetch;
+    }
+}
+/**
+ * Nitro plugin to provide an internal fetch function on the event.
+ *
+ * Nitro includes an `event.$fetch` function for internal fetch requests to allow sharing the headers and
+ * context across requests. However, as of 2.11.7, the context is no longer shared, just the headers. As our
+ * bootstrapping depends on this behavior, we create a custom function with the pre-2.11.7 behavior. This enables
+ * compability with 2.11.7 as well as earlier versions.
+ *
+ * @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/internalFetch.js

@@ -0,0 +1,18 @@
+import { defineNitroPlugin } from "nitropack/runtime/plugin";
+import { fetchWithEvent } from "h3";
+export default defineNitroPlugin((nitroApp) => {
+  nitroApp.hooks.hook("request", (event) => {
+    const $fetch = globalThis.$fetch;
+    const envContext = (
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      event.node.req?.__unenv__
+    );
+    if (envContext) {
+      Object.assign(event.context, envContext);
+    }
+    event.context.$fetchWithContext = (req, init) => fetchWithEvent(event, req, init, {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      fetch: $fetch
+    });
+  });
+});

package/dist/runtime/rpc/rpcCall.d.ts

@@ -1,6 +1,6 @@
 import type { RpcContext, RpcMethodName, RpcMethodParameters, RpcMethodReturnType } from '@scayle/storefront-core';
 import type { NuxtApp } from 'nuxt/app';
-import type { PublicShopConfig } from '../../index.js';
+import type { PublicShopConfig } from '../types/module.js';
 /**
  * Invokes an RPC method on the client or server.
  * Uses an HTTP request on the client and a direct call on the server via `$fetch`.

package/dist/runtime/rpc/rpcCall.js

@@ -1,6 +1,6 @@
 import { unwrap } from "@scayle/storefront-core/dist/utils/response";
 export const rpcCall = (nuxtApp, method, shop) => {
-  const fetch = nuxtApp.ssrContext?.event.$fetch ?? $fetch;
+  const fetch = nuxtApp.ssrContext?.event.context.$fetchWithContext ?? $fetch;
   return async (params = void 0) => {
     const data = await fetch(`${shop.apiBasePath ?? "/api"}/rpc/${method}`, {
       // @ts-expect-error Type '"POST"' is not assignable to type 'AvailableRouterMethod<`${string}/rpc/${N}`> | Uppercase<AvailableRouterMethod<`${string}/rpc/${N}`>> | undefined'.ts(2322)

package/dist/{shared/storefront-nuxt.CRtTNUi9.d.mts → runtime/types/module.d.ts}

@@ -1,21 +1,21 @@
-import { WithParams, rpcMethods, StorefrontHooks, RpcContext, RpcMethodName, HashAlgorithm, ShopUser } from '@scayle/storefront-core';
-import { CompressionEncodings } from '@scayle/unstorage-compression-driver';
-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';
-
+import type { HashAlgorithm, ShopUser, WithParams, rpcMethods, 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 { 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
  */
-type CheckoutShopConfig = CheckoutShopConfigType;
+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
  */
-type SessionConfig = SessionType;
+export type SessionConfig = SessionType;
 /**
  * Representation of a custom [Unstorage](https://unstorage.unjs.io/) driver name.
  *
@@ -32,7 +32,7 @@ type CustomDriverName = string & {
  *
  * @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> = {
+export type StorageEntity<Driver extends SupportedDriverName | CustomDriverName | unknown = unknown, DriverOptions = Driver extends keyof BuiltinDriverOptions ? BuiltinDriverOptions[Driver] : unknown> = {
     driver: Driver;
     compression?: CompressionEncodings;
 } & DriverOptions;
@@ -43,7 +43,7 @@ type StorageEntity<Driver extends SupportedDriverName | CustomDriverName | unkno
  *
  * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#storage
  */
-interface StorageConfig {
+export interface StorageConfig {
     /**
      * The cache storage configuration.
      *
@@ -69,14 +69,14 @@ interface StorageConfig {
  * @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;
+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
  */
-interface AppKeys {
+export 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. */
@@ -91,20 +91,20 @@ interface AppKeys {
  *
  * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#additional-shop-data
  */
-interface AdditionalShopConfig {
+export interface AdditionalShopConfig {
 }
 /**
  * Shop configuration.
  */
-type ShopConfig = ShopConfigType & AdditionalShopConfig;
+export type ShopConfig = ShopConfigType & AdditionalShopConfig;
 /**
  * Shop configuration indexed by shop ID.
  */
-type ShopConfigIndexed = Record<string, ShopConfig>;
+export 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'> {
+export interface PublicShopConfig extends Pick<ShopConfig, 'shopId' | 'domain' | 'locale' | 'currency' | 'currencyFractionDigits'> {
     /** Checkout configuration. */
     checkout: Pick<CheckoutShopConfig, 'host'>;
     /** API base path. */
@@ -117,7 +117,7 @@ interface PublicShopConfig extends Pick<ShopConfig, 'shopId' | 'domain' | 'local
 /**
  * Storefront configuration.
  */
-type StorefrontConfig = StorefrontConfigType & {
+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
@@ -185,11 +185,11 @@ type ModuleOption = {
      */
     shops: ShopConfigIndexed;
 };
-type SupportedDriverName = BuiltinDriverName | 'scayleKv';
+export type SupportedDriverName = BuiltinDriverName | 'scayleKv';
 /**
  * Module base options. Extends `StorefrontConfig` and `ModuleOption`.
  */
-type ModuleBaseOptions = StorefrontConfig & 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.
@@ -209,7 +209,7 @@ type ModuleBaseOptions = StorefrontConfig & ModuleOption & {
  *
  * @see https://scayle.dev/en/checkout-guide/integration/webcomponent#tracking
  */
-interface CheckoutEvent {
+export interface CheckoutEvent {
     /** Action. */
     action?: 'authenticated';
     /** Type. */
@@ -237,7 +237,7 @@ interface CheckoutEvent {
         status: 'successful' | 'error';
     };
 }
-interface ModulePublicRuntimeConfig extends ModulePublicRuntimeConfigType {
+export interface ModulePublicRuntimeConfig extends ModulePublicRuntimeConfigType {
 }
 declare module '@nuxt/schema' {
     interface RuntimeConfig {
@@ -264,5 +264,3 @@ declare module 'nitropack' {
         '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.mts

@@ -1,12 +1,8 @@
 import { Factory } from 'fishery';
-import { M as ModuleBaseOptions, e as ShopConfig } from '../shared/storefront-nuxt.CRtTNUi9.mjs';
+import { ModuleBaseOptions, ShopConfig } from '../../dist/runtime/types/module.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[];

package/dist/types.d.mts

@@ -1,18 +1,15 @@
 import type { NuxtModule } from '@nuxt/schema'
 
-import type { default as Module, ModuleHooks, ModulePublicRuntimeConfig } from './module.mjs'
+import type { default as Module, ModuleHooks } 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 './shared/storefront-nuxt.CRtTNUi9.mjs'
-
-export { type LogLevel } from '@scayle/storefront-core'
-
-export { type ModuleBaseOptions, default } from './module.mjs'
+export { default } from './module.mjs'
 
 export { type ModuleHooks } from './module.mjs'
+
+export * from '../dist/runtime/types/module.js'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.24.0",
+  "version": "8.24.2",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -65,7 +65,7 @@
     "build": "nuxt-module-build build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
-    "prep": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "prep": "nuxt-module-build prepare && nuxi prepare playground",
     "format": "dprint check",
     "format:fix": "dprint fmt",
     "lint": "eslint .",
@@ -73,14 +73,15 @@
     "lint:fix": "eslint . --fix",
     "typecheck": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
     "package:lint": "publint",
+    "verify-packaging": "attw --pack . --profile esm-only",
     "test": "vitest run",
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit --outputFile=./coverage/junit.xml",
     "test:watch": "vitest watch"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@scayle/h3-session": "0.6.0",
-    "@scayle/storefront-core": "8.24.0",
+    "@scayle/h3-session": "0.6.1",
+    "@scayle/storefront-core": "8.24.2",
     "@scayle/unstorage-compression-driver": "^0.2.6",
     "@vercel/nft": "0.29.2",
     "@vueuse/core": "13.1.0",
@@ -99,30 +100,32 @@
     "schema-dts": "1.1.5"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "0.17.4",
     "@eslint/eslintrc": "3.3.1",
     "@nuxt/eslint": "1.3.0",
-    "@nuxt/kit": "3.15.4",
+    "@nuxt/kit": "3.16.2",
     "@nuxt/module-builder": "1.0.1",
-    "@nuxt/schema": "3.15.4",
+    "@nuxt/schema": "3.16.2",
     "@nuxt/test-utils": "3.17.2",
     "@scayle/eslint-config-storefront": "4.5.0",
     "@scayle/eslint-plugin-vue-composable": "0.2.1",
     "@scayle/unstorage-scayle-kv-driver": "0.1.1",
-    "@types/node": "22.14.1",
+    "@types/node": "22.15.2",
     "dprint": "0.49.1",
-    "eslint-formatter-gitlab": "5.1.0",
-    "eslint": "9.24.0",
+    "eslint-formatter-gitlab": "6.0.0",
+    "eslint": "9.25.1",
     "fishery": "2.2.3",
-    "h3": "1.15.0",
-    "nitropack": "2.10.4",
+    "h3": "1.15.1",
+    "nitropack": "2.11.9",
+    "nitro-test-utils": "0.9.2",
     "node-mocks-http": "1.16.2",
-    "nuxi": "3.24.1",
-    "nuxt": "3.15.4",
+    "nuxi": "3.25.0",
+    "nuxt": "3.16.2",
     "publint": "0.2.12",
     "typescript": "5.8.3",
-    "unbuild": "2.0.0",
-    "vitest": "3.1.1",
-    "vue-tsc": "2.2.8"
+    "unbuild": "3.5.0",
+    "vitest": "3.1.2",
+    "vue-tsc": "2.2.10"
   },
   "peerDependencies": {
     "@nuxt/kit": ">=3.12.2",