@liquidcommercedev/rmn-sdk 1.5.0-beta.4 → 1.5.0-beta.41

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

@@ -1,11 +1,17 @@
 import type { IAuthCredentials } from 'modules/auth';
-import type { IInjectSpotElementParams, IRmnCreateSpotElementConfig } from 'modules/element';
+import type { IInjectSpotElementParams } from 'modules/element';
 import type { ISpot, ISpots, ISpotSelectionParams } from 'modules/selection';
 import type { IRmnClient, IRmnConfig, IRmnEventManager } from 'types';
-export declare class LiquidCommerceRmnClient implements IRmnClient {
+/**
+ * The RmnClient for client-side.
+ * This client is used when you are initializing the client in a browser environment.
+ *
+ * @class
+ */
+export declare class BrowserRmnClient implements IRmnClient {
     private readonly selectionService;
     private readonly elementService;
-    private readonly eventService;
+    private readonly spotManagerService;
     constructor(auth: IAuthCredentials);
     /**
      * Makes a selection request on our server based on the provided data.
@@ -14,11 +20,19 @@ 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;
     }>;
+    /**
+     * Publishes the spot data for a given placement ID to the RMN.
+     *
+     * @param {string} placementId - The unique identifier for the placement.
+     * @param {ISpot} spot - The spot data.
+     * @return {void} - Does not return any value.
+     */
+    publishSpotToRmn(placementId: string, spot: ISpot): void;
     /**
      * Injects the spot elements into their provided placement.
      *
@@ -28,55 +42,91 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      */
     injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
     /**
-     * Makes a selection request on our server based on the provided data.
+     * Processes the placements that are within range and injects the spot elements into the provided placements.
      *
      * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
+     * @param {string[]} placementIds - The placement IDs to process.
      *
-     * @return {Promise<ISpots | {error: string}>} - The spots response object.
+     * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
      */
-    private spotSelectionRequest;
+    private processPlacements;
     /**
-     * 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;
+    /**
+     * Makes a selection request on our server based on the provided data.
+     *
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
+     *
+     * @return {Promise<ISpots | {error: string}>} - The spots response object.
+     */
+    private injectSpotSelectionRequest;
+}
+/**
+ * The RmnClient for server-side.
+ * This client is used when you are initializing the client in a non-browser environment.
+ *
+ * @class
+ */
+export declare class ServerRmnClient implements IRmnClient {
+    private readonly selectionService;
+    constructor(auth: IAuthCredentials);
     /**
-     * Prevents duplicate placement ids in the inject data.
+     * Makes a selection request on our server based on the provided data.
      *
-     * @param {IInjectSpotElement[]} inject - The inject data.
+     * To create a spot html element, use the RmnCreateSpotElement function.
      *
-     * @throws {Error} - If a duplicate placement id is found.
+     * @param {ISpotSelectionParams} params - Spots selection parameters.
      *
-     * @return {void}
+     * @return {Promise<ISpots | { error : string }>} - The spots response object.
+     */
+    spotSelection(params: ISpotSelectionParams): Promise<ISpots | {
+        error: string;
+    }>;
+    /**
+     * Publishes the spot data for a given placement ID to the RMN.
+     *
+     * @param {string} placementId - The unique identifier for the placement.
+     * @param {ISpot} spot - The spot data.
+     * @return {void} - Does not return any value.
+     */
+    publishSpotToRmn(placementId: string, spot: ISpot): void;
+    /**
+     * Injects the spot elements into their provided placement.
+     *
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
+     *
+     * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
      */
-    private preventDuplicateSpotPlacementIds;
-    private preventNonExistentSpotTypes;
-    private updateSpotsState;
-    private useSpotSelectionExample;
+    injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
 }
 /**
- * Creates a new instance of the RmnClient.
+ * Creates a new instance of the appropriate RmnClient based on the environment.
+ *
+ * Initializes RmnClientBrowser for client-side.
+ * Initializes RmnClientServer for server-side.
  *
  * @param {string} apiKey - The api key.
  * @param {IRmnConfig} config - The configuration object.
  *
- * @return {Promise<IRmnClient>} - The RmnClient instance.
+ * @return {Promise<Partial<IRmnClient>>} - The appropriate RmnClient instance.
  */
 declare function RmnClient(apiKey: string, config: IRmnConfig): Promise<IRmnClient>;
 /**
@@ -85,17 +135,4 @@ declare function RmnClient(apiKey: string, config: IRmnConfig): Promise<IRmnClie
  * @return {IRmnEventManager} - The RmnEventManager instance.
  */
 declare function RmnEventManager(): IRmnEventManager;
-/**
- * Creates the spot html element based on the provided data using shadow dom.
- *
- * This method is useful when you are initializing the client in a non-browser environment.
- * When you request a spot selection, you will receive the spot data in server-side and return them to the client.
- * Then you can use this function to create the spot html element based on the provided data without the need of the RmnClient instance.
- *
- * @param {ISpot} spot - The spot data.
- * @param {IRmnCreateSpotElementConfig} config - The configuration object.
- *
- * @return {HTMLElement | null} - The spot html element or null if the browser environment is not available.
- */
-declare function RmnCreateSpotElement(spot: ISpot, config?: IRmnCreateSpotElementConfig): HTMLElement | null;
-export { RmnClient, RmnCreateSpotElement, RmnEventManager };
+export { RmnClient, RmnEventManager };

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

@@ -0,0 +1,41 @@
+import type { IInjectSpotElement, ISpotColors } from 'modules/element';
+import type { ISpot } 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;
+/**
+ * Overrides the spot colors with the provided colors.
+ *
+ * @param {ISpot} spot - The spot data.
+ * @param {ISpotColors} colors - The colors to override.
+ *
+ * @return {ISpot} - The spot data with the colors overridden.
+ */
+export declare function overrideSpotColors(spot: ISpot, colors?: ISpotColors): ISpot;
+export declare function setUserId(): void;

package/dist/types/types.d.ts

@@ -1,21 +1,22 @@
-export type { IInjectSpotElement, IInjectSpotElementConfig, IInjectSpotElementParams, IRmnCreateSpotElementConfig, ISpotColors, ISpotOverlay, } from 'modules/element';
+export type { IInjectSpotElement, IInjectSpotElementConfig, IInjectSpotElementParams, ISpotColors, ISpotOverlay, } from 'modules/element';
 export type { CarouselNavPositionType, ICarouselButtonOptions, ICarouselDotOptions, ICarouselOptions, } from 'modules/element/component/carousel';
-export type { IAddToCartEvent, IAddToWishlistEvent, IBuyNowEvent, IClickEvent, IImpressionEvent, ILifecycleState, ILSDisplayConfig, ILSDom, ILSIdentifier, ILSState, IPurchaseEvent, IRmnEventMap, } 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';
+export type { ILifecycleState, ILSDisplayConfig, ILSDom, ILSIdentifier, ILSState, IRmnEventMap, IRmnSpotEvent, } from 'modules/spot-manager';
+import type { RMN_ENV, RMN_EVENT } from 'enums';
 import type { IInjectSpotElementParams } from 'modules/element';
-import type { IRmnEventMap } from 'modules/event';
-import type { ISpots, ISpotSelectionParams } from 'modules/selection';
+import type { ISpot, ISpots, ISpotSelectionParams } from 'modules/selection';
+import type { IRmnEventMap } from 'modules/spot-manager';
 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: IRmnEventMap[RMN_SPOT_EVENT]) => void) => () => void;
-    publish: (eventType: RMN_SPOT_EVENT, data: IRmnEventMap[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.4",
+  "version": "1.5.0-beta.41",
   "homepage": "https://docs.liquidcommerce.co/rmn-sdk",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",
@@ -36,12 +36,9 @@
   "type": "module",
   "sideEffects": false,
   "scripts": {
-    "build": "rollup -c --environment NODE_ENV:production",
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-    "dev": "rollup -c --environment NODE_ENV:development -w",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
     "lint": "eslint \"src/**/*.ts\"",
     "format": "prettier --write \"src/**/*.ts\"",
     "docs": "typedoc --out docs src",
@@ -60,62 +57,53 @@
   ],
   "license": "",
   "dependencies": {
-    "axios": "^1.7.7",
+    "axios": "^1.7.9",
     "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.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.17.0",
+    "@rollup/plugin-commonjs": "^28.0.2",
     "@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.1",
+    "@rollup/plugin-replace": "^6.0.2",
     "@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/node": "^22.10.2",
+    "@typescript-eslint/eslint-plugin": "^8.18.1",
+    "@typescript-eslint/parser": "^8.18.1",
+    "@vitest/coverage-v8": "^2.1.8",
     "conventional-changelog-cli": "^5.0.0",
     "crypto-js": "^4.2.0",
-    "dotenv": "^16.4.5",
-    "eslint": "^9.9.1",
+    "eslint": "^9.17.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.7.0",
+    "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.1",
     "events": "^3.3.0",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.4.3",
-    "prettier": "^3.3.3",
+    "prettier": "^3.4.2",
     "process": "^0.11.10",
-    "rollup": "^4.21.0",
-    "rollup-plugin-livereload": "^2.0.5",
+    "rollup": "^4.28.1",
     "rollup-plugin-polyfill-node": "^0.13.0",
-    "rollup-plugin-serve": "^1.1.1",
     "rollup-plugin-typescript2": "^0.36.0",
-    "semantic-release": "^24.1.0",
-    "ts-jest": "^29.2.5",
+    "semantic-release": "^24.2.0",
     "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.7.2",
+    "typescript-eslint": "^8.18.1"
   },
   "engines": {
     "node": ">=20"