@liquidcommercedev/rmn-sdk 1.5.0-beta.8 → 1.5.0-beta.9

package/dist/types/common/helpers/utils.helper.d.ts

@@ -0,0 +1,50 @@
+import { RMN_SPOT_EVENT } from 'enums';
+import type { IFireEventParams } from 'modules/event';
+export interface IExtractIdsProps {
+    id?: string | number;
+    upc?: string | number;
+    [key: string]: string | number | undefined;
+}
+/**
+ * Determines the event type from a raw event string.
+ *
+ * @param {string} [event] - The raw event string to evaluate.
+ * @returns {RMN_SPOT_EVENT | null} - The corresponding RMN_SPOT_EVENT or null if no match is found.
+ */
+export declare function getEventTypeFromRawEvent(event?: string): RMN_SPOT_EVENT | null;
+/**
+ * Recursively extracts ID values from a nested data structure.
+ * Searches for specified property names and collects their primitive values (strings/numbers).
+ *
+ * @param data - The data structure to search through (can be nested objects/arrays)
+ * @param propertyNames - Array of property names to look for
+ * @returns Array of extracted ID values (strings/numbers only)
+ *
+ * @example
+ * const data = {
+ *   id: [1, 2, 3],
+ *   nested: { id: 'abc' },
+ *   items: [{ id: 456 }]
+ * };
+ * extractDeepIds(data); // Returns [1, 2, 3, 'abc', 456]
+ */
+export declare function extractDeepIds(data: any, propertyNames?: string[]): Array<string | number>;
+export declare function fallbackEventFire(url: string): Promise<boolean>;
+/**
+ * Extracts and decodes a URL from a base64-encoded query parameter.
+ *
+ * @param {string} url - The URL containing the base64-encoded query parameter.
+ * @returns {string | null} - The decoded URL or null if not found or invalid.
+ */
+export declare function getRedirectUrlFromPayload(url: string): string | null;
+/**
+ * Fires an event using the navigator.sendBeacon method or a fallback method if sendBeacon is not available.
+ * If the event is a click event and a redirect URL is found, it redirects the user to that URL.
+ *
+ * @param {IFireEventParams} params - The parameters for firing the event.
+ * @param {RMN_SPOT_EVENT} params.event - The event type.
+ * @param {string} params.eventUrl - The URL to which the event is sent.
+ * @returns {Promise<void>} - A promise that resolves when the event is fired.
+ */
+export declare function fireEvent({ event, eventUrl }: IFireEventParams): Promise<void>;
+export declare function calculateScaleFactor(elementScale: number): number;

package/dist/types/enums.d.ts

@@ -49,8 +49,11 @@ export declare enum RMN_FILTER_PROPERTIES {
     PUBLISHERS = "publishers",
     SECTION = "section"
 }
-export declare enum RMN_SPOT_EVENT {
+export declare enum RMN_EVENT {
     LIFECYCLE_STATE = "LIFECYCLE_STATE",
+    SPOT_EVENT = "SPOT_EVENT"
+}
+export declare enum RMN_SPOT_EVENT {
     IMPRESSION = "IMPRESSION",
     CLICK = "CLICK",
     PURCHASE = "PURCHASE",

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

@@ -1,4 +1,4 @@
-import type { RMN_SPOT_EVENT } from 'enums';
+import type { RMN_EVENT, RMN_SPOT_EVENT } from 'enums';
 import type { ISpot } from '../selection';
 export interface IFireEventParams {
     event: RMN_SPOT_EVENT;
@@ -30,45 +30,15 @@ export interface ILifecycleState {
     state?: Partial<ILSState>;
     displayConfig?: Partial<ILSDisplayConfig>;
 }
-export interface IClickEvent {
-    placementId: string;
-    spotId: string;
-    spotElement: HTMLElement;
-}
-export interface IImpressionEvent {
-    placementId: string;
-    spotId: string;
-    spotElement: HTMLElement;
-}
-export interface IAddToCartEvent {
-    placementId: string;
-    spotId: string;
-}
-export interface IRemoveFromCartEvent {
-    placementId: string;
-    spotId: string;
-}
-export interface IAddToWishlistEvent {
-    placementId: string;
-    spotId: string;
-}
-export interface IPurchaseEvent {
-    placementId: string;
-    spotId: string;
-}
-export interface IBuyNowEvent {
+export interface IRmnSpotEvent {
+    eventType: RMN_SPOT_EVENT;
     placementId: string;
     spotId: string;
+    spotElement?: HTMLElement;
 }
 export interface IRmnEventMap {
-    [RMN_SPOT_EVENT.LIFECYCLE_STATE]: ILifecycleState;
-    [RMN_SPOT_EVENT.CLICK]: IClickEvent;
-    [RMN_SPOT_EVENT.IMPRESSION]: IImpressionEvent;
-    [RMN_SPOT_EVENT.ADD_TO_CART]: IAddToCartEvent;
-    [RMN_SPOT_EVENT.REMOVE_FROM_CART]: IRemoveFromCartEvent;
-    [RMN_SPOT_EVENT.ADD_TO_WISHLIST]: IAddToWishlistEvent;
-    [RMN_SPOT_EVENT.PURCHASE]: IPurchaseEvent;
-    [RMN_SPOT_EVENT.BUY_NOW]: IBuyNowEvent;
+    [RMN_EVENT.LIFECYCLE_STATE]: ILifecycleState;
+    [RMN_EVENT.SPOT_EVENT]: IRmnSpotEvent;
 }
 export interface IRegisterSpotParams {
     placementId: string;

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

@@ -1,16 +1,16 @@
-import { RMN_SPOT_EVENT } from 'enums';
+import { RMN_EVENT } from 'enums';
 import type { ILifecycleState, IRegisterSpotParams, IRmnEventMap } from './event.interface';
 export declare class EventService {
     private static instance;
-    private pubSub;
-    private localStorage;
+    private pubSubService;
+    private localStorageService;
     private intersectionObserver;
     private spotStates;
     private activeSpots;
     private constructor();
     static getInstance(): EventService;
-    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;
     registerSpot(params: IRegisterSpotParams): void;
     unregisterSpot(placementId: string): void;
     /**
@@ -27,22 +27,4 @@ export declare class EventService {
     private handleClick;
     private handleIntersectionObserver;
     private fireImpressionEvent;
-    /**
-     * Fires an event using the navigator.sendBeacon method or a fallback method if sendBeacon is not available.
-     * If the event is a click event and a redirect URL is found, it redirects the user to that URL.
-     *
-     * @param {IFireEventParams} params - The parameters for firing the event.
-     * @param {RMN_SPOT_EVENT} params.event - The event type.
-     * @param {string} params.eventUrl - The URL to which the event is sent.
-     * @returns {Promise<void>} - A promise that resolves when the event is fired.
-     */
-    private fireEvent;
-    private fallbackEventFire;
-    /**
-     * Extracts and decodes a URL from a base64-encoded query parameter.
-     *
-     * @param {string} url - The URL containing the base64-encoded query parameter.
-     * @returns {string | null} - The decoded URL or null if not found or invalid.
-     */
-    private getRedirectUrlFromPayload;
 }

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

@@ -1,5 +1,3 @@
 export * from './event.constant';
 export * from './event.interface';
 export * from './event.service';
-export * from './helpers';
-export * from './user.monitor';

package/dist/types/modules/{event/helpers → helper-service}/index.d.ts

@@ -1,4 +1,4 @@
-export * from './datalayer.monitor';
 export * from './intersection.service';
 export * from './localstorage.service';
+export * from './pubsub.service';
 export * from './resize.service';

package/dist/types/modules/{event/helpers → helper-service}/localstorage.service.d.ts

@@ -28,13 +28,13 @@ export declare enum ENUM_LOCAL_STORAGE_SPOT_ARRAY_INDEX {
 }
 export type LocalStorageSpotsArrayType = Record<string, // spotId
 LocalStorageSpotArray>;
-export declare class LocalStorage {
+export declare class LocalStorageService {
     private spots?;
     private static instance;
     private static readonly localStorageKey;
     private static readonly spotExpirationTime;
     private constructor();
-    static getInstance(): LocalStorage;
+    static getInstance(): LocalStorageService;
     private syncLocalStorage;
     setSpot(spotId: string, data: ILocalStorageSpot): void;
     removeSpot(spotId: string): void;

package/dist/types/modules/{event/pubsub.d.ts → helper-service/pubsub.service.d.ts}

@@ -8,13 +8,13 @@ export type PubSubCallback<T> = (data: T) => void;
  */
 export type PubSubUnsubscribe = () => void;
 /**
- * PubSub class
+ * PubsubService class
  * Manages event subscriptions and publications
  * @template IRmnEventMap A record type defining the structure of events and their data
  */
-export declare class PubSub<IRmnEventMap> {
+export declare class PubsubService<IRmnEventMap> {
     private static instance;
-    static getInstance<IRmnEventMap>(): PubSub<IRmnEventMap>;
+    static getInstance<IRmnEventMap>(): PubsubService<IRmnEventMap>;
     /**
      * Object to store subscribers for each event type
      */
@@ -49,7 +49,7 @@ export declare class PubSub<IRmnEventMap> {
  *   pageView: { url: string; timestamp: number };
  * }
  *
- * const pubSub = new PubSub<IRmnEventMap>();
+ * const pubSub = new PubsubService<IRmnEventMap>();
  *
  * // Subscribe to events
  * const unsubscribeLogin = pubSub.subscribe('userLogin', (data) => {

package/dist/types/modules/monitor/index.d.ts

@@ -0,0 +1,2 @@
+export * from './monitor.interface';
+export * from './monitor.service';

package/dist/types/modules/monitor/monitor.enums.d.ts

@@ -0,0 +1,4 @@
+export declare enum AnalyticsTool {
+    GoogleAnalytics = "google-analytics",
+    Other = "Other"
+}

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

@@ -0,0 +1,12 @@
+import type { RMN_SPOT_EVENT } from 'enums';
+export interface INormalizedEventData {
+    event: RMN_SPOT_EVENT;
+    productIds: Array<string | number>;
+}
+export interface IFireAndPublishSpotEventParams {
+    spotEvent: RMN_SPOT_EVENT;
+    eventUrl: string;
+    placementId: string;
+    spotId: string;
+    spotElement?: HTMLElement;
+}

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

@@ -0,0 +1,12 @@
+export declare class MonitorService {
+    private static instance;
+    private readonly implementedMonitor?;
+    private readonly pubSubService?;
+    private readonly localStorageService?;
+    private constructor();
+    static getInstance(): MonitorService;
+    start(): void;
+    private matchAndFireEvent;
+    private fireAndPublishSpotEvent;
+    private detectAnalyticsTool;
+}

package/dist/types/modules/{event/helpers → monitor/monitors}/datalayer.monitor.d.ts

@@ -1,13 +1,4 @@
-import type { RMN_SPOT_EVENT } from 'enums';
-export interface IDataLayerEvent {
-    event?: string;
-    value?: any[];
-    [key: string]: any;
-}
-export interface INormalizedEventData {
-    event: RMN_SPOT_EVENT;
-    productIds: Array<string | number>;
-}
+import type { INormalizedEventData } from '../monitor.interface';
 export declare class DataLayerMonitor {
     private static instance;
     private readonly originalPush;

package/dist/types/types.d.ts

@@ -1,9 +1,9 @@
 export type { IInjectSpotElement, IInjectSpotElementConfig, IInjectSpotElementParams, IRmnCreateSpotElementConfig, 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, IRemoveFromCartEvent, IRmnEventMap, } from 'modules/event';
+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 { IRmnEventMap } from 'modules/event';
 import type { ISpots, ISpotSelectionParams } from 'modules/selection';
@@ -14,8 +14,8 @@ export interface IRmnClient {
     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.8",
+  "version": "1.5.0-beta.9",
   "homepage": "https://docs.liquidcommerce.co/rmn-sdk",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",