@depict-ai/ui 0.0.83 → 1.0.2

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { SearchSuggestionsResponse, CategorySuggestion } from "@depict-ai/types/
 import { SearchSuggestionsRequest } from "@depict-ai/types/api/SearchSuggestionsRequest";
 import { ProductListingRequest } from "@depict-ai/types/api/ProductListingRequest";
 import { ProductListingResponse } from "@depict-ai/types/api/ProductListingResponse";
-export const version = "0.0.83";
+export const version = "1.0.2";
 export type OnNavigation = ((options: {
     is_replace: boolean;
     new_url: URL;
@@ -33,6 +33,8 @@ type RecsAPIWrapperOptions = {
     type: string;
     merchant: string;
     market: string;
+    userId?: string;
+    sessionId?: string;
     headers?: HeadersInit;
 } & ExclusiveId;
 /**
@@ -45,6 +47,8 @@ type RecsAPIWrapperOptions = {
  * @param categoryId When requesting recommendations for a category page, pass the id of the category page as `categoryId`.
  * @param productId When requesting recommendations for a single product, e.g. on a product detail page, pass the id of the product as `productId`.
  * @param productIds When requesting recommendations that should take multiple products into account, i.e. the contents of the basket/cart, pass an array of product ids as `productIds`
+ * @param userId Optional unique identifier of a logged in user. Should be persistent across devices and sessions.
+ * @param sessionId Optional unique identifer of the current session. Only necessary when performing server side requests to Depict.
  * @param headers Optional headers to send to the Depict API. This could be authentication for example. 99% of integrations can leave this unset.
  * When no id is provided (none out of `categoryId`, `productId` and `productIds`) general recommendations will be fetched. This is for, for example, the frontpage where generally popular products get returned.
  *
@@ -158,11 +162,16 @@ export type InstantCard<T extends Display> = (display: T, context: {
     merchant: string;
     market: string;
 }) => JSX.Element;
+interface DepictAPIConstructorOptions {
+    get_metadata?: () => Promise<{
+        [k: string]: string;
+    } | undefined>;
+    get_user_id?: () => string | undefined;
+    get_session_id?: () => string | undefined;
+}
 export class DepictAPI {
     #private;
-    constructor(get_metadata?: () => Promise<{
-        [k: string]: string;
-    } | undefined>);
+    constructor({ get_metadata, get_user_id, get_session_id }?: DepictAPIConstructorOptions);
     suggest(input_req: SearchSuggestionsRequest): Promise<SearchSuggestionsResponse & {
         failed?: true;
     }>;
@@ -374,6 +383,18 @@ export type BaseProviderConfig = {
      * @example "YOUR_MARKET", "no", "en-de"
      */
     market: string;
+    /**
+     * Optional unique identifier of a logged in user. Should be persistent across devices and sessions.
+     */
+    userId?: string;
+    /**
+     * Optional unique identifer of the current session. Only necessary when performing server side requests to Depict.
+     */
+    sessionId?: string;
+    /**
+     * Custom metadata to be sent with each request to the Depict API. Only necessary if specifically instructed by Depict.
+     */
+    metaData?: Record<string, string>;
 };
 export type BaseSearchProviderConfig = {
     /**