@constructor-io/constructorio-node 4.6.1 → 4.6.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.6.1",
+  "version": "4.6.3",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",

package/src/modules/catalog.js

@@ -3312,6 +3312,170 @@ class Catalog {
       return helpers.throwHttpErrorFromResponse(new Error(), response);
     });
   }
+
+  /**
+   * Retrieve metadata searchabilities
+   *
+   * @function retrieveSearchabilities
+   * @param {object} [parameters] - Additional parameters for retrieving metadata searchabilities
+   * @param {string} [parameters.name] - Name of metadata searchability. Providing this field would filter the results based on name
+   * @param {number} [parameters.page] - The page number of the results. Can't be used together with 'offset'
+   * @param {number} [parameters.offset] - The number of results to skip from the beginning. Can't be used together with 'page'
+   * @param {number} [parameters.numResultsPerPage] - The number of searchability configurations to return. Defaults to 100
+   * @param {object} [parameters.filters] - Filters the results based on name, exactSearchable or fuzzySearchable
+   * @param {boolean} [parameters.searchable] - Retrieve only results which are either exactSearchable or fuzzySearchable
+   * @param {string} [parameters.sortBy] - The criteria by which searchability configurations should be sorted. Defaults to no sorting. Valid criteria is name
+   * @param {string} [parameters.sortOrder] - Either descending or ascending. The sort order by which searchability configurations should be sorted. Only valid in conjunction with sortBy
+   * @param {string} [parameters.section] - The section in which the searchability is defined. Default value is Products
+   * @param {object} [networkParameters] - Parameters relevant to the network request
+   * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+   * @returns {Promise}
+   * @see https://docs.constructor.io/rest_api/searchabilities/#retrieve-searchabilities
+   * @example
+   * constructorio.catalog.retrieveSearchabilities({
+   *     page: 2,
+   *     numResultsPerPage: 50,
+   *     filters: { exactSearchable: true }
+   * });
+   */
+  retrieveSearchabilities(parameters = {}, networkParameters = {}) {
+    let requestUrl;
+    const { fetch } = this.options;
+    const controller = new AbortController();
+    const { signal } = controller;
+    const { name, page, offset, numResultsPerPage, filters, searchable, sortBy, sortOrder, section = 'Products' } = parameters;
+    const additionalQueryParams = {};
+
+    if (!helpers.isNil(page)) {
+      additionalQueryParams.page = page;
+    }
+
+    if (!helpers.isNil(offset)) {
+      additionalQueryParams.offset = offset;
+    }
+
+    if (!helpers.isNil(numResultsPerPage)) {
+      additionalQueryParams.num_results_per_page = numResultsPerPage;
+    }
+
+    if (filters) {
+      additionalQueryParams.filters = toSnakeCaseKeys(filters);
+    }
+
+    if (searchable) {
+      additionalQueryParams.searchable = searchable;
+    }
+
+    if (sortBy) {
+      additionalQueryParams.sort_by = sortBy;
+    }
+
+    if (sortOrder) {
+      additionalQueryParams.sort_order = sortOrder;
+    }
+
+    if (sortOrder) {
+      additionalQueryParams.sort_order = sortOrder;
+    }
+
+    if (section) {
+      additionalQueryParams.section = section;
+    }
+
+    if (name) {
+      if (additionalQueryParams.filters) {
+        additionalQueryParams.filters.name = name;
+      } else {
+        additionalQueryParams.filters = { name };
+      }
+    }
+
+    try {
+      requestUrl = createCatalogUrl('searchabilities', this.options, additionalQueryParams);
+    } catch (e) {
+      return Promise.reject(e);
+    }
+
+    // Handle network timeout if specified
+    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+    return fetch(requestUrl, {
+      method: 'GET',
+      headers: {
+        'Content-Type': 'application/json',
+        ...helpers.createAuthHeader(this.options),
+      },
+      signal,
+    }).then((response) => {
+      if (response.ok) {
+        return response.json();
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    });
+  }
+
+  /**
+   * Patch metadata searchabilities
+   *
+   * @function patchSearchabilities
+   * @param {object} parameters - Additional parameters for patching metadata searchabilities
+   * @param {object[]} parameters.searchabilities - Array of searchabilities. Additional information about the searchabilities schema can be found [here]{@link https://docs.constructor.io/rest_api/searchabilities/#patch-searchabilities}
+   * @param {string} [parameters.section] - The section in which the searchability is defined. Default value is Products
+   * @param {object} [networkParameters] - Parameters relevant to the network request
+   * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+   * @returns {Promise}
+   * @see https://docs.constructor.io/rest_api/searchabilities/#patch-searchabilities
+   * @example
+   * constructorio.catalog.patchSearchabilities({
+   *   searchabilities: [
+   *     {
+   *       name: 'style_id',
+   *       exactSearchable: true,
+   *     },
+   *     {
+   *       name: 'keywords',
+   *       fuzzySearchable: true,
+   *     },
+   *   ],
+   * });
+   */
+  patchSearchabilities(parameters = {}, networkParameters = {}) {
+    let requestUrl;
+    const { fetch } = this.options;
+    const controller = new AbortController();
+    const { signal } = controller;
+    const { searchabilities: searchabilitiesRaw, section = 'Products' } = parameters;
+    const searchabilities = searchabilitiesRaw?.map((config) => toSnakeCaseKeys(config));
+    const additionalQueryParams = {
+      section,
+    };
+
+    try {
+      requestUrl = createCatalogUrl('searchabilities', this.options, additionalQueryParams);
+    } catch (e) {
+      return Promise.reject(e);
+    }
+
+    // Handle network timeout if specified
+    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+    return fetch(requestUrl, {
+      method: 'PATCH',
+      body: JSON.stringify({ searchabilities }),
+      headers: {
+        'Content-Type': 'application/json',
+        ...helpers.createAuthHeader(this.options),
+      },
+      signal,
+    }).then((response) => {
+      if (response.ok) {
+        return response.json();
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    });
+  }
 }
 
 module.exports = Catalog;

package/src/types/catalog.d.ts

@@ -10,6 +10,8 @@ import {
   RedirectRuleResponse,
   OneWaySynonymRelation,
   SynonymGroup,
+  SearchabilityConfiguration,
+  SearchabilityConfigurationResponse,
 } from '.';
 
 export default Catalog;
@@ -21,7 +23,9 @@ export interface CreateOrReplaceItemsParameters {
   section?: string;
 }
 
-export interface UpdateItemsParameters extends CreateOrReplaceItemsParameters {}
+export interface UpdateItemsParameters extends CreateOrReplaceItemsParameters {
+  onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
+}
 
 export interface DeleteItemsParameters {
   items: Pick<Item, 'id'>[];
@@ -44,7 +48,9 @@ export interface CreateOrReplaceVariationsParameters {
 }
 
 export interface UpdateVariationsParameters
-  extends CreateOrReplaceVariationsParameters {}
+  extends CreateOrReplaceVariationsParameters {
+    onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
+  }
 
 export interface DeleteVariationsParameters {
   variations: Pick<Variation, 'id'>[];
@@ -64,12 +70,12 @@ export interface RetrieveVariationsParameters {
 export interface AddItemGroupParameters {
   id: string;
   name: string;
-  parent_id?: string;
+  parentId?: string;
   data?: Record<string, any>;
 }
 
 export interface AddItemGroupsParameters {
-  item_groups: ItemGroup[];
+  itemGroups: ItemGroup[];
 }
 
 export interface GetItemGroupParameters {
@@ -81,7 +87,7 @@ export interface AddOrUpdateItemGroupsParameters
 
 export interface AddOneWaySynonymParameters {
   phrase: string;
-  child_phrases: string[];
+  childPhrases: string[];
 }
 
 export interface ModifyOneWaySynonymParameters
@@ -92,7 +98,7 @@ export interface GetOneWaySynonymParameters {
 }
 
 export interface GetOneWaySynonymsParameters {
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   page?: number;
 }
 
@@ -105,7 +111,6 @@ export interface AddSynonymGroupParameters {
 }
 
 export interface ModifySynonymGroupParameters {
-  id: number;
   synonyms: string[];
 }
 
@@ -115,7 +120,7 @@ export interface GetSynonymGroupParameters {
 
 export interface GetSynonymGroupsParameters {
   phrase?: string;
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   page?: number;
 }
 
@@ -126,9 +131,9 @@ export interface RemoveSynonymGroupParameters {
 export interface AddRedirectRuleParameters {
   url: string;
   matches: RedirectRuleMatchObject[];
-  start_time?: string;
-  end_time?: string;
-  user_segments?: string[];
+  startTime?: string;
+  endTime?: string;
+  userSegments?: string[];
   metadata?: Record<string, any>;
 }
 
@@ -147,7 +152,7 @@ export interface GetRedirectRuleParameters {
 }
 
 export interface GetRedirectRulesParameters {
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   page?: number;
   query?: string;
   status?: string;
@@ -159,28 +164,28 @@ export interface RemoveRedirectRuleParameters {
 
 export interface ReplaceCatalogParameters {
   section: string;
-  notification_email?: string;
+  notificationEmail?: string;
   force?: boolean;
   items?: File;
   variations?: File;
-  item_groups?: File;
+  itemGroups?: File;
 }
 
 export interface UpdateCatalogParameters extends ReplaceCatalogParameters {}
 
 export interface PatchCatalogParameters {
   section: string;
-  notification_email?: string;
+  notificationEmail?: string;
   force?: boolean;
   onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
   items?: File;
   variations?: File;
-  item_groups?: File;
+  itemGroups?: File;
 }
 
 export interface ReplaceCatalogUsingTarArchiveParameters {
   section: string;
-  notification_email?: string;
+  notificationEmail?: string;
   force?: boolean;
   tarArchive?: File;
 }
@@ -189,11 +194,13 @@ export interface UpdateCatalogUsingTarArchiveParameters
   extends ReplaceCatalogUsingTarArchiveParameters {}
 
 export interface PatchCatalogUsingTarArchiveParameters
-  extends ReplaceCatalogUsingTarArchiveParameters {}
+  extends ReplaceCatalogUsingTarArchiveParameters {
+    onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
+  }
 
 export interface GetFacetConfigurationsParameters {
   page?: number;
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   section?: string;
 }
 
@@ -225,7 +232,7 @@ export interface AddOrModifyFacetOptionConfigurationsParameters {
 export interface GetFacetOptionConfigurationsParameters {
   facetGroupName: string;
   page?: number;
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   section?: string;
 }
 
@@ -244,6 +251,22 @@ export type ModifyFacetOptionConfigurationParameters = ReplaceFacetOptionConfigu
 
 export interface RemoveFacetOptionConfiguration extends GetFacetOptionConfigurationParameters {}
 
+export interface RetrieveSearchabilitiesParameters {
+  name?: string;
+  page?: number;
+  offset?: number;
+  numResultsPerPage?: number;
+  filters?: Record<string, any>;
+  searchable?: boolean;
+  sortBy?: string;
+  sortOrder?: string;
+  section?: string;
+}
+
+export interface PatchSearchabilitiesParameters {
+  searchabilities: SearchabilityConfiguration[],
+}
+
 declare class Catalog {
   constructor(options: ConstructorClientOptions);
 
@@ -579,4 +602,19 @@ declare class Catalog {
     parameters: RemoveFacetOptionConfiguration,
     networkParameters?: NetworkParameters
   ): Promise<FacetOptionConfiguration>;
+
+  retrieveSearchabilities(
+    parameters?: RetrieveSearchabilitiesParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    searchabilities: SearchabilityConfigurationResponse[];
+    total_count: number;
+  }>;
+
+  patchSearchabilities(
+    parameters: PatchSearchabilitiesParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    searchabilities: SearchabilityConfigurationResponse[];
+  }>;
 }

package/src/types/index.d.ts

@@ -298,3 +298,23 @@ export type FilterExpressionRange = {
 };
 
 export type FilterExpressionRangeValue = ['-inf' | number, 'inf' | number];
+
+export interface SearchabilityConfigurationResponse {
+  name: string;
+  fuzzy_searchable: boolean,
+  exact_searchable: boolean,
+  type: string,
+  displayable: boolean,
+  hidden: boolean,
+  created_at: string,
+  updated_at: string
+}
+
+export interface SearchabilityConfiguration {
+  name: string;
+  fuzzySearchable?: boolean,
+  exactSearchable?: boolean,
+  type?: string,
+  displayable?: boolean,
+  hidden?: boolean,
+}

package/src/types/tests/catalog.test-d.ts

@@ -7,6 +7,7 @@ import {
   OneWaySynonymRelation,
   RedirectRuleResponse,
   Variation,
+  SearchabilityConfigurationResponse,
 } from '..';
 
 expectAssignable<Item>({
@@ -107,3 +108,14 @@ expectAssignable<FacetOptionConfiguration>({
   data: null,
   hidden: false,
 });
+
+expectAssignable<SearchabilityConfigurationResponse>({
+  name: 'groups',
+  fuzzy_searchable: false,
+  exact_searchable: false,
+  type: 'string',
+  displayable: true,
+  hidden: false,
+  created_at: '2019-04-12T18:15:30',
+  updated_at: '2019-04-12T18:15:30',
+});

package/src/types/tracker.d.ts

@@ -35,9 +35,10 @@ declare class Tracker {
 
   trackItemDetailLoad(
     parameters: {
-      item_name: string;
-      item_id: string;
-      variation_id?: string;
+      itemName: string;
+      itemId: string;
+      url: string;
+      variationId?: string;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -46,11 +47,11 @@ declare class Tracker {
   trackAutocompleteSelect(
     term: string,
     parameters: {
-      original_query: string;
+      originalQuery: string;
       section: string;
       tr?: string;
-      group_id?: string;
-      display_name?: string;
+      groupId?: string;
+      displayName?: string;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -59,9 +60,9 @@ declare class Tracker {
   trackSearchSubmit(
     term: string,
     parameters: {
-      original_query: string;
-      group_id?: string;
-      display_name?: string;
+      originalQuery: string;
+      groupId?: string;
+      displayName?: string;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -70,8 +71,8 @@ declare class Tracker {
   trackSearchResultsLoaded(
     term: string,
     parameters: {
-      num_results: number;
-      item_ids?: string[];
+      numResults: number;
+      itemIds?: string[];
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -80,11 +81,11 @@ declare class Tracker {
   trackSearchResultClick(
     term: string,
     parameters: {
-      item_name: string;
-      item_id: string;
-      variation_id?: string;
-      result_id?: string;
-      item_is_convertible?: string;
+      itemName: string;
+      itemId: string;
+      variationId?: string;
+      resultId?: string;
+      itemIsConvertible?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,
@@ -94,14 +95,14 @@ declare class Tracker {
   trackConversion(
     term : string | null | undefined,
     parameters: {
-      item_id: string;
+      itemId: string;
       revenue?: number;
-      item_name?: string;
-      variation_id?: string;
+      itemName?: string;
+      variationId?: string;
       type?: string;
-      is_custom_type?: boolean;
-      display_name?: string;
-      result_id?: string;
+      isCustomType?: boolean;
+      displayName?: string;
+      resultId?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,
@@ -112,7 +113,7 @@ declare class Tracker {
     parameters: {
       items: object[];
       revenue: number;
-      order_id?: string;
+      orderId?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,
@@ -122,12 +123,12 @@ declare class Tracker {
   trackRecommendationView(
     parameters: {
       url: string;
-      pod_id: string;
-      num_results_viewed: number;
+      podId: string;
+      numResultsViewed: number;
       items?: object[];
-      result_count?: number;
-      result_page?: number;
-      result_id?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,
@@ -136,17 +137,17 @@ declare class Tracker {
 
   trackRecommendationClick(
     parameters: {
-      pod_id: string;
-      strategy_id: string;
-      item_id: string;
-      item_name: string;
-      variation_id?: string;
+      podId: string;
+      strategyId: string;
+      itemId: string;
+      itemName: string;
+      variationId?: string;
       section?: string;
-      result_id?: string;
-      result_count?: number;
-      result_page?: number;
-      result_position_on_page?: number;
-      num_results_per_page?: number;
+      resultId?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultPositionOnPage?: number;
+      numResultsPerPage?: number;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -155,15 +156,15 @@ declare class Tracker {
   trackBrowseResultsLoaded(
     parameters: {
       url: string;
-      filter_name: string;
-      filter_value: string;
+      filterName: string;
+      filterValue: string;
       section?: string;
-      result_count?: number;
-      result_page?: number;
-      result_id?: string;
-      selected_filters?: object;
-      sort_order?: string;
-      sort_by?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
+      selectedFilters?: object;
+      sortOrder?: string;
+      sortBy?: string;
       items?: object[];
     },
     userParameters?: TrackerUserParameters,
@@ -172,17 +173,17 @@ declare class Tracker {
 
   trackBrowseResultClick(
     parameters: {
-      filter_name: string;
-      filter_value: string;
-      item_id: string;
+      filterName: string;
+      filterValue: string;
+      itemId: string;
       section?: string;
-      variation_id?: string;
-      result_id?: string;
-      result_count?: number;
-      result_page?: number;
-      result_position_on_page?: number;
-      num_results_per_page?: number;
-      selected_filters?: object;
+      variationId?: string;
+      resultId?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultPositionOnPage?: number;
+      numResultsPerPage?: number;
+      selectedFilters?: object;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -190,9 +191,9 @@ declare class Tracker {
 
   trackGenericResultClick(
     parameters: {
-      item_id: string;
-      item_name?: string;
-      variation_id?: string;
+      itemId: string;
+      itemName?: string;
+      variationId?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,