@scayle/storefront-nuxt 8.53.1 → 8.53.2

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @scayle/storefront-nuxt
 
+## 8.53.2
+
+### Patch Changes
+
+- Introduced the `rpcDefaultLazy` configuration flag to streamline data fetching. When enabled via the `NUXT_PUBLIC_STOREFRONT_RPC_DEFAULT_LAZY` environment variable or by setting `rpcDefaultLazy` in your `nuxt.config.ts`, `useRpc` and derived composables like `useProducts` or `useBasket` will behave lazily by default. This eliminates the need to repeatedly pass `{ lazy: true }` in your component logic.
+
+  **Examples:**
+
+  ```ts
+  // Before (or when `rpcDefaultLazy: false`)
+  // You had to explicitly opt-in to lazy behavior
+  const { data } = useRpc('someMethod', { some: 'param' }, { lazy: true })
+
+  // After (when `rpcDefaultLazy: true`)
+  // Lazy behavior is now the default
+  const { data } = useRpc('someMethod', { some: 'param' })
+  ```
+
+**Dependencies**
+
+**@scayle/storefront-core v8.53.2**
+
+- No changes in this release.
+
 ## 8.53.1
 
 ### Patch Changes

package/dist/module.json

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

package/dist/module.mjs

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

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

@@ -1,6 +1,6 @@
 import type { RpcContext, RpcMethodName, RpcMethodParameters, RpcMethodReturnType } from '@scayle/storefront-core';
 import { useAsyncData } from 'nuxt/app';
-import type { AsyncDataOptions } from 'nuxt/app';
+import type { AsyncDataOptions, NuxtApp } from 'nuxt/app';
 import type { MaybeRefOrGetter } from 'vue';
 /**
  * Extracts keys from a type `T` as an array of strings.
@@ -47,6 +47,7 @@ type AwaitedAsyncData<ResT, ErrorT = unknown, DataT = ResT, PickKeys extends Key
  * @template DefaultT The default value type. Defaults to `null`.
  */
 export type ExtendedAsyncData<ResT, ErrorT = unknown, DataT = ResT, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null> = AwaitedAsyncData<ResT, ErrorT, DataT, PickKeys, DefaultT> & Promise<AwaitedAsyncData<ResT, ErrorT, DataT, PickKeys, DefaultT>>;
+export declare const defaultCachedData: <ResponseT>(key: string, nuxtApp: NuxtApp) => ResponseT | undefined;
 /**
  * `useRpc` is a wrapper around `useAsyncData` for registered RPC methods.
  *

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

@@ -1,9 +1,8 @@
 import { unwrap } from "@scayle/storefront-core";
-import { useNuxtApp, useAsyncData } from "nuxt/app";
+import { useAsyncData, useRuntimeConfig, useNuxtApp } from "nuxt/app";
 import { useCoreLog } from "../useCoreLog.js";
 import { useCurrentShop } from "./useCurrentShop.js";
 import { toValue, isRef } from "vue";
-import { useRuntimeConfig } from "#app/nuxt";
 function getFetch(nuxtApp, log) {
   const fetch = nuxtApp.ssrContext?.event.context.$fetchWithContext ?? $fetch;
   if (nuxtApp.ssrContext?.event && !nuxtApp.ssrContext?.event.context.$fetchWithContext) {
@@ -11,6 +10,10 @@ function getFetch(nuxtApp, log) {
   }
   return fetch;
 }
+export const defaultCachedData = (key, nuxtApp) => {
+  const hydrationData = nuxtApp.isHydrating ? nuxtApp.payload.data[key] : nuxtApp.static.data[key];
+  return hydrationData ?? nuxtApp._asyncData[key]?.data.value;
+};
 export function useRpc(method, key, params, options) {
   const currentShop = useCurrentShop();
   const log = useCoreLog("rpc");
@@ -18,6 +21,8 @@ export function useRpc(method, key, params, options) {
   const {
     public: { storefront }
   } = useRuntimeConfig();
+  options ??= {};
+  options.lazy ??= storefront.rpcDefaultLazy;
   const asyncData = useAsyncData(
     key,
     async () => {
@@ -40,10 +45,7 @@ export function useRpc(method, key, params, options) {
     {
       // Both refs and getter functions are valid watch sources
       ...isRef(params) || typeof params === "function" ? { watch: [params] } : {},
-      getCachedData: storefront.legacy?.enableDefaultGetCachedDataOverride ? (key2, nuxtApp2) => {
-        const hydrationData = nuxtApp2.isHydrating ? nuxtApp2.payload.data[key2] : nuxtApp2.static.data[key2];
-        return hydrationData ?? nuxtApp2._asyncData[key2]?.data.value;
-      } : void 0,
+      getCachedData: storefront.legacy?.enableDefaultGetCachedDataOverride ? defaultCachedData : void 0,
       ...options
     }
   );

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

@@ -3,7 +3,7 @@ export * from './core/useCurrentShop.js';
 export * from './core/useFormatHelpers.js';
 export * from './core/useIDP.js';
 export * from './core/useLog.js';
-export * from './core/useRpc.js';
+export { useRpc, type KeysOf, type NormalizedRpcResponse, type UseRpcOptions, type UseRpcReturn, type Status, type ExtendedAsyncData, } from './core/useRpc.js';
 export * from './core/useRpcCall.js';
 export * from './core/useSession.js';
 export * from './core/useUser.js';

package/dist/runtime/composables/index.js

@@ -3,7 +3,9 @@ export * from "./core/useCurrentShop.js";
 export * from "./core/useFormatHelpers.js";
 export * from "./core/useIDP.js";
 export * from "./core/useLog.js";
-export * from "./core/useRpc.js";
+export {
+  useRpc
+} from "./core/useRpc.js";
 export * from "./core/useRpcCall.js";
 export * from "./core/useSession.js";
 export * from "./core/useUser.js";

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

@@ -879,6 +879,13 @@ declare const StorefrontPublicRuntimeConfigSchema: z.ZodMiniObject<{
     legacy: z.ZodMiniOptional<z.ZodMiniObject<{
         enableDefaultGetCachedDataOverride: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
     }, z.core.$strip>>;
+    /**
+     * Controls the default lazy loading behavior for useRpc.
+     * If set to true,the useRpc composable will not block during data fetching.
+     *
+     * @default false
+     */
+    rpcDefaultLazy: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
 }, z.core.$strip>;
 export declare const RuntimeConfigSchema: z.ZodMiniObject<{
     storefront: z.ZodMiniObject<{
@@ -1395,6 +1402,13 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
             legacy: z.ZodMiniOptional<z.ZodMiniObject<{
                 enableDefaultGetCachedDataOverride: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
             }, z.core.$strip>>;
+            /**
+             * Controls the default lazy loading behavior for useRpc.
+             * If set to true,the useRpc composable will not block during data fetching.
+             *
+             * @default false
+             */
+            rpcDefaultLazy: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
         }, z.core.$strip>;
     }, z.core.$strip>;
 }, z.core.$strip>;

package/dist/runtime/utils/zodSchema.js

@@ -190,7 +190,14 @@ const StorefrontPublicRuntimeConfigSchema = z.object({
   /** Collection of feature flags regarding legacy features and functionalities */
   legacy: z.optional(z.object({
     enableDefaultGetCachedDataOverride: z.optional(z.boolean())
-  }))
+  })),
+  /**
+   * Controls the default lazy loading behavior for useRpc.
+   * If set to true,the useRpc composable will not block during data fetching.
+   *
+   * @default false
+   */
+  rpcDefaultLazy: z.optional(z.boolean())
 });
 export const RuntimeConfigSchema = z.object({
   storefront: StorefrontRuntimeConfigSchema,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.53.1",
+  "version": "8.53.2",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -90,7 +90,7 @@
     "utility-types": "^3.11.0",
     "vue-router": "^4.4.0",
     "zod": "^4.0.0",
-    "@scayle/storefront-core": "8.53.1",
+    "@scayle/storefront-core": "8.53.2",
     "@scayle/unstorage-compression-driver": "1.2.4"
   },
   "devDependencies": {
@@ -117,11 +117,11 @@
     "typescript": "5.9.3",
     "unbuild": "3.6.1",
     "vitest": "4.0.13",
-    "vue-tsc": "3.1.4",
+    "vue-tsc": "3.1.5",
     "happy-dom": "20.0.10",
+    "@scayle/eslint-config-storefront": "4.7.14",
     "@scayle/eslint-plugin-vue-composable": "0.2.2",
     "@scayle/vitest-config-storefront": "1.0.0",
-    "@scayle/eslint-config-storefront": "4.7.14",
     "@scayle/unstorage-scayle-kv-driver": "2.0.9"
   },
   "volta": {