@scayle/storefront-nuxt 7.75.0 → 7.75.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @scayle/storefront-nuxt
 
+## 7.75.1
+
+### Patch Changes
+
+- Add `immediate` option to `useUser` and deprecate `autoFetch`
+- Log warning when deprecated `autoFetch` option is used
+
 ## 7.75.0
 
 ### Minor Changes

package/dist/module.json

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

package/dist/module.mjs

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

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

@@ -15,8 +15,13 @@ export function useRpc(method, key, params, options) {
   const currentShop = useCurrentShop();
   const log = useCoreLog("rpc");
   const nuxtApp = useNuxtApp();
-  if (options && options.autoFetch !== void 0 && options.immediate === void 0) {
-    options.immediate = options.autoFetch;
+  if (options && options.autoFetch !== void 0) {
+    log.warn("autoFetch is disabled; use immediate instead");
+    if (options.immediate === void 0) {
+      options.immediate = options.autoFetch;
+    } else {
+      log.warn("autoFetch will be ignored because immediate was specified");
+    }
   }
   const asyncData = useAsyncData(
     key,

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

@@ -1,8 +1,12 @@
-import type { ShopUser, UpdatePasswordParams, UseUserParams } from '@scayle/storefront-core';
-export type ExtendedUseUserParams = UseUserParams & {
+import type { ShopUser, UpdatePasswordParams } from '@scayle/storefront-core';
+export type ExtendedUseUserParams = {
+    key?: string;
+    /** @deprecated use immediate instead */
+    autoFetch?: boolean;
+    immediate?: boolean;
     lazy?: boolean;
 };
-export declare function useUser({ autoFetch, lazy, key, }?: ExtendedUseUserParams): {
+export declare function useUser(options?: ExtendedUseUserParams): {
     user: import("vue").ComputedRef<ShopUser | undefined>;
     isLoggedIn: import("vue").ComputedRef<boolean>;
     customerType: import("vue").ComputedRef<"guest" | "new" | "existing">;

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

@@ -6,20 +6,29 @@ import { extendPromise } from "../../utils/promise.mjs";
 import { useRpc } from "./useRpc.mjs";
 import { useCurrentShop } from "./useCurrentShop.mjs";
 import { toValue } from "#imports";
-export function useUser({
-  autoFetch = true,
-  lazy = false,
-  key = "useUser"
-} = {}) {
+export function useUser(options = {}) {
   const nuxtApp = useNuxtApp();
   const shop = useCurrentShop();
   const log = useCoreLog("useUser");
+  if (options && options.autoFetch !== void 0) {
+    log.warn("autoFetch is disabled; use immediate instead");
+    if (options.immediate === void 0) {
+      options.immediate = options.autoFetch;
+    } else {
+      log.warn("autoFetch will be ignored because immediate was specified");
+    }
+  }
+  const {
+    immediate = true,
+    lazy = false,
+    key = "useUser"
+  } = options;
   const asyncDataPromise = useRpc(
     "getUser",
     key,
     void 0,
     {
-      autoFetch,
+      immediate,
       lazy,
       server: false,
       dedupe: "defer",

package/dist/runtime/composables/storefront/useFacet.mjs

@@ -38,7 +38,7 @@ export function useFacet({
       path: currentPath.value,
       includeHidden: params.with?.product?.categories?.includeHidden || void 0
     }),
-    options: { autoFetch: false },
+    options: { immediate: false },
     key: `${key}-categories`
   });
   const productsPromise = useProducts({
@@ -55,7 +55,7 @@ export function useFacet({
       cache: currentCacheParams.value,
       orFiltersOperator: currentOrFiltersOperator.value
     }),
-    options: { autoFetch: false },
+    options: { immediate: false },
     key: `${key}-products`
   });
   const productsCountPromise = useProductsCount({
@@ -67,7 +67,7 @@ export function useFacet({
       where: productCountWhere.value,
       orFiltersOperator: currentOrFiltersOperator.value
     }),
-    options: { autoFetch: false },
+    options: { immediate: false },
     key: `${key}-productCount`
   });
   const filtersPromise = useFilters({
@@ -79,7 +79,7 @@ export function useFacet({
       where: currentWhereCondition.value,
       orFiltersOperator: currentOrFiltersOperator.value
     }),
-    options: { autoFetch: false },
+    options: { immediate: false },
     key: `${key}-filters`
   });
   const {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.75.0",
+  "version": "7.75.1",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",