@seekora-ai/search-sdk 0.2.21 → 0.2.23

package/dist/analytics/types.gen.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/client.d.ts

@@ -2,16 +2,36 @@
  * Seekora SDK Client
  * High-level wrapper around generated OpenAPI client
  */
-import type { DataTypesIndexConfig, DataTypesEventPayload, DataTypesFiltersResponse, DataTypesFacetValuesSearchResponse, DataTypesFiltersSchemaResponse, DataTypesFilterField, DataTypesFilterValue, DataTypesFilterStats, DataTypesFilterSchemaField } from './generated';
-import { type SeekoraEnvironment } from './config';
-import { Logger, type LogLevel, type LoggerConfig } from './logger';
-import { type ContextCollectorConfig, type BrowserContext } from './context-collector';
-import { EventQueue, type EventQueueConfig } from './event-queue';
+import type { DataTypesIndexConfig, DataTypesEventPayload, DataTypesFiltersResponse, DataTypesFacetValuesSearchResponse, DataTypesFiltersSchemaResponse, DataTypesFilterField, DataTypesFilterValue, DataTypesFilterStats, DataTypesFilterSchemaField } from "./generated";
+import { type SeekoraEnvironment } from "./config";
+import { Logger, type LogLevel, type LoggerConfig } from "./logger";
+import { type ContextCollectorConfig, type BrowserContext } from "./context-collector";
+import { EventQueue, type EventQueueConfig } from "./event-queue";
 export interface SeekoraClientConfig {
     storeId?: string;
+    /** Alias for readSecret — accepted for convenience */
+    apiKey?: string;
+    /** Alias for baseUrl host — accepted for convenience */
+    apiHost?: string;
     readSecret?: string;
     writeSecret?: string;
     baseUrl?: string;
+    /**
+     * Jitsu per-site analytics write key (from tjitsu_sites.write_key on the
+     * Seekora backend). When unset, all track/identify calls become no-ops
+     * — events are NOT sent to the Seekora backend or anywhere else.
+     * SCRUM-259 V4 analytics: this is distinct from writeSecret (which is
+     * the Seekora store API write secret).
+     */
+    jitsuWriteKey?: string;
+    /**
+     * Jitsu Ingest endpoint base URL (e.g. https://jitsu.seekora.ai). Used
+     * as the analytics-next cdnURL so events flow to the correct CDP.
+     * When unset, analytics-next defaults to its hosted endpoint which is
+     * NOT where Seekora events should land — pair with jitsuWriteKey.
+     * SCRUM-259 V4 analytics.
+     */
+    jitsuIngestUrl?: string;
     environment?: SeekoraEnvironment;
     timeout?: number;
     logLevel?: LogLevel;
@@ -64,7 +84,7 @@ export interface SeekoraClientConfig {
         include_dropdown_product_list?: boolean;
         include_filtered_tabs?: boolean;
         hitsPerPage?: number;
-        time_range?: '7d' | '30d' | '90d';
+        time_range?: "7d" | "30d" | "90d";
         [key: string]: unknown;
     };
     /**
@@ -190,8 +210,8 @@ export interface SearchOptions {
     include_snippets?: boolean;
     group_field?: string;
     group_size?: number;
-    prefix_mode?: 'always' | 'fallback' | 'false';
-    infix_mode?: 'always' | 'fallback' | 'false';
+    prefix_mode?: "always" | "fallback" | "false";
+    infix_mode?: "always" | "fallback" | "false";
     typo_max?: number;
     typo_min_len_1?: number;
     typo_min_len_2?: number;
@@ -312,7 +332,7 @@ export interface DeleteDocumentResponse {
  */
 export interface SchemaField {
     name: string;
-    type: 'string' | 'int32' | 'int64' | 'float' | 'bool' | 'string[]' | 'int32[]' | 'int64[]' | 'float[]' | 'bool[]' | 'object' | 'object[]' | 'auto' | 'geopoint' | 'geopoint[]';
+    type: "string" | "int32" | "int64" | "float" | "bool" | "string[]" | "int32[]" | "int64[]" | "float[]" | "bool[]" | "object" | "object[]" | "auto" | "geopoint" | "geopoint[]";
     facet?: boolean;
     index?: boolean;
     optional?: boolean;
@@ -325,7 +345,7 @@ export interface SchemaField {
  */
 export interface CreateSchemaRequest {
     fields: SchemaField[];
-    mode?: 'additive' | 'replace';
+    mode?: "additive" | "replace";
     confirmDelete?: boolean;
     defaultSortingField?: string;
     enableNestedFields?: boolean;
@@ -377,6 +397,13 @@ export declare class SeekoraClient {
     private deduplicationWindow;
     private abTestId?;
     private abVariant?;
+    private _analytics;
+    /**
+     * Lazy-init analytics-next. Returns null when Jitsu config is incomplete
+     * (jitsuWriteKey missing) so callers no-op rather than firing events
+     * with the wrong credential to the wrong endpoint. SCRUM-259.
+     */
+    private getAnalytics;
     constructor(config?: SeekoraClientConfig);
     /**
      * Search for documents
@@ -420,13 +447,13 @@ export declare class SeekoraClient {
         hitsPerPage?: number;
         page?: number;
         analytics_tags?: string | string[];
-        tags_match_mode?: 'any' | 'all';
+        tags_match_mode?: "any" | "all";
         include_categories?: boolean;
         include_facets?: boolean;
         max_categories?: number;
         max_facets?: number;
         min_popularity?: number;
-        time_range?: '7d' | '30d' | '90d';
+        time_range?: "7d" | "30d" | "90d";
         disable_typo_tolerance?: boolean;
         include_dropdown_recommendations?: boolean;
         /** When false, omit product hits list from dropdown result (default true) */
@@ -636,16 +663,54 @@ export declare class SeekoraClient {
         event_name?: string;
     })[], context?: SearchContext): Promise<void>;
     /**
-     * Track a search event
+     * Track a search event (Segment "Products Searched" spec)
      *
      * @param params - Search tracking parameters
      */
     trackSearch(params: {
         query: string;
-        resultsCount: number;
-        context?: SearchContext;
-        analyticsTags?: string[];
-        metadata?: Record<string, any>;
+        /** Segment Spec field name */
+        numFound?: number;
+        /** Legacy alias from V3-era seekora-ui-sdk — still accepted */
+        resultsCount?: number;
+        results?: Array<{
+            id: string;
+            sku?: string;
+            category?: string;
+            [key: string]: any;
+        }>;
+        searchId?: string;
+        latencyMs?: number;
+        engine?: string;
+        /** Legacy V3 fields tolerated for backward compat */
+        context?: unknown;
+        analyticsTags?: unknown;
+        metadata?: unknown;
+    }): Promise<void>;
+    /**
+     * Track a product click event (Segment "Product Clicked" spec)
+     *
+     * @param params - Product click parameters
+     */
+    trackProductClick(params: {
+        productId: string;
+        sku?: string;
+        position?: number;
+        searchId?: string;
+        [key: string]: any;
+    }): Promise<void>;
+    /**
+     * Track a product impression event (Segment "Product Viewed" spec)
+     *
+     * @param params - Product impression parameters
+     */
+    trackProductImpression(params: {
+        productId: string;
+        sku?: string;
+        position?: number;
+        searchId?: string;
+        category?: string;
+        [key: string]: any;
     }): Promise<void>;
     /**
      * Track an impression event