@liquidcommercedev/rmn-sdk 1.4.6-beta.3 → 1.4.6-beta.4

package/dist/index.cjs

@@ -44,6 +44,7 @@ exports.RMN_SPOT_TYPE = void 0;
 exports.RMN_FILTER_PROPERTIES = void 0;
 (function (RMN_FILTER_PROPERTIES) {
     RMN_FILTER_PROPERTIES["KEYWORDS"] = "keywords";
+    RMN_FILTER_PROPERTIES["PAGE_LOCATION"] = "pageLocation";
     RMN_FILTER_PROPERTIES["PARENTCO"] = "parentCo";
     RMN_FILTER_PROPERTIES["BRAND"] = "brand";
     RMN_FILTER_PROPERTIES["CATEGORY"] = "category";
@@ -17656,40 +17657,32 @@ class LiquidCommerceRmnClient {
      *
      * To create a spot html element, use the RmnCreateSpotElement function.
      *
-     * @param {ISpotSelectionParams} data - Spots selection parameters.
+     * @param {ISpotSelectionParams} params - Spots selection parameters.
      *
      * @return {Promise<ISpots>} - The spots response object.
      */
-    async spotSelection(data) {
-        return this.selectionService.spotSelection(data);
+    async spotSelection(params) {
+        return this.selectionService.spotSelection(params);
     }
     /**
      * Injects the spot elements into their provided placement.
      *
-     * @param {IInjectSpotElement[]} data - The spot element's data.
-     * @param {IInjectSpotElementConfig} config - The configuration object.
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
      *
      * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
      */
-    async injectSpotElement(data, config) {
-        if (!data.length) {
-            console.warn('RmnSdk: Failed to request spot selection. No spot elements provided.');
+    async injectSpotElement(params) {
+        var _a;
+        const { inject, config } = params;
+        if (!inject.length) {
+            console.warn('RmnSdk: Failed to inject spot element. Please provide at least one spot element to inject.');
             return;
         }
-        const spotSelectionRequest = data.map((item) => {
-            var _a;
-            return ({
-                spot: item.spotType,
-                count: (_a = item === null || item === void 0 ? void 0 : item.count) !== null && _a !== void 0 ? _a : 1,
-            });
-        });
-        const response = await this.spotSelection({
-            spots: spotSelectionRequest,
-            url: config === null || config === void 0 ? void 0 : config.url,
-        });
-        const normalizedData = this.normalizeDataSpotType(data);
-        for (const item of normalizedData) {
-            const spots = response[item.spotType];
+        this.preventDuplicateSpotPlacementIds(inject);
+        const response = await this.spotSelectionRequest(params);
+        for (const item of inject) {
+            const itemConfig = (_a = item.config) !== null && _a !== void 0 ? _a : config;
+            const spots = response[item.placementId];
             if (!(spots === null || spots === void 0 ? void 0 : spots.length)) {
                 console.warn(`RmnSdk: Failed to inject spot element. No spots found for type "${item.spotType}".`);
                 continue;
@@ -17701,13 +17694,34 @@ class LiquidCommerceRmnClient {
                 continue;
             }
             if (spots.length === 1) {
-                this.injectOneSpotElement(item, placement, spots[0], config);
+                this.injectOneSpotElement(item, placement, spots[0], itemConfig);
             }
             if (spots.length > 1) {
-                this.injectCarouselSpotElement(placement, spots, config);
+                this.injectCarouselSpotElement(placement, spots, itemConfig);
             }
         }
     }
+    /**
+     * Makes a selection request on our server based on the provided data.
+     *
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
+     *
+     * @return {Promise<ISpots>} - The spots response object.
+     */
+    async spotSelectionRequest(params) {
+        const { inject, filter, config } = params;
+        const request = {
+            url: config === null || config === void 0 ? void 0 : config.url,
+            filter,
+            spots: inject.map((item) => ({
+                placementId: item.placementId,
+                spot: item.spotType,
+                count: item === null || item === void 0 ? void 0 : item.count,
+                ...item === null || item === void 0 ? void 0 : item.filter,
+            })),
+        };
+        return this.spotSelection(request);
+    }
     /**
      * Injects a carousel element with the provided spots into the placement.
      *
@@ -17781,25 +17795,22 @@ class LiquidCommerceRmnClient {
         placement.replaceChildren(spotElement);
     }
     /**
-     * Normalizes the spot type data by adding a number suffix to the spot type.
+     * Prevents duplicate placement ids in the inject data.
+     *
+     * @param {IInjectSpotElement[]} inject - The inject data.
      *
-     * @param {IInjectSpotElement[]} spots - The spot type data.
+     * @throws {Error} - If a duplicate placement id is found.
      *
-     * @return {IInjectSpotElement[]} - The normalized spot type data.
+     * @return {void}
      */
-    normalizeDataSpotType(spots) {
-        const spotTypeCounts = {};
-        return spots.map((spot) => {
-            const { spotType } = spot;
-            spotTypeCounts[spotType] = (spotTypeCounts[spotType] || 0) + 1;
-            if (spotTypeCounts[spotType] === 1) {
-                return spot;
+    preventDuplicateSpotPlacementIds(inject) {
+        const placementIds = new Set();
+        for (const item of inject) {
+            if (placementIds.has(item.placementId)) {
+                throw new Error(`RmnSdk: Duplicate placement id (${item.placementId}) found. Please provide a unique placement id for each spot element.`);
             }
-            return {
-                ...spot,
-                spotType: `${spotType}${spotTypeCounts[spotType]}`,
-            };
-        });
+            placementIds.add(item.placementId);
+        }
     }
 }
 /**

package/dist/index.esm.js

@@ -42,6 +42,7 @@ var RMN_SPOT_TYPE;
 var RMN_FILTER_PROPERTIES;
 (function (RMN_FILTER_PROPERTIES) {
     RMN_FILTER_PROPERTIES["KEYWORDS"] = "keywords";
+    RMN_FILTER_PROPERTIES["PAGE_LOCATION"] = "pageLocation";
     RMN_FILTER_PROPERTIES["PARENTCO"] = "parentCo";
     RMN_FILTER_PROPERTIES["BRAND"] = "brand";
     RMN_FILTER_PROPERTIES["CATEGORY"] = "category";
@@ -17654,40 +17655,32 @@ class LiquidCommerceRmnClient {
      *
      * To create a spot html element, use the RmnCreateSpotElement function.
      *
-     * @param {ISpotSelectionParams} data - Spots selection parameters.
+     * @param {ISpotSelectionParams} params - Spots selection parameters.
      *
      * @return {Promise<ISpots>} - The spots response object.
      */
-    async spotSelection(data) {
-        return this.selectionService.spotSelection(data);
+    async spotSelection(params) {
+        return this.selectionService.spotSelection(params);
     }
     /**
      * Injects the spot elements into their provided placement.
      *
-     * @param {IInjectSpotElement[]} data - The spot element's data.
-     * @param {IInjectSpotElementConfig} config - The configuration object.
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
      *
      * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
      */
-    async injectSpotElement(data, config) {
-        if (!data.length) {
-            console.warn('RmnSdk: Failed to request spot selection. No spot elements provided.');
+    async injectSpotElement(params) {
+        var _a;
+        const { inject, config } = params;
+        if (!inject.length) {
+            console.warn('RmnSdk: Failed to inject spot element. Please provide at least one spot element to inject.');
             return;
         }
-        const spotSelectionRequest = data.map((item) => {
-            var _a;
-            return ({
-                spot: item.spotType,
-                count: (_a = item === null || item === void 0 ? void 0 : item.count) !== null && _a !== void 0 ? _a : 1,
-            });
-        });
-        const response = await this.spotSelection({
-            spots: spotSelectionRequest,
-            url: config === null || config === void 0 ? void 0 : config.url,
-        });
-        const normalizedData = this.normalizeDataSpotType(data);
-        for (const item of normalizedData) {
-            const spots = response[item.spotType];
+        this.preventDuplicateSpotPlacementIds(inject);
+        const response = await this.spotSelectionRequest(params);
+        for (const item of inject) {
+            const itemConfig = (_a = item.config) !== null && _a !== void 0 ? _a : config;
+            const spots = response[item.placementId];
             if (!(spots === null || spots === void 0 ? void 0 : spots.length)) {
                 console.warn(`RmnSdk: Failed to inject spot element. No spots found for type "${item.spotType}".`);
                 continue;
@@ -17699,13 +17692,34 @@ class LiquidCommerceRmnClient {
                 continue;
             }
             if (spots.length === 1) {
-                this.injectOneSpotElement(item, placement, spots[0], config);
+                this.injectOneSpotElement(item, placement, spots[0], itemConfig);
             }
             if (spots.length > 1) {
-                this.injectCarouselSpotElement(placement, spots, config);
+                this.injectCarouselSpotElement(placement, spots, itemConfig);
             }
         }
     }
+    /**
+     * Makes a selection request on our server based on the provided data.
+     *
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
+     *
+     * @return {Promise<ISpots>} - The spots response object.
+     */
+    async spotSelectionRequest(params) {
+        const { inject, filter, config } = params;
+        const request = {
+            url: config === null || config === void 0 ? void 0 : config.url,
+            filter,
+            spots: inject.map((item) => ({
+                placementId: item.placementId,
+                spot: item.spotType,
+                count: item === null || item === void 0 ? void 0 : item.count,
+                ...item === null || item === void 0 ? void 0 : item.filter,
+            })),
+        };
+        return this.spotSelection(request);
+    }
     /**
      * Injects a carousel element with the provided spots into the placement.
      *
@@ -17779,25 +17793,22 @@ class LiquidCommerceRmnClient {
         placement.replaceChildren(spotElement);
     }
     /**
-     * Normalizes the spot type data by adding a number suffix to the spot type.
+     * Prevents duplicate placement ids in the inject data.
+     *
+     * @param {IInjectSpotElement[]} inject - The inject data.
      *
-     * @param {IInjectSpotElement[]} spots - The spot type data.
+     * @throws {Error} - If a duplicate placement id is found.
      *
-     * @return {IInjectSpotElement[]} - The normalized spot type data.
+     * @return {void}
      */
-    normalizeDataSpotType(spots) {
-        const spotTypeCounts = {};
-        return spots.map((spot) => {
-            const { spotType } = spot;
-            spotTypeCounts[spotType] = (spotTypeCounts[spotType] || 0) + 1;
-            if (spotTypeCounts[spotType] === 1) {
-                return spot;
+    preventDuplicateSpotPlacementIds(inject) {
+        const placementIds = new Set();
+        for (const item of inject) {
+            if (placementIds.has(item.placementId)) {
+                throw new Error(`RmnSdk: Duplicate placement id (${item.placementId}) found. Please provide a unique placement id for each spot element.`);
             }
-            return {
-                ...spot,
-                spotType: `${spotType}${spotTypeCounts[spotType]}`,
-            };
-        });
+            placementIds.add(item.placementId);
+        }
     }
 }
 /**

package/dist/types/enums.d.ts

@@ -38,6 +38,7 @@ export declare enum RMN_SPOT_TYPE {
 }
 export declare enum RMN_FILTER_PROPERTIES {
     KEYWORDS = "keywords",
+    PAGE_LOCATION = "pageLocation",
     PARENTCO = "parentCo",
     BRAND = "brand",
     CATEGORY = "category",

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

@@ -1,6 +1,7 @@
 import type { RMN_SPOT_TYPE } from 'enums';
-import type { ICarouselOptions, ICreateCarouselElementParams } from './component/carousel';
-import type { ICreateSpotElementParams } from './component/spot';
+import type { ICarouselOptions, ICreateCarouselElementParams } from 'modules/element/component/carousel';
+import type { ICreateSpotElementParams } from 'modules/element/component/spot';
+import type { RmnFilterType } from 'modules/selection';
 export interface ISpotColors {
     textColor?: string;
     backgroundColor?: string;
@@ -11,11 +12,6 @@ export interface ISpotOverlay {
     color: string;
     colorStop: string;
 }
-export interface IInjectSpotElement {
-    placementId: string;
-    spotType: RMN_SPOT_TYPE | string;
-    count?: number;
-}
 export interface IInjectSpotElementConfig {
     url?: string;
     colors?: ISpotColors;
@@ -23,15 +19,27 @@ export interface IInjectSpotElementConfig {
     overlay?: ISpotOverlay[];
     carousel?: ICarouselOptions;
 }
+export interface IInjectSpotElement {
+    placementId: string;
+    spotType: RMN_SPOT_TYPE | string;
+    count?: number;
+    config?: Omit<IInjectSpotElementConfig, 'url'>;
+    filter?: Partial<RmnFilterType>;
+}
 export interface ICreateElementConfig {
     width: number;
     height: number;
     fluid?: boolean;
     minScale: number;
 }
+export interface IInjectSpotElementParams {
+    inject: IInjectSpotElement[];
+    config?: IInjectSpotElementConfig;
+    filter?: Partial<RmnFilterType>;
+}
 export interface IElementService {
-    createSpotElement(data: ICreateSpotElementParams): HTMLElement | null;
-    createCarouselElement(data: ICreateCarouselElementParams): HTMLElement | null;
+    createSpotElement(params: ICreateSpotElementParams): HTMLElement | null;
+    createCarouselElement(params: ICreateCarouselElementParams): HTMLElement | null;
 }
 export interface IRmnCreateSpotElementConfig {
     fluid?: boolean;

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

@@ -1,5 +1,5 @@
 import type { RMN_SPOT_EVENT, RMN_SPOT_TYPE } from 'enums';
-import type { SpotIdentifierType, SpotVariantType } from 'modules/selection';
+import type { PlacementIdType, SpotVariantType } from 'modules/selection';
 import type { RmnFilterType, RmnSpotType } from 'types';
 export interface ISpotSelectionParams {
     url?: string;
@@ -30,7 +30,7 @@ export interface ISpot {
     mobileSecondaryImage?: string;
     productUpcs?: string[];
 }
-export type ISpots = Record<SpotIdentifierType, ISpot[]>;
+export type ISpots = Record<PlacementIdType, ISpot[]>;
 export interface ISelectionService {
     spotSelection(data: ISpotSelectionParams): Promise<ISpots>;
 }

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

@@ -2,12 +2,13 @@ import type { RMN_FILTER_PROPERTIES, RMN_SPOT_TYPE } from 'enums';
 export type RmnFilterType = {
     [key in RMN_FILTER_PROPERTIES]?: string[];
 };
+export type PlacementIdType = RMN_SPOT_TYPE | `${RMN_SPOT_TYPE}${number}` | string;
 export type SpotFilterType = {
+    placementId?: PlacementIdType;
     spot: RMN_SPOT_TYPE | string;
-    count: number;
+    count?: number;
     exactMatch?: string;
 } & Omit<RmnFilterType, RMN_FILTER_PROPERTIES.KEYWORDS>;
-export type SpotIdentifierType = RMN_SPOT_TYPE | `${RMN_SPOT_TYPE}${number}`;
 export type RmnSpotType = RMN_SPOT_TYPE | string | SpotFilterType;
 type RBSpotTypeKeys = keyof {
     [K in keyof typeof RMN_SPOT_TYPE as K extends `RB_${string}` ? K : never]: (typeof RMN_SPOT_TYPE)[K];

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

@@ -1,5 +1,5 @@
 import type { IAuthCredentials } from 'modules/auth';
-import type { IInjectSpotElement, IInjectSpotElementConfig, IRmnCreateSpotElementConfig } from 'modules/element';
+import type { IInjectSpotElementParams, IRmnCreateSpotElementConfig } from 'modules/element';
 import type { ISpot, ISpots, ISpotSelectionParams } from 'modules/selection';
 import type { IRmnClient, IRmnConfig } from 'types';
 export declare class LiquidCommerceRmnClient implements IRmnClient {
@@ -11,20 +11,27 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      *
      * To create a spot html element, use the RmnCreateSpotElement function.
      *
-     * @param {ISpotSelectionParams} data - Spots selection parameters.
+     * @param {ISpotSelectionParams} params - Spots selection parameters.
      *
      * @return {Promise<ISpots>} - The spots response object.
      */
-    spotSelection(data: ISpotSelectionParams): Promise<ISpots>;
+    spotSelection(params: ISpotSelectionParams): Promise<ISpots>;
     /**
      * Injects the spot elements into their provided placement.
      *
-     * @param {IInjectSpotElement[]} data - The spot element's data.
-     * @param {IInjectSpotElementConfig} config - The configuration object.
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
      *
      * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
      */
-    injectSpotElement(data: IInjectSpotElement[], config?: IInjectSpotElementConfig): Promise<void>;
+    injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
+    /**
+     * Makes a selection request on our server based on the provided data.
+     *
+     * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
+     *
+     * @return {Promise<ISpots>} - The spots response object.
+     */
+    private spotSelectionRequest;
     /**
      * Injects a carousel element with the provided spots into the placement.
      *
@@ -47,13 +54,15 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      */
     private injectOneSpotElement;
     /**
-     * Normalizes the spot type data by adding a number suffix to the spot type.
+     * Prevents duplicate placement ids in the inject data.
      *
-     * @param {IInjectSpotElement[]} spots - The spot type data.
+     * @param {IInjectSpotElement[]} inject - The inject data.
      *
-     * @return {IInjectSpotElement[]} - The normalized spot type data.
+     * @throws {Error} - If a duplicate placement id is found.
+     *
+     * @return {void}
      */
-    private normalizeDataSpotType;
+    private preventDuplicateSpotPlacementIds;
 }
 /**
  * Creates a new instance of the RmnClient.

package/dist/types/types.d.ts

@@ -2,11 +2,11 @@ export type { IInjectSpotElement, IInjectSpotElementConfig, IRmnCreateSpotElemen
 export type { ISpots, RmnFilterType, RmnSpotType } from 'modules/selection';
 export { ISpot, ISpotEvent, ISpotSelectionParams } from 'modules/selection';
 import type { RMN_ENV } from 'enums';
-import type { IInjectSpotElement, IInjectSpotElementConfig } from 'modules/element';
+import type { IInjectSpotElementParams } from 'modules/element';
 import type { ISpots, ISpotSelectionParams } from 'modules/selection';
 export interface IRmnClient {
-    spotSelection(data: ISpotSelectionParams): Promise<ISpots>;
-    injectSpotElement(spots: IInjectSpotElement[], config?: IInjectSpotElementConfig): Promise<void>;
+    spotSelection(params: ISpotSelectionParams): Promise<ISpots>;
+    injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
 }
 export interface IRmnConfig {
     env: RMN_ENV;

package/package.json

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