@scayle/storefront-nuxt 8.6.1 → 8.7.1

package/CHANGELOG.md

@@ -1,5 +1,62 @@
 # @scayle/storefront-nuxt
 
+## 8.7.1
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@8.3.2
+
+## 8.7.0
+
+### Minor Changes
+
+- Introduce a flexible interface for registering custom RPC methods from other modules
+
+  Currently, applications can configure `rpcDir` and `rpcMethodNames` in the module configuration to register custom RPC methods, however this does not extend to modules.
+  This release adds a new module hook `storefront:custom-rpc:extend` which can be used to register custom RPC methods.
+  By registering a callback to this hook, other modules can add custom RPC methods to the application.
+
+  The hook functions similarly to `rpcDir` and `rpcMethodNames`. Hook registrants receive an array of custom RPC imports and can add their own. The import definition should include a `source` which defines the file to import the RPC methods from and a `names` array which controls the exports of this file which should be registered as RPC methods.
+
+  **rpc-methods.ts**
+
+  ```typescript
+  import type { RpcContext, RpcHandler } from '@scayle/storefront-nuxt'
+
+  export const foo: RpcHandler<string, number> = function testing(
+    param: string,
+    _: RpcContext,
+  ) {
+    return param.length
+  }
+  ```
+
+  **module.ts**
+
+  ```typescript
+  function setup() {
+    const resolver = createResolver(import.meta.url)
+
+    nuxt.hook('storefront:custom-rpc:extend', (customRpcImports) => {
+      customRpcImports.push({
+        source: resolver.resolve('./rpc-methods.ts'),
+        names: ['foo'],
+      })
+    })
+  }
+  ```
+
+  As part of this change, the `RPCMethod` types are automatically extended with all custom RPC methods.
+  It is no longer necessary to extend `RpcMethodsStorefront`.
+  This applies both for the `rpcDir` + `rpcMethodNames` strategy as well as the new hook-based implementation.
+
+### Patch Changes
+
+- [RPC] Improve warning about missing RPC method overrides
+- Improve error handling when bootstrapping fails due to a missing shop.
+
 ## 8.6.1
 
 ### Patch Changes

package/dist/module.d.mts

@@ -1,4 +1,5 @@
 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';
 export { LogLevel } from '@scayle/storefront-core';
@@ -6,6 +7,25 @@ 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 {
+    }
+}
 declare const _default: _nuxt_schema.NuxtModule<ModuleBaseOptions, ModuleBaseOptions, false>;
 
-export { ModuleBaseOptions, _default as default };
+export { ModuleBaseOptions, type ModuleHooks, _default as default };

package/dist/module.d.ts

@@ -1,4 +1,5 @@
 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';
 export { LogLevel } from '@scayle/storefront-core';
@@ -6,6 +7,25 @@ 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 {
+    }
+}
 declare const _default: _nuxt_schema.NuxtModule<ModuleBaseOptions, ModuleBaseOptions, false>;
 
-export { ModuleBaseOptions, _default as default };
+export { ModuleBaseOptions, type ModuleHooks, _default as default };

package/dist/module.json

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

package/dist/module.mjs

@@ -1,7 +1,7 @@
-import { defineNuxtModule, createResolver, extendViteConfig, addServerHandler, addTypeTemplate, addServerPlugin, addPlugin, addImportsDir } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, extendViteConfig, addTypeTemplate, addPlugin, addImportsDir } from '@nuxt/kit';
 import { rpcMethods } from '@scayle/storefront-core';
 import { defu } from 'defu';
-import { genImport, genSafeVariableName } from 'knitwork';
+import { genImport, genSafeVariableName, genExport } from 'knitwork';
 import { builtinDrivers } from 'unstorage';
 import { createConsola } from 'consola';
 import { getApiBasePath } from '../dist/runtime/server/middleware/bootstrap-utils.js';
@@ -27,8 +27,7 @@ function getUsedDrivers(options) {
   });
   return Array.from(drivers);
 }
-function createVirtualDriverImport(options) {
-  const usedDrivers = getUsedDrivers(options);
+function createVirtualDriverImport(usedDrivers) {
   const usesCompression = !stringToBoolean(
     process.env.SFC_OMIT_COMPRESSION,
     false
@@ -45,7 +44,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.6.1";
+const PACKAGE_VERSION = "8.7.1";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -59,6 +58,150 @@ const logger = createConsola({
   // However when typechecking it will resolve to consola/browser which does have the fancy option
   // This assertion avoids the typescript error
 });
+function createRpcMethodIndex(customRpcImports) {
+  return customRpcImports.map(({ source, names }) => genExport(source, names)).join(
+    "\n"
+  ) + `
+export {}`;
+}
+function createRpcMethodTypeDeclaration(customRpcImports) {
+  return `// Auto-generated
+    type RpcMethodsCustomType = {
+      ${customRpcImports.reduce(
+    (lines, { source, names }) => lines.concat(
+      names.map((name) => `${name}: typeof import('${source}')['${name}'],`).join("\n")
+    ),
+    []
+  ).join("\n")}
+    }
+    declare module '@scayle/storefront-nuxt' {
+      export interface RpcMethodsStorefront extends RpcMethodsCustomType {}
+    }
+    export {}`;
+}
+function nitroSetup(nitroConfig, config) {
+  const { resolve } = createResolver(import.meta.url);
+  const { apiBasePath, customRpcImports, coreMethodNames, usedDrivers } = config;
+  nitroConfig.externals = nitroConfig.externals || {};
+  nitroConfig.externals.inline = nitroConfig.externals.inline || [];
+  const runtimePaths = [
+    "handler",
+    "error/handler",
+    "campaignKey",
+    "cached",
+    "context",
+    "createLog",
+    "log",
+    "api/cacheAuth",
+    "rpc/rpcCall",
+    "rpc/rpcRequest",
+    "server/middleware/oauth",
+    "server/middleware/redirects",
+    "server/middleware/cache",
+    "server/utils/cacheStorage",
+    "utils/zodSchema",
+    "nitro/plugins/cacheRuntimeConfig",
+    "nitro/plugins/nitroLogger",
+    "nitro/plugins/nitroRuntimeStorageConfig",
+    "nitro/plugins/nitroSetXPoweredByHeader",
+    "nitro/plugins/configValidation"
+  ];
+  runtimePaths.forEach((path) => {
+    const file = resolve(`./runtime/${path}`);
+    nitroConfig.externals?.inline?.push(file);
+  });
+  nitroConfig.replace = nitroConfig.replace || {};
+  nitroConfig.replace["process.env.SFC_OMIT_MD5"] = stringToBoolean(
+    process.env.SFC_OMIT_MD5
+  );
+  nitroConfig.replace.__sfc_version = PACKAGE_VERSION;
+  nitroConfig.virtual = {
+    ...nitroConfig.virtual,
+    "#virtual/storage-drivers": createVirtualDriverImport(
+      usedDrivers
+    ),
+    "#virtual/customRpcMethods": createRpcMethodIndex(
+      customRpcImports
+    )
+  };
+  nitroConfig.handlers = nitroConfig.handlers ?? [];
+  nitroConfig.handlers.unshift({
+    middleware: true,
+    handler: resolve("./runtime/server/middleware/bootstrap")
+  });
+  const allRpcNames = customRpcImports.reduce(
+    (acc, { names }) => acc.concat(names),
+    []
+  ).concat(coreMethodNames);
+  for (const methodName of allRpcNames) {
+    nitroConfig.handlers.push({
+      route: `${apiBasePath}/rpc/${methodName}`,
+      handler: resolve("./runtime/api/rpcHandler"),
+      method: "post"
+    });
+  }
+  nitroConfig.handlers.push({
+    route: `${apiBasePath}/purge/all`,
+    handler: resolve("./runtime/api/purgeAll"),
+    method: "post"
+  });
+  nitroConfig.handlers.push({
+    route: `${apiBasePath}/purge/tags`,
+    handler: resolve("./runtime/api/purgeTags"),
+    method: "post"
+  });
+  nitroConfig.handlers.push({
+    route: `${apiBasePath}/up`,
+    handler: resolve("./runtime/api/up")
+  });
+  nitroConfig.plugins = nitroConfig.plugins ?? [];
+  nitroConfig.plugins.push(resolve("./runtime/nitro/plugins/nitroLogger"));
+  nitroConfig.plugins.push(
+    resolve("./runtime/nitro/plugins/nitroRuntimeStorageConfig")
+  );
+  if (stringToBoolean(process.env.SFC_PLUGIN_CONFIG_VALIDATION_ENABLED, true)) {
+    logger.debug("Installing config validation plugin");
+    nitroConfig.plugins.push(
+      resolve("./runtime/nitro/plugins/configValidation")
+    );
+  }
+  if (stringToBoolean(process.env.SFC_PLUGIN_POWERED_BY_ENABLED, true)) {
+    logger.debug("Installing X-Powered-By plugin");
+    nitroConfig.plugins.push(
+      resolve("./runtime/nitro/plugins/nitroSetXPoweredByHeader")
+    );
+  }
+  if (stringToBoolean(process.env.SFC_PLUGIN_RUNTIME_PERFORMANCE_ENABLED, true)) {
+    logger.debug("Installing runtime performance plugin");
+    nitroConfig.plugins.push(
+      resolve("./runtime/nitro/plugins/cacheRuntimeConfig")
+    );
+  }
+}
+function validateRpcMethodOverrides(rpcMethodOverrides, customRpcNames, coreRpcNames) {
+  const overridenRPCMethodNames = new Set(rpcMethodOverrides);
+  for (const rpcMethodName of customRpcNames) {
+    if (coreRpcNames.has(rpcMethodName) && !overridenRPCMethodNames.has(rpcMethodName)) {
+      logger.warn(`
+Overriding RPC method '${rpcMethodName}' from '@scayle/storefront-nuxt' with a local custom implementation.
+
+Should this be done on purpose, please be aware that this can lead to unexpected issues since the '@scayle/storefront-nuxt' package also uses this RPC method internally.
+To silence this warning, you can add '${rpcMethodName}' to 'rpcMethodOverrides' in the '@scayle/storefront-nuxt' config.
+
+In the future this will become an error where overrides need to be explicitly defined as an override.
+`);
+    } else {
+      overridenRPCMethodNames.delete(rpcMethodName);
+    }
+  }
+  if (overridenRPCMethodNames.size > 0) {
+    logger.warn(`
+Detected RPC methods which were supposed to be overridden but are not. This indicates an incorrect configuration and should be adjusted. Check the 'rpcMethodOverrides' property.
+
+Missing RPC Method Overrides: ${Array.from(overridenRPCMethodNames).map((name) => `'${name}'`).join(", ")}
+`);
+  }
+}
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,
@@ -102,7 +245,7 @@ const module = defineNuxtModule({
     },
     internalAccessHeader: ""
   },
-  setup(options, nuxt) {
+  async setup(options, nuxt) {
     const { resolve } = createResolver(import.meta.url);
     const { resolve: appResolve } = createResolver(nuxt.options.srcDir);
     nuxt.options.runtimeConfig.storefront = defu(
@@ -125,55 +268,40 @@ const module = defineNuxtModule({
         "slugify"
       );
     });
-    nuxt.options.serverHandlers.unshift({
-      middleware: true,
-      handler: resolve("./runtime/server/middleware/bootstrap")
-    });
     const apiBasePath = getApiBasePath(options, "/");
     const rpcMethodNames = new Set(Object.keys(rpcMethods));
-    const overridenRPCMethodNames = new Set(options.rpcMethodOverrides);
-    for (const rpcMethodName of options.rpcMethodNames ?? []) {
-      if (rpcMethodNames.has(rpcMethodName) && !overridenRPCMethodNames.has(rpcMethodName)) {
-        logger.warn(`
-Overriding RPC method '${rpcMethodName}' from '@scayle/storefront-nuxt' with a local custom implementation.
-
-Should this be done on purpose, please be aware that this can lead to unexpected issues since the '@scayle/storefront-nuxt' package also uses this RPC method internally.
-To silence this warning, you can add '${rpcMethodName}' to 'rpcMethodOverrides' in the '@scayle/storefront-nuxt' config.
-
-In the future this will become an error where overrides need to be explicitly defined as an override.
-`);
-      } else {
-        overridenRPCMethodNames.delete(rpcMethodName);
-      }
-      rpcMethodNames.add(rpcMethodName);
-    }
-    if (overridenRPCMethodNames.size > 0) {
-      logger.warn(`
-Specified RPC which were supposed to be overriden but are not. This indicates and outdated config and should be adjusted.
-
-Missing RPC Overrides: ${Array.from(overridenRPCMethodNames).map((name) => `'${name}'`).join(", ")}
-`);
-    }
-    rpcMethodNames.forEach((methodName) => {
-      addServerHandler({
-        route: `${apiBasePath}/rpc/${methodName}`,
-        handler: resolve("./runtime/api/rpcHandler"),
-        method: "post"
+    const storefrontRpcMethodNames = options.rpcMethodNames ?? [];
+    const customRpcImports = [];
+    nuxt.hook("modules:done", async () => {
+      await nuxt.callHook("storefront:custom-rpc:extend", customRpcImports);
+      customRpcImports.forEach((customImport) => {
+        customImport.names.forEach((name) => {
+          if (rpcMethodNames.has(name)) {
+            throw new Error(
+              `Core RPC method '${name}' cannot be overriden via the 'storefront:custom-rpc:extend' hook`
+            );
+          }
+        });
+        customImport.names = customImport.names.filter(
+          (name) => !storefrontRpcMethodNames.includes(name)
+        );
+      });
+      customRpcImports.push({
+        source: appResolve(options.rpcDir ?? "./rpcMethods"),
+        names: storefrontRpcMethodNames
+      });
+      validateRpcMethodOverrides(
+        options.rpcMethodOverrides ?? [],
+        customRpcImports.reduce(
+          (acc, { names }) => acc.concat(names),
+          []
+        ),
+        rpcMethodNames
+      );
+      addTypeTemplate({
+        filename: "types/storefront-custom-rpc.d.ts",
+        getContents: () => createRpcMethodTypeDeclaration(customRpcImports)
       });
-    });
-    addServerHandler({
-      route: `${apiBasePath}/purge/all`,
-      handler: resolve("./runtime/api/purgeAll"),
-      method: "post"
-    });
-    addServerHandler({
-      route: `${apiBasePath}/purge/tags`,
-      handler: resolve("./runtime/api/purgeTags"),
-      method: "post"
-    });
-    addServerHandler({
-      route: `${apiBasePath}/up`,
-      handler: resolve("./runtime/api/up")
     });
     addTypeTemplate({
       filename: "types/storefront-bootstrap.d.ts",
@@ -183,10 +311,10 @@ Missing RPC Overrides: ${Array.from(overridenRPCMethodNames).map((name) => `'${n
         import type { PublicShopConfig } from '@scayle/storefront-nuxt';
         declare module 'h3' {
           interface H3EventContext {
-            $rpcContext: RpcContext,
-            $cache: Cache
-            $currentShop: PublicShopConfig,
-            $availableShops: PublicShopConfig[]
+            $rpcContext?: RpcContext,
+            $cache?: Cache
+            $currentShop?: PublicShopConfig,
+            $availableShops?: PublicShopConfig[]
             $log: Log
           }
         }
@@ -195,64 +323,13 @@ Missing RPC Overrides: ${Array.from(overridenRPCMethodNames).map((name) => `'${n
         }
         export {}`
     });
-    addServerPlugin(resolve("./runtime/nitro/plugins/nitroLogger"));
-    addServerPlugin(
-      resolve("./runtime/nitro/plugins/nitroRuntimeStorageConfig")
-    );
-    if (stringToBoolean(process.env.SFC_PLUGIN_CONFIG_VALIDATION_ENABLED, true)) {
-      logger.debug("Installing config validation plugin");
-      addServerPlugin(resolve("./runtime/nitro/plugins/configValidation"));
-    }
-    if (stringToBoolean(process.env.SFC_PLUGIN_POWERED_BY_ENABLED, true)) {
-      logger.debug("Installing X-Powered-By plugin");
-      addServerPlugin(
-        resolve("./runtime/nitro/plugins/nitroSetXPoweredByHeader")
-      );
-    }
-    if (stringToBoolean(process.env.SFC_PLUGIN_RUNTIME_PERFORMANCE_ENABLED, true)) {
-      logger.debug("Installing runtime performance plugin");
-      addServerPlugin(resolve("./runtime/nitro/plugins/cacheRuntimeConfig"));
-    }
     nuxt.hooks.hook("nitro:config", (nitroConfig) => {
-      nitroConfig.externals = nitroConfig.externals || {};
-      nitroConfig.externals.inline = nitroConfig.externals.inline || [];
-      const runtimePaths = [
-        "handler",
-        "error/handler",
-        "campaignKey",
-        "cached",
-        "context",
-        "createLog",
-        "log",
-        "api/cacheAuth",
-        "rpc/rpcCall",
-        "rpc/rpcRequest",
-        "server/middleware/oauth",
-        "server/middleware/redirects",
-        "server/middleware/cache",
-        "server/utils/cacheStorage",
-        "utils/zodSchema",
-        "nitro/plugins/cacheRuntimeConfig",
-        "nitro/plugins/nitroLogger",
-        "nitro/plugins/nitroRuntimeStorageConfig",
-        "nitro/plugins/nitroSetXPoweredByHeader",
-        "nitro/plugins/configValidation"
-      ];
-      runtimePaths.forEach((path) => {
-        const file = resolve(`./runtime/${path}`);
-        nitroConfig.externals?.inline?.push(file);
+      nitroSetup(nitroConfig, {
+        apiBasePath,
+        customRpcImports,
+        coreMethodNames: [...rpcMethodNames],
+        usedDrivers: getUsedDrivers(nuxt.options.runtimeConfig.storefront)
       });
-      nitroConfig.replace = nitroConfig.replace || {};
-      nitroConfig.replace["process.env.SFC_OMIT_MD5"] = stringToBoolean(
-        process.env.SFC_OMIT_MD5
-      );
-      nitroConfig.replace.__sfc_version = PACKAGE_VERSION;
-      nitroConfig.virtual = {
-        ...nitroConfig.virtual,
-        "#virtual/storage-drivers": createVirtualDriverImport(
-          nuxt.options.runtimeConfig.storefront
-        )
-      };
     });
     nuxt.hooks.hook("nitro:init", (nitro) => {
       nitro.hooks.hook("rollup:before", (_nitro, rollupConfig) => {
@@ -269,9 +346,6 @@ Missing RPC Overrides: ${Array.from(overridenRPCMethodNames).map((name) => `'${n
         };
       });
     });
-    nuxt.options.alias["#rpcMethods"] = appResolve(
-      options.rpcDir ?? "./rpcMethods"
-    );
     nuxt.options.alias["#storefront/composables"] = resolve(
       "./runtime/composables"
     );

package/dist/runtime/api/purgeAll.js

@@ -3,6 +3,16 @@ import { HttpStatusCode } from "@scayle/storefront-core";
 import { eventHandlerWithCacheAuth } from "./cacheAuth.js";
 export default eventHandlerWithCacheAuth(
   defineEventHandler(async (event) => {
+    if (!event.context.$rpcContext) {
+      return new Response("No $rpcContext was found for the request", {
+        status: HttpStatusCode.INTERNAL_SERVER_ERROR
+      });
+    }
+    if (!event.context.$cache) {
+      return new Response("No $cache was found for the request", {
+        status: HttpStatusCode.INTERNAL_SERVER_ERROR
+      });
+    }
     const logger = event.context.$rpcContext.log.space("purge-all");
     try {
       logger.debug("purging cache");

package/dist/runtime/api/purgeTags.js

@@ -3,6 +3,16 @@ import { HttpStatusCode } from "@scayle/storefront-core";
 import { eventHandlerWithCacheAuth } from "./cacheAuth.js";
 export default eventHandlerWithCacheAuth(
   defineEventHandler(async (event) => {
+    if (!event.context.$rpcContext) {
+      return new Response("No $rpcContext was found for the request", {
+        status: HttpStatusCode.INTERNAL_SERVER_ERROR
+      });
+    }
+    if (!event.context.$cache) {
+      return new Response("No $cache was found for the request", {
+        status: HttpStatusCode.INTERNAL_SERVER_ERROR
+      });
+    }
     const tags = await readBody(event);
     const logger = event.context.$rpcContext.log.space("purge-tags");
     logger.debug(`purging tags: ${tags}`);

package/dist/runtime/api/rpcHandler.d.ts

@@ -1,2 +1,51 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string | true | string[] | import("@scayle/storefront-core").ShopUser | Response | import("@scayle/storefront-api").Product | import("@scayle/storefront-api").Product[] | {
+    count: number;
+} | {
+    filters: import("@scayle/storefront-api").FiltersEndpointResponseData;
+    unfilteredCount: number;
+} | {
+    products: import("@scayle/storefront-api").Product[];
+    pagination: {
+        current: number;
+        total: number;
+        perPage: number;
+        page: number;
+        first: number;
+        prev: number;
+        next: number;
+        last: number;
+    };
+} | {
+    basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
+} | {
+    readonly type: "success";
+    readonly basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
+} | {
+    readonly type: "failure";
+    readonly basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
+    readonly errors: import("@scayle/storefront-api").AddOrUpdateItemError[];
+} | import("@scayle/storefront-api").BrandsEndpointResponseData | import("@scayle/storefront-api").Brand | {
+    categories: import("@scayle/storefront-api").Category[];
+    activeNode: undefined;
+} | import("@scayle/storefront-api").Category | {
+    categories: import("@scayle/storefront-api").Category;
+    activeNode: import("@scayle/storefront-api").Category;
+} | import("@scayle/storefront-core").Order | import("@scayle/storefront-api").SearchV2SuggestionsEndpointResponseData | import("@scayle/storefront-api").SearchEntity | import("@scayle/storefront-api").ShopConfiguration | {
+    user: import("@scayle/storefront-core").ShopUser | undefined;
+} | import("@scayle/storefront-api").Wishlist | import("@scayle/storefront-core").ShopUserAddress[] | {
+    accessToken: string;
+    checkoutJwt: string;
+} | import("@scayle/storefront-api").VariantDetail[] | import("@scayle/storefront-api").NavigationAllEndpointResponseData | import("@scayle/storefront-api").NavigationTree | {
+    success: true;
+} | {
+    success: false;
+} | {
+    result: true;
+} | {
+    result: false;
+} | import("@scayle/storefront-api").PromotionsEndpointResponseData | {
+    [k: string]: string;
+} | {
+    message: string;
+} | null | undefined>>;
 export default _default;

package/dist/runtime/api/rpcHandler.js

@@ -1,5 +1,5 @@
 import { defineEventHandler, readBody, createError, getRequestURL } from "h3";
-import { purifySensitiveData } from "@scayle/storefront-core";
+import { purifySensitiveData, HttpStatusCode } from "@scayle/storefront-core";
 import { trace, SpanStatusCode } from "@opentelemetry/api";
 import { handler } from "../handler.js";
 import { resolveError } from "../error/handler.js";
@@ -9,6 +9,12 @@ const tracer = trace.getTracer(
   "__sfc_version"
 );
 export default defineEventHandler(async (event) => {
+  const $rpcContext = event.context.$rpcContext;
+  if (!$rpcContext) {
+    return new Response("No $rpcContext was found for the request", {
+      status: HttpStatusCode.INTERNAL_SERVER_ERROR
+    });
+  }
   const pathComponents = event.path.split("?")[0].split("/");
   const method = pathComponents[pathComponents.length - 1];
   const body = await readBody(event);
@@ -21,7 +27,7 @@ export default defineEventHandler(async (event) => {
       typeof body?.payload !== "object" ? { [typeof body?.payload]: body?.payload } : body?.payload
     )
   );
-  event.context.$rpcContext.log.space("sfc").debug(`RPC Handler: ${method}, Payload: ${payloadToBeLogged}`);
+  $rpcContext.log.space("sfc").debug(`RPC Handler: ${method}, Payload: ${payloadToBeLogged}`);
   const nitroApp = useNitroApp();
   return await tracer.startActiveSpan(
     `storefront-nuxt.rpc/${method}`,
@@ -41,14 +47,14 @@ export default defineEventHandler(async (event) => {
         await nitroApp.hooks?.callHook(
           "storefront:rpc:before",
           method,
-          event.context.$rpcContext,
+          $rpcContext,
           body?.payload
         );
-        result = await handler(method, body?.payload, event.context.$rpcContext);
+        result = await handler(method, body?.payload, $rpcContext);
         await nitroApp.hooks.callHook(
           "storefront:rpc:after",
           method,
-          event.context.$rpcContext,
+          $rpcContext,
           result
         );
         if (result instanceof Response && !result.ok) {
@@ -57,11 +63,11 @@ export default defineEventHandler(async (event) => {
           span.setStatus({ code: SpanStatusCode.OK });
         }
       } catch (e) {
-        event.context.$rpcContext.log.space("sfc").error(`RPC Handler failed: ${method}`, e);
+        $rpcContext.log.space("sfc").error(`RPC Handler failed: ${method}`, e);
         await nitroApp.hooks.callHook(
           "storefront:rpc:error",
           method,
-          event.context.$rpcContext,
+          $rpcContext,
           e
         );
         result = createError(resolveError(e));

package/dist/runtime/composables/storefront/useStorefrontSearch.d.ts

@@ -14,5 +14,5 @@ export declare function useStorefrontSearch(searchQuery: Ref<string>, { params }
     error: Ref<unknown, unknown>;
     resetSearch: () => void;
     getSearchSuggestions: () => Promise<void>;
-    resolveSearch: () => Promise<any>;
+    resolveSearch: () => Promise<import("@scayle/storefront-api").SearchEntity | null | undefined>;
 };

package/dist/runtime/handler.js

@@ -1,5 +1,5 @@
 import { rpcMethods as coreRpcMethods } from "@scayle/storefront-core";
-import * as storefrontRpcMethods from "#rpcMethods";
+import * as storefrontRpcMethods from "#virtual/customRpcMethods";
 export const handler = async (method, payload, rpcContext) => {
   const rpcMethods = {
     ...coreRpcMethods,

package/dist/runtime/plugin/shop.js

@@ -5,8 +5,12 @@ export default defineNuxtPlugin((nuxtApp) => {
   const currentShop = useCurrentShop();
   const availableShops = useAvailableShops();
   if (import.meta.server && nuxtApp.ssrContext) {
-    currentShop.value = nuxtApp.ssrContext.event.context.$currentShop;
-    availableShops.value = nuxtApp.ssrContext.event.context.$availableShops;
+    if (nuxtApp.ssrContext.event.context.$currentShop) {
+      currentShop.value = nuxtApp.ssrContext.event.context.$currentShop;
+    }
+    if (nuxtApp.ssrContext.event.context.$availableShops) {
+      availableShops.value = nuxtApp.ssrContext.event.context.$availableShops;
+    }
   }
   return {
     provide: {

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

@@ -1,13 +1,4 @@
-import type { RpcContext, Cache, ShopUser } from '@scayle/storefront-core';
-import type { PublicShopConfig } from '../../../module.js';
-declare module 'h3' {
-    interface H3EventContext {
-        $rpcContext: RpcContext;
-        $cache: Cache;
-        $currentShop: PublicShopConfig;
-        $availableShops: PublicShopConfig[];
-    }
-}
+import type { ShopUser } from '@scayle/storefront-core';
 export interface ShopSessionData {
     user?: ShopUser;
     accessToken?: string;

package/dist/runtime/server/middleware/redirects.js

@@ -51,6 +51,9 @@ async function fetchRedirectWithCache(sourceUrl, storefrontAPIClient, redirectCa
   return sapiResult;
 }
 export async function useRedirects(event) {
+  if (!event.context.$rpcContext) {
+    return;
+  }
   const config = useRuntimeConfig();
   const $storefrontConfig = config.storefront;
   const options = $storefrontConfig.redirects;

package/dist/types.d.mts

@@ -1,8 +1,9 @@
 import type { NuxtModule } from '@nuxt/schema'
 
-import type { default as Module, ModulePublicRuntimeConfig } from './module.js'
+import type { default as Module, ModuleHooks, ModulePublicRuntimeConfig } from './module.js'
 
 declare module '@nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
   interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 

package/dist/types.d.ts

@@ -1,8 +1,9 @@
 import type { NuxtModule } from '@nuxt/schema'
 
-import type { default as Module, ModulePublicRuntimeConfig } from './module'
+import type { default as Module, ModuleHooks, ModulePublicRuntimeConfig } from './module'
 
 declare module '@nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
   interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.6.1",
+  "version": "8.7.1",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -72,7 +72,7 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "0.6.0",
-    "@scayle/storefront-core": "8.3.1",
+    "@scayle/storefront-core": "8.3.2",
     "@scayle/unstorage-compression-driver": "^0.2.3",
     "@vueuse/core": "12.5.0",
     "consola": "^3.2.3",