@scayle/storefront-core 7.46.1 → 7.47.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scayle/storefront-core
 
+## 7.47.0
+
+### Minor Changes
+
+- Add `resolveSearch` and `getSearchSuggestions` RPC methods
+
 ## 7.46.1
 
 ### Patch Changes

package/dist/constants/withParameters.d.ts

@@ -1,7 +1,4 @@
-import type { BasketWith } from '@aboutyou/backbone/endpoints/basket/getBasket';
-import type { ProductWith } from '@aboutyou/backbone/types/ProductWith';
-import type { WishlistWith } from '@aboutyou/backbone/endpoints/wishlist/getWishlist';
-import { SearchWith } from '../types';
+import type { SearchWith, BasketWith, ProductWith, WishlistWith } from '../types';
 declare const DEFAULT_WITH_LISTING: {
     items: {
         product: {

package/dist/rpc/methods/search.cjs

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.searchProducts = void 0;
+exports.searchProducts = exports.resolveSearch = exports.getSearchSuggestions = void 0;
 var _constants = require("../../constants/index.cjs");
 var _stringHelpers = require("../../helpers/stringHelpers.cjs");
 const searchProducts = exports.searchProducts = async function searchProducts2({
@@ -25,6 +25,39 @@ const searchProducts = exports.searchProducts = async function searchProducts2({
     with: _with ?? withParams?.search ?? _constants.MIN_WITH_PARAMS_SEARCH
   });
 };
+const getSearchSuggestions = exports.getSearchSuggestions = async function getSearchSuggestions2({
+  term,
+  with: _with,
+  categoryId
+}, {
+  bapiClient,
+  withParams
+}) {
+  return await bapiClient.searchv2.suggestions(term, {
+    categoryId,
+    with: _with ?? withParams?.searchV2
+  });
+};
+const resolveSearch = exports.resolveSearch = async function resolveSearch2({
+  term,
+  with: _with,
+  categoryId
+}, {
+  cached,
+  bapiClient,
+  withParams
+}) {
+  const resolvedEntity = await cached(bapiClient.searchv2.resolve, {
+    cacheKeyPrefix: `resolve-${term}`
+  })(term, {
+    categoryId,
+    with: _with ?? withParams?.searchV2
+  });
+  if (!resolvedEntity) {
+    return null;
+  }
+  return resolvedEntity;
+};
 const getCategoryId = async (cached, bapiClient, slug) => {
   if (!slug) {
     return;

package/dist/rpc/methods/search.d.ts

@@ -1,9 +1,13 @@
 import type { TypeaheadSuggestionsEndpointRequestParameters, TypeaheadSuggestionsEndpointResponseData } from '@aboutyou/backbone/endpoints/typeahead/typeahead';
+import type { SearchV2ResolveEndpointParameters, SearchV2SuggestionsEndpointResponseData, SearchV2SuggestionsEndpointParameters } from '../../types/bapi/search';
 type SearchWith = TypeaheadSuggestionsEndpointRequestParameters['with'];
+/** @deprecated `searchProducts` is deprecated. Please, use `getSuggestions` or `resolve` RPC methods */
 export declare const searchProducts: ({ term, slug, with: _with, productLimit }: {
     term: string;
     slug?: string | undefined;
     with?: SearchWith;
     productLimit?: number | undefined;
 }, { cached, bapiClient, withParams }: import("../../types").RpcContext) => Promise<TypeaheadSuggestionsEndpointResponseData>;
+export declare const getSearchSuggestions: ({ term, with: _with, categoryId }: SearchV2SuggestionsEndpointParameters, { bapiClient, withParams }: import("../../types").RpcContext) => Promise<SearchV2SuggestionsEndpointResponseData>;
+export declare const resolveSearch: ({ term, with: _with, categoryId }: SearchV2ResolveEndpointParameters, { cached, bapiClient, withParams }: import("../../types").RpcContext) => Promise<import("@aboutyou/backbone/types/Search").SearchEntity | null>;
 export {};

package/dist/rpc/methods/search.mjs

@@ -10,6 +10,27 @@ export const searchProducts = async function searchProducts2({ term, slug, with:
     with: _with ?? withParams?.search ?? MIN_WITH_PARAMS_SEARCH
   });
 };
+export const getSearchSuggestions = async function getSearchSuggestions2({ term, with: _with, categoryId }, { bapiClient, withParams }) {
+  return await bapiClient.searchv2.suggestions(
+    term,
+    {
+      categoryId,
+      with: _with ?? withParams?.searchV2
+    }
+  );
+};
+export const resolveSearch = async function resolveSearch2({ term, with: _with, categoryId }, { cached, bapiClient, withParams }) {
+  const resolvedEntity = await cached(bapiClient.searchv2.resolve, {
+    cacheKeyPrefix: `resolve-${term}`
+  })(term, {
+    categoryId,
+    with: _with ?? withParams?.searchV2
+  });
+  if (!resolvedEntity) {
+    return null;
+  }
+  return resolvedEntity;
+};
 const getCategoryId = async (cached, bapiClient, slug) => {
   if (!slug) {
     return;

package/dist/types/api/context.d.ts

@@ -2,7 +2,7 @@ import type { BapiClient } from '@aboutyou/backbone';
 import type { Log } from '../../utils';
 import type { CachedType } from '../../cache/cached';
 import type { ShopUser } from '../user';
-import type { WishlistWithOptions, BasketWithOptions, ProductWith, VariantWith, SearchWith, CategoryWith, ProductCategoryWith } from '../';
+import type { WishlistWithOptions, BasketWithOptions, ProductWith, VariantWith, SearchWith, SearchV2With, CategoryWith, ProductCategoryWith } from '../';
 import { OAuthTokens, IDPConfig } from './auth';
 export type WithParams = Partial<{
     basket: BasketWithOptions;
@@ -11,6 +11,7 @@ export type WithParams = Partial<{
     productCategory: ProductCategoryWith;
     category: CategoryWith;
     search: SearchWith;
+    searchV2: SearchV2With;
     variant: VariantWith;
 }>;
 export interface RuntimeConfiguration {

package/dist/types/bapi/search.d.ts

@@ -2,6 +2,10 @@ import type { ProductWith } from '@aboutyou/backbone/types/ProductWith';
 import type { TypeaheadSuggestionsEndpointRequestParameters } from '@aboutyou/backbone/endpoints/typeahead/typeahead';
 import { Query } from '../index';
 export type { BrandOrCategorySuggestion, ProductSuggestion, TypeaheadSuggestion, TypeaheadBrandOrCategorySuggestion, TypeaheadProductSuggestion, TypeaheadSuggestionsEndpointResponseData, } from '@aboutyou/backbone/endpoints/typeahead/typeahead';
+export type { SearchV2With } from '@aboutyou/backbone/endpoints/searchv2/includes';
+export type { SearchV2SuggestionsEndpointResponseData, SearchV2SuggestionsEndpointParameters, } from '@aboutyou/backbone/endpoints/searchv2/suggestions';
+export type { SearchV2ResolveEndpointResponseData, SearchV2ResolveEndpointParameters, } from '@aboutyou/backbone/endpoints/searchv2/resolve';
+export type * from '@aboutyou/backbone/types/Search';
 export type SearchInput = {
     term?: Query;
     slug?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.46.1",
+  "version": "7.47.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -71,7 +71,7 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "3.2.6",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "20.11.30",
+    "@types/node": "20.12.3",
     "@types/webpack-env": "1.18.4",
     "@vitest/coverage-v8": "1.4.0",
     "dprint": "0.45.0",