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

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/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,40 @@
+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;
+}>;

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.16",
   "homepage": "https://docs.liquidcommerce.co/rmn-sdk",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",