@scayle/storefront-nuxt 7.63.0 → 7.64.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scayle/storefront-nuxt
 
+## 7.64.0
+
+### Minor Changes
+
+- Add `useStorefrontSearch` composable
+
 ## 7.63.0
 
 ### Minor Changes

package/dist/module.json

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

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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.63.0",
+  "version": "7.64.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -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",