@depict-ai/ui 1.2.2 → 1.3.0

package/README.md

@@ -4,4 +4,6 @@ You're most likely looking for https://www.npmjs.com/package/@depict-ai/js-ui or
 
 Breaking changes:
 
-- 1.1.0 made the `include_input_field` option of `SearchPage` default to true
+- 1.1.0 made the `include_input_field` option of `SearchPage` default to true
+- 1.2.0 added `page_url_creator` and changed typing to support it. The only breaking change is that this potentially causes type errors where the resolution is to move the generics to the provider instead of the SearchPage and CategoryPage components.
+- 1.3.0 moved `depict-filter-sort-mobile-modal-container` from being a class to being an id

package/dist/client/main.cjs

@@ -43,7 +43,7 @@ $parcel$export(module.exports, "defaultGridSpacing", () => $a3280f0aad997933$exp
 $parcel$export(module.exports, "defaultColsAtSize", () => $a3280f0aad997933$export$c3834fa86c616831);
 $parcel$export(module.exports, "defaultCategoryTitlePlugin", () => $a3280f0aad997933$export$7bf543b9d9be2c22);
 $parcel$export(module.exports, "version", () => $b757f75811f3261f$export$83d89fbfd8236492);
-/*! Depict.ai search and product listing SDK */ const $b757f75811f3261f$export$83d89fbfd8236492 = "1.2.2";
+/*! Depict.ai search and product listing SDK */ const $b757f75811f3261f$export$83d89fbfd8236492 = "1.3.0";
 
 
 
@@ -371,7 +371,11 @@ class $e1d6c0f3d89d531c$export$e015ed2f2950f2e3 {
         this.page_url_creator = page_url_creator;
     }
     async suggest(input_req) {
-        const request = this.#add_ids_to_request(input_req);
+        const with_ids = this.#add_ids_to_request(input_req);
+        const metaData = await this.#get_metadata?.();
+        const request = metaData ? Object.assign(with_ids, {
+            metadata: JSON.stringify(metaData)
+        }) : with_ids;
         const url = (0, $57o7A$depictaiutilishared.make_url_with_query_params)($e1d6c0f3d89d531c$var$search_base_url + "suggestions", request);
         const results = await (0, $57o7A$depictaiutilishared.fetch_retry)((0, $57o7A$depictaiutilishared.add_version_query_params)(url));
         attempt_to_return_api_response: {
@@ -3912,7 +3916,7 @@ function $02215fefc955d01e$export$28f6150e232898de() {
 }
 
 
-const $1872ceb56ede7a52$var$_tmpl$ = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<button class="clear minor"></button>`, 2), $1872ceb56ede7a52$var$_tmpl$2 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<div class="depict plp depict-filter-sort-mobile-modal-container"><div class="depict-filter-sort-modal-backdrop"></div><button class="dismiss-modal"></button><div class="filter-sort-modal"><div class="body"><!#><!/><!#><!/></div><div class="bottom-row"><!#><!/><button class="show-results major"></button></div></div></div>`, 20), $1872ceb56ede7a52$var$_tmpl$3 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<details class="sorting"></details>`, 2), $1872ceb56ede7a52$var$_tmpl$4 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<summary class="sort-filter-summary"><div class="summary"><div class="left-els"><!#><!/><span></span></div><!#><!/></div></summary>`, 12), $1872ceb56ede7a52$var$_tmpl$5 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<div class="body"></div>`, 2), $1872ceb56ede7a52$var$_tmpl$6 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<details class="filters"></details>`, 2), $1872ceb56ede7a52$var$_tmpl$7 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<b></b>`, 2);
+const $1872ceb56ede7a52$var$_tmpl$ = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<button class="clear minor"></button>`, 2), $1872ceb56ede7a52$var$_tmpl$2 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<div class="depict plp" id="depict-filter-sort-mobile-modal-container"><div class="depict-filter-sort-modal-backdrop"></div><button class="dismiss-modal"></button><div class="filter-sort-modal"><div class="body"><!#><!/><!#><!/></div><div class="bottom-row"><!#><!/><button class="show-results major"></button></div></div></div>`, 20), $1872ceb56ede7a52$var$_tmpl$3 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<details class="sorting"></details>`, 2), $1872ceb56ede7a52$var$_tmpl$4 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<summary class="sort-filter-summary"><div class="summary"><div class="left-els"><!#><!/><span></span></div><!#><!/></div></summary>`, 12), $1872ceb56ede7a52$var$_tmpl$5 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<div class="body"></div>`, 2), $1872ceb56ede7a52$var$_tmpl$6 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<details class="filters"></details>`, 2), $1872ceb56ede7a52$var$_tmpl$7 = /*@__PURE__*/ (0, /*@__PURE__*/$57o7A$solidjsweb.template)(`<b></b>`, 2);
 const $1872ceb56ede7a52$var$no_go_selector = ".range .range-group";
 function $1872ceb56ede7a52$export$9bf11afa910f536e({ args_for_sorting_: args_for_sorting_ , args_for_filtering_: args_for_filtering_ , search_filters_open_: [get_search_filters_open, set_search_filters_open] , search_sorting_open_: [get_search_sorting_open, set_search_sorting_open] , dismiss_modal_: dismiss_modal_ , register_closing_animation_: register_closing_animation_ , formatted_number_of_results_: formatted_number_of_results_ , i18n_: i18n_  }) {
     (0, $ca1176b694a6ee2e$export$fe334901e8bebd57)();

package/dist/client/module.js

@@ -2,7 +2,7 @@ import {add_to_version_info as $gco9i$add_to_version_info, observer as $gco9i$ob
 import {createRoot as $gco9i$createRoot, createSignal as $gco9i$createSignal, getOwner as $gco9i$getOwner, runWithOwner as $gco9i$runWithOwner, onCleanup as $gco9i$onCleanup, createComputed as $gco9i$createComputed, createRenderEffect as $gco9i$createRenderEffect, createEffect as $gco9i$createEffect, untrack as $gco9i$untrack, batch as $gco9i$batch, createResource as $gco9i$createResource, createMemo as $gco9i$createMemo, Show as $gco9i$Show, createReaction as $gco9i$createReaction, Suspense as $gco9i$Suspense, on as $gco9i$on, ErrorBoundary as $gco9i$ErrorBoundary, For as $gco9i$For, Index as $gco9i$Index} from "solid-js";
 import {template as $gco9i$template, getNextElement as $gco9i$getNextElement, spread as $gco9i$spread, mergeProps as $gco9i$mergeProps, runHydrationEvents as $gco9i$runHydrationEvents, effect as $gco9i$effect, setAttribute as $gco9i$setAttribute, insert as $gco9i$insert, isServer as $gco9i$isServer, createComponent as $gco9i$createComponent, getNextMarker as $gco9i$getNextMarker, use as $gco9i$use, memo as $gco9i$memo, addEventListener as $gco9i$addEventListener, delegateEvents as $gco9i$delegateEvents, classList as $gco9i$classList, style as $gco9i$style, className as $gco9i$className, Dynamic as $gco9i$Dynamic} from "solid-js/web";
 
-/*! Depict.ai search and product listing SDK */ const $ec291e0010116877$export$83d89fbfd8236492 = "1.2.2";
+/*! Depict.ai search and product listing SDK */ const $ec291e0010116877$export$83d89fbfd8236492 = "1.3.0";
 
 
 
@@ -330,7 +330,11 @@ class $7fa23e2a0079eca4$export$e015ed2f2950f2e3 {
         this.page_url_creator = page_url_creator;
     }
     async suggest(input_req) {
-        const request = this.#add_ids_to_request(input_req);
+        const with_ids = this.#add_ids_to_request(input_req);
+        const metaData = await this.#get_metadata?.();
+        const request = metaData ? Object.assign(with_ids, {
+            metadata: JSON.stringify(metaData)
+        }) : with_ids;
         const url = (0, $gco9i$make_url_with_query_params)($7fa23e2a0079eca4$var$search_base_url + "suggestions", request);
         const results = await (0, $gco9i$fetch_retry)((0, $gco9i$add_version_query_params)(url));
         attempt_to_return_api_response: {
@@ -3871,7 +3875,7 @@ function $b9bf7fce0ae60241$export$28f6150e232898de() {
 }
 
 
-const $757dac7f7c6c5241$var$_tmpl$ = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<button class="clear minor"></button>`, 2), $757dac7f7c6c5241$var$_tmpl$2 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<div class="depict plp depict-filter-sort-mobile-modal-container"><div class="depict-filter-sort-modal-backdrop"></div><button class="dismiss-modal"></button><div class="filter-sort-modal"><div class="body"><!#><!/><!#><!/></div><div class="bottom-row"><!#><!/><button class="show-results major"></button></div></div></div>`, 20), $757dac7f7c6c5241$var$_tmpl$3 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<details class="sorting"></details>`, 2), $757dac7f7c6c5241$var$_tmpl$4 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<summary class="sort-filter-summary"><div class="summary"><div class="left-els"><!#><!/><span></span></div><!#><!/></div></summary>`, 12), $757dac7f7c6c5241$var$_tmpl$5 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<div class="body"></div>`, 2), $757dac7f7c6c5241$var$_tmpl$6 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<details class="filters"></details>`, 2), $757dac7f7c6c5241$var$_tmpl$7 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<b></b>`, 2);
+const $757dac7f7c6c5241$var$_tmpl$ = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<button class="clear minor"></button>`, 2), $757dac7f7c6c5241$var$_tmpl$2 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<div class="depict plp" id="depict-filter-sort-mobile-modal-container"><div class="depict-filter-sort-modal-backdrop"></div><button class="dismiss-modal"></button><div class="filter-sort-modal"><div class="body"><!#><!/><!#><!/></div><div class="bottom-row"><!#><!/><button class="show-results major"></button></div></div></div>`, 20), $757dac7f7c6c5241$var$_tmpl$3 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<details class="sorting"></details>`, 2), $757dac7f7c6c5241$var$_tmpl$4 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<summary class="sort-filter-summary"><div class="summary"><div class="left-els"><!#><!/><span></span></div><!#><!/></div></summary>`, 12), $757dac7f7c6c5241$var$_tmpl$5 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<div class="body"></div>`, 2), $757dac7f7c6c5241$var$_tmpl$6 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<details class="filters"></details>`, 2), $757dac7f7c6c5241$var$_tmpl$7 = /*@__PURE__*/ (0, /*@__PURE__*/$gco9i$template)(`<b></b>`, 2);
 const $757dac7f7c6c5241$var$no_go_selector = ".range .range-group";
 function $757dac7f7c6c5241$export$9bf11afa910f536e({ args_for_sorting_: args_for_sorting_ , args_for_filtering_: args_for_filtering_ , search_filters_open_: [get_search_filters_open, set_search_filters_open] , search_sorting_open_: [get_search_sorting_open, set_search_sorting_open] , dismiss_modal_: dismiss_modal_ , register_closing_animation_: register_closing_animation_ , formatted_number_of_results_: formatted_number_of_results_ , i18n_: i18n_  }) {
     (0, $aea1edf92433e81e$export$fe334901e8bebd57)();

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { SearchRequest, SearchFilter } from "@depict-ai/types/api/SearchRequest"
 import { BaseSearchRequest } from "@depict-ai/types/api/BaseSearchRequest";
 import { SearchSuggestionsRequest } from "@depict-ai/types/api/SearchSuggestionsRequest";
 import { ProductListingRequest } from "@depict-ai/types/api/ProductListingRequest";
-export const version = "1.2.2";
+export const version = "1.3.0";
 type PageURLCreatorAlwaysThereData = {
     merchant: string;
     market: string;
@@ -26,13 +26,13 @@ export type ModernDisplayWithPageUrl<T extends ModernDisplay> = {
         page_url: string;
     })[] : T[K];
 };
+type PageURLCreatorOptions<InputDisplay extends ModernDisplay> = (PageURLCreatorAlwaysThereData & PageURLCreatorCategoryData) | (PageURLCreatorAlwaysThereData & PageURLCreatorProductData<InputDisplay>);
 /**
  * PageUrlCreator is, in its most basic form, a function that takes in a list of categories or products and returns a list of page_urls for the provided categories or products.
  * It's main use case is to allow for the creation of links to the product or category pages on the merchant's site.
  * It can also be used for the depict customers which already have links to change those links (i.e. for staging sites).
  * Also, it can be used to enrich the data for each product card in a batched way, which is why it can be an async function and return a whole display in the case of products.
  */
-type PageURLCreatorOptions<InputDisplay extends ModernDisplay> = (PageURLCreatorAlwaysThereData & PageURLCreatorCategoryData) | (PageURLCreatorAlwaysThereData & PageURLCreatorProductData<InputDisplay>);
 export type PageURLCreator<InputDisplay extends ModernDisplay, OutputDisplay extends ModernDisplay | never> = (options: PageURLCreatorOptions<InputDisplay>) => (typeof options)["type"] extends "categories" ? CanBePromiseWrapped<{
     page_url: string;
 }[]> : CanBePromiseWrapped<{

package/dist/server/main.cjs

@@ -43,7 +43,7 @@ $parcel$export(module.exports, "defaultGridSpacing", () => $a3280f0aad997933$exp
 $parcel$export(module.exports, "defaultColsAtSize", () => $a3280f0aad997933$export$c3834fa86c616831);
 $parcel$export(module.exports, "defaultCategoryTitlePlugin", () => $a3280f0aad997933$export$7bf543b9d9be2c22);
 $parcel$export(module.exports, "version", () => $b757f75811f3261f$export$83d89fbfd8236492);
-/*! Depict.ai search and product listing SDK */ const $b757f75811f3261f$export$83d89fbfd8236492 = "1.2.2";
+/*! Depict.ai search and product listing SDK */ const $b757f75811f3261f$export$83d89fbfd8236492 = "1.3.0";
 
 
 
@@ -355,7 +355,11 @@ class $e1d6c0f3d89d531c$export$e015ed2f2950f2e3 {
         this.page_url_creator = page_url_creator;
     }
     async suggest(input_req) {
-        const request = this.#add_ids_to_request(input_req);
+        const with_ids = this.#add_ids_to_request(input_req);
+        const metaData = await this.#get_metadata?.();
+        const request = metaData ? Object.assign(with_ids, {
+            metadata: JSON.stringify(metaData)
+        }) : with_ids;
         const url = (0, $diwD4$depictaiutilishared.make_url_with_query_params)($e1d6c0f3d89d531c$var$search_base_url + "suggestions", request);
         const results = await (0, $diwD4$depictaiutilishared.fetch_retry)((0, $diwD4$depictaiutilishared.add_version_query_params)(url));
         attempt_to_return_api_response: {
@@ -3300,7 +3304,7 @@ const $1872ceb56ede7a52$var$_tmpl$ = [
     "</button>"
 ], $1872ceb56ede7a52$var$_tmpl$2 = [
     "<div",
-    ' class="depict plp depict-filter-sort-mobile-modal-container"><div class="depict-filter-sort-modal-backdrop"></div><button class="dismiss-modal"',
+    ' class="depict plp" id="depict-filter-sort-mobile-modal-container"><div class="depict-filter-sort-modal-backdrop"></div><button class="dismiss-modal"',
     ">",
     '</button><div class="filter-sort-modal"><div class="body" style="',
     '"><!--#-->',

package/dist/server/module.js

@@ -2,7 +2,7 @@ import {add_to_version_info as $cV3wj$add_to_version_info, observer as $cV3wj$ob
 import {createRoot as $cV3wj$createRoot, createSignal as $cV3wj$createSignal, getOwner as $cV3wj$getOwner, runWithOwner as $cV3wj$runWithOwner, onCleanup as $cV3wj$onCleanup, createComputed as $cV3wj$createComputed, createRenderEffect as $cV3wj$createRenderEffect, createEffect as $cV3wj$createEffect, untrack as $cV3wj$untrack, batch as $cV3wj$batch, createResource as $cV3wj$createResource, createMemo as $cV3wj$createMemo, Show as $cV3wj$Show, createReaction as $cV3wj$createReaction, Suspense as $cV3wj$Suspense, on as $cV3wj$on, ErrorBoundary as $cV3wj$ErrorBoundary, For as $cV3wj$For, Index as $cV3wj$Index} from "solid-js";
 import {ssrElement as $cV3wj$ssrElement, ssr as $cV3wj$ssr, ssrHydrationKey as $cV3wj$ssrHydrationKey, ssrAttribute as $cV3wj$ssrAttribute, escape as $cV3wj$escape, isServer as $cV3wj$isServer, createComponent as $cV3wj$createComponent, ssrClassList as $cV3wj$ssrClassList, insert as $cV3wj$insert, ssrStyle as $cV3wj$ssrStyle, Dynamic as $cV3wj$Dynamic, mergeProps as $cV3wj$mergeProps} from "solid-js/web";
 
-/*! Depict.ai search and product listing SDK */ const $ec291e0010116877$export$83d89fbfd8236492 = "1.2.2";
+/*! Depict.ai search and product listing SDK */ const $ec291e0010116877$export$83d89fbfd8236492 = "1.3.0";
 
 
 
@@ -314,7 +314,11 @@ class $7fa23e2a0079eca4$export$e015ed2f2950f2e3 {
         this.page_url_creator = page_url_creator;
     }
     async suggest(input_req) {
-        const request = this.#add_ids_to_request(input_req);
+        const with_ids = this.#add_ids_to_request(input_req);
+        const metaData = await this.#get_metadata?.();
+        const request = metaData ? Object.assign(with_ids, {
+            metadata: JSON.stringify(metaData)
+        }) : with_ids;
         const url = (0, $cV3wj$make_url_with_query_params)($7fa23e2a0079eca4$var$search_base_url + "suggestions", request);
         const results = await (0, $cV3wj$fetch_retry)((0, $cV3wj$add_version_query_params)(url));
         attempt_to_return_api_response: {
@@ -3259,7 +3263,7 @@ const $757dac7f7c6c5241$var$_tmpl$ = [
     "</button>"
 ], $757dac7f7c6c5241$var$_tmpl$2 = [
     "<div",
-    ' class="depict plp depict-filter-sort-mobile-modal-container"><div class="depict-filter-sort-modal-backdrop"></div><button class="dismiss-modal"',
+    ' class="depict plp" id="depict-filter-sort-mobile-modal-container"><div class="depict-filter-sort-modal-backdrop"></div><button class="dismiss-modal"',
     ">",
     '</button><div class="filter-sort-modal"><div class="body" style="',
     '"><!--#-->',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@depict-ai/ui",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Base package containing the actual UI of Depict UI along with translations, with a not-simplified API. We recommend using @depict-ai/js-ui or @depict-ai/react-ui instead.",
   "packageManager": "yarn@3.2.2",
   "main": "dist/client/main.cjs",
@@ -124,9 +124,9 @@
     "ts-jest": "^29.0.3"
   },
   "dependencies": {
-    "@depict-ai/plp-styling": "^1.0.24",
-    "@depict-ai/types": "^1.0.27",
-    "@depict-ai/utilishared": "^1.0.23",
+    "@depict-ai/plp-styling": "^1.0.25",
+    "@depict-ai/types": "^1.0.28",
+    "@depict-ai/utilishared": "^1.0.24",
     "solid-js": "^1.7.3"
   },
   "types": "dist/index.d.ts",