@scayle/storefront-nuxt 7.62.4 → 7.64.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @scayle/storefront-nuxt
 
+## 7.64.0
+
+### Minor Changes
+
+- Add `useStorefrontSearch` composable
+
+## 7.63.0
+
+### Minor Changes
+
+- Add support for dynamically adding query parameters to the IDP redirect callback URLs to be read back when the user returns from the IDP.
+
+  ```ts
+  const { data: externalIDPRedirects } = await useIDP({
+    queryParams: { redirectTo: '/account' },
+  })
+  ```
+
+  Please note that `code` and `state` are not supported as these are used by the SCAYLE Authentication API.
+
+### Patch Changes
+
+- Avoid querying for redirects on pages matching the `/__nuxt_error` pattern.
+- Updated dependencies
+  - @scayle/storefront-core@7.48.0
+
 ## 7.62.4
 
 ### Patch Changes
@@ -650,8 +676,8 @@ There is an `unwrap` function exported by this package (>=7.55.0) that can be us
 
 ### Minor Changes
 
-- - Add promotion data to the `addItemToBasket` method
-- - Add `usePromotions`, `useCurrentPromotions` & `usePromotionsByIds` composables
+- Add promotion data to the `addItemToBasket` method
+- Add `usePromotions`, `useCurrentPromotions` & `usePromotionsByIds` composables
 
 ### Patch Changes
 
@@ -1150,8 +1176,8 @@ There is an `unwrap` function exported by this package (>=7.55.0) that can be us
 
 ### Minor Changes
 
-- - Add possibility to define the session config on application and store level.
-  - Add possibility to configure the `domain` attribute of the session cookie
+- Add possibility to define the session config on application and store level.
+- Add possibility to configure the `domain` attribute of the session cookie
 
 ## 7.0.0
 

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.9.0"
   },
-  "version": "7.62.3"
+  "version": "7.63.0"
 }

package/dist/runtime/api/rpcHandler.d.ts

@@ -1,4 +1,4 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<boolean | string[] | import("@scayle/storefront-core").ShopUser | import("@scayle/storefront-core").Product | import("@scayle/storefront-core").BasketResponseData<import("@scayle/storefront-core").Product, import("@scayle/storefront-core").Variant> | {
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<boolean | void | string[] | import("@scayle/storefront-core").ShopUser | import("@scayle/storefront-core").Product | import("@scayle/storefront-core").BasketResponseData<import("@scayle/storefront-core").Product, import("@scayle/storefront-core").Variant> | {
     type: "failure";
     statusCode: number;
     basket: import("@scayle/storefront-core").BasketResponseData<import("@scayle/storefront-core").Product, import("@scayle/storefront-core").Variant>;
@@ -37,5 +37,5 @@ declare const _default: import("h3").EventHandler<import("h3").EventHandlerReque
     [k: string]: string;
 } | {
     message: string;
-} | null | undefined>>;
+} | null>>;
 export default _default;

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

@@ -1,4 +1,6 @@
-export declare const useIDP: () => Promise<{
+import { type MaybeRefOrGetter } from 'vue';
+import type { RpcMethodParameters } from '@scayle/storefront-core';
+export declare const useIDP: (params?: MaybeRefOrGetter<RpcMethodParameters<'getExternalIdpRedirect'>>) => Promise<{
     data: import("vue").Ref<{
         [k: string]: string;
     } | undefined>;

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

@@ -3,12 +3,13 @@ import { useRpc } from "../core/useRpc.mjs";
 import { rpcCall } from "./../../rpc/rpcCall.mjs";
 import { useCurrentShop } from "./useCurrentShop.mjs";
 import { toValue } from "#imports";
-export const useIDP = async () => {
+export const useIDP = async (params = {}) => {
   const nuxtApp = useNuxtApp();
   const shop = useCurrentShop();
   const { data, fetching, fetch, error, status } = await useRpc(
     "getExternalIdpRedirect",
-    "getExternalIdpRedirect"
+    `getExternalIdpRedirect-${JSON.stringify(toValue(params))}`,
+    params
   );
   const handleIDPLoginCallback = rpcCall(
     nuxtApp,

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

@@ -18,7 +18,7 @@ export declare function useBasket({ params, key, }?: UseBasketOptions): Promise<
     count: import("vue").ComputedRef<number | undefined>;
     countWithoutSoldOutItems: import("vue").ComputedRef<number | undefined>;
     addItem: ({ variantId, promotionId, quantity, existingItemHandling, displayData, customData, itemGroup, }: AddOrUpdateItemType & {
-        existingItemHandling?: 0 | 1 | 2 | 3 | undefined;
+        existingItemHandling?: ExistingItemHandling;
     }) => Promise<void>;
     addItems: (items: AddOrUpdateItemType[], existingItemHandling?: 1) => Promise<void>;
     removeItem: (item: {

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

@@ -1,12 +1,13 @@
-import { type SearchInput, type SearchOptions } from '@scayle/storefront-core';
+import { type SearchInput, type SearchOptions, type TypeaheadSuggestionsEndpointResponseData } from '@scayle/storefront-core';
 type Options = Partial<{
     params: SearchOptions;
     key: string;
 }>;
+/** @deprecated `useSearch` is deprecated. Please, use `useSearchSuggestions` or `useSearchResolve` */
 export declare const useSearch: ({ params, key }?: Options) => {
-    data: any;
-    pending: any;
-    searchQuery: any;
+    data: import("vue").Ref<TypeaheadSuggestionsEndpointResponseData | undefined>;
+    pending: import("vue").Ref<boolean>;
+    searchQuery: import("vue").Ref<string>;
     resetSearch: () => void;
     search: ({ term, slug, productLimit }: SearchInput) => Promise<void>;
 };

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

@@ -1,6 +1,7 @@
+import { useState } from "nuxt/app";
 import { rpcCall } from "../../rpc/rpcCall.mjs";
 import { useCurrentShop } from "../core/useCurrentShop.mjs";
-import { useState, useNuxtApp, toValue } from "#imports";
+import { useNuxtApp, toValue } from "#imports";
 export const useSearch = ({ params, key = "search" } = {}) => {
   const data = useState(
     `${key}-data`,

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

@@ -0,0 +1,15 @@
+import { type SearchV2SuggestionsEndpointResponseData, type SearchV2With } from '@scayle/storefront-core';
+export type SearchOptions = Partial<{
+    params: Partial<{
+        categoryId: number;
+        with: SearchV2With;
+    }>;
+    key: string;
+}>;
+export declare const useStorefrontSearch: (searchQuery: Ref<string>, { params, key }?: SearchOptions) => {
+    data: import("vue").Ref<SearchV2SuggestionsEndpointResponseData | undefined>;
+    pending: import("vue").Ref<boolean>;
+    resetSearch: () => void;
+    getSearchSuggestions: () => Promise<void>;
+    resolveSearch: () => Promise<import("@scayle/storefront-core").SearchEntity | null | undefined>;
+};

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

@@ -0,0 +1,64 @@
+import { useState } from "nuxt/app";
+import { rpcCall } from "../../rpc/rpcCall.mjs";
+import { useCurrentShop } from "../core/useCurrentShop.mjs";
+import { useNuxtApp, toValue } from "#imports";
+export const useStorefrontSearch = (searchQuery, { params, key = "search" } = {}) => {
+  const data = useState(
+    `${key}-data`,
+    () => void 0
+  );
+  const nuxtApp = useNuxtApp();
+  const pending = useState(`${key}-pending`, () => false);
+  const error = useState(
+    `${key}-error`,
+    () => void 0
+  );
+  const status = useState(`${key}-error`, () => "idle");
+  const shop = useCurrentShop();
+  const getSearchSuggestions = async () => {
+    pending.value = true;
+    status.value = "pending";
+    if (!searchQuery.value) {
+      return;
+    }
+    try {
+      data.value = await rpcCall(
+        nuxtApp,
+        "getSearchSuggestions",
+        toValue(shop)
+      )({
+        term: String(searchQuery.value),
+        ...params
+      });
+    } catch (e) {
+      error.value = e;
+    } finally {
+      pending.value = false;
+      status.value = error.value ? "error" : "success";
+    }
+  };
+  const resolveSearch = async () => {
+    if (!searchQuery.value) {
+      return;
+    }
+    return await rpcCall(
+      nuxtApp,
+      "resolveSearch",
+      toValue(shop)
+    )({
+      term: searchQuery.value,
+      ...params
+    });
+  };
+  const resetSearch = () => {
+    searchQuery.value = "";
+    data.value = { suggestions: [] };
+  };
+  return {
+    data,
+    pending,
+    resetSearch,
+    getSearchSuggestions,
+    resolveSearch
+  };
+};

package/dist/runtime/server/middleware/bootstrap.mjs

@@ -105,14 +105,12 @@ async function bootstrap(event, $shopConfig, $storefrontConfig, apiBasePath, con
 }
 function getBootstrapPath(event) {
   const url = getRequestURL(event);
-  if (url.pathname === "/__nuxt_error") {
-    return url.searchParams.get("url") ?? url.pathname;
-  }
-  return url.pathname;
+  const path = url.pathname === "/__nuxt_error" ? url.searchParams.get("url") ?? url.pathname : url.pathname;
+  return { path, originalPath: url.pathname };
 }
 export default defineEventHandler(async (event) => {
   try {
-    const path = getBootstrapPath(event);
+    const { path, originalPath } = getBootstrapPath(event);
     if (path.startsWith("/__nuxt")) {
       return;
     }
@@ -133,7 +131,7 @@ export default defineEventHandler(async (event) => {
         config
       );
     }
-    if ($storefrontConfig.redirects?.enabled && !path.startsWith(apiBasePath)) {
+    if ($storefrontConfig.redirects?.enabled && !path.startsWith(apiBasePath) && originalPath !== "/__nuxt_error") {
       await useRedirects(event);
     }
   } catch (e) {

package/dist/runtime/server/middleware/redirects.mjs

@@ -18,7 +18,9 @@ async function fetchRedirectWithCache(sourceUrl, bapiClient, redirectCache, log)
   try {
     bapiResult = await bapiClient.redirects.post(sourceUrl);
   } catch (error) {
-    log.error(`Error: Failed to fetch redirects ... ${error}`);
+    log.error(
+      `Error: Failed to fetch redirects ... ${error} for sourceURL: ${sourceUrl}`
+    );
     return null;
   }
   const isValidRedirect = (redirect) => {
@@ -67,17 +69,17 @@ export async function useRedirects(event) {
     log.info(`There are multiple valid redirects for: ${url.toString()}`);
   }
   const redirect = relativeRedirect ?? absoluteRedirect;
+  if (!redirect) {
+    log.debug(`There are no valid redirects for: ${url.toString()}`);
+    return;
+  }
   try {
-    if (redirect?.target) {
-      log.debug(`Redirecting to ${redirect.target}`);
-      await sendRedirect(
-        event,
-        getTargetLocation(url, redirect.target, queryParamWhitelist),
-        redirect.statusCode
-      );
-    } else {
-      log.debug(`No redirect found`);
-    }
+    log.debug(`Redirecting to ${redirect.target}`);
+    await sendRedirect(
+      event,
+      getTargetLocation(url, redirect.target, queryParamWhitelist),
+      redirect.statusCode
+    );
   } catch (error) {
     log.error(`Error: Failed to execute redirect ... ${error}`);
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.62.4",
+  "version": "7.64.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -62,7 +62,7 @@
   "dependencies": {
     "@nuxt/kit": "3.11.1",
     "@scayle/h3-session": "0.3.5",
-    "@scayle/storefront-core": "7.47.0",
+    "@scayle/storefront-core": "7.48.0",
     "@scayle/unstorage-compression-driver": "0.1.2",
     "@vueuse/core": "10.9.0",
     "consola": "3.2.3",
@@ -85,7 +85,7 @@
     "@scayle/eslint-config-storefront": "3.2.6",
     "@scayle/eslint-plugin-vue-composable": "0.1.1",
     "@scayle/prettier-config-storefront": "2.0.2",
-    "@types/node": "20.12.3",
+    "@types/node": "20.12.5",
     "eslint": "8.57.0",
     "eslint-formatter-gitlab": "5.1.0",
     "h3": "1.11.1",
@@ -94,7 +94,7 @@
     "prettier": "3.0.0",
     "publint": "0.2.7",
     "vitest": "1.4.0",
-    "vue-tsc": "2.0.7"
+    "vue-tsc": "2.0.11"
   },
   "peerDependencies": {
     "h3": "^1.10.0",
@@ -109,6 +109,6 @@
     "@nuxt/schema": "3.11.1"
   },
   "volta": {
-    "node": "20.12.0"
+    "node": "20.12.1"
   }
 }