@lana-commerce/core 12.0.0 → 13.0.0-alpha.2

package/CHANGELOG.md

@@ -7,9 +7,15 @@ This project adheres to [Semantic Versioning][semantic versioning].
 ## [Unreleased]
 
 ### Major Changes
+
+- Autocomplete APIs are removed in favor of "suggest" APIs.
+- Search API pagination no longer supports keyset pagination, offset-based pagination becomes the only option.
+
 ### Minor Changes
 ### Patch Changes
 
+- Update how "productFiltering" converts variant options to API search requests.
+
 ## [Released]
 
 ## 12.0.0 (2024-07-18)

package/cjs/graphql/fragments/ProductSearchResult.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = "fragment ProductSearchResult on StorefrontProductSearchResult{last_key count items{...SearchProduct}options{...ProductSearchOptionAgg}price_max price_min}\n";
+exports.default = "fragment ProductSearchResult on StorefrontProductSearchResult{count items{...SearchProduct}options{...ProductSearchOptionAgg}price_max price_min}\n";

package/cjs/graphql/operations/SearchProductsAdvancedQuery.js

@@ -21,4 +21,4 @@ exports.default = (CommonCartVariant_js_1.default +
     TieredPricing_js_1.default +
     TieredPricingTier_js_1.default +
     VariantOption_js_1.default +
-    "query SearchProductsAdvanced($shopID:String!$data:[SearchOption!]!$lastKey:String!$limit:Int!$sortBy:SearchProductsSortBy!$sortDesc:Boolean!$aggregations:Boolean!){search:storefrontSearchProducts(shop_id:$shopID data:$data last_key:$lastKey limit:$limit sort_by:$sortBy sort_desc:$sortDesc aggregations:$aggregations){...ProductSearchResult}}");
+    "query SearchProductsAdvanced($shopID:String!$data:[SearchOption!]!$offset:Int!$limit:Int!$sortBy:SearchProductsSortBy!$sortDesc:Boolean!$aggregations:Boolean!){search:storefrontSearchProducts(shop_id:$shopID data:$data offset:$offset limit:$limit sort_by:$sortBy sort_desc:$sortDesc aggregations:$aggregations){...ProductSearchResult}}");

package/cjs/modules/advancedSearch.js

@@ -16,7 +16,7 @@ exports.defaultSearchData = {
     options: [],
     priceRange: null,
     count: 0,
-    lastKey: "",
+    nextOffset: 0,
     hasMore: false,
     params: null,
 };
@@ -44,12 +44,12 @@ function createAdvancedSearch(config) {
     const loadProducts = (0, effector_1.createEvent)();
     const loadProductsFx = (0, effector_1.createEffect)((params) => tslib_1.__awaiter(this, void 0, void 0, function* () {
         // reset products iteration?
-        const lastKey = (0, dequal_1.dequal)(params.params, params.currentParams) ? params.lastKey : "";
+        const offset = (0, dequal_1.dequal)(params.params, params.currentParams) ? params.offset : 0;
         const p = params.params;
         const data = (0, hierarchicalSearchOption_js_1.flattenHierarchicalSearchOptions)([...p.baseFilter, ...p.filter]);
         const agg = p.filter.length === 0; // do we need options aggregation?
         return (0, mapResponseData_js_1.mapResponseData)(yield (0, request_js_1.request)(config.graphql.searchProductsQuery)({
-            lastKey,
+            offset,
             data,
             limit: p.limit,
             shopID: p.shopID,
@@ -57,6 +57,7 @@ function createAdvancedSearch(config) {
             sortDesc: p.sortDesc,
             aggregations: agg,
         }, config.opts), (d) => {
+            var _a, _b;
             const options = d.options.sort((a, b) => {
                 return a.name.localeCompare(b.name);
             });
@@ -71,10 +72,10 @@ function createAdvancedSearch(config) {
                 options: agg ? options : "keep",
                 priceRange: agg ? { min: d.price_min, max: d.price_max } : "keep",
                 count: d.count,
-                lastKey: d.last_key,
-                hasMore: lastKey && products.length === 0 ? false : true,
+                nextOffset: offset + ((_b = (_a = d.items) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0),
+                hasMore: offset > 0 && products.length === 0 ? false : true,
                 params: p,
-                mode: lastKey ? "append" : "replace",
+                mode: offset > 0 ? "append" : "replace",
             };
         });
     }));
@@ -88,7 +89,7 @@ function createAdvancedSearch(config) {
         return {
             products,
             count: r.count,
-            lastKey: r.lastKey,
+            nextOffset: r.nextOffset,
             hasMore: r.hasMore && products.length < r.count,
             options: r.options === "keep" ? prevData.options : r.options,
             priceRange: r.priceRange === "keep" ? prevData.priceRange : r.priceRange,
@@ -101,7 +102,7 @@ function createAdvancedSearch(config) {
     const somethingIsPending = (0, combineSome_js_1.combineSome)(loadProductsFx.pending);
     const everythingIdle = somethingIsPending.map((pending) => !pending);
     (0, effector_1.guard)({
-        source: (0, effector_1.sample)((0, effector_1.combine)(configWithJWTAndLocale, data), loadProducts, ([config, data], ev) => (Object.assign({ config, lastKey: data.lastKey, currentParams: data.params }, ev))),
+        source: (0, effector_1.sample)((0, effector_1.combine)(configWithJWTAndLocale, data), loadProducts, ([config, data], ev) => (Object.assign({ config, offset: data.nextOffset, currentParams: data.params }, ev))),
         filter: everythingIdle,
         target: loadProductsFx,
     });
@@ -109,7 +110,7 @@ function createAdvancedSearch(config) {
     (0, effector_1.guard)({
         source: (0, effector_1.sample)((0, effector_1.combine)(configWithJWTAndLocale, data), config.locale, ([config, data]) => ({
             config,
-            lastKey: "",
+            offset: 0,
             currentParams: null,
             params: data.params,
         })),

package/cjs/productFiltering.js

@@ -102,11 +102,8 @@ function makeOptionFilter(optionID) {
             return {
                 kind: "or",
                 opts: vals.map((val) => ({
-                    kind: "and",
-                    opts: [
-                        { kind: "opt", opt: { op: "eq", name: "variants.options.option_id", text: optionID } },
-                        { kind: "opt", opt: { op: "eq", name: "variants.options.option_value_id", text: val } },
-                    ],
+                    kind: "opt",
+                    opt: { op: "eq", name: "variants.options", text: `${optionID}:${val}` },
                 })),
             };
         },

package/esm/graphql/fragments/ProductSearchResult.js

@@ -1 +1 @@
-export default "fragment ProductSearchResult on StorefrontProductSearchResult{last_key count items{...SearchProduct}options{...ProductSearchOptionAgg}price_max price_min}\n";
+export default "fragment ProductSearchResult on StorefrontProductSearchResult{count items{...SearchProduct}options{...ProductSearchOptionAgg}price_max price_min}\n";

package/esm/graphql/operations/SearchProductsAdvancedQuery.js

@@ -18,4 +18,4 @@ export default (CommonCartVariant +
     TieredPricing +
     TieredPricingTier +
     VariantOption +
-    "query SearchProductsAdvanced($shopID:String!$data:[SearchOption!]!$lastKey:String!$limit:Int!$sortBy:SearchProductsSortBy!$sortDesc:Boolean!$aggregations:Boolean!){search:storefrontSearchProducts(shop_id:$shopID data:$data last_key:$lastKey limit:$limit sort_by:$sortBy sort_desc:$sortDesc aggregations:$aggregations){...ProductSearchResult}}");
+    "query SearchProductsAdvanced($shopID:String!$data:[SearchOption!]!$offset:Int!$limit:Int!$sortBy:SearchProductsSortBy!$sortDesc:Boolean!$aggregations:Boolean!){search:storefrontSearchProducts(shop_id:$shopID data:$data offset:$offset limit:$limit sort_by:$sortBy sort_desc:$sortDesc aggregations:$aggregations){...ProductSearchResult}}");

package/esm/modules/advancedSearch.js

@@ -12,7 +12,7 @@ export const defaultSearchData = {
     options: [],
     priceRange: null,
     count: 0,
-    lastKey: "",
+    nextOffset: 0,
     hasMore: false,
     params: null,
 };
@@ -45,12 +45,12 @@ export function createAdvancedSearch(config) {
     const loadProducts = createEvent();
     const loadProductsFx = createEffect(async (params) => {
         // reset products iteration?
-        const lastKey = dequal(params.params, params.currentParams) ? params.lastKey : "";
+        const offset = dequal(params.params, params.currentParams) ? params.offset : 0;
         const p = params.params;
         const data = flattenHierarchicalSearchOptions([...p.baseFilter, ...p.filter]);
         const agg = p.filter.length === 0; // do we need options aggregation?
         return mapResponseData(await request(config.graphql.searchProductsQuery)({
-            lastKey,
+            offset,
             data,
             limit: p.limit,
             shopID: p.shopID,
@@ -72,10 +72,10 @@ export function createAdvancedSearch(config) {
                 options: agg ? options : "keep",
                 priceRange: agg ? { min: d.price_min, max: d.price_max } : "keep",
                 count: d.count,
-                lastKey: d.last_key,
-                hasMore: lastKey && products.length === 0 ? false : true,
+                nextOffset: offset + (d.items?.length ?? 0),
+                hasMore: offset > 0 && products.length === 0 ? false : true,
                 params: p,
-                mode: lastKey ? "append" : "replace",
+                mode: offset > 0 ? "append" : "replace",
             };
         });
     });
@@ -89,7 +89,7 @@ export function createAdvancedSearch(config) {
         return {
             products,
             count: r.count,
-            lastKey: r.lastKey,
+            nextOffset: r.nextOffset,
             hasMore: r.hasMore && products.length < r.count,
             options: r.options === "keep" ? prevData.options : r.options,
             priceRange: r.priceRange === "keep" ? prevData.priceRange : r.priceRange,
@@ -104,7 +104,7 @@ export function createAdvancedSearch(config) {
     guard({
         source: sample(combine(configWithJWTAndLocale, data), loadProducts, ([config, data], ev) => ({
             config,
-            lastKey: data.lastKey,
+            offset: data.nextOffset,
             currentParams: data.params,
             ...ev,
         })),
@@ -115,7 +115,7 @@ export function createAdvancedSearch(config) {
     guard({
         source: sample(combine(configWithJWTAndLocale, data), config.locale, ([config, data]) => ({
             config,
-            lastKey: "",
+            offset: 0,
             currentParams: null,
             params: data.params,
         })),

package/esm/productFiltering.js

@@ -96,11 +96,8 @@ export function makeOptionFilter(optionID) {
             return {
                 kind: "or",
                 opts: vals.map((val) => ({
-                    kind: "and",
-                    opts: [
-                        { kind: "opt", opt: { op: "eq", name: "variants.options.option_id", text: optionID } },
-                        { kind: "opt", opt: { op: "eq", name: "variants.options.option_value_id", text: val } },
-                    ],
+                    kind: "opt",
+                    opt: { op: "eq", name: "variants.options", text: `${optionID}:${val}` },
                 })),
             };
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lana-commerce/core",
-  "version": "12.0.0",
+  "version": "13.0.0-alpha.2",
   "description": "Lana JS Core",
   "scripts": {
     "test": "jest",

package/types/graphql/fragments/ProductSearchResult.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "fragment ProductSearchResult on StorefrontProductSearchResult{last_key count items{...SearchProduct}options{...ProductSearchOptionAgg}price_max price_min}\n";
+declare const _default: "fragment ProductSearchResult on StorefrontProductSearchResult{count items{...SearchProduct}options{...ProductSearchOptionAgg}price_max price_min}\n";
 export default _default;

package/types/graphql/types.d.ts

@@ -1177,7 +1177,6 @@ export interface ProductSearchOptionAggFragment {
 export interface ProductSearchResultFragment {
     count: number;
     items: Array<SearchProductFragment | null> | null;
-    last_key: string;
     options: Array<ProductSearchOptionAggFragment>;
     price_max: number;
     price_min: number;
@@ -2236,8 +2235,8 @@ export interface SearchProductsAdvancedQuery {
 export interface SearchProductsAdvancedQueryVariables {
     aggregations: boolean;
     data: Array<SearchOption>;
-    lastKey: string;
     limit: number;
+    offset: number;
     shopID: string;
     sortBy: SearchProductsSortBy;
     sortDesc: boolean;

package/types/json/commerceTypes.d.ts

@@ -5172,8 +5172,6 @@ export interface ProductSearchResult {
     items: Array<{
         id: string;
     } | Product | null>;
-    /** Key of the last item for keyset based iteration */
-    last_key: string;
     /** Options aggregation */
     options: Array<ProductSearchOptionAgg>;
     /** Maximum price for given search conditions */
@@ -9838,24 +9836,6 @@ export interface EndpointAuthRefresh extends Endpoint<EndpointAuthRefresh, Token
     data(v: Token): EndpointAuthRefresh;
     extract(v: Extractor<TokenAndUserID>): EndpointAuthRefresh;
 }
-export interface EndpointAutocompleteCustomers extends Endpoint<EndpointAutocompleteCustomers, CustomerExpandableItems> {
-    /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
-    shop_id(v: string): EndpointAutocompleteCustomers;
-    data(v: Query): EndpointAutocompleteCustomers;
-    expand(v: CustomerExpandableItemsExpansionMap): EndpointAutocompleteCustomers;
-    extract(v: Extractor<CustomerExpandableItems>): EndpointAutocompleteCustomers;
-}
-export interface EndpointAutocompleteProducts extends Endpoint<EndpointAutocompleteProducts, ProductExpandableItems> {
-    /** Ignore bundle variant types */
-    ignore_bundles(v: boolean): EndpointAutocompleteProducts;
-    /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
-    shop_id(v: string): EndpointAutocompleteProducts;
-    /** Filter output by variant type */
-    type(v: VariantTypeFilter): EndpointAutocompleteProducts;
-    data(v: Query): EndpointAutocompleteProducts;
-    expand(v: ProductExpandableItemsExpansionMap): EndpointAutocompleteProducts;
-    extract(v: Extractor<ProductExpandableItems>): EndpointAutocompleteProducts;
-}
 export interface EndpointBlogs extends Endpoint<EndpointBlogs, Array<Blog>> {
     /** Output filtering */
     fields(v: Array<string>): EndpointBlogs;
@@ -13506,8 +13486,6 @@ export interface EndpointSearchOrders extends Endpoint<EndpointSearchOrders, Ord
 export interface EndpointSearchProducts extends Endpoint<EndpointSearchProducts, ProductSearchResult> {
     /** Whether to include aggregations into results or not */
     aggregations(v: boolean): EndpointSearchProducts;
-    /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */
-    last_key(v: string): EndpointSearchProducts;
     /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */
     limit(v: number): EndpointSearchProducts;
     /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */
@@ -14027,6 +14005,8 @@ export interface EndpointSuggestProducts extends Endpoint<EndpointSuggestProduct
     ignore_bundles(v: boolean): EndpointSuggestProducts;
     /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
     shop_id(v: string): EndpointSuggestProducts;
+    /** Filter output by variant type */
+    type(v: VariantTypeFilter): EndpointSuggestProducts;
     data(v: Query): EndpointSuggestProducts;
     expand(v: ProductExpandableItemsExpansionMap): EndpointSuggestProducts;
     extract(v: Extractor<ProductExpandableItems>): EndpointSuggestProducts;
@@ -14906,8 +14886,6 @@ export interface ReqFunction {
     (ctx: Context, v: "POST:auth/password/reset.json"): EndpointAuthPasswordReset;
     (ctx: Context, v: "POST:auth/password/verify.json"): EndpointAuthPasswordVerify;
     (ctx: Context, v: "POST:auth/refresh.json"): EndpointAuthRefresh;
-    (ctx: Context, v: "POST:autocomplete/customers.json"): EndpointAutocompleteCustomers;
-    (ctx: Context, v: "POST:autocomplete/products.json"): EndpointAutocompleteProducts;
     (ctx: Context, v: "GET:blogs.json"): EndpointBlogs;
     (ctx: Context, v: "GET:blogs/page.json"): EndpointBlogsPage;
     (ctx: Context, v: "GET:branding.json"): EndpointBranding;

package/types/json/storefrontTypes.d.ts

@@ -2390,8 +2390,6 @@ export interface StorefrontProductSearchResult {
     items: Array<{
         id: string;
     } | StorefrontProduct | null>;
-    /** Key of the last item for keyset based iteration */
-    last_key: string;
     /** Options aggregation */
     options: Array<ProductSearchOptionAgg>;
     /** Maximum price for given search conditions */
@@ -3047,7 +3045,6 @@ export interface VariantOption {
     option_value_name: string;
 }
 export type VariantType = "bundle" | "digital_good" | "gift_card" | "physical" | "service";
-export type VariantTypeFilter = "bundle" | "digital_good" | "gift_card" | "physical" | "service";
 export interface AddressShortExpansionMap {
     country?: true;
     province?: true;
@@ -3508,15 +3505,6 @@ export interface EndpointStorefrontAuthRequest extends Endpoint<EndpointStorefro
     shop_id(v: string): EndpointStorefrontAuthRequest;
     extract(v: Extractor<FileURL>): EndpointStorefrontAuthRequest;
 }
-export interface EndpointStorefrontAutocompleteProducts extends Endpoint<EndpointStorefrontAutocompleteProducts, StorefrontProductExpandableItems> {
-    /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
-    shop_id(v: string): EndpointStorefrontAutocompleteProducts;
-    /** Filter output by variant type */
-    type(v: VariantTypeFilter): EndpointStorefrontAutocompleteProducts;
-    data(v: Query): EndpointStorefrontAutocompleteProducts;
-    expand(v: StorefrontProductExpandableItemsExpansionMap): EndpointStorefrontAutocompleteProducts;
-    extract(v: Extractor<StorefrontProductExpandableItems>): EndpointStorefrontAutocompleteProducts;
-}
 export interface EndpointStorefrontBranding extends Endpoint<EndpointStorefrontBranding, StorefrontBranding> {
     /** Output filtering */
     fields(v: Array<string>): EndpointStorefrontBranding;
@@ -4669,8 +4657,6 @@ export interface EndpointStorefrontReviewDimensions extends Endpoint<EndpointSto
 export interface EndpointStorefrontSearchProducts extends Endpoint<EndpointStorefrontSearchProducts, StorefrontProductSearchResult> {
     /** Whether to include aggregations into results or not */
     aggregations(v: boolean): EndpointStorefrontSearchProducts;
-    /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */
-    last_key(v: string): EndpointStorefrontSearchProducts;
     /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */
     limit(v: number): EndpointStorefrontSearchProducts;
     /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */
@@ -4915,7 +4901,6 @@ export interface ReqFunction {
     (ctx: Context, v: "POST:storefront/auth/password/verify.json"): EndpointStorefrontAuthPasswordVerify;
     (ctx: Context, v: "POST:storefront/auth/refresh.json"): EndpointStorefrontAuthRefresh;
     (ctx: Context, v: "POST:storefront/auth/request.json"): EndpointStorefrontAuthRequest;
-    (ctx: Context, v: "POST:storefront/autocomplete/products.json"): EndpointStorefrontAutocompleteProducts;
     (ctx: Context, v: "GET:storefront/branding.json"): EndpointStorefrontBranding;
     (ctx: Context, v: "GET:storefront/branding/default.json"): EndpointStorefrontBrandingDefault;
     (ctx: Context, v: "GET:storefront/brands.json"): EndpointStorefrontBrands;

package/types/modules/advancedSearch.d.ts

@@ -20,7 +20,7 @@ export interface SearchData<Product> {
         max: number;
     } | null;
     count: number;
-    lastKey: string;
+    nextOffset: number;
     hasMore: boolean;
     params: ProductsPageQueryParameters | null;
 }
@@ -45,7 +45,6 @@ export interface AdvancedSearchConfig<Product> {
             search: {
                 count: number;
                 items: Array<Product | null> | null;
-                last_key: string;
                 options: Array<OptionAgg>;
                 price_max: number;
                 price_min: number;
@@ -53,7 +52,7 @@ export interface AdvancedSearchConfig<Product> {
         }, {
             aggregations: boolean;
             data: Array<SearchOption>;
-            lastKey: string;
+            offset: number;
             limit: number;
             shopID: string;
             sortBy: SearchProductsSortBy;