@liquidcommercedev/rmn-sdk 1.4.6-beta.6 → 1.4.6-beta.7

package/dist/index.cjs

@@ -56,6 +56,7 @@ exports.RMN_FILTER_PROPERTIES = void 0;
 })(exports.RMN_FILTER_PROPERTIES || (exports.RMN_FILTER_PROPERTIES = {}));
 exports.RMN_SPOT_EVENT = void 0;
 (function (RMN_SPOT_EVENT) {
+    RMN_SPOT_EVENT["INJECT_SPOTS"] = "INJECT_SPOTS";
     RMN_SPOT_EVENT["MOUNTED"] = "MOUNTED";
     RMN_SPOT_EVENT["UNMOUNTED"] = "UNMOUNTED";
     RMN_SPOT_EVENT["IMPRESSION"] = "IMPRESSION";
@@ -17913,19 +17914,19 @@ class SelectionService extends BaseApi {
      *
      * @param {ISpotSelectionParams} data - Spots selection parameters.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | { error: string }>} - The spots response object.
      */
     async spotSelection(data) {
         const { isOk, val, isErr } = await this.post(SELECTION_API_PATH, data, {});
         if (isErr) {
-            throw new Error(`There was an error during spot selection: (${isErr === null || isErr === void 0 ? void 0 : isErr.errorMessage})`);
+            return { error: `There was an error during spot selection: (${isErr === null || isErr === void 0 ? void 0 : isErr.errorMessage})` };
         }
         if (isOk && val && val.data && (val === null || val === void 0 ? void 0 : val.refresh.token)) {
             this.authInfo.authenticated = true;
             this.authInfo.token = val.refresh.token;
             return val.data.spots;
         }
-        throw new Error('Spot selection response was not successful');
+        return { error: 'Spot selection response was not successful' };
     }
 }
 
@@ -17942,7 +17943,7 @@ class LiquidCommerceRmnClient {
      *
      * @param {ISpotSelectionParams} params - Spots selection parameters.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | {error : string}>} - The spots response object.
      */
     async spotSelection(params) {
         return this.selectionService.spotSelection(params);
@@ -17956,31 +17957,51 @@ class LiquidCommerceRmnClient {
      */
     async injectSpotElement(params) {
         var _a;
-        const { inject, config } = params;
+        const config = params.config;
+        let inject = params.inject;
+        this.eventService.publish(exports.RMN_SPOT_EVENT.INJECT_SPOTS, {
+            isLoading: true,
+            isCompleted: false,
+            error: null,
+        });
         if (!inject.length) {
-            console.warn('RmnSdk: Failed to inject spot element. Please provide at least one spot element to inject.');
+            this.eventError('RmnSdk: Failed to inject spot element. Please provide at least one spot element to inject.');
+            return;
+        }
+        const hasDuplicatePlacementIds = this.preventDuplicateSpotPlacementIds(inject);
+        if (!hasDuplicatePlacementIds) {
+            return;
+        }
+        inject = this.preventNonExistentSpotTypes(inject);
+        const response = await this.spotSelectionRequest({ ...params, inject });
+        if (typeof response === 'object' && 'error' in response) {
+            this.eventError(response.error);
             return;
         }
-        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}".`);
+                this.eventError(`RmnSdk: Failed to inject spot element. No spots found for type "${item.spotType}".`, { placementId: item.placementId, type: item.spotType });
                 continue;
             }
             const placementId = item.placementId.replace('#', '');
             const placement = document.getElementById(placementId);
             if (!placement) {
-                console.warn(`RmnSdk: Failed to inject spot element. Placement not found for id "#${placementId}".`);
+                this.eventError(`RmnSdk: Failed to inject spot element. Placement not found for id "#${placementId}".`, { placementId, type: item.spotType });
                 continue;
             }
             if (spots.length === 1) {
-                this.injectOneSpotElement(item, placement, spots[0], itemConfig);
+                const isInjected = this.injectOneSpotElement(item, placement, spots[0], itemConfig);
+                if (!isInjected) {
+                    continue;
+                }
             }
             if (spots.length > 1) {
-                this.injectCarouselSpotElement(placement, spots, itemConfig);
+                const isInjected = this.injectCarouselSpotElement(placement, spots, itemConfig);
+                if (!isInjected) {
+                    continue;
+                }
             }
         }
     }
@@ -17997,7 +18018,7 @@ class LiquidCommerceRmnClient {
      *
      * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | {error: string}>} - The spots response object.
      */
     async spotSelectionRequest(params) {
         const { inject, filter, config } = params;
@@ -18029,8 +18050,8 @@ class LiquidCommerceRmnClient {
             const spot = this.elementService.overrideSpotColors(spotItem, config === null || config === void 0 ? void 0 : config.colors);
             const content = SPOT_TEMPLATE_HTML_ELEMENT(spot, { overlay: config === null || config === void 0 ? void 0 : config.overlay });
             if (!content) {
-                console.warn(`RmnSdk: Failed to inject carousel spot element. Could not create element for type "${spot.spot}".`);
-                return;
+                this.eventError(`RmnSdk: Failed to inject carousel spot element. Could not create element for type "${spot.spot}".`, { placementId: placement.id, type: spot.spot });
+                continue;
             }
             this.eventSpotElement({
                 spot,
@@ -18054,10 +18075,11 @@ class LiquidCommerceRmnClient {
             },
         });
         if (!carouselElement) {
-            console.warn(`RmnSdk: Failed to inject spot carousel element. Could not create spot carousel element.`);
-            return;
+            this.eventError(`RmnSdk: Failed to inject spot carousel element. Could not create spot carousel element.`, { placementId: placement.id });
+            return false;
         }
         placement.replaceChildren(carouselElement);
+        return true;
     }
     /**
      * Injects a single spot element into the provided placement.
@@ -18074,8 +18096,8 @@ class LiquidCommerceRmnClient {
         const spotData = this.elementService.overrideSpotColors(spot, config === null || config === void 0 ? void 0 : config.colors);
         const content = SPOT_TEMPLATE_HTML_ELEMENT(spotData, { overlay: config === null || config === void 0 ? void 0 : config.overlay });
         if (!content) {
-            console.warn(`RmnSdk: Failed to inject spot element. Could not create element for type "${injectItem.spotType}".`);
-            return;
+            this.eventError(`RmnSdk: Failed to inject spot element. Could not create element for type "${injectItem.spotType}".`, { placementId: injectItem.placementId, type: injectItem.spotType });
+            return false;
         }
         const spotElement = this.elementService.createSpotElement({
             content,
@@ -18088,8 +18110,8 @@ class LiquidCommerceRmnClient {
             },
         });
         if (!spotElement) {
-            console.warn(`RmnSdk: Failed to inject spot element. Could not create element for type "${injectItem.spotType}".`);
-            return;
+            this.eventError(`RmnSdk: Failed to inject spot element. Could not create element for type "${injectItem.spotType}".`, { placementId: injectItem.placementId, type: injectItem.spotType });
+            return false;
         }
         this.eventSpotElement({
             spot,
@@ -18097,6 +18119,7 @@ class LiquidCommerceRmnClient {
             element: spotElement,
         });
         placement.replaceChildren(spotElement);
+        return true;
     }
     eventSpotElement({ spot, placementId, element, }) {
         this.eventService.registerSpot({
@@ -18118,10 +18141,33 @@ class LiquidCommerceRmnClient {
         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.`);
+                this.eventError(`RmnSdk: Duplicate placement id (${item.placementId}) found. Please provide a unique placement id for each spot element.`, { placementId: item.placementId, type: item.spotType });
+                return false;
             }
             placementIds.add(item.placementId);
         }
+        return true;
+    }
+    preventNonExistentSpotTypes(inject) {
+        const newInject = [];
+        for (const item of inject) {
+            if (!Object.values(exports.RMN_SPOT_TYPE).includes(item.spotType)) {
+                this.eventError(`RmnSdk: Invalid spot type (${item.spotType}) found. Please provide a valid spot type for each spot element.`, { placementId: item.placementId, type: item.spotType });
+                continue;
+            }
+            newInject.push(item);
+        }
+        return newInject;
+    }
+    eventError(error, spot) {
+        this.eventService.publish(exports.RMN_SPOT_EVENT.INJECT_SPOTS, {
+            isLoading: false,
+            isCompleted: true,
+            error: {
+                message: error,
+                spot,
+            },
+        });
     }
 }
 /**

package/dist/index.esm.js

@@ -54,6 +54,7 @@ var RMN_FILTER_PROPERTIES;
 })(RMN_FILTER_PROPERTIES || (RMN_FILTER_PROPERTIES = {}));
 var RMN_SPOT_EVENT;
 (function (RMN_SPOT_EVENT) {
+    RMN_SPOT_EVENT["INJECT_SPOTS"] = "INJECT_SPOTS";
     RMN_SPOT_EVENT["MOUNTED"] = "MOUNTED";
     RMN_SPOT_EVENT["UNMOUNTED"] = "UNMOUNTED";
     RMN_SPOT_EVENT["IMPRESSION"] = "IMPRESSION";
@@ -17911,19 +17912,19 @@ class SelectionService extends BaseApi {
      *
      * @param {ISpotSelectionParams} data - Spots selection parameters.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | { error: string }>} - The spots response object.
      */
     async spotSelection(data) {
         const { isOk, val, isErr } = await this.post(SELECTION_API_PATH, data, {});
         if (isErr) {
-            throw new Error(`There was an error during spot selection: (${isErr === null || isErr === void 0 ? void 0 : isErr.errorMessage})`);
+            return { error: `There was an error during spot selection: (${isErr === null || isErr === void 0 ? void 0 : isErr.errorMessage})` };
         }
         if (isOk && val && val.data && (val === null || val === void 0 ? void 0 : val.refresh.token)) {
             this.authInfo.authenticated = true;
             this.authInfo.token = val.refresh.token;
             return val.data.spots;
         }
-        throw new Error('Spot selection response was not successful');
+        return { error: 'Spot selection response was not successful' };
     }
 }
 
@@ -17940,7 +17941,7 @@ class LiquidCommerceRmnClient {
      *
      * @param {ISpotSelectionParams} params - Spots selection parameters.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | {error : string}>} - The spots response object.
      */
     async spotSelection(params) {
         return this.selectionService.spotSelection(params);
@@ -17954,31 +17955,51 @@ class LiquidCommerceRmnClient {
      */
     async injectSpotElement(params) {
         var _a;
-        const { inject, config } = params;
+        const config = params.config;
+        let inject = params.inject;
+        this.eventService.publish(RMN_SPOT_EVENT.INJECT_SPOTS, {
+            isLoading: true,
+            isCompleted: false,
+            error: null,
+        });
         if (!inject.length) {
-            console.warn('RmnSdk: Failed to inject spot element. Please provide at least one spot element to inject.');
+            this.eventError('RmnSdk: Failed to inject spot element. Please provide at least one spot element to inject.');
+            return;
+        }
+        const hasDuplicatePlacementIds = this.preventDuplicateSpotPlacementIds(inject);
+        if (!hasDuplicatePlacementIds) {
+            return;
+        }
+        inject = this.preventNonExistentSpotTypes(inject);
+        const response = await this.spotSelectionRequest({ ...params, inject });
+        if (typeof response === 'object' && 'error' in response) {
+            this.eventError(response.error);
             return;
         }
-        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}".`);
+                this.eventError(`RmnSdk: Failed to inject spot element. No spots found for type "${item.spotType}".`, { placementId: item.placementId, type: item.spotType });
                 continue;
             }
             const placementId = item.placementId.replace('#', '');
             const placement = document.getElementById(placementId);
             if (!placement) {
-                console.warn(`RmnSdk: Failed to inject spot element. Placement not found for id "#${placementId}".`);
+                this.eventError(`RmnSdk: Failed to inject spot element. Placement not found for id "#${placementId}".`, { placementId, type: item.spotType });
                 continue;
             }
             if (spots.length === 1) {
-                this.injectOneSpotElement(item, placement, spots[0], itemConfig);
+                const isInjected = this.injectOneSpotElement(item, placement, spots[0], itemConfig);
+                if (!isInjected) {
+                    continue;
+                }
             }
             if (spots.length > 1) {
-                this.injectCarouselSpotElement(placement, spots, itemConfig);
+                const isInjected = this.injectCarouselSpotElement(placement, spots, itemConfig);
+                if (!isInjected) {
+                    continue;
+                }
             }
         }
     }
@@ -17995,7 +18016,7 @@ class LiquidCommerceRmnClient {
      *
      * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | {error: string}>} - The spots response object.
      */
     async spotSelectionRequest(params) {
         const { inject, filter, config } = params;
@@ -18027,8 +18048,8 @@ class LiquidCommerceRmnClient {
             const spot = this.elementService.overrideSpotColors(spotItem, config === null || config === void 0 ? void 0 : config.colors);
             const content = SPOT_TEMPLATE_HTML_ELEMENT(spot, { overlay: config === null || config === void 0 ? void 0 : config.overlay });
             if (!content) {
-                console.warn(`RmnSdk: Failed to inject carousel spot element. Could not create element for type "${spot.spot}".`);
-                return;
+                this.eventError(`RmnSdk: Failed to inject carousel spot element. Could not create element for type "${spot.spot}".`, { placementId: placement.id, type: spot.spot });
+                continue;
             }
             this.eventSpotElement({
                 spot,
@@ -18052,10 +18073,11 @@ class LiquidCommerceRmnClient {
             },
         });
         if (!carouselElement) {
-            console.warn(`RmnSdk: Failed to inject spot carousel element. Could not create spot carousel element.`);
-            return;
+            this.eventError(`RmnSdk: Failed to inject spot carousel element. Could not create spot carousel element.`, { placementId: placement.id });
+            return false;
         }
         placement.replaceChildren(carouselElement);
+        return true;
     }
     /**
      * Injects a single spot element into the provided placement.
@@ -18072,8 +18094,8 @@ class LiquidCommerceRmnClient {
         const spotData = this.elementService.overrideSpotColors(spot, config === null || config === void 0 ? void 0 : config.colors);
         const content = SPOT_TEMPLATE_HTML_ELEMENT(spotData, { overlay: config === null || config === void 0 ? void 0 : config.overlay });
         if (!content) {
-            console.warn(`RmnSdk: Failed to inject spot element. Could not create element for type "${injectItem.spotType}".`);
-            return;
+            this.eventError(`RmnSdk: Failed to inject spot element. Could not create element for type "${injectItem.spotType}".`, { placementId: injectItem.placementId, type: injectItem.spotType });
+            return false;
         }
         const spotElement = this.elementService.createSpotElement({
             content,
@@ -18086,8 +18108,8 @@ class LiquidCommerceRmnClient {
             },
         });
         if (!spotElement) {
-            console.warn(`RmnSdk: Failed to inject spot element. Could not create element for type "${injectItem.spotType}".`);
-            return;
+            this.eventError(`RmnSdk: Failed to inject spot element. Could not create element for type "${injectItem.spotType}".`, { placementId: injectItem.placementId, type: injectItem.spotType });
+            return false;
         }
         this.eventSpotElement({
             spot,
@@ -18095,6 +18117,7 @@ class LiquidCommerceRmnClient {
             element: spotElement,
         });
         placement.replaceChildren(spotElement);
+        return true;
     }
     eventSpotElement({ spot, placementId, element, }) {
         this.eventService.registerSpot({
@@ -18116,10 +18139,33 @@ class LiquidCommerceRmnClient {
         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.`);
+                this.eventError(`RmnSdk: Duplicate placement id (${item.placementId}) found. Please provide a unique placement id for each spot element.`, { placementId: item.placementId, type: item.spotType });
+                return false;
             }
             placementIds.add(item.placementId);
         }
+        return true;
+    }
+    preventNonExistentSpotTypes(inject) {
+        const newInject = [];
+        for (const item of inject) {
+            if (!Object.values(RMN_SPOT_TYPE).includes(item.spotType)) {
+                this.eventError(`RmnSdk: Invalid spot type (${item.spotType}) found. Please provide a valid spot type for each spot element.`, { placementId: item.placementId, type: item.spotType });
+                continue;
+            }
+            newInject.push(item);
+        }
+        return newInject;
+    }
+    eventError(error, spot) {
+        this.eventService.publish(RMN_SPOT_EVENT.INJECT_SPOTS, {
+            isLoading: false,
+            isCompleted: true,
+            error: {
+                message: error,
+                spot,
+            },
+        });
     }
 }
 /**

package/dist/types/enums.d.ts

@@ -49,6 +49,7 @@ export declare enum RMN_FILTER_PROPERTIES {
     SECTION = "section"
 }
 export declare enum RMN_SPOT_EVENT {
+    INJECT_SPOTS = "INJECT_SPOTS",
     MOUNTED = "MOUNTED",
     UNMOUNTED = "UNMOUNTED",
     IMPRESSION = "IMPRESSION",

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

@@ -4,6 +4,18 @@ export interface IFireEventParams {
     event: RMN_SPOT_EVENT;
     eventUrl: string;
 }
+export interface IInjectSpotError {
+    message: string;
+    spot?: {
+        type?: string;
+        placementId?: string;
+    };
+}
+export interface IInjectSpotsEvent {
+    isLoading: boolean;
+    isCompleted: boolean;
+    error: null | IInjectSpotError;
+}
 export interface IMountedEvent {
     placementId: string;
     spotId: string;
@@ -42,6 +54,7 @@ export interface IBuyNowEvent {
     spotId: string;
 }
 export interface IEventMap {
+    [RMN_SPOT_EVENT.INJECT_SPOTS]: IInjectSpotsEvent;
     [RMN_SPOT_EVENT.MOUNTED]: IMountedEvent;
     [RMN_SPOT_EVENT.UNMOUNTED]: IUnMountedEvent;
     [RMN_SPOT_EVENT.CLICK]: IClickEvent;

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

@@ -33,5 +33,7 @@ export interface ISpot {
 }
 export type ISpots = Record<PlacementIdType, ISpot[]>;
 export interface ISelectionService {
-    spotSelection(data: ISpotSelectionParams): Promise<ISpots>;
+    spotSelection(data: ISpotSelectionParams): Promise<ISpots | {
+        error: string;
+    }>;
 }

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

@@ -10,7 +10,9 @@ export declare class SelectionService extends BaseApi implements ISelectionServi
      *
      * @param {ISpotSelectionParams} data - Spots selection parameters.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | { error: string }>} - The spots response object.
      */
-    spotSelection(data: ISpotSelectionParams): Promise<ISpots>;
+    spotSelection(data: ISpotSelectionParams): Promise<ISpots | {
+        error: string;
+    }>;
 }

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

@@ -15,9 +15,11 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      *
      * @param {ISpotSelectionParams} params - Spots selection parameters.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | {error : string}>} - The spots response object.
      */
-    spotSelection(params: ISpotSelectionParams): Promise<ISpots>;
+    spotSelection(params: ISpotSelectionParams): Promise<ISpots | {
+        error: string;
+    }>;
     /**
      * Injects the spot elements into their provided placement.
      *
@@ -37,7 +39,7 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      *
      * @param {IInjectSpotElementParams} params - Parameters for injecting spot elements.
      *
-     * @return {Promise<ISpots>} - The spots response object.
+     * @return {Promise<ISpots | {error: string}>} - The spots response object.
      */
     private spotSelectionRequest;
     /**
@@ -72,6 +74,8 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      * @return {void}
      */
     private preventDuplicateSpotPlacementIds;
+    private preventNonExistentSpotTypes;
+    private eventError;
 }
 /**
  * Creates a new instance of the RmnClient.

package/dist/types/types.d.ts

@@ -7,7 +7,9 @@ import type { RMN_ENV } from 'enums';
 import type { IInjectSpotElementParams } from 'modules/element';
 import type { ISpots, ISpotSelectionParams } from 'modules/selection';
 export interface IRmnClient {
-    spotSelection(params: ISpotSelectionParams): Promise<ISpots>;
+    spotSelection(params: ISpotSelectionParams): Promise<ISpots | {
+        error: string;
+    }>;
     injectSpotElement(params: IInjectSpotElementParams): Promise<void>;
     eventManager(): EventService;
 }

package/package.json

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