@constructor-io/constructorio-client-javascript 2.34.1 → 2.34.3

package/lib/types/index.d.ts

@@ -0,0 +1,154 @@
+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;

package/lib/types/quizzes.d.ts

@@ -0,0 +1,85 @@
+import { Nullable } from './index.d';
+import { ConstructorClientOptions, NetworkParameters } from '.';
+
+export default Quizzes;
+
+export interface QuizzesParameters {
+  section?: string;
+  answers?: any[];
+  versionId?: string;
+}
+
+declare class Quizzes {
+  constructor(options: ConstructorClientOptions);
+
+  options: ConstructorClientOptions;
+
+  getQuizNextQuestion(
+    id: string,
+    parameters?: QuizzesParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<NextQuestionResponse>;
+
+  getQuizResults(
+    id: string,
+    parameters?: QuizzesParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<QuizResultsResponse>;
+}
+
+/* quizzes results returned from server */
+export interface NextQuestionResponse extends Record<string, any> {
+  next_question: Question;
+  is_last_question?: boolean;
+  version_id?: string;
+}
+export interface QuizResultsResponse extends Record<string, any> {
+  result: Partial<QuizResult>;
+  version_id?: string;
+}
+
+export type Question = SelectQuestion | OpenQuestion | CoverQuestion
+
+export interface BaseQuestion extends Record<string, any> {
+  id: number;
+  title: string;
+  description: string;
+  cta_text: Nullable<string>;
+  images?: Nullable<QuestionImages>;
+}
+
+export interface SelectQuestion extends BaseQuestion {
+  type: 'single' | 'multiple'
+  options: QuestionOption[];
+}
+
+export interface OpenQuestion extends BaseQuestion {
+  type: 'open'
+  inputPlaceholder?: Nullable<string>;
+}
+
+export interface CoverQuestion extends BaseQuestion {
+  type: 'cover'
+}
+
+export interface QuizResult extends Record<string, any> {
+  filter_expression: Record<string, any>;
+  results_url: string;
+}
+
+export interface QuestionOption extends Record<string, any> {
+  id: number;
+  value: string;
+  attribute: Nullable<{
+    name: string;
+    value: string;
+  }>;
+  images?: Nullable<QuestionImages>;
+}
+
+export interface QuestionImages extends Record<string, any> {
+  primary_url?: Nullable<string>;
+  primary_alt?: Nullable<string>;
+  secondary_url?: Nullable<string>;
+  secondary_alt?: Nullable<string>;
+}

package/lib/types/recommendations.d.ts

@@ -1,77 +1,68 @@
-import { ConstructorClientOptions, ErrorData } from "./types";
-import EventDispatcher from "./event-dispatcher";
+import { ConstructorClientOptions, NetworkParameters } from '.';
+import EventDispatcher from './event-dispatcher';
 
-/******************
- *
- * 	Recommendations
- *
- *****************/
-export = Recommendations;
+export default Recommendations;
 
-interface RecommendationsParameters {
-	itemIds?: string | string[];
-	numResults?: number;
-	section?: string;
-	term?: string;
-	filters?: Record<string, any>;
-	variationsMap?: Record<string, any>;
+export interface RecommendationsParameters {
+  itemIds?: string | string[];
+  numResults?: number;
+  section?: string;
+  term?: string;
+  filters?: Record<string, any>;
+  variationsMap?: Record<string, any>;
 }
 
 declare class Recommendations {
-	constructor(options: ConstructorClientOptions);
-	options: ConstructorClientOptions;
-	eventDispatcher: EventDispatcher;
+  constructor(options: ConstructorClientOptions);
 
-	getRecommendations(
-		podId: string,
-		parameters?: RecommendationsParameters,
-		networkParameters?: {
-			timeout?: number;
-		}
-	): Promise<Recommendations.RecommendationsResponse>;
+  options: ConstructorClientOptions;
+
+  eventDispatcher: EventDispatcher;
+
+  getRecommendations(
+    podId: string,
+    parameters?: RecommendationsParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<RecommendationsResponse>;
 }
 
-/***********
- *
- * 	Recommendations results returned from server
- *
- ***********/
-declare namespace Recommendations {
-	export interface RecommendationsResponse extends Record<string, any> {
-		request: Partial<Request>;
-		response: Partial<Response>;
-		result_id: string;
-	}
+/** *********
+ * Recommendations results returned from server
+ ********** */
+export interface RecommendationsResponse extends Record<string, any> {
+  request: Partial<RecommendationsRequestType>;
+  response: Partial<RecommendationsResponseType>;
+  result_id: string;
 }
 
-interface Request extends Record<string, any> {
-	num_results: number;
-	item_id: string;
-	filters: {
-		group_id: string;
-		[key: string]: any;
-	};
-	pod_id: string;
+export interface RecommendationsRequestType extends Record<string, any> {
+  num_results: number;
+  item_id: string;
+  filters: {
+    group_id: string;
+    [key: string]: any;
+  };
+  pod_id: string;
 }
 
-interface Response extends Record<string, any> {
-	results: Partial<Result>;
-	total_num_results: number;
-	pod: {
-		id:string;
-		display_name: string;
-		[key: string]: any;
-	};
+export interface RecommendationsResponseType extends Record<string, any> {
+  results: Partial<RecommendationsResultType>;
+  total_num_results: number;
+  pod: {
+    id: string;
+    display_name: string;
+    [key: string]: any;
+  };
 }
 
-interface Result extends Record<string, any> {
-	matched_terms: string[];
-	data: Record<string, any>;
-	value: string;
-	is_slotted: boolean;
-	labels: Record<string, any>;
-	strategy: {
-		id: string;
-		[key: string]: any;
-	};
-}
+export interface RecommendationsResultType extends Record<string, any> {
+  matched_terms: string[];
+  data: Record<string, any>;
+  value: string;
+  is_slotted: boolean;
+  labels: Record<string, any>;
+  strategy: {
+    id: string;
+    [key: string]: any;
+  };
+}

package/lib/types/search.d.ts

@@ -1,109 +1,101 @@
 import {
-	ConstructorClientOptions,
-	ErrorData,
-	Facet,
-	Feature,
-	FmtOption,
-	Group,
-	RequestFeature,
-	RequestFeatureVariant,
-	ResultSources,
-	SortOption,
-} from "./types";
-import EventDispatcher from "./event-dispatcher";
+  ConstructorClientOptions,
+  Facet,
+  Feature,
+  FmtOption,
+  Group,
+  NetworkParameters,
+  RequestFeature,
+  RequestFeatureVariant,
+  ResultSources,
+  SortOption,
+} from '.';
+import EventDispatcher from './event-dispatcher';
 
-/***********
- *
- * 	SEARCH
- *
- ***********/
+export default Search;
 
-export = Search;
-
-interface SearchParameters {
-	page?: number;
-	resultsPerPage?: number;
-	filters?: Record<string, any>;
-	sortBy?: string;
-	sortOrder?: string;
-	section?: string;
-	fmtOptions?: Record<string, any>;
-	hiddenFields?: string[];
-	hiddenFacets?: string[];
-	variationsMap?: Record<string, any>;
+export interface SearchParameters {
+  page?: number;
+  offset?: number;
+  resultsPerPage?: number;
+  filters?: Record<string, any>;
+  sortBy?: string;
+  sortOrder?: string;
+  section?: string;
+  fmtOptions?: Record<string, any>;
+  hiddenFields?: string[];
+  hiddenFacets?: string[];
+  variationsMap?: Record<string, any>;
 }
 declare class Search {
-	constructor(options: ConstructorClientOptions);
-	options: ConstructorClientOptions;
-	eventDispatcher: EventDispatcher;
-	getSearchResults(
-		query: string,
-		parameters?: SearchParameters,
-		networkParameters?: {
-			timeout?: number;
-		}
-	): Promise<Search.SearchResponse>;
+  constructor(options: ConstructorClientOptions);
+
+  options: ConstructorClientOptions;
+
+  eventDispatcher: EventDispatcher;
+
+  getSearchResults(
+    query: string,
+    parameters?: SearchParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<SearchResponse>;
 }
 
-/***********
- *
- * 	search results returned from server
- *
- ***********/
-interface Response extends Record<string, any> {
-	result_sources: Partial<ResultSources>;
-	facets: Partial<Facet>[];
-	groups: Partial<Group>[];
-	results: Partial<Result>[];
-	sort_options: Partial<SortOption>[];
-	refined_content: Record<string, any>[];
-	total_num_results: number;
-	features: Partial<Feature>[];
+/** *********
+ * search results returned from server
+ ********** */
+export interface SearchResponse {
+  request: Partial<SearchRequestType>;
+  response: Partial<SearchResponseType | Redirect>;
+  result_id: string;
 }
 
-interface Request extends Record<string, any> {
-	page: number;
-	num_results_per_page: number;
-	section: string;
-	blacklist_rules: boolean;
-	term: string;
-	fmt_options: Partial<FmtOption>;
-	sort_by: string;
-	sort_order: string;
-	features: Partial<RequestFeature>;
-	feature_variants: Partial<RequestFeatureVariant>;
-	searchandized_items: Record<string, any>;
+export interface SearchResponseType extends Record<string, any> {
+  result_sources: Partial<ResultSources>;
+  facets: Partial<Facet>[];
+  groups: Partial<Group>[];
+  results: Partial<Result>[];
+  sort_options: Partial<SortOption>[];
+  refined_content: Record<string, any>[];
+  total_num_results: number;
+  features: Partial<Feature>[];
 }
 
-interface Result 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 SearchRequestType extends Record<string, any> {
+  page: number;
+  num_results_per_page: number;
+  section: string;
+  blacklist_rules: boolean;
+  term: string;
+  fmt_options: Partial<FmtOption>;
+  sort_by: string;
+  sort_order: string;
+  features: Partial<RequestFeature>;
+  feature_variants: Partial<RequestFeatureVariant>;
+  searchandized_items: Record<string, any>;
 }
 
-declare namespace Search {
-	export interface SearchResponse {
-		request: Partial<Request>;
-		response: Partial<Response | Redirect>;
-		result_id: string;
-	}
+export interface Result 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 Redirect extends Record<string, any> {
-	redirect: {
-		data: {
-			match_id: number;
-			rule_id: number;
-			url: string;
-			[key: string]: any;
-		};
-		matched_terms: string[];
-		matched_user_segments: string[];
-	}
+export interface Redirect extends Record<string, any> {
+  redirect: {
+    data: {
+      match_id: number;
+      rule_id: number;
+      url: string;
+      [key: string]: any;
+    };
+    matched_terms: string[];
+    matched_user_segments: string[];
+  };
 }