@scayle/storefront-nuxt 7.80.0 → 7.82.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @scayle/storefront-nuxt
 
+## 7.82.0
+
+### Minor Changes
+
+- Add new `useRpcCall` composable to make imperative RPC calls more ergonomic
+
+  ```vue
+  <script lang="ts" setup>
+  const getConfig = useRpcCall('getShopConfiguration)
+  const getProduct = useRpcCall('getProductById')
+  const config = await getConfig()
+  const product = await getProduct({ id: 1 })
+  </script>
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+  - @scayle/storefront-core@7.59.1
+
+## 7.81.0
+
+### Minor Changes
+
+- Support enabling or disabling optional server-side plugins
+
+  Plugins with optional behavior can now be disabled at build time through `env` variables.
+
+  - `SFC_PLUGIN_CONFIG_VALIDATION_ENABLED` This plugin executes during app startup and validates the runtime config, exiting with an error if a problem is found. It is enabled by default and can be disabled by setting this variable to `false`.
+  - `SFC_PLUGIN_POWERED_BY_ENABLED` This plugin sets the `X-Powered-By-Header` on every HTTP response to incude SCAYLE. It is enabled by default and can be disabled by setting this variable to `false`.
+  - `SFC_PLUGIN_RUNTIME_PERFORMANCE_ENABLED` This plugin improves performance by computing the runtime configuration at startup rather than for every request. It is enabled by default and can be disabled by setting this variable to `false`.
+
+- Add a plugin to cache the runtime config
+
+  This change adds a Nitro plugin to calculate the runtime config at startup, rather than for every requests. It offers significant performance improvements for large runtime configs.
+
+### Patch Changes
+
+- Add import for runtimeConfig plugin
+- Revert type of `publicShopData` to `string[]`
+
 ## 7.80.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-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.282cc1d9.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.ed010583.mjs';
 export { rpcCall } from './rpc.mjs';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-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.282cc1d9.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.ed010583.js';
 export { rpcCall } from './rpc.js';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';

package/dist/module.d.mts

@@ -1,6 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { M as ModuleBaseOptions } from './shared/storefront-nuxt.282cc1d9.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.282cc1d9.mjs';
+import { M as ModuleBaseOptions } from './shared/storefront-nuxt.ed010583.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.ed010583.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.282cc1d9.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.282cc1d9.js';
+import { M as ModuleBaseOptions } from './shared/storefront-nuxt.ed010583.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.ed010583.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.79.1",
+  "version": "7.81.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.79.1";
+const PACKAGE_VERSION = "7.81.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -241,8 +241,20 @@ Missing RPC Overrides: ${Array.from(overridenRPCMethodNames).map((name) => `'${n
     addServerPlugin(
       resolve("./runtime/nitro/plugins/nitroRuntimeStorageConfig")
     );
-    addServerPlugin(resolve("./runtime/nitro/plugins/nitroSetXPoweredByHeader"));
-    addServerPlugin(resolve("./runtime/nitro/plugins/configValidation"));
+    if (yn(process.env.SFC_PLUGIN_CONFIG_VALIDATION_ENABLED, { default: true })) {
+      logger.debug("Installing config validation plugin");
+      addServerPlugin(resolve("./runtime/nitro/plugins/configValidation"));
+    }
+    if (yn(process.env.SFC_PLUGIN_POWERED_BY_ENABLED, { default: true })) {
+      logger.debug("Installing X-Powered-By plugin");
+      addServerPlugin(
+        resolve("./runtime/nitro/plugins/nitroSetXPoweredByHeader")
+      );
+    }
+    if (yn(process.env.SFC_PLUGIN_RUNTIME_PERFORMANCE_ENABLED, { default: 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 || [];
@@ -261,6 +273,7 @@ Missing RPC Overrides: ${Array.from(overridenRPCMethodNames).map((name) => `'${n
         "server/middleware/cache",
         "server/utils/cacheStorage",
         "utils/zodSchema",
+        "nitro/plugins/cacheRuntimeConfig",
         "nitro/plugins/nitroLogger",
         "nitro/plugins/nitroRuntimeStorageConfig",
         "nitro/plugins/nitroSetXPoweredByHeader",

package/dist/rpc.d.mts

@@ -1,6 +1,6 @@
 import { RpcMethodName, RpcMethodParameters, RpcMethodReturnType, RpcContext } from '@scayle/storefront-core';
 import { NuxtApp } from 'nuxt/app';
-import { P as PublicShopConfig } from './shared/storefront-nuxt.282cc1d9.mjs';
+import { P as PublicShopConfig } from './shared/storefront-nuxt.ed010583.mjs';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import 'zod';

package/dist/rpc.d.ts

@@ -1,6 +1,6 @@
 import { RpcMethodName, RpcMethodParameters, RpcMethodReturnType, RpcContext } from '@scayle/storefront-core';
 import { NuxtApp } from 'nuxt/app';
-import { P as PublicShopConfig } from './shared/storefront-nuxt.282cc1d9.js';
+import { P as PublicShopConfig } from './shared/storefront-nuxt.ed010583.js';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import 'zod';

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

@@ -0,0 +1,2 @@
+import type { RpcContext, RpcMethodName, RpcMethodParameters, RpcMethodReturnType } from '@scayle/storefront-core';
+export declare function useRpcCall<N extends RpcMethodName, P extends RpcMethodParameters<N>, TResult extends Exclude<Awaited<RpcMethodReturnType<N>>, Response>, TakesParameters = P extends RpcContext ? undefined : boolean>(method: N): TakesParameters extends undefined ? () => Promise<TResult> : (params: P) => Promise<TResult>;

package/dist/runtime/composables/core/useRpcCall.mjs

@@ -0,0 +1,8 @@
+import { rpcCall } from "../../rpc/rpcCall.mjs";
+import { useNuxtApp } from "nuxt/app";
+import { useCurrentShop } from "./useCurrentShop.mjs";
+export function useRpcCall(method) {
+  const nuxtApp = useNuxtApp();
+  const currentShop = useCurrentShop();
+  return rpcCall(nuxtApp, method, currentShop.value);
+}

package/dist/runtime/composables/index.d.ts

@@ -4,6 +4,7 @@ export * from './core/useFormatHelpers';
 export * from './core/useIDP';
 export * from './core/useLog';
 export * from './core/useRpc';
+export * from './core/useRpcCall';
 export * from './core/useSession';
 export * from './core/useUser';
 export * from './storefront/useBasket';

package/dist/runtime/composables/index.mjs

@@ -4,6 +4,7 @@ export * from "./core/useFormatHelpers.mjs";
 export * from "./core/useIDP.mjs";
 export * from "./core/useLog.mjs";
 export * from "./core/useRpc.mjs";
+export * from "./core/useRpcCall.mjs";
 export * from "./core/useSession.mjs";
 export * from "./core/useUser.mjs";
 export * from "./storefront/useBasket.mjs";

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

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/runtime/nitro/plugins/cacheRuntimeConfig.mjs

@@ -0,0 +1,8 @@
+import { defineNitroPlugin, useRuntimeConfig } from "#imports";
+export default defineNitroPlugin((nitroApp) => {
+  const runtimeConfig = useRuntimeConfig();
+  nitroApp.hooks.hook("request", (event) => {
+    event.context.nitro = event.context.nitro ?? {};
+    event.context.nitro.runtimeConfig = runtimeConfig;
+  });
+});

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

@@ -810,7 +810,7 @@ declare const StorefrontConfigSchema: z.ZodObject<{
         };
         enabled?: boolean | undefined;
     }>>;
-    publicShopData: z.ZodOptional<z.ZodArray<z.ZodType<("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders", z.ZodTypeDef, ("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders">, "many">>;
+    publicShopData: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     idp: z.ZodOptional<z.ZodObject<{
         enabled: z.ZodBoolean;
         idpKeys: z.ZodArray<z.ZodString, "many">;
@@ -936,7 +936,7 @@ declare const StorefrontConfigSchema: z.ZodObject<{
             tls?: boolean | undefined;
         } | undefined;
     } | undefined;
-    publicShopData?: (("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders")[] | undefined;
+    publicShopData?: string[] | undefined;
 }, {
     oauth: {
         apiHost: string;
@@ -1011,7 +1011,7 @@ declare const StorefrontConfigSchema: z.ZodObject<{
             tls?: boolean | undefined;
         } | undefined;
     } | undefined;
-    publicShopData?: (("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders")[] | undefined;
+    publicShopData?: string[] | undefined;
 }>;
 declare const PublicRuntimeConfigSchema: z.ZodObject<{
     log: z.ZodObject<{
@@ -1254,7 +1254,7 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             };
             enabled?: boolean | undefined;
         }>>;
-        publicShopData: z.ZodOptional<z.ZodArray<z.ZodType<("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders", z.ZodTypeDef, ("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders">, "many">>;
+        publicShopData: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
         idp: z.ZodOptional<z.ZodObject<{
             enabled: z.ZodBoolean;
             idpKeys: z.ZodArray<z.ZodString, "many">;
@@ -1380,7 +1380,7 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
                 tls?: boolean | undefined;
             } | undefined;
         } | undefined;
-        publicShopData?: (("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders")[] | undefined;
+        publicShopData?: string[] | undefined;
     }, {
         oauth: {
             apiHost: string;
@@ -1455,7 +1455,7 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
                 tls?: boolean | undefined;
             } | undefined;
         } | undefined;
-        publicShopData?: (("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders")[] | undefined;
+        publicShopData?: string[] | undefined;
     }>, z.ZodObject<{
         shopSelector: z.ZodEnum<["path", "domain", "path_or_default"]>;
         stores: z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -2187,7 +2187,7 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
                 tls?: boolean | undefined;
             } | undefined;
         } | undefined;
-        publicShopData?: (("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders")[] | undefined;
+        publicShopData?: string[] | undefined;
     } | {
         shopSelector: "domain" | "path" | "path_or_default";
         stores: Record<string, {
@@ -2360,7 +2360,7 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
                 tls?: boolean | undefined;
             } | undefined;
         } | undefined;
-        publicShopData?: (("locale" | "checkout" | "shopId" | "auth" | "currency") | ("domain" | "storeCampaignKeyword" | "idp" | "path" | "redis" | "apiBasePath" | "appKeys" | "currencyFractionDigits" | "isEnabled" | "sessionConfig" | "bapi" | "storage" | "isDefault") | "paymentProviders")[] | undefined;
+        publicShopData?: string[] | undefined;
     } | {
         shopSelector: "domain" | "path" | "path_or_default";
         stores: Record<string, {

package/dist/runtime/utils/zodSchema.mjs

@@ -131,9 +131,7 @@ const StorefrontConfigSchema = z.object({
   appKeys: AppKeysSchema,
   apiBasePath: z.string().optional(),
   cache: CacheSchema.optional(),
-  publicShopData: z.array(
-    z.custom()
-  ).optional(),
+  publicShopData: z.array(z.string()).optional(),
   idp: IdpSchema.optional(),
   /** @deprecated Global storefront.redis config is being removed in favor of `storefront.storage` config */
   redis: RedisConfigSchema.optional()