@liquidcommercedev/rmn-sdk 1.5.0-beta.3 → 1.5.0-beta.31

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

@@ -1,7 +1,5 @@
 import type { RMN_FILTER_PROPERTIES, RMN_SPOT_TYPE } from 'enums';
-export type RmnFilterType = {
-    [key in RMN_FILTER_PROPERTIES]?: string[];
-};
+export type RmnFilterType = Partial<Record<RMN_FILTER_PROPERTIES, string[]>>;
 export type PlacementIdType = RMN_SPOT_TYPE | `${RMN_SPOT_TYPE}${number}` | string;
 export type SpotFilterType = {
     placementId?: PlacementIdType;
@@ -19,10 +17,8 @@ type IABSpotTypeKeys = keyof {
 type RBSpotTypeValues = (typeof RMN_SPOT_TYPE)[RBSpotTypeKeys];
 type IABSpotTypeValues = (typeof RMN_SPOT_TYPE)[IABSpotTypeKeys];
 export type SpotVariantType = RBSpotTypeValues | `${IABSpotTypeValues}V${number}`;
-export type SpotDimensionsType = {
-    [key in RMN_SPOT_TYPE]: {
-        width: number;
-        height: number;
-    };
-};
+export type SpotDimensionsType = Record<RMN_SPOT_TYPE, {
+    width: number;
+    height: number;
+}>;
 export {};

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

@@ -2,10 +2,16 @@ 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;
     private readonly eventService;
+    private intersectionObserver;
     constructor(auth: IAuthCredentials);
     /**
      * Makes a selection request on our server based on the provided data.
@@ -14,64 +20,59 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      *
      * @param {ISpotSelectionParams} params - Spots selection parameters.
      *
-     * @return {Promise<ISpots | {error : string}>} - The spots response object.
+     * @return {Promise<ISpots | { error : string }>} - The spots response object.
      */
     spotSelection(params: ISpotSelectionParams): Promise<ISpots | {
         error: string;
     }>;
     /**
-     * Injects the spot elements into their provided placement.
+     * Publishes the spot data for a given placement ID to the RMN.
      *
-     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
-     *
-     * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
+     * @param {string} placementId - The unique identifier for the placement.
+     * @param {ISpot} spot - The spot data.
+     * @return {void} - Does not return any value.
      */
-    injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
+    publishSpotToRmn(placementId: string, spot: ISpot): void;
     /**
-     * Makes a selection request on our server based on the provided data.
+     * Injects the spot elements into their provided placement.
      *
      * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
      *
-     * @return {Promise<ISpots | {error: string}>} - The spots response object.
+     * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
      */
-    private spotSelectionRequest;
+    injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
     /**
-     * Injects a carousel element with the provided spots into the placement.
+     * Injects a single spot element into the provided placement.
      *
      * @param {HTMLElement} placement - The placement element.
-     * @param {ISpot[]} spots - The spot data.
+     * @param {ISpot} spot - The spot data.
      * @param {IInjectSpotElementConfig} config - The configuration object.
      *
      * @return {void}
      */
-    private injectCarouselSpotElement;
+    private injectOneSpotElement;
     /**
-     * Injects a single spot element into the provided placement.
+     * Injects a carousel element with the provided spots into the placement.
      *
-     * @param {IInjectSpotElement} injectItem - The inject item data.
      * @param {HTMLElement} placement - The placement element.
-     * @param {ISpot} spot - The spot data.
+     * @param {ISpot[]} spots - The spot data.
      * @param {IInjectSpotElementConfig} config - The configuration object.
      *
      * @return {void}
      */
-    private injectOneSpotElement;
+    private injectCarouselSpotElement;
     /**
-     * Prevents duplicate placement ids in the inject data.
-     *
-     * @param {IInjectSpotElement[]} inject - The inject data.
+     * Makes a selection request on our server based on the provided data.
      *
-     * @throws {Error} - If a duplicate placement id is found.
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
      *
-     * @return {void}
+     * @return {Promise<ISpots | {error: string}>} - The spots response object.
      */
-    private preventDuplicateSpotPlacementIds;
-    private preventNonExistentSpotTypes;
-    private updateSpotsState;
-    private useSpotSelectionExample;
+    private injectSpotSelectionRequest;
 }
 /**
  * Creates a new instance of the RmnClient.
+ * Ensures the page is fully loaded before initializing.
  *
  * @param {string} apiKey - The api key.
  * @param {IRmnConfig} config - The configuration object.

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

@@ -0,0 +1,36 @@
+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;
+export declare function useSpotSelectionExample(inject: IInjectSpotElement[]): Promise<ISpots | {
+    error: string;
+}>;
+export declare function setUserId(): void;
+export declare function initDOMObserver(elementIds: string[], callback: (element: HTMLElement) => void): MutationObserver;

package/dist/types/types.d.ts

@@ -1,20 +1,22 @@
-import type { IEventMap } from './modules/event';
 export type { IInjectSpotElement, IInjectSpotElementConfig, IInjectSpotElementParams, IRmnCreateSpotElementConfig, ISpotColors, ISpotOverlay, } from 'modules/element';
 export type { CarouselNavPositionType, ICarouselButtonOptions, ICarouselDotOptions, ICarouselOptions, } from 'modules/element/component/carousel';
+export type { ILifecycleState, ILSDisplayConfig, ILSDom, ILSIdentifier, ILSState, IRmnEventMap, IRmnSpotEvent, } from 'modules/event';
 export type { ISpots, RmnFilterType, RmnSpotType } from 'modules/selection';
 export { ISpot, ISpotEvent, ISpotSelectionParams } from 'modules/selection';
-import type { RMN_ENV, RMN_SPOT_EVENT } from 'enums';
+import type { RMN_ENV, RMN_EVENT } from 'enums';
 import type { IInjectSpotElementParams } from 'modules/element';
-import type { ISpots, ISpotSelectionParams } from 'modules/selection';
+import type { IRmnEventMap } from 'modules/event';
+import type { ISpot, ISpots, ISpotSelectionParams } from 'modules/selection';
 export interface IRmnClient {
     spotSelection(params: ISpotSelectionParams): Promise<ISpots | {
         error: string;
     }>;
+    publishSpotToRmn(placementId: string, spot: ISpot): void;
     injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
 }
 export interface IRmnEventManager {
-    subscribe: (eventType: RMN_SPOT_EVENT, callback: (data: IEventMap[RMN_SPOT_EVENT]) => void) => () => void;
-    publish: (eventType: RMN_SPOT_EVENT, data: IEventMap[RMN_SPOT_EVENT]) => void;
+    subscribe: (eventType: RMN_EVENT, callback: (data: IRmnEventMap[RMN_EVENT]) => void) => () => void;
+    publish: (eventType: RMN_EVENT, data: IRmnEventMap[RMN_EVENT]) => void;
     destroySpot: (placementId: string) => void;
 }
 export interface IRmnConfig {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@liquidcommercedev/rmn-sdk",
   "description": "LiquidCommerce RMN SDK",
   "author": "LiquidCommerce Tech",
-  "version": "1.5.0-beta.3",
+  "version": "1.5.0-beta.31",
   "homepage": "https://docs.liquidcommerce.co/rmn-sdk",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",
@@ -62,60 +62,60 @@
   "dependencies": {
     "axios": "^1.7.7",
     "buffer": "^6.0.3",
-    "jose": "^5.9.2"
+    "jose": "^5.9.6"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.1",
-    "@commitlint/config-conventional": "^17.6.1",
-    "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.9.1",
-    "@rollup/plugin-commonjs": "^26.0.1",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.15.0",
+    "@rollup/plugin-commonjs": "^28.0.1",
     "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-replace": "^5.0.7",
+    "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-replace": "^6.0.1",
     "@rollup/plugin-terser": "^0.4.4",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^10.1.7",
+    "@semantic-release/github": "^11.0.1",
     "@semantic-release/npm": "^12.0.1",
     "@types/core-js": "^2.5.8",
     "@types/crypto-js": "^4.2.2",
     "@types/eslint__js": "^8.42.3",
-    "@types/jest": "^29.4.0",
-    "@types/node": "^20.16.11",
-    "@typescript-eslint/eslint-plugin": "^8.5.0",
-    "@typescript-eslint/parser": "^8.5.0",
-    "@vitest/coverage-v8": "^1.0.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.9.0",
+    "@typescript-eslint/eslint-plugin": "^8.15.0",
+    "@typescript-eslint/parser": "^8.15.0",
+    "@vitest/coverage-v8": "^2.1.5",
     "conventional-changelog-cli": "^5.0.0",
     "crypto-js": "^4.2.0",
     "dotenv": "^16.4.5",
-    "eslint": "^9.9.1",
+    "eslint": "^9.15.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.30.0",
-    "eslint-plugin-import-helpers": "^1.3.1",
-    "eslint-plugin-prettier": "^5.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-import-helpers": "^2.0.1",
+    "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-sonarjs": "^2.0.1",
-    "eslint-plugin-unicorn": "^55.0.0",
+    "eslint-plugin-sonarjs": "^2.0.4",
+    "eslint-plugin-unicorn": "^56.0.0",
     "events": "^3.3.0",
     "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.4.3",
+    "jest-environment-jsdom": "^29.7.0",
     "prettier": "^3.3.3",
     "process": "^0.11.10",
-    "rollup": "^4.21.0",
+    "rollup": "^4.27.3",
     "rollup-plugin-livereload": "^2.0.5",
     "rollup-plugin-polyfill-node": "^0.13.0",
     "rollup-plugin-serve": "^1.1.1",
     "rollup-plugin-typescript2": "^0.36.0",
-    "semantic-release": "^24.1.0",
+    "semantic-release": "^24.2.0",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.26.6",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.2.0",
-    "vite": "^5.0.0",
-    "vitest": "^1.0.0"
+    "typedoc": "^0.26.11",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.15.0",
+    "vite": "^5.4.11",
+    "vitest": "^2.1.5"
   },
   "engines": {
     "node": ">=20"