@depict-ai/ui 1.0.8 → 1.0.9

package/locales/index.d.ts

@@ -1,89 +1,89 @@
-import { Elem } from "@depict-ai/utilishared";
-/**
- * PLP internationalisation shared between search and category listing
- */
-type plp_shared_i18n = {
-    scroll_to_top_: string;
-    back_: string;
-    open_sorting_: string;
-    close_sorting_: string;
-    open_filters_: string;
-    close_filters_: string;
-    close_: string;
-    ok_: string;
-    filters_cleared_: string;
-    we_cleared_your_filters_: string;
-    restore_: string;
-    sorting_text_: string;
-    filter_text_: string;
-    selected_filters_title_: string;
-    filters_: string;
-    view_less_: string;
-    view_more_: string;
-    clear_all_from_filter_crumbs_: string;
-    clear_individual_filter_: string;
-    of_: string;
-    clear_all_filters_from_big_button_: string;
-    try_without_filters_: string;
-    range_filter_low_point_aria_label_: string;
-    range_filter_high_point_aria_label_: string;
-    morphing_sign_expanded_aria_label_: string;
-    morphing_sign_collapsed_aria_label_: string;
-    price_formatting_: {
-        pre_: string;
-        post_: string;
-        decimal_places_delimiter_: string;
-        thousands_delimiter_: string;
-        places_after_comma_: number | "auto";
-    };
-};
-/**
- * Search internationalisation
- */
-interface search_i18n extends plp_shared_i18n {
-    placeholder_text_: string;
-    show_n_results_: (number_of_results: HTMLElement) => Elem[];
-    no_results_text_: string;
-    search_recs_title_: string;
-    clear_filters_query_sorting_after_submit_: string;
-    modal_view_all_results_: (number_of_results: HTMLElement) => Elem[];
-    modal_discover_more_: string;
-    get_showing_results_for_: (query: HTMLElement, number_of_results: HTMLElement) => Elem[];
-    previous_searches_text_: string;
-    category_: string;
-    suggestions_: string;
-    search_submit_button_aria_label_: string;
-    search_field_field_aria_label_: string;
-    previous_searches_delete_entry_from_history_: string;
-}
-/**
- * Category internationalisation
- */
-interface category_i18n extends plp_shared_i18n {
-    show_n_products_: (number_of_results: HTMLElement) => Elem[];
-    no_products_text_: string;
-    product_: string;
-    products_: string;
-    breadcrumbs_aria_label_: string;
-    quicklinks_aria_label_: string;
-    breadcrumbs_separator_: string;
-}
-/**
- * Depict UI internationalisation
- */
-interface Locale extends category_i18n, search_i18n {
-}
-export const cz: Locale;
-export const da: Locale;
-export const nl: Locale;
-export const en: Locale;
-export const fi: Locale;
-export const fr: Locale;
-export const de: Locale;
-export const it: Locale;
-export const no: Locale;
-export const pl: Locale;
-export const pt: Locale;
-export const es: Locale;
-export const sv: Locale;
-export const defaultLocale: Locale;
+import { Elem } from "@depict-ai/utilishared";
+/**
+ * PLP internationalisation shared between search and category listing
+ */
+type plp_shared_i18n = {
+    scroll_to_top_: string;
+    back_: string;
+    open_sorting_: string;
+    close_sorting_: string;
+    open_filters_: string;
+    close_filters_: string;
+    close_: string;
+    ok_: string;
+    filters_cleared_: string;
+    we_cleared_your_filters_: string;
+    restore_: string;
+    sorting_text_: string;
+    filter_text_: string;
+    selected_filters_title_: string;
+    filters_: string;
+    view_less_: string;
+    view_more_: string;
+    clear_all_from_filter_crumbs_: string;
+    clear_individual_filter_: string;
+    of_: string;
+    clear_all_filters_from_big_button_: string;
+    try_without_filters_: string;
+    range_filter_low_point_aria_label_: string;
+    range_filter_high_point_aria_label_: string;
+    morphing_sign_expanded_aria_label_: string;
+    morphing_sign_collapsed_aria_label_: string;
+    price_formatting_: {
+        pre_: string;
+        post_: string;
+        decimal_places_delimiter_: string;
+        thousands_delimiter_: string;
+        places_after_comma_: number | "auto";
+    };
+};
+/**
+ * Search internationalisation
+ */
+interface search_i18n extends plp_shared_i18n {
+    placeholder_text_: string;
+    show_n_results_: (number_of_results: HTMLElement) => Elem[];
+    no_results_text_: string;
+    search_recs_title_: string;
+    clear_filters_query_sorting_after_submit_: string;
+    modal_view_all_results_: (number_of_results: HTMLElement) => Elem[];
+    modal_discover_more_: string;
+    get_showing_results_for_: (query: HTMLElement, number_of_results: HTMLElement) => Elem[];
+    previous_searches_text_: string;
+    category_: string;
+    suggestions_: string;
+    search_submit_button_aria_label_: string;
+    search_field_field_aria_label_: string;
+    previous_searches_delete_entry_from_history_: string;
+}
+/**
+ * Category internationalisation
+ */
+interface category_i18n extends plp_shared_i18n {
+    show_n_products_: (number_of_results: HTMLElement) => Elem[];
+    no_products_text_: string;
+    product_: string;
+    products_: string;
+    breadcrumbs_aria_label_: string;
+    quicklinks_aria_label_: string;
+    breadcrumbs_separator_: string;
+}
+/**
+ * Depict UI internationalisation
+ */
+interface Locale extends category_i18n, search_i18n {
+}
+export const cz: Locale;
+export const da: Locale;
+export const nl: Locale;
+export const en: Locale;
+export const fi: Locale;
+export const fr: Locale;
+export const de: Locale;
+export const it: Locale;
+export const no: Locale;
+export const pl: Locale;
+export const pt: Locale;
+export const es: Locale;
+export const sv: Locale;
+export const defaultLocale: Locale;

package/locales/index.js

@@ -1,5 +1,5 @@
-/**
- * Exported naming follows IETF BCP 47: https://en.wikipedia.org/wiki/IETF_language_tag
+/**
+ * Exported naming follows IETF BCP 47: https://en.wikipedia.org/wiki/IETF_language_tag
  */ const $0f11d1c8c78bac40$var$english_base_translation = {
     "of_": "of",
     "sorting_text_": "Sort",

package/locales/require.js

@@ -16,8 +16,8 @@ $parcel$export(module.exports, "pt", () => $2d187e768d780a64$export$84175d5f1cb4
 $parcel$export(module.exports, "es", () => $2d187e768d780a64$export$ca5e4045a55e76d2);
 $parcel$export(module.exports, "sv", () => $2d187e768d780a64$export$65540e5f7f6e7dce);
 $parcel$export(module.exports, "defaultLocale", () => $2d187e768d780a64$export$d7f512c98c859244);
-/**
- * Exported naming follows IETF BCP 47: https://en.wikipedia.org/wiki/IETF_language_tag
+/**
+ * Exported naming follows IETF BCP 47: https://en.wikipedia.org/wiki/IETF_language_tag
  */ const $f1b6d8431ecd6285$var$english_base_translation = {
     "of_": "of",
     "sorting_text_": "Sort",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@depict-ai/ui",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "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",
   "source": [
@@ -102,9 +102,9 @@
     "ts-jest": "^29.0.3"
   },
   "dependencies": {
-    "@depict-ai/plp-styling": "^1.0.8",
-    "@depict-ai/types": "^1.0.7",
-    "@depict-ai/utilishared": "^1.0.7",
+    "@depict-ai/plp-styling": "^1.0.9",
+    "@depict-ai/types": "^1.0.8",
+    "@depict-ai/utilishared": "^1.0.8",
     "solid-js": "^1.7.3"
   },
   "types": "dist/index.d.ts"

package/styles.scss

@@ -1 +1 @@
-@forward "@depict-ai/plp-styling";
+@forward "@depict-ai/plp-styling";

package/dist/typescript_schema/BaseSearchRequest.d.ts

@@ -1,197 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-/**
- * An enumeration.
- */
-export type SortingOrder = "asc" | "desc";
-
-export interface BaseSearchRequest {
-  tenant: string;
-  market: string;
-  /**
-   * List of filters to apply to the results.
-   */
-  filters?: SearchFilter[];
-  /**
-   * Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the `sorts` field.
-   */
-  sort?: SortModel;
-  /**
-   * User identifier
-   */
-  user_id?: string;
-  /**
-   * Session identifier
-   */
-  session_id?: string;
-  /**
-   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id
-   */
-  dsid?: string;
-  /**
-   * Metadata that can be used to modify the behaviour of the search.
-   */
-  metadata?: {
-    [k: string]: string;
-  };
-  /**
-   * The search query.
-   */
-  query?: string;
-}
-export interface SearchFilter {
-  /**
-   * The field to filter by.
-   */
-  field: string;
-  /**
-   * The operation used for filtering. The filtering should be read as `field op data`, for example `brand in ["Nike", "Adidas"]`.
-   */
-  op: "eq" | "neq" | "in" | "nin" | "leq" | "geq" | "inrange";
-  /**
-   * Data for the filter.
-   */
-  data?:
-    | ("true" | "false")
-    | number
-    | number
-    | string
-    | [number, number]
-    | [number, number]
-    | [number, number]
-    | [number, number]
-    | (
-        | ("true" | "false")
-        | number
-        | number
-        | string
-        | [number, number]
-        | [number, number]
-        | [number, number]
-        | [number, number]
-      )[]
-    | (("true" | "false") | number | number | string)[][];
-  /**
-   * Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.
-   */
-  meta?: RangeFilterMeta | ValuesFilterMeta | HierarchicalValuesFilterMeta;
-  /**
-   * ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.
-   */
-  id?: string;
-}
-export interface RangeFilterMeta {
-  /**
-   * Title of the group, where a group consists of all the filters that share an ID.
-   */
-  group_title?: string;
-  /**
-   * Whether the filter group should be expanded by default or not.
-   */
-  group_expanded?: boolean;
-  type?: "range";
-  /**
-   * The minimum value that can be selected in the range.
-   */
-  min: number;
-  /**
-   * The maximum value that can be selected in the range.
-   */
-  max: number;
-  /**
-   * The unit of the range values.
-   */
-  unit?: string;
-  /**
-   * The currency of the range values.
-   */
-  currency?: string;
-}
-export interface ValuesFilterMeta {
-  /**
-   * Title of the group, where a group consists of all the filters that share an ID.
-   */
-  group_title?: string;
-  /**
-   * Whether the filter group should be expanded by default or not.
-   */
-  group_expanded?: boolean;
-  /**
-   * Type of filter.
-   */
-  type?: "radio" | "checkbox" | "checkbox-grid";
-  /**
-   * Selectable values
-   */
-  values: (
-    | ("true" | "false")
-    | number
-    | number
-    | string
-    | [number, number]
-    | [number, number]
-    | [number, number]
-    | [number, number]
-  )[];
-  /**
-   * Counts for values
-   */
-  counts?: number[];
-  /**
-   * Names for values
-   */
-  names?: string[];
-}
-export interface HierarchicalValuesFilterMeta {
-  /**
-   * Title of the group, where a group consists of all the filters that share an ID.
-   */
-  group_title?: string;
-  /**
-   * Whether the filter group should be expanded by default or not.
-   */
-  group_expanded?: boolean;
-  type?: "checkbox-hierarchical";
-  /**
-   * Selectable hierarchical values
-   */
-  values: (("true" | "false") | number | number | string)[][];
-  /**
-   * Counts for values
-   */
-  counts?: number[];
-  /**
-   * Names for hierarchical values
-   */
-  names?: string[];
-}
-export interface SortModel {
-  /**
-   * The field to sort by.
-   */
-  field: string;
-  /**
-   * The order to sort by.
-   */
-  order: SortingOrder;
-  /**
-   * Metadata about the sort that can be used for rendering.
-   */
-  meta?: SortMeta;
-}
-export interface SortMeta {
-  title: string;
-  /**
-   * Selectable values
-   */
-  values?: SortingOrder[];
-  /**
-   * Names for orders
-   */
-  names?: string[];
-}

package/dist/typescript_schema/ProductListingQueriesRequest.d.ts

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface ProductListingQueriesRequest {
-  tenant: string;
-  market: string;
-  metadata?: {
-    [k: string]: string;
-  };
-}

package/dist/typescript_schema/ProductListingQueriesResponse.d.ts

@@ -1,10 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-export interface ProductListingQueriesResponse {
-  query_ids?: string[];
-}

package/dist/typescript_schema/ProductListingRequest.d.ts

@@ -1,221 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-/**
- * An enumeration.
- */
-export type SortingOrder = "asc" | "desc";
-
-export interface ProductListingRequest {
-  /**
-   * Deprecated, do not use. Will be removed.
-   */
-  page?: number;
-  /**
-   * Deprecated, do not use. Will be removed.
-   */
-  hits_per_page?: number;
-  /**
-   * Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.
-   */
-  cursor?: string;
-  /**
-   * Maximum number of results per response.
-   */
-  limit?: number;
-  tenant: string;
-  market: string;
-  /**
-   * List of filters to apply to the results.
-   */
-  filters?: SearchFilter[];
-  /**
-   * Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the `sorts` field.
-   */
-  sort?: SortModel;
-  /**
-   * User identifier
-   */
-  user_id?: string;
-  /**
-   * Session identifier
-   */
-  session_id?: string;
-  /**
-   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id
-   */
-  dsid?: string;
-  /**
-   * Metadata that can be used to modify the behaviour of the search.
-   */
-  metadata?: {
-    [k: string]: string;
-  };
-  /**
-   * ID of the page to get products for. This is typically the slug, for example `hoodies-and-sweaters`.
-   */
-  query_id: string;
-  /**
-   * Disables rules to hide products.
-   */
-  show_hidden_products?: boolean;
-  /**
-   * Whether to return grouping IDs or not.
-   */
-  return_grouping_ids?: boolean;
-}
-export interface SearchFilter {
-  /**
-   * The field to filter by.
-   */
-  field: string;
-  /**
-   * The operation used for filtering. The filtering should be read as `field op data`, for example `brand in ["Nike", "Adidas"]`.
-   */
-  op: "eq" | "neq" | "in" | "nin" | "leq" | "geq" | "inrange";
-  /**
-   * Data for the filter.
-   */
-  data?:
-    | ("true" | "false")
-    | number
-    | number
-    | string
-    | [number, number]
-    | [number, number]
-    | [number, number]
-    | [number, number]
-    | (
-        | ("true" | "false")
-        | number
-        | number
-        | string
-        | [number, number]
-        | [number, number]
-        | [number, number]
-        | [number, number]
-      )[]
-    | (("true" | "false") | number | number | string)[][];
-  /**
-   * Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.
-   */
-  meta?: RangeFilterMeta | ValuesFilterMeta | HierarchicalValuesFilterMeta;
-  /**
-   * ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.
-   */
-  id?: string;
-}
-export interface RangeFilterMeta {
-  /**
-   * Title of the group, where a group consists of all the filters that share an ID.
-   */
-  group_title?: string;
-  /**
-   * Whether the filter group should be expanded by default or not.
-   */
-  group_expanded?: boolean;
-  type?: "range";
-  /**
-   * The minimum value that can be selected in the range.
-   */
-  min: number;
-  /**
-   * The maximum value that can be selected in the range.
-   */
-  max: number;
-  /**
-   * The unit of the range values.
-   */
-  unit?: string;
-  /**
-   * The currency of the range values.
-   */
-  currency?: string;
-}
-export interface ValuesFilterMeta {
-  /**
-   * Title of the group, where a group consists of all the filters that share an ID.
-   */
-  group_title?: string;
-  /**
-   * Whether the filter group should be expanded by default or not.
-   */
-  group_expanded?: boolean;
-  /**
-   * Type of filter.
-   */
-  type?: "radio" | "checkbox" | "checkbox-grid";
-  /**
-   * Selectable values
-   */
-  values: (
-    | ("true" | "false")
-    | number
-    | number
-    | string
-    | [number, number]
-    | [number, number]
-    | [number, number]
-    | [number, number]
-  )[];
-  /**
-   * Counts for values
-   */
-  counts?: number[];
-  /**
-   * Names for values
-   */
-  names?: string[];
-}
-export interface HierarchicalValuesFilterMeta {
-  /**
-   * Title of the group, where a group consists of all the filters that share an ID.
-   */
-  group_title?: string;
-  /**
-   * Whether the filter group should be expanded by default or not.
-   */
-  group_expanded?: boolean;
-  type?: "checkbox-hierarchical";
-  /**
-   * Selectable hierarchical values
-   */
-  values: (("true" | "false") | number | number | string)[][];
-  /**
-   * Counts for values
-   */
-  counts?: number[];
-  /**
-   * Names for hierarchical values
-   */
-  names?: string[];
-}
-export interface SortModel {
-  /**
-   * The field to sort by.
-   */
-  field: string;
-  /**
-   * The order to sort by.
-   */
-  order: SortingOrder;
-  /**
-   * Metadata about the sort that can be used for rendering.
-   */
-  meta?: SortMeta;
-}
-export interface SortMeta {
-  title: string;
-  /**
-   * Selectable values
-   */
-  values?: SortingOrder[];
-  /**
-   * Names for orders
-   */
-  names?: string[];
-}