@liquidcommercedev/rmn-sdk 1.5.0-beta.15 → 1.5.0-beta.17

package/dist/types/common/helpers/extract-deep.helper.d.ts

@@ -0,0 +1,14 @@
+type ExtractorTarget = 'ids' | 'price';
+type ExtractedValue = string | number;
+/**
+ * Extracts deep values from an object based on specified target type
+ * @param data - The source data object to extract values from
+ * @param target - The type of values to extract ('ids' or 'price')
+ * @param options - Optional configuration for the extraction process
+ * @returns Array of extracted values or a single value if onlyFirst is true
+ */
+export declare function extractDeepValues(data: unknown, target: ExtractorTarget, options?: {
+    onlyFirst?: boolean;
+    shouldIncludeZero?: boolean;
+}): ExtractedValue[] | ExtractedValue | undefined;
+export {};

package/dist/types/common/helpers/index.d.ts

@@ -1,4 +1,5 @@
 export * from './event-type.helper';
+export * from './extract-deep.helper';
 export * from './helpers.interface';
 export * from './object.helper';
 export * from './string.helper';

package/dist/types/common/helpers/utils.helper.d.ts

@@ -1,28 +1,18 @@
 import type { IFireEventParams } from 'modules/event';
+export declare function fallbackEventFire(url: string): Promise<boolean>;
 /**
- * Recursively extracts ID values from a nested data structure.
- * Searches for specified property names and collects their primitive values (strings/numbers).
- * Captures properties ending with 'id' and any additional specified property names.
- *
- * @param data - The data structure to search through (can be nested objects/arrays)
- * @param propertyNames - Array of additional property names to look for (optional)
- * @returns Array of extracted ID values (strings/numbers only)
+ * Helper function to decode base64 string and parse JSON
  *
- * @example
- * const data = {
- *   id: [1, 2, 3],
- *   nested: { id: 'abc', userId: 123 },
- *   items: [{ id: 456, productId: '789', sku: 'ABC123' }]
- * };
- * extractDeepIds(data); // Returns [1, 2, 3, 'abc', 123, 456, '789', 'ABC123']
+ * @param {string} base64String - The base64 encoded JSON string
+ * @returns {T | null} - Decoded and parsed object or null if invalid
  */
-export declare function extractDeepIds(data: any, propertyNames?: string[]): Array<string | number>;
-export declare function fallbackEventFire(url: string): Promise<boolean>;
+export declare function decodeBase64Json<T>(base64String: string): T | null;
 /**
  * Extracts and decodes a URL from a base64-encoded query parameter.
  *
  * @param {string} url - The URL containing the base64-encoded query parameter.
  * @returns {string | null} - The decoded URL or null if not found or invalid.
+ * @throws {Error} - If URL is malformed or payload is invalid.
  */
 export declare function getRedirectUrlFromPayload(url: string): string | null;
 /**
@@ -36,3 +26,10 @@ export declare function getRedirectUrlFromPayload(url: string): string | null;
  */
 export declare function fireEvent({ event, eventUrl }: IFireEventParams): Promise<void>;
 export declare function calculateScaleFactor(elementScale: number): number;
+/**
+ * Converts an object to a query string.
+ *
+ * @param {Record<string, string|number|undefined|null>} obj - The object to be converted to a query string.
+ * @returns {string} - The query string.
+ */
+export declare function objectToQueryParams(obj?: Record<string, string | number | undefined | null>): string;

package/dist/types/modules/helper-service/localstorage.service.d.ts

@@ -45,7 +45,8 @@ LocalStorageSpotArray>;
 export declare class LocalStorageService {
     private spots?;
     private static instance;
-    private static readonly localStorageKey;
+    private static readonly localStorageKeyPrefix;
+    private static localStorageKey;
     private static readonly spotExpirationTime;
     private static readonly encryptData;
     private constructor();
@@ -58,6 +59,13 @@ export declare class LocalStorageService {
     private updateLocalStorage;
     private clearLocalStorage;
     private removeExpiredSpots;
+    getUserId(): string;
+    /**
+     * Sets the user ID in the local storage.
+     * If no existing key is found,
+     * it generates a new unique ID and sets it as the local storage key.
+     */
+    setUserId(): void;
     private mapToObject;
     private objectToMap;
     private spotEventObjectToArray;

package/dist/types/modules/monitor/monitor.interface.d.ts

@@ -6,6 +6,7 @@ export interface IDataLayerEvent {
 export interface INormalizedEventData {
     event: RMN_SPOT_EVENT;
     productIds: Array<string | number>;
+    productPrice?: number;
 }
 export interface IFireAndPublishSpotEventParams {
     spotEvent: RMN_SPOT_EVENT;

package/dist/types/modules/selection/selection.interface.d.ts

@@ -2,14 +2,20 @@ import type { RMN_SPOT_EVENT, RMN_SPOT_TYPE } from 'enums';
 import type { PlacementIdType, SpotVariantType } from 'modules/selection';
 import type { RmnFilterType, RmnSpotType } from 'types';
 export interface ISpotSelectionParams {
-    url?: string;
     spots: RmnSpotType[];
     filter?: Partial<RmnFilterType>;
+    userId?: string;
+    url?: string;
 }
 export interface ISpotEvent {
     event: RMN_SPOT_EVENT;
     url: string;
 }
+export interface ISpotEventPayload {
+    e: number;
+    u: string;
+    ss: string;
+}
 export interface ISpot {
     id: string;
     events: ISpotEvent[];

package/dist/types/modules/selection/selection.service.d.ts

@@ -15,4 +15,5 @@ export declare class SelectionService extends BaseApi implements ISelectionServi
     spotSelection(data: ISpotSelectionParams): Promise<ISpots | {
         error: string;
     }>;
+    private getUserId;
 }

package/dist/types/rmn-client.d.ts

@@ -2,6 +2,10 @@ import type { IAuthCredentials } from 'modules/auth';
 import type { IInjectSpotElementParams, IRmnCreateSpotElementConfig } from 'modules/element';
 import type { ISpot, ISpots, ISpotSelectionParams } from 'modules/selection';
 import type { IRmnClient, IRmnConfig, IRmnEventManager } from 'types';
+/**
+ * LiquidCommerce Rmn Client
+ * @class
+ */
 export declare class LiquidCommerceRmnClient implements IRmnClient {
     private readonly selectionService;
     private readonly elementService;
@@ -28,21 +32,9 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
      */
     injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
-    /** ========================= HELPER METHODS ========================= **/
-    /**
-     * Injects a carousel element with the provided spots into the placement.
-     *
-     * @param {HTMLElement} placement - The placement element.
-     * @param {ISpot[]} spots - The spot data.
-     * @param {IInjectSpotElementConfig} config - The configuration object.
-     *
-     * @return {void}
-     */
-    private injectCarouselSpotElement;
     /**
      * Injects a single spot element into the provided placement.
      *
-     * @param {IInjectSpotElement} injectItem - The inject item data.
      * @param {HTMLElement} placement - The placement element.
      * @param {ISpot} spot - The spot data.
      * @param {IInjectSpotElementConfig} config - The configuration object.
@@ -51,13 +43,15 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      */
     private injectOneSpotElement;
     /**
-     * Clears the placement element by removing all its children.
+     * Injects a carousel element with the provided spots into the placement.
      *
-     * @param {string} placementId - The placement id.
+     * @param {HTMLElement} placement - The placement element.
+     * @param {ISpot[]} spots - The spot data.
+     * @param {IInjectSpotElementConfig} config - The configuration object.
      *
      * @return {void}
      */
-    private clearPlacement;
+    private injectCarouselSpotElement;
     /**
      * Makes a selection request on our server based on the provided data.
      *
@@ -65,25 +59,7 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      *
      * @return {Promise<ISpots | {error: string}>} - The spots response object.
      */
-    private spotSelectionRequest;
-    /**
-     * Prevents duplicate placement ids in the inject data.
-     *
-     * @param {IInjectSpotElement[]} inject - The inject data.
-     *
-     * @throws {Error} - If a duplicate placement id is found.
-     *
-     * @return {void}
-     */
-    private preventDuplicateSpotPlacementIds;
-    /**
-     * Prevents non-existent spot types in the inject data.
-     *
-     * @param {IInjectSpotElement[]} inject - The inject data.
-     * @return {IInjectSpotElement[]} - The filtered inject data.
-     */
-    private preventNonExistentSpotTypes;
-    private useSpotSelectionExample;
+    private injectSpotSelectionRequest;
 }
 /**
  * Creates a new instance of the RmnClient.

package/dist/types/rmn-client.helper.d.ts

@@ -0,0 +1,41 @@
+import type { IInjectSpotElement } from 'modules/element';
+import type { ISpots } from 'modules/selection';
+/**
+ * Checks if the current environment is a browser environment.
+ *
+ * @return {boolean} - Whether the current environment is a browser environment.
+ */
+export declare function isBrowserEnvironment(): boolean;
+/**
+ * Validates the inject data by preventing duplicate placement ids and non-existent spot types.
+ *
+ * @param {IInjectSpotElement[]} inject - The inject data.
+ * @return {IInjectSpotElement[]} - The validated inject data.
+ */
+export declare function validateInjectData(inject: IInjectSpotElement[]): IInjectSpotElement[];
+/**
+ * Clears the placement element by removing all its children.
+ *
+ * @param {string} placementId - The placement id.
+ *
+ * @return {void}
+ */
+export declare function clearPlacement(placementId: string): void;
+/**
+ * Prepares the spot placement for rendering by taking care of its styling.
+ *
+ * @param {HTMLElement} placement - The placement element.
+ *
+ * @return {void}
+ */
+export declare function prepareSpotPlacement(placement: HTMLElement): void;
+/**
+ * Waits for the DOM to be ready before continuing.
+ *
+ * @return {Promise<void>} - A promise that resolves when the DOM is ready.
+ */
+export declare function waitForDOM(): Promise<void>;
+export declare function useSpotSelectionExample(inject: IInjectSpotElement[]): Promise<ISpots | {
+    error: string;
+}>;
+export declare function setUserId(): void;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@liquidcommercedev/rmn-sdk",
   "description": "LiquidCommerce RMN SDK",
   "author": "LiquidCommerce Tech",
-  "version": "1.5.0-beta.15",
+  "version": "1.5.0-beta.17",
   "homepage": "https://docs.liquidcommerce.co/rmn-sdk",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",