@scayle/storefront-nuxt 7.78.1 → 7.79.1

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # @scayle/storefront-nuxt
 
+## 7.79.1
+
+### Patch Changes
+
+- Import `useNitroApp` from `#imports`
+
+## 7.79.0
+
+### Minor Changes
+
+- Add hooks before and after RPC execution (`storefront:rpc:before` and `storefront:rpc:after`) and when an RPC fails (`storefront:rpc:error`)
+
+  These hooks allow you to execute extra logic before/after executing an RPC and even alter the properties of the RPC context/result.
+
+  Hooks can be registered by adding a nitro plugin inside ´server/plugins/´:
+
+  ```ts
+  import { defineNitroPlugin } from "#imports";
+
+  export default defineNitroPlugin((nitroApp) => {
+    nitroApp.hooks.hook("storefront:rpc:before", (rpcName, rpcContext) => {
+      rpcContext.log.debug(`Before: ${rpcName}`);
+    });
+
+    nitroApp.hooks.hook(
+      "storefront:rpc:after",
+      (rpcName, rpcContext, result) => {
+        rpcContext.log.debug(`After: ${rpcName} returned ${result}`);
+      }
+    );
+
+    nitroApp.hooks.hook(
+      "storefront:rpc:error",
+      (rpcName, rpcContext, error) => {
+        rpcContext.log.error(`ERROR: ${rpcName} did throw ${error}`);
+      }
+    );
+  });
+  ```
+
+  Added [`callHook`](https://github.com/unjs/hookable?tab=readme-ov-file#async-callhook-name-args), `callHookParallel` and [`callHookWith`](https://github.com/unjs/hookable?tab=readme-ov-file#callhookwith-name-callerfn) to `RpcContext` to allow triggering hooks within RPCs
+
+### Patch Changes
+
+- Updated dependencies
+  - @scayle/storefront-core@7.59.0
+
 ## 7.78.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,12 +1,12 @@
-export { d as AdditionalShopConfig, A as AppKeys, B as BapiConfig, h as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, i as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, a as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, g as StorefrontConfig } from './shared/storefront-nuxt.b2288199.mjs';
+export { d as AdditionalShopConfig, A as AppKeys, B as BapiConfig, h as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, i as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, a as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, g as StorefrontConfig } from './shared/storefront-nuxt.2c3f3a8a.mjs';
 export { rpcCall } from './rpc.mjs';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';
-import '@nuxt/schema';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import 'zod';
+import '@nuxt/schema';
 import 'nuxt/app';
 
 /**

package/dist/index.d.ts

@@ -1,12 +1,12 @@
-export { d as AdditionalShopConfig, A as AppKeys, B as BapiConfig, h as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, i as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, a as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, g as StorefrontConfig } from './shared/storefront-nuxt.b2288199.js';
+export { d as AdditionalShopConfig, A as AppKeys, B as BapiConfig, h as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, i as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, a as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, g as StorefrontConfig } from './shared/storefront-nuxt.2c3f3a8a.js';
 export { rpcCall } from './rpc.js';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';
-import '@nuxt/schema';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import 'zod';
+import '@nuxt/schema';
 import 'nuxt/app';
 
 /**

package/dist/module.d.mts

@@ -1,6 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { M as ModuleBaseOptions } from './shared/storefront-nuxt.b2288199.mjs';
-export { d as AdditionalShopConfig, A as AppKeys, B as BapiConfig, h as CheckoutEvent, C as CheckoutShopConfig, i as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, a as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, g as StorefrontConfig } from './shared/storefront-nuxt.b2288199.mjs';
+import { M as ModuleBaseOptions } from './shared/storefront-nuxt.2c3f3a8a.mjs';
+export { d as AdditionalShopConfig, A as AppKeys, B as BapiConfig, h as CheckoutEvent, C as CheckoutShopConfig, i as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, a as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, g as StorefrontConfig } from './shared/storefront-nuxt.2c3f3a8a.mjs';
 export { LogLevel } from '@scayle/storefront-core';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';

package/dist/module.d.ts

@@ -1,6 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { M as ModuleBaseOptions } from './shared/storefront-nuxt.b2288199.js';
-export { d as AdditionalShopConfig, A as AppKeys, B as BapiConfig, h as CheckoutEvent, C as CheckoutShopConfig, i as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, a as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, g as StorefrontConfig } from './shared/storefront-nuxt.b2288199.js';
+import { M as ModuleBaseOptions } from './shared/storefront-nuxt.2c3f3a8a.js';
+export { d as AdditionalShopConfig, A as AppKeys, B as BapiConfig, h as CheckoutEvent, C as CheckoutShopConfig, i as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, a as SessionConfig, e as ShopConfig, f as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, g as StorefrontConfig } from './shared/storefront-nuxt.2c3f3a8a.js';
 export { LogLevel } from '@scayle/storefront-core';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';

package/dist/module.json

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

package/dist/module.mjs

@@ -65,7 +65,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "7.78.0";
+const PACKAGE_VERSION = "7.79.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {

package/dist/rpc.d.mts

@@ -1,10 +1,10 @@
 import { RpcMethodName, RpcMethodParameters, RpcMethodReturnType, RpcContext } from '@scayle/storefront-core';
 import { NuxtApp } from 'nuxt/app';
-import { P as PublicShopConfig } from './shared/storefront-nuxt.b2288199.mjs';
-import '@nuxt/schema';
+import { P as PublicShopConfig } from './shared/storefront-nuxt.2c3f3a8a.mjs';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import 'zod';
+import '@nuxt/schema';
 
 /**
  * rpcCall can be used to invoke an RPC method either on the client or server

package/dist/rpc.d.ts

@@ -1,10 +1,10 @@
 import { RpcMethodName, RpcMethodParameters, RpcMethodReturnType, RpcContext } from '@scayle/storefront-core';
 import { NuxtApp } from 'nuxt/app';
-import { P as PublicShopConfig } from './shared/storefront-nuxt.b2288199.js';
-import '@nuxt/schema';
+import { P as PublicShopConfig } from './shared/storefront-nuxt.2c3f3a8a.js';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import 'zod';
+import '@nuxt/schema';
 
 /**
  * rpcCall can be used to invoke an RPC method either on the client or server

package/dist/runtime/api/rpcHandler.mjs

@@ -3,6 +3,7 @@ import { purifySensitiveData } from "@scayle/storefront-core";
 import { trace, SpanStatusCode } from "@opentelemetry/api";
 import { handler } from "../handler.mjs";
 import { resolveError } from "../error/handler.mjs";
+import { useNitroApp } from "#imports";
 const tracer = trace.getTracer(
   "storefront-nuxt",
   "__sfc_version"
@@ -21,6 +22,7 @@ export default defineEventHandler(async (event) => {
     )
   );
   event.context.$rpcContext.log.space("sfc").debug(`RPC Handler: ${method}, Payload: ${payloadToBeLogged}`);
+  const nitroApp = useNitroApp();
   return await tracer.startActiveSpan(
     `storefront-nuxt.rpc/${method}`,
     {
@@ -36,7 +38,19 @@ export default defineEventHandler(async (event) => {
     async (span) => {
       let result;
       try {
+        await nitroApp.hooks?.callHook(
+          "storefront:rpc:before",
+          method,
+          event.context.$rpcContext,
+          body?.payload
+        );
         result = await handler(method, body?.payload, event.context.$rpcContext);
+        await nitroApp.hooks.callHook(
+          "storefront:rpc:after",
+          method,
+          event.context.$rpcContext,
+          result
+        );
         if (result instanceof Response && !result.ok) {
           span.setStatus({ code: SpanStatusCode.ERROR });
         } else {
@@ -44,6 +58,12 @@ export default defineEventHandler(async (event) => {
         }
       } catch (e) {
         event.context.$rpcContext.log.space("sfc").error(`RPC Handler failed: ${method}`, e);
+        await nitroApp.hooks.callHook(
+          "storefront:rpc:error",
+          method,
+          event.context.$rpcContext,
+          e
+        );
         result = createError(resolveError(e));
         if (e instanceof Error) {
           span.recordException(e);

package/dist/runtime/context.mjs

@@ -92,6 +92,7 @@ export const buildContext = async (context) => {
     }
   });
   const cached = new Cached($cache, $log, "", $storefront.cache?.enabled ?? true).execute;
+  const { hooks } = useNitroApp();
   const baseContext = {
     cached,
     bapiClient,
@@ -142,13 +143,15 @@ export const buildContext = async (context) => {
     ),
     runtimeConfiguration: config,
     ip: getRequestIP(event, { xForwardedFor: true }),
-    headers: createAndPurifyHeaders(getRequestHeaders(event))
+    headers: createAndPurifyHeaders(getRequestHeaders(event)),
+    callHook: hooks.callHook,
+    callHookParallel: hooks.callHookParallel,
+    callHookWith: hooks.callHookWith
   };
   const rpcContext = Object.defineProperties({}, {
     ...Object.getOwnPropertyDescriptors(baseContext),
     ...Object.getOwnPropertyDescriptors(await sessionProperties(context))
   });
-  const nitro = useNitroApp();
-  await nitro.hooks?.callHook("storefront:context:created", rpcContext);
+  await hooks?.callHook("storefront:context:created", rpcContext);
   return rpcContext;
 };

package/dist/shared/{storefront-nuxt.b2288199.d.mts → storefront-nuxt.2c3f3a8a.d.mts}

@@ -1,8 +1,8 @@
-import { HookResult } from '@nuxt/schema';
-import { LogLevel, RpcContext, HashAlgorithm, WithParams, rpcMethods, ShopUser } from '@scayle/storefront-core';
+import { LogLevel, StorefrontHooks, RpcContext, RpcMethodName, HashAlgorithm, WithParams, rpcMethods, ShopUser } from '@scayle/storefront-core';
 import { CompressionEncodings } from '@scayle/unstorage-compression-driver';
 import { BuiltinDriverName, BuiltinDriverOptions } from 'unstorage';
 import { z } from 'zod';
+import { HookResult } from '@nuxt/schema';
 
 declare const RedirectsSchema: z.ZodObject<{
     enabled: z.ZodBoolean;
@@ -1128,8 +1128,11 @@ declare module '@nuxt/schema' {
     }
 }
 declare module 'nitropack' {
-    interface NitroRuntimeHooks {
+    interface NitroRuntimeHooks extends StorefrontHooks {
         'storefront:context:created': (context: RpcContext) => HookResult;
+        'storefront:rpc:before': (rpcName: RpcMethodName, context: RpcContext, payload: unknown) => HookResult;
+        'storefront:rpc:after': (rpcName: RpcMethodName, context: RpcContext, result: unknown) => HookResult;
+        'storefront:rpc:error': (rpcName: RpcMethodName, context: RpcContext, error: unknown) => HookResult;
     }
 }
 

package/dist/shared/{storefront-nuxt.b2288199.d.ts → storefront-nuxt.2c3f3a8a.d.ts}

@@ -1,8 +1,8 @@
-import { HookResult } from '@nuxt/schema';
-import { LogLevel, RpcContext, HashAlgorithm, WithParams, rpcMethods, ShopUser } from '@scayle/storefront-core';
+import { LogLevel, StorefrontHooks, RpcContext, RpcMethodName, HashAlgorithm, WithParams, rpcMethods, ShopUser } from '@scayle/storefront-core';
 import { CompressionEncodings } from '@scayle/unstorage-compression-driver';
 import { BuiltinDriverName, BuiltinDriverOptions } from 'unstorage';
 import { z } from 'zod';
+import { HookResult } from '@nuxt/schema';
 
 declare const RedirectsSchema: z.ZodObject<{
     enabled: z.ZodBoolean;
@@ -1128,8 +1128,11 @@ declare module '@nuxt/schema' {
     }
 }
 declare module 'nitropack' {
-    interface NitroRuntimeHooks {
+    interface NitroRuntimeHooks extends StorefrontHooks {
         'storefront:context:created': (context: RpcContext) => HookResult;
+        'storefront:rpc:before': (rpcName: RpcMethodName, context: RpcContext, payload: unknown) => HookResult;
+        'storefront:rpc:after': (rpcName: RpcMethodName, context: RpcContext, result: unknown) => HookResult;
+        'storefront:rpc:error': (rpcName: RpcMethodName, context: RpcContext, error: unknown) => HookResult;
     }
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.78.1",
+  "version": "7.79.1",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -60,12 +60,13 @@
     "@nuxt/kit": "3.11.2",
     "@opentelemetry/api": "1.9.0",
     "@scayle/h3-session": "0.4.0",
-    "@scayle/storefront-core": "7.58.3",
+    "@scayle/storefront-core": "7.59.0",
     "@scayle/unstorage-compression-driver": "0.1.3",
     "@vueuse/core": "10.11.0",
     "consola": "3.2.3",
     "core-js": "3.37.1",
     "defu": "6.1.4",
+    "hookable": "5.5.3",
     "jose": "^5.2.0",
     "knitwork": "1.1.0",
     "nitropack": "2.9.7",
@@ -86,7 +87,7 @@
     "@scayle/eslint-config-storefront": "4.2.0",
     "@scayle/eslint-plugin-vue-composable": "0.2.0",
     "@types/node": "20.14.9",
-    "dprint": "0.46.3",
+    "dprint": "0.47.0",
     "eslint": "9.6.0",
     "eslint-formatter-gitlab": "5.1.0",
     "fishery": "2.2.2",