@constructor-io/constructorio-client-javascript 2.34.2 → 2.34.4

package/lib/modules/quizzes.js

@@ -119,7 +119,7 @@ var Quizzes = /*#__PURE__*/function () {
 
   (0, _createClass2["default"])(Quizzes, [{
     key: "getQuizNextQuestion",
-    value: function getQuizNextQuestion(quizId, parameters) {
+    value: function getQuizNextQuestion(id, parameters) {
       var _this = this;
 
       var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
@@ -129,7 +129,7 @@ var Quizzes = /*#__PURE__*/function () {
       var signal = controller.signal;
 
       try {
-        requestUrl = createQuizUrl(quizId, parameters, this.options, 'next');
+        requestUrl = createQuizUrl(id, parameters, this.options, 'next');
       } catch (e) {
         return Promise.reject(e);
       } // Handle network timeout if specified
@@ -178,7 +178,7 @@ var Quizzes = /*#__PURE__*/function () {
 
   }, {
     key: "getQuizResults",
-    value: function getQuizResults(quizId, parameters) {
+    value: function getQuizResults(id, parameters) {
       var _this2 = this;
 
       var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
@@ -188,7 +188,7 @@ var Quizzes = /*#__PURE__*/function () {
       var signal = controller.signal;
 
       try {
-        requestUrl = createQuizUrl(quizId, parameters, this.options, 'finalize');
+        requestUrl = createQuizUrl(id, parameters, this.options, 'finalize');
       } catch (e) {
         return Promise.reject(e);
       } // Handle network timeout if specified

package/lib/types/autocomplete.d.ts

@@ -1,67 +1,59 @@
 import {
-	ConstructorClientOptions,
-	RequestFeature,
-	RequestFeatureVariant,
-} from "./types";
-import EventDispatcher from "./event-dispatcher";
-
-/***************
- *
- * 	Autocomplete
- *
- ***************/
-export = Autocomplete;
-
-interface IAutocompleteParameters {
-	numResults: number;
-	filters: Record<string, any>;
-	resultsPerSection: Record<string, number>;
-	hiddenFields: string[];
-	variationsMap: Record<string, any>;
+  ConstructorClientOptions,
+  NetworkParameters,
+  RequestFeature,
+  RequestFeatureVariant,
+} from '.';
+import EventDispatcher from './event-dispatcher';
+
+export default Autocomplete;
+
+export interface IAutocompleteParameters {
+  numResults?: number;
+  filters?: Record<string, any>;
+  resultsPerSection?: Record<string, number>;
+  hiddenFields?: string[];
+  variationsMap?: Record<string, any>;
 }
 
 declare class Autocomplete {
-	constructor(options: ConstructorClientOptions);
-	options: ConstructorClientOptions;
-	eventDispatcher: EventDispatcher;
+  constructor(options: ConstructorClientOptions);
+
+  options: ConstructorClientOptions;
+
+  eventDispatcher: EventDispatcher;
 
-	getAutocompleteResults(
-		query: string,
-		parameters?: IAutocompleteParameters,
-		networkParameters?: {
-			timeout?: number;
-		}
-	): Promise<Autocomplete.AutocompleteResponse>;
+  getAutocompleteResults(
+    query: string,
+    parameters?: IAutocompleteParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<AutocompleteResponse>;
 }
 
-/***********
- *
- * 	Autocomplete results returned from server
- *
- ***********/
-declare namespace Autocomplete {
-	export interface AutocompleteResponse extends Record<string, any> {
-		request: Partial<Request>;
-		sections: Record<string, Section>;
-		result_id: string;
-	}
+/** *********
+ * Autocomplete results returned from server
+ ********** */
+export interface AutocompleteResponse extends Record<string, any> {
+  request: Partial<AutocompleteRequestType>;
+  sections: Record<string, Section>;
+  result_id: string;
 }
 
-interface Request extends Record<string, any> {
-	num_results: number;
-	term: string;
-	query: string;
-	features: Partial<RequestFeature>;
-	feature_variants: Partial<RequestFeatureVariant>;
-	searchandized_items: Record<string, any>;
+export interface AutocompleteRequestType extends Record<string, any> {
+  num_results: number;
+  term: string;
+  query: string;
+  features: Partial<RequestFeature>;
+  feature_variants: Partial<RequestFeatureVariant>;
+  searchandized_items: Record<string, any>;
 }
 
-type Section = Partial<SectionItem>[]
+export type Section = Partial<SectionItem>[];
 
-interface SectionItem extends Record<string, any> {
-	data: Record<string, any>;
-	is_slotted: boolean;
-	labels: Record<string, any>;
-	matched_terms: string[];
-	value: string;
+export interface SectionItem extends Record<string, any> {
+  data: Record<string, any>;
+  is_slotted: boolean;
+  labels: Record<string, any>;
+  matched_terms: string[];
+  value: string;
 }

package/lib/types/browse.d.ts

@@ -1,133 +1,141 @@
-import { Collection, ConstructorClientOptions, ErrorData, Facet, Feature, Group, RequestFeature, RequestFeatureVariant, ResultSources, SortOption } from "./types";
-import EventDispatcher from "./event-dispatcher";
+import {
+  Collection,
+  ConstructorClientOptions,
+  Facet,
+  Feature,
+  FilterExpression,
+  Group,
+  NetworkParameters,
+  RequestFeature,
+  RequestFeatureVariant,
+  ResultSources,
+  SortOption,
+} from '.';
+import EventDispatcher from './event-dispatcher';
 
-/*********
- *
- * 	Browse
- *
- *********/
-export = Browse;
+export default Browse;
 
-interface IBrowseParameters {
-	page?: number;
-	offset?: number;
-	resultsPerPage?: number;
-	filters?: Record<string, any>;
-	sortBy?: string;
-	sortOrder?: string;
-	section?: string;
-	fmtOptions?: object;
-	preFilterExpression: Record<string, any>;
-	hiddenFields?: string[];
-	hiddenFacets?: string[];
-	variationsMap?: Record<string, any>;
-	qs?: Record<string, any>;
+export interface IBrowseParameters {
+  page?: number;
+  offset?: number;
+  resultsPerPage?: number;
+  filters?: Record<string, any>;
+  sortBy?: string;
+  sortOrder?: string;
+  section?: string;
+  fmtOptions?: Record<string, any>;
+  preFilterExpression: FilterExpression;
+  hiddenFields?: string[];
+  hiddenFacets?: string[];
+  variationsMap?: Record<string, any>;
+  qs?: Record<string, any>;
 }
 
 declare class Browse {
-	constructor(options: ConstructorClientOptions);
-	options: ConstructorClientOptions;
-	eventDispatcher: EventDispatcher;
+  constructor(options: ConstructorClientOptions);
 
-	getBrowseResults(
-		filterName: string,
-		filterValue: string,
-		parameters?: IBrowseParameters,
-		networkParameters?: {
-			timeout?: number;
-		}
-	): Promise<Browse.GetBrowseResultsResponse>;
+  options: ConstructorClientOptions;
 
-	getBrowseResultsForItemIds(
-		itemIds: string[],
-		parameters?: Omit<IBrowseParameters, "preFilterExpression" | "preFilterExpression">,
-		networkParameters?: {
-			timeout?: number;
-		}
-	): Promise<Browse.GetBrowseResultsForItemIdsResponse>;
+  eventDispatcher: EventDispatcher;
 
-	getBrowseGroups(
-		parameters: Pick<IBrowseParameters, "filters" | "section" | "fmtOptions">,
-		networkParameters?: {
-			timeout?: number;
-		}
-	): Promise<Browse.GetBrowseGroupsResponse>;
+  getBrowseResults(
+    filterName: string,
+    filterValue: string,
+    parameters?: IBrowseParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<GetBrowseResultsResponse>;
 
-	getBrowseFacets(
-		parameters?: Pick<IBrowseParameters, "page" | "offset" | "section" | "fmtOptions"| "resultsPerPage">,
-		networkParameters?: {
-			timeout?: number;
-		}
-	): Promise<Browse.GetBrowseFacetsResponse>;
+  getBrowseResultsForItemIds(
+    itemIds: string[],
+    parameters?: Omit<IBrowseParameters, 'preFilterExpression' | 'qs'>,
+    networkParameters?: NetworkParameters
+  ): Promise<GetBrowseResultsForItemIdsResponse>;
 
-	getBrowseFacetOptions(
-		facetName: string,
-		parameters?: Pick<IBrowseParameters, "section" | "fmtOptions">,
-		networkParameters?: {
-			timeout?: number;
-		}
-	): Promise<Browse.GetBrowseFacetOptionsResponse>;
+  getBrowseGroups(
+    parameters?: Pick<IBrowseParameters, 'filters' | 'section' | 'fmtOptions'>,
+    networkParameters?: NetworkParameters
+  ): Promise<GetBrowseGroupsResponse>;
+
+  getBrowseFacets(
+    parameters?: Pick<
+      IBrowseParameters,
+      'page' | 'offset' | 'section' | 'fmtOptions' | 'resultsPerPage'
+    >,
+    networkParameters?: NetworkParameters
+  ): Promise<GetBrowseFacetsResponse>;
+
+  getBrowseFacetOptions(
+    facetName: string,
+    parameters?: Pick<IBrowseParameters, 'section' | 'fmtOptions'>,
+    networkParameters?: NetworkParameters
+  ): Promise<GetBrowseFacetOptionsResponse>;
 }
 
-/***********
- *
- * 	Browse results returned from server
- *
- ***********/
-declare namespace Browse {
-	export type GetBrowseResultsResponse = BrowseResponse<GetBrowseResultsResponseData>;
-	export type GetBrowseResultsForItemIdsResponse = BrowseResponse<GetBrowseResultsResponseData>;
-	export type GetBrowseGroupsResponse = BrowseResponse<Pick<GetBrowseResultsResponseData, "result_sources" | "groups" | "refined_content">>;
-	export type GetBrowseFacetsResponse = BrowseResponse<Pick<GetBrowseResultsResponseData, "facets" | "total_num_results">>;
-	export type GetBrowseFacetOptionsResponse = BrowseResponse<Pick<GetBrowseResultsResponseData, "facets">>;
+/** *********
+ * Browse results returned from server
+ ********** */
+export interface BrowseResponse<ResponseType> extends Record<string, any> {
+  request?: Partial<BrowseRequestType>;
+  response?: Partial<ResponseType>;
+  result_id?: string;
+  ad_based?: boolean;
 }
 
-interface BrowseResponse<ResponseType> extends Record<string, any> {
-	request?: Partial<Request>;
-	response?: Partial<ResponseType>;
-	result_id?: string;
-	ad_based?: boolean;
+export type GetBrowseResultsResponse =
+  BrowseResponse<GetBrowseResultsResponseData>;
+export type GetBrowseResultsForItemIdsResponse =
+  BrowseResponse<GetBrowseResultsResponseData>;
+export type GetBrowseGroupsResponse = BrowseResponse<
+  Pick<
+    GetBrowseResultsResponseData,
+    'result_sources' | 'groups' | 'refined_content'
+  >
+>;
+export type GetBrowseFacetsResponse = BrowseResponse<
+  Pick<GetBrowseResultsResponseData, 'facets' | 'total_num_results'>
+>;
+export type GetBrowseFacetOptionsResponse = BrowseResponse<
+  Pick<GetBrowseResultsResponseData, 'facets'>
+>;
 
+export interface GetBrowseResultsResponseData extends Record<string, any> {
+  result_sources: Partial<ResultSources>;
+  facets: Partial<Facet>[];
+  groups: Partial<Group>[];
+  results: Partial<BrowseResultData>[];
+  sort_options: Partial<SortOption>[];
+  refined_content: Record<string, any>[];
+  total_num_results: number;
+  features: Partial<Feature>[];
+  collection: Partial<Collection>;
 }
 
-interface GetBrowseResultsResponseData extends Record<string, any> {
-	result_sources: Partial<ResultSources>;
-	facets: Partial<Facet>[];
-	groups: Partial<Group>[];
-	results: Partial<BrowseResultData>[];
-	sort_options: Partial<SortOption>[];
-	refined_content: Record<string, any>[];
-	total_num_results: number;
-	features: Partial<Feature>[];
-	collection: Partial<Collection>
+export interface BrowseResultData extends Record<string, any> {
+  matched_terms: string[];
+  data: {
+    id: string;
+    [key: string]: any;
+  };
+  value: string;
+  is_slotted: false;
+  labels: Record<string, any>;
+  variations: Record<string, any>[];
 }
 
-interface BrowseResultData extends Record<string, any> {
-	matched_terms: string[];
-	data: {
-		id: string;
-		[key: string]: any;
-	};
-	value: string;
-	is_slotted: false;
-	labels: Record<string, any>;
-	variations: Record<string, any>[];
+export interface BrowseRequestType extends Record<string, any> {
+  browse_filter_name: string;
+  browse_filter_value: string;
+  filter_match_types: Record<string, any>;
+  filters: Record<string, any>;
+  fmt_options: Record<string, any>;
+  num_results_per_page: number;
+  page: number;
+  section: string;
+  sort_by: string;
+  sort_order: string;
+  term: string;
+  query: string;
+  features: Partial<RequestFeature>;
+  feature_variants: Partial<RequestFeatureVariant>;
+  searchandized_items: Record<string, any>;
 }
-
-interface Request extends Record<string, any> {
-	browse_filter_name: string;
-	browse_filter_value: string;
-	filter_match_types: Record<string, any>,
-	filters: Record<string, any>,
-	fmt_options: Record<string, any>,
-	num_results_per_page: number;
-	page: number,
-	section: string,
-	sort_by: string,
-	sort_order: string,
-	term: string;
-	query: string;
-	features: Partial<RequestFeature>;
-	feature_variants: Partial<RequestFeatureVariant>;
-	searchandized_items: Record<string, any>;
-}

package/lib/types/constructorio.d.ts

@@ -1,29 +1,30 @@
-import Search from "./search";
-import Browse from "./browse";
-import Autocomplete from "./autocomplete";
-import Recommendations from "./recommendations";
-import Tracker from "./tracker";
-import { ConstructorClientOptions } from "./types";
+import Search from './search';
+import Browse from './browse';
+import Autocomplete from './autocomplete';
+import Recommendations from './recommendations';
+import Tracker from './tracker';
+import { ConstructorClientOptions } from '.';
 
 export = ConstructorIO;
 
-/*********************
- *
- * 	Constructor client
- *
- *********************/
 declare class ConstructorIO {
-	constructor(options: ConstructorClientOptions);
-	private options: ConstructorClientOptions;
-	search: Search;
-	browse: Browse;
-	autocomplete: Autocomplete;
-	recommendations: Recommendations;
-	tracker: Tracker;
-
-	setClientOptions(options: ConstructorClientOptions): void;
+  constructor(options: ConstructorClientOptions);
+
+  private options: ConstructorClientOptions;
+
+  search: Search;
+
+  browse: Browse;
+
+  autocomplete: Autocomplete;
+
+  recommendations: Recommendations;
+
+  tracker: Tracker;
+
+  setClientOptions(options: ConstructorClientOptions): void;
 }
 
 declare namespace ConstructorIO {
-	export { Tracker }
-}
+  export { Search, Browse, Autocomplete, Recommendations, Tracker };
+}

package/lib/types/event-dispatcher.d.ts

@@ -1,13 +1,19 @@
-import { ConstructorClientOptions } from "./types";
+import { ConstructorClientOptions } from '.';
 
-export = EventDispatcher;
+export default EventDispatcher;
 
 declare class EventDispatcher {
-	constructor(options: ConstructorClientOptions);
-	events: { name: string; data: Record<string, any> }[];
-	enabled: boolean;
-	waitForBeacon: boolean;
-	active: boolean;
-	queue(name: string, data: Record<string, any>): void;
-	dispatchEvents(): void;
+  constructor(options: ConstructorClientOptions);
+
+  events: { name: string; data: Record<string, any> }[];
+
+  enabled: boolean;
+
+  waitForBeacon: boolean;
+
+  active: boolean;
+
+  queue(name: string, data: Record<string, any>): void;
+
+  dispatchEvents(): void;
 }

package/lib/types/index.d.ts

@@ -0,0 +1,182 @@
+import EventDispatcher from './event-dispatcher';
+
+export * from './search';
+export * from './autocomplete';
+export * from './quizzes';
+export * from './recommendations';
+export * from './browse';
+export * from './tracker';
+export * from './event-dispatcher';
+
+export interface NetworkParameters extends Record<string, any> {
+  timeout?: number;
+}
+
+export interface IdOptions extends Record<string, any> {
+  base_url?: string;
+  ip_address?: string;
+  user_agent?: string;
+  timeout?: number;
+  persist?: boolean;
+  cookie_name_client_id?: string;
+  cookie_name_session_id?: string;
+  cookie_name_session_data?: string;
+  local_name_client_id?: string;
+  local_name_session_id?: string;
+  local_name_session_data?: string;
+  cookie_prefix_for_experiment?: string;
+  cookie_domain?: string;
+  cookie_days_to_live?: number;
+  on_node?: boolean;
+  session_is_new?: boolean;
+  client_id_storage_location?: string;
+  session_id_storage_location?: string;
+}
+
+export interface ConstructorClientOptions {
+  apiKey: string;
+  version?: string;
+  serviceUrl?: string;
+  sessionId?: string;
+  clientId?: string;
+  userId?: string;
+  segments?: string[];
+  testCells?: Record<string, string>;
+  idOptions?: IdOptions;
+  fetch?: any;
+  trackingSendDelay?: number;
+  sendTrackingEvents?: boolean;
+  sendReferrerWithTrackingEvents?: boolean;
+  eventDispatcher?: EventDispatcher;
+  beaconMode?: boolean;
+  networkParameters?: NetworkParameters;
+}
+
+export interface RequestFeature extends Record<string, any> {
+  query_items: boolean;
+  auto_generated_refined_query_rules: boolean;
+  manual_searchandizing: boolean;
+  personalization: boolean;
+  filter_items: boolean;
+}
+
+export interface RequestFeatureVariant extends Record<string, any> {
+  query_items: string;
+  auto_generated_refined_query_rules: string;
+  manual_searchandizing: string | null;
+  personalization: string;
+  filter_items: string;
+}
+
+export type ErrorData = {
+  message: string;
+  [key: string]: any;
+};
+
+export interface ResultSources extends Record<string, any> {
+  token_match: { count: number; [key: string]: any };
+  embeddings_match: { count: number; [key: string]: any };
+}
+
+export interface SortOption extends Record<string, any> {
+  sort_by: string;
+  display_name: string;
+  sort_order: string;
+  status: string;
+}
+
+export interface Feature extends Record<string, any> {
+  feature_name: string;
+  display_name: string;
+  enabled: boolean;
+  variant: {
+    name: string;
+    display_name: string;
+    [key: string]: any;
+  };
+}
+
+export interface FmtOption extends Record<string, any> {
+  groups_start: string;
+  groups_max_depth: number;
+}
+
+export type Facet = RangeFacet | OptionFacet;
+
+export interface BaseFacet extends Record<string, any> {
+  data: Record<string, any>;
+  status: Record<string, any>;
+  display_name: string;
+  name: string;
+  hidden: boolean;
+}
+
+export interface RangeFacet extends BaseFacet, Record<string, any> {
+  max: number;
+  min: number;
+  type: 'range';
+}
+
+export interface OptionFacet extends BaseFacet, Record<string, any> {
+  options: FacetOption[];
+  type: 'multiple' | 'single' | 'hierarchical';
+}
+
+export interface FacetOption extends Record<string, any> {
+  count: number;
+  display_name: string;
+  value: string;
+  options?: FacetOption[];
+  range?: ['-inf' | number, 'inf' | number];
+  status: string;
+}
+
+export interface Group extends BaseGroup, Record<string, any> {
+  count: number;
+  data: Record<string, any>;
+  parents: BaseGroup[];
+  children: Group[];
+}
+
+export interface Collection extends Record<string, any> {
+  collection_id: string;
+  display_name: string;
+  data: Record<string, any>;
+}
+
+export interface BaseGroup extends Record<string, any> {
+  display_name: string;
+  group_id: string;
+}
+
+export interface FmtOptions extends Record<string, any> {}
+
+export type Nullable<T> = T | null;
+
+export type FilterExpression =
+  | FilterExpressionGroup
+  | FilterExpressionNot
+  | FilterExpressionValue
+  | FilterExpressionRange;
+
+export type FilterExpressionGroup =
+  | FilterExpressionGroupOr
+  | FilterExpressionGroupAnd;
+
+export type FilterExpressionGroupOr = { or: FilterExpression[] };
+export type FilterExpressionGroupAnd = { and: FilterExpression[] };
+export type FilterExpressionCondition = 'or' | 'and';
+
+export type FilterExpressionNot = { not: FilterExpression };
+
+export type FilterExpressionValue = {
+  name: string;
+  value: string;
+};
+
+export type FilterExpressionRange = {
+  name: string;
+  range: FilterExpressionRangeValue;
+};
+
+export type FilterExpressionRangeValue = ['-inf' | number, 'inf' | number];