@scayle/storefront-nuxt 7.71.1 → 7.72.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @scayle/storefront-nuxt
 
+## 7.72.0
+
+### Minor Changes
+
+- Introduced a new feature that validates runtime configurations using Zod schemas upon server startup.
+  The server will exit if validation fails.
+- We now log a warning when an RPC method from `@scayle/storefront-nuxt` is overridden by an RPC custom implementation.
+
+  If the override is intentional, we provide a new config option called `rpcMethodOverrides` to silence this warning.
+  In the future, the warning will become an error message if the RPC is not explicitly marked as an override.
+
+## 7.71.2
+
+### Patch Changes
+
+- Provide new import alias `#storefront/composables` to allow for explicit imports of composables provided by the `@scayle/storefront-nuxt` package instead of only relying on the Nuxt auto-import functionality
+
 ## 7.71.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, M as ModuleOptions, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.b9f5584c.mjs';
+export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, M as ModuleOptions, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.20d8641a.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 { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, M as ModuleOptions, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.b9f5584c.js';
+export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, M as ModuleOptions, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.20d8641a.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 ModuleOptions } from './shared/storefront-nuxt.b9f5584c.mjs';
-export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.b9f5584c.mjs';
+import { M as ModuleOptions } from './shared/storefront-nuxt.20d8641a.mjs';
+export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.20d8641a.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 ModuleOptions } from './shared/storefront-nuxt.b9f5584c.js';
-export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.b9f5584c.js';
+import { M as ModuleOptions } from './shared/storefront-nuxt.20d8641a.js';
+export { f as AdditionalShopConfig, A as AppKeys, B as BapiConfig, b as CacheConfig, j as CheckoutEvent, C as CheckoutShopConfig, k as ModulePublicRuntimeConfig, O as OauthConfig, P as PublicShopConfig, e as RedirectsConfig, R as RedisConfig, a as SessionConfig, g as ShopConfig, h as ShopConfigIndexed, d as StorageConfig, c as StorageEntity, S as StorageProvider, i as StorefrontConfig } from './shared/storefront-nuxt.20d8641a.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.71.0",
+  "version": "7.71.2",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -4,6 +4,7 @@ import { rpcMethods } from '@scayle/storefront-core';
 import { defu } from 'defu';
 import { genImport, genSafeVariableName } from 'knitwork';
 import { builtinDrivers } from 'unstorage';
+import { createConsola } from 'consola';
 import 'h3';
 
 const convertShopsToList = (stores) => {
@@ -60,7 +61,17 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "7.71.0";
+const PACKAGE_VERSION = "7.71.2";
+const logger = createConsola({
+  fancy: true,
+  formatOptions: {
+    colors: true
+  },
+  level: 1,
+  defaults: {
+    tag: PACKAGE_NAME
+  }
+});
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,
@@ -133,10 +144,30 @@ const module = defineNuxtModule({
       handler: resolve("./runtime/server/middleware/bootstrap")
     });
     const apiBasePath = nuxt.options.runtimeConfig.storefront.apiBasePath || "/api";
-    const rpcMethodNames = /* @__PURE__ */ new Set([
-      ...Object.keys(rpcMethods),
-      ...options.rpcMethodNames ?? []
-    ]);
+    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(", ")}
+`);
+    }
     function addRPCServerHandlers(base) {
       rpcMethodNames.forEach((methodName) => {
         addServerHandler({
@@ -201,6 +232,7 @@ const module = defineNuxtModule({
       resolve("./runtime/nitro/plugins/nitroRuntimeStorageConfig")
     );
     addServerPlugin(resolve("./runtime/nitro/plugins/nitroSetXPoweredByHeader"));
+    addServerPlugin(resolve("./runtime/nitro/plugins/configValidation"));
     nuxt.hooks.hook("nitro:config", (nitroConfig) => {
       nitroConfig.externals = nitroConfig.externals || {};
       nitroConfig.externals.inline = nitroConfig.externals.inline || [];
@@ -218,9 +250,11 @@ const module = defineNuxtModule({
         "server/middleware/redirects",
         "server/middleware/cache",
         "server/utils/cacheStorage",
+        "utils/zodSchema",
         "nitro/plugins/nitroLogger",
         "nitro/plugins/nitroRuntimeStorageConfig",
-        "nitro/plugins/nitroSetXPoweredByHeader"
+        "nitro/plugins/nitroSetXPoweredByHeader",
+        "nitro/plugins/configValidation"
       ];
       runtimePaths.forEach((path) => {
         const file = resolve(`./runtime/${path}`);
@@ -256,6 +290,9 @@ const module = defineNuxtModule({
     nuxt.options.alias["#rpcMethods"] = appResolve(
       options.rpcDir ?? "./rpcMethods"
     );
+    nuxt.options.alias["#storefront/composables"] = resolve(
+      "./runtime/composables"
+    );
     addPlugin(resolve("./runtime/plugin/shop"));
     addPlugin({
       src: resolve("./runtime/plugin/log.client"),

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.b9f5584c.mjs';
+import { P as PublicShopConfig } from './shared/storefront-nuxt.20d8641a.mjs';
 import '@nuxt/schema';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';

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.b9f5584c.js';
+import { P as PublicShopConfig } from './shared/storefront-nuxt.20d8641a.js';
 import '@nuxt/schema';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';

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

@@ -0,0 +1,35 @@
+export * from './core/useAvailableShops';
+export * from './core/useCurrentShop';
+export * from './core/useFormatHelpers';
+export * from './core/useIDP';
+export * from './core/useLog';
+export * from './core/useRpc';
+export * from './core/useSession';
+export * from './core/useUser';
+export * from './storefront/useBasket';
+export * from './storefront/useBrand';
+export * from './storefront/useBrands';
+export * from './storefront/useCategories';
+export * from './storefront/useCategoryById';
+export * from './storefront/useCategoryByPath';
+export * from './storefront/useCurrentPromotions';
+export * from './storefront/useFacet';
+export * from './storefront/useFilters';
+export * from './storefront/useNavigationTree';
+export * from './storefront/useNavigationTrees';
+export * from './storefront/useOrder';
+export * from './storefront/useOrderConfirmation';
+export * from './storefront/useProduct';
+export * from './storefront/useProducts';
+export * from './storefront/useProductsByIds';
+export * from './storefront/useProductsByReferenceKeys';
+export * from './storefront/useProductsCount';
+export * from './storefront/usePromotions';
+export * from './storefront/usePromotionsByIds';
+export * from './storefront/useQueryFilterState';
+export * from './storefront/useSearch';
+export * from './storefront/useShopConfiguration';
+export * from './storefront/useStorefrontSearch';
+export * from './storefront/useUserAddresses';
+export * from './storefront/useVariant';
+export * from './storefront/useWishlist';

package/dist/runtime/composables/index.mjs

@@ -0,0 +1,35 @@
+export * from "./core/useAvailableShops.mjs";
+export * from "./core/useCurrentShop.mjs";
+export * from "./core/useFormatHelpers.mjs";
+export * from "./core/useIDP.mjs";
+export * from "./core/useLog.mjs";
+export * from "./core/useRpc.mjs";
+export * from "./core/useSession.mjs";
+export * from "./core/useUser.mjs";
+export * from "./storefront/useBasket.mjs";
+export * from "./storefront/useBrand.mjs";
+export * from "./storefront/useBrands.mjs";
+export * from "./storefront/useCategories.mjs";
+export * from "./storefront/useCategoryById.mjs";
+export * from "./storefront/useCategoryByPath.mjs";
+export * from "./storefront/useCurrentPromotions.mjs";
+export * from "./storefront/useFacet.mjs";
+export * from "./storefront/useFilters.mjs";
+export * from "./storefront/useNavigationTree.mjs";
+export * from "./storefront/useNavigationTrees.mjs";
+export * from "./storefront/useOrder.mjs";
+export * from "./storefront/useOrderConfirmation.mjs";
+export * from "./storefront/useProduct.mjs";
+export * from "./storefront/useProducts.mjs";
+export * from "./storefront/useProductsByIds.mjs";
+export * from "./storefront/useProductsByReferenceKeys.mjs";
+export * from "./storefront/useProductsCount.mjs";
+export * from "./storefront/usePromotions.mjs";
+export * from "./storefront/usePromotionsByIds.mjs";
+export * from "./storefront/useQueryFilterState.mjs";
+export * from "./storefront/useSearch.mjs";
+export * from "./storefront/useShopConfiguration.mjs";
+export * from "./storefront/useStorefrontSearch.mjs";
+export * from "./storefront/useUserAddresses.mjs";
+export * from "./storefront/useVariant.mjs";
+export * from "./storefront/useWishlist.mjs";

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

@@ -17,7 +17,7 @@ export declare function useFacet({ key, params, }?: Options): Promise<{
     filters: import("vue").ComputedRef<import("@scayle/storefront-api").FiltersEndpointResponseData | undefined>;
     filtersFetching: import("vue").Ref<boolean>;
     unfilteredCount: import("vue").ComputedRef<number | undefined>;
-    filterStatus: import("vue").Ref<import("../core/useRpc").Status>;
+    filterStatus: import("vue").Ref<import("..").Status>;
     filterError: import("vue").Ref<import("nuxt/app").NuxtError<unknown> | undefined>;
     productCountData: import("vue").Ref<{
         count: number;
@@ -25,7 +25,7 @@ export declare function useFacet({ key, params, }?: Options): Promise<{
     refreshProductCount: ({ where, }?: FilterParams) => Promise<void>;
     productCountFetching: import("vue").Ref<boolean>;
     productCountError: import("vue").Ref<import("nuxt/app").NuxtError<unknown> | undefined>;
-    productCountStatus: import("vue").Ref<import("../core/useRpc").Status>;
+    productCountStatus: import("vue").Ref<import("..").Status>;
     products: import("vue").ComputedRef<import("@scayle/storefront-api").Product[] | undefined>;
     pagination: import("vue").ComputedRef<{
         current: number;
@@ -40,12 +40,12 @@ export declare function useFacet({ key, params, }?: Options): Promise<{
     productsFetching: import("vue").Ref<boolean>;
     filterProducts: ({ where, page, sort, orFiltersOperator, }: FilterParams) => Promise<void>;
     productError: import("vue").Ref<import("nuxt/app").NuxtError<unknown> | undefined>;
-    productStatus: import("vue").Ref<import("../core/useRpc").Status>;
+    productStatus: import("vue").Ref<import("..").Status>;
     categories: import("vue").ComputedRef<import("@scayle/storefront-api").Category | import("@scayle/storefront-api").Category[] | undefined>;
     selectedCategory: import("vue").ComputedRef<import("@scayle/storefront-api").Category | undefined>;
     categoriesFetching: import("vue").Ref<boolean>;
     categoriesError: import("vue").Ref<import("nuxt/app").NuxtError<unknown> | undefined>;
-    categoriesStatus: import("vue").Ref<import("../core/useRpc").Status>;
+    categoriesStatus: import("vue").Ref<import("..").Status>;
     fetchProducts: ({ path, page, perPage, where, sort, pricePromotionKey, cache, orFiltersOperator, }: FilterParams & {
         path: string;
         pricePromotionKey?: string | undefined;

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

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

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

@@ -0,0 +1,17 @@
+import { defineNitroPlugin, useRuntimeConfig } from "#imports";
+import { runtimeConfigSchema } from "../../utils/zodSchema.mjs";
+export default defineNitroPlugin(() => {
+  const runtimeConfig = useRuntimeConfig();
+  const { success, error } = runtimeConfigSchema.safeParse(runtimeConfig);
+  if (!success) {
+    error.errors.forEach((e) => {
+      console.error("[storefront-nuxt] configValidation:", {
+        code: e.code,
+        path: e.path.join("."),
+        message: e.message
+      });
+    });
+    throw Error("[storefront-nuxt] configValidation: Runtime config invalid");
+  }
+  console.log("[storefront-nuxt] configValidation: Runtime config valid");
+});