@constructor-io/constructorio-node 5.5.1 → 5.8.0

package/src/modules/quizzes.js

@@ -15,6 +15,7 @@ function createQuizUrl(quizId, parameters, userParameters, options, path) {
     clientId,
     userId,
     segments,
+    originReferrer,
   } = userParameters;
   const serviceUrl = 'https://quizzes.cnstrc.com';
   let queryParams = { c: version };
@@ -34,6 +35,11 @@ function createQuizUrl(quizId, parameters, userParameters, options, path) {
     queryParams.ui = String(userId);
   }
 
+  // Pull origin referrer from userParameters
+  if (originReferrer && typeof originReferrer === 'string') {
+    queryParams.origin_referrer = originReferrer;
+  }
+
   // Validate quiz id is provided
   if (!quizId || typeof quizId !== 'string') {
     throw new Error('quizId is a required parameter of type string');
@@ -124,6 +130,7 @@ class Quizzes {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -207,6 +214,7 @@ class Quizzes {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request

package/src/modules/recommendations.js

@@ -15,6 +15,7 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
     clientId,
     userId,
     segments,
+    originReferrer,
   } = userParameters;
   let queryParams = { c: version };
 
@@ -37,6 +38,11 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
     queryParams.ui = String(userId);
   }
 
+  // Pull origin referrer from userParameters
+  if (originReferrer && typeof originReferrer === 'string') {
+    queryParams.origin_referrer = originReferrer;
+  }
+
   if (parameters) {
     const {
       numResults,
@@ -147,6 +153,7 @@ class Recommendations {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request

package/src/modules/search.js

@@ -18,6 +18,7 @@ function createSearchUrl(query, parameters, userParameters, options, isVoiceSear
     userId,
     segments,
     testCells,
+    originReferrer,
   } = userParameters;
   let queryParams = { c: version };
 
@@ -47,6 +48,11 @@ function createSearchUrl(query, parameters, userParameters, options, isVoiceSear
     queryParams.ui = String(userId);
   }
 
+  // Pull origin referrer from userParameters
+  if (originReferrer && typeof originReferrer === 'string') {
+    queryParams.origin_referrer = originReferrer;
+  }
+
   if (parameters) {
     const {
       page,
@@ -186,6 +192,7 @@ class Search {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -288,6 +295,7 @@ class Search {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request

package/src/types/catalog.d.ts

@@ -15,6 +15,10 @@ import {
   SynonymGroup,
   SearchabilityConfiguration,
   SearchabilityConfigurationResponse,
+  FacetConfigurationV2,
+  FacetConfigurationV2Response,
+  SearchabilityConfigurationV2,
+  SearchabilityConfigurationV2Response,
 } from '.';
 
 export default Catalog;
@@ -173,6 +177,7 @@ export interface ReplaceCatalogParameters {
   items?: File | fs.ReadStream | Duplex
   variations?: File | fs.ReadStream | Duplex;
   itemGroups?: File | fs.ReadStream | Duplex;
+  format?: 'csv' | 'jsonl';
 }
 
 export interface UpdateCatalogParameters extends ReplaceCatalogParameters {}
@@ -185,6 +190,7 @@ export interface PatchCatalogParameters {
   items?: File | fs.ReadStream | Duplex
   variations?: File | fs.ReadStream | Duplex;
   itemGroups?: File | fs.ReadStream | Duplex;
+  format?: 'csv' | 'jsonl';
 }
 
 export interface ReplaceCatalogUsingTarArchiveParameters {
@@ -192,6 +198,7 @@ export interface ReplaceCatalogUsingTarArchiveParameters {
   notificationEmail?: string;
   force?: boolean;
   tarArchive?: File | fs.ReadStream | Duplex;
+  format?: 'csv' | 'jsonl';
 }
 
 export interface UpdateCatalogUsingTarArchiveParameters
@@ -272,6 +279,86 @@ export interface PatchSearchabilitiesParameters {
   section?: string;
 }
 
+// V2 Facet Configuration Parameters
+export type AddFacetConfigurationV2Parameters = FacetConfigurationV2;
+
+export type ReplaceFacetConfigurationV2Parameters = FacetConfigurationV2;
+
+export interface GetFacetConfigurationsV2Parameters {
+  page?: number;
+  numResultsPerPage?: number;
+  offset?: number;
+  section?: string;
+}
+
+export interface GetFacetConfigurationV2Parameters {
+  name: string;
+  section?: string;
+}
+
+export interface CreateOrReplaceFacetConfigurationsV2Parameters {
+  facetConfigurations: FacetConfigurationV2[];
+  section?: string;
+}
+
+export interface ModifyFacetConfigurationsV2Parameters {
+  facetConfigurations: (Partial<FacetConfigurationV2> & { name: string })[];
+  section?: string;
+}
+
+export interface RemoveFacetConfigurationV2Parameters {
+  name: string;
+  section?: string;
+}
+
+// V2 Searchabilities Parameters
+export interface RetrieveSearchabilitiesV2Parameters {
+  name?: string;
+  page?: number;
+  offset?: number;
+  numResultsPerPage?: number;
+  fuzzySearchable?: boolean;
+  exactSearchable?: boolean;
+  displayable?: boolean;
+  matchType?: 'and' | 'or';
+  sortBy?: 'name';
+  sortOrder?: 'ascending' | 'descending';
+  section?: string;
+}
+
+export interface RetrieveSearchabilityV2Parameters {
+  name: string;
+  section?: string;
+}
+
+export interface PatchSearchabilitiesV2Parameters {
+  searchabilities: SearchabilityConfigurationV2[];
+  skipRebuild?: boolean;
+  section?: string;
+}
+
+export interface PatchSearchabilityV2Parameters {
+  name: string;
+  fuzzySearchable?: boolean;
+  exactSearchable?: boolean;
+  displayable?: boolean;
+  hidden?: boolean;
+  skipRebuild?: boolean;
+  section?: string;
+}
+
+export interface DeleteSearchabilitiesV2Parameters {
+  searchabilities: { name: string }[];
+  skipRebuild?: boolean;
+  section?: string;
+}
+
+export interface DeleteSearchabilityV2Parameters {
+  name: string;
+  skipRebuild?: boolean;
+  section?: string;
+}
+
 interface CatalogMutationResponse {
   task_id: string;
   task_status_path: string;
@@ -512,11 +599,13 @@ declare class Catalog {
     networkParameters?: NetworkParameters
   ): Promise<CatalogMutationResponse>;
 
+  /** @deprecated Use addFacetConfigurationV2 instead. */
   addFacetConfiguration(
     parameters: FacetConfiguration,
     networkParameters?: NetworkParameters
   ): Promise<FacetConfiguration>;
 
+  /** @deprecated Use getFacetConfigurationsV2 instead. */
   getFacetConfigurations(
     parameters: GetFacetConfigurationsParameters,
     networkParameters?: NetworkParameters
@@ -526,26 +615,31 @@ declare class Catalog {
     [key: string]: any;
   }>;
 
+  /** @deprecated Use getFacetConfigurationV2 instead. */
   getFacetConfiguration(
     parameters: GetFacetConfigurationParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetConfiguration>;
 
+  /** @deprecated Use modifyFacetConfigurationsV2 instead. */
   modifyFacetConfigurations(
     parameters?: ModifyFacetConfigurationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetConfiguration[]>;
 
+  /** @deprecated Use replaceFacetConfigurationV2 instead. */
   replaceFacetConfiguration(
     parameters: FacetConfiguration,
     networkParameters?: NetworkParameters
   ): Promise<FacetConfiguration>;
 
+  /** @deprecated Use modifyFacetConfigurationV2 instead. */
   modifyFacetConfiguration(
     parameters: FacetConfiguration,
     networkParameters?: NetworkParameters
   ): Promise<FacetConfiguration>;
 
+  /** @deprecated Use removeFacetConfigurationV2 instead. */
   removeFacetConfiguration(
     parameters?: RemoveFacetConfigurationParameters,
     networkParameters?: NetworkParameters
@@ -590,6 +684,7 @@ declare class Catalog {
     networkParameters?: NetworkParameters
   ): Promise<FacetOptionConfiguration>;
 
+  /** @deprecated Use retrieveSearchabilitiesV2 instead. */
   retrieveSearchabilities(
     parameters?: RetrieveSearchabilitiesParameters,
     networkParameters?: NetworkParameters
@@ -598,10 +693,99 @@ declare class Catalog {
     total_count: number;
   }>;
 
+  /** @deprecated Use patchSearchabilitiesV2 instead. */
   patchSearchabilities(
     parameters: PatchSearchabilitiesParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     searchabilities: SearchabilityConfigurationResponse[];
   }>;
+
+  // V2 Facet Configuration Methods
+  addFacetConfigurationV2(
+    parameters: AddFacetConfigurationV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<FacetConfigurationV2Response>;
+
+  getFacetConfigurationsV2(
+    parameters?: GetFacetConfigurationsV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    facets: FacetConfigurationV2Response[];
+    total_count: number;
+  }>;
+
+  getFacetConfigurationV2(
+    parameters: GetFacetConfigurationV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<FacetConfigurationV2Response>;
+
+  createOrReplaceFacetConfigurationsV2(
+    parameters: CreateOrReplaceFacetConfigurationsV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    facets: FacetConfigurationV2Response[];
+  }>;
+
+  modifyFacetConfigurationsV2(
+    parameters: ModifyFacetConfigurationsV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    facets: FacetConfigurationV2Response[];
+  }>;
+
+  replaceFacetConfigurationV2(
+    parameters: ReplaceFacetConfigurationV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<FacetConfigurationV2Response>;
+
+  modifyFacetConfigurationV2(
+    parameters: Partial<FacetConfigurationV2> & { name: string },
+    networkParameters?: NetworkParameters
+  ): Promise<FacetConfigurationV2Response>;
+
+  removeFacetConfigurationV2(
+    parameters: RemoveFacetConfigurationV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<FacetConfigurationV2Response>;
+
+  // V2 Searchabilities Methods
+  retrieveSearchabilitiesV2(
+    parameters?: RetrieveSearchabilitiesV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    searchabilities: SearchabilityConfigurationV2Response[];
+    total_count: number;
+  }>;
+
+  retrieveSearchabilityV2(
+    parameters: RetrieveSearchabilityV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<SearchabilityConfigurationV2Response>;
+
+  patchSearchabilitiesV2(
+    parameters: PatchSearchabilitiesV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    searchabilities: SearchabilityConfigurationV2Response[];
+    total_count: number;
+  }>;
+
+  patchSearchabilityV2(
+    parameters: PatchSearchabilityV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<SearchabilityConfigurationV2Response>;
+
+  deleteSearchabilitiesV2(
+    parameters: DeleteSearchabilitiesV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    searchabilities: SearchabilityConfigurationV2Response[];
+    total_count: number;
+  }>;
+
+  deleteSearchabilityV2(
+    parameters: DeleteSearchabilityV2Parameters,
+    networkParameters?: NetworkParameters
+  ): Promise<SearchabilityConfigurationV2Response>;
 }

package/src/types/index.d.ts

@@ -27,6 +27,7 @@ export interface UserParameters {
   userId?: string;
   segments?: string[];
   testCells?: Record<string, any>;
+  originReferrer?: string;
   userIp?: string;
   userAgent?: string;
 }
@@ -335,6 +336,70 @@ export interface SearchabilityConfiguration {
   hidden?: boolean,
 }
 
+// V2 Facet Types
+export interface FacetConfigurationV2Base {
+  name: string;
+  pathInMetadata: string;
+  displayName?: string;
+  sortOrder?: 'relevance' | 'value' | 'num_matches';
+  sortDescending?: boolean;
+  matchType?: 'any' | 'all' | 'none';
+  position?: number | null;
+  hidden?: boolean;
+  protected?: boolean;
+  countable?: boolean;
+  optionsLimit?: number;
+  data?: Record<string, unknown>;
+  section?: string;
+}
+
+export type FacetConfigurationV2 = FacetConfigurationV2Base & (
+  | { type: 'multiple' | 'hierarchical'; rangeType?: null; rangeFormat?: null; rangeInclusive?: null; rangeLimits?: null }
+  | { type: 'range'; rangeFormat: 'boundaries'; rangeType?: 'static'; rangeInclusive?: 'above' | 'below' | null; rangeLimits?: null }
+  | { type: 'range'; rangeFormat: 'options'; rangeLimits: number[]; rangeType?: 'static'; rangeInclusive?: 'above' | 'below' | null }
+);
+
+export interface FacetConfigurationV2Response {
+  name: string;
+  path_in_metadata: string;
+  type: 'multiple' | 'hierarchical' | 'range';
+  display_name?: string | null;
+  sort_order?: 'relevance' | 'value' | 'num_matches';
+  sort_descending?: boolean;
+  range_type?: 'static' | null;
+  range_format?: 'boundaries' | 'options' | null;
+  range_inclusive?: 'above' | 'below' | null;
+  range_limits?: number[] | null;
+  match_type?: 'any' | 'all' | 'none';
+  position?: number | null;
+  hidden?: boolean;
+  protected?: boolean;
+  countable?: boolean;
+  options_limit?: number;
+  data?: Record<string, unknown>;
+  created_at: string;
+  updated_at?: string;
+}
+
+// V2 Searchability Types
+export interface SearchabilityConfigurationV2 {
+  name: string;
+  fuzzySearchable?: boolean;
+  exactSearchable?: boolean;
+  displayable?: boolean;
+  hidden?: boolean;
+}
+
+export interface SearchabilityConfigurationV2Response {
+  name: string;
+  fuzzy_searchable: boolean;
+  exact_searchable: boolean;
+  displayable: boolean;
+  hidden: boolean;
+  created_at: string;
+  updated_at?: string;
+}
+
 export interface ItemTracked {
   itemName?: string;
   itemId?: string;