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

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

@@ -1,5 +1,30 @@
-import type { IFireEventParams } from './event.interface';
+import type { IEventMap, IRegisterSpotParams } from './event.interface';
 export declare class EventService {
-    fireEvent({ event, eventUrl }: IFireEventParams): Promise<void>;
+    private static instance;
+    private pubSub;
+    private intersectionObserver;
+    private activeSpots;
+    private constructor();
+    static getInstance(): EventService;
+    registerSpot({ placementId, element, spot }: IRegisterSpotParams): void;
+    unregisterSpot(spotId: string): void;
+    private handleIntersectionObserver;
+    subscribe<K extends keyof IEventMap>(eventType: K, callback: (data: IEventMap[K]) => void): () => void;
+    publish<K extends keyof IEventMap>(eventType: K, data: IEventMap[K]): void;
+    /**
+     * Fires an event using the navigator.sendBeacon method and redirects the user if the event is a click event.
+     *
+     * @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;
+    /**
+     * Extracts and decodes a URL from a base64-encoded query parameter.
+     *
+     * @param {string} url - The URL containing the base64-encoded query parameter.
+     * @returns {string} - The decoded URL or an empty string if decoding fails.
+     */
     private getRedirectUrlFromPayload;
 }

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

@@ -0,0 +1,67 @@
+/**
+ * Callback function type for event subscribers
+ * @template T The type of data the callback receives
+ */
+export type PSCallback<T> = (data: T) => void;
+/**
+ * Function type for unsubscribing from an event
+ */
+export type PSUnsubscribe = () => void;
+/**
+ * PubSub class
+ * Manages event subscriptions and publications
+ * @template IEventMap A record type defining the structure of events and their data
+ */
+export declare class PubSub<IEventMap> {
+    /**
+     * Object to store subscribers for each event type
+     */
+    private subscribers;
+    /**
+     * Subscribe to an event
+     * @param eventType - The type of event to subscribe to
+     * @param callback - The function to be called when the event is published
+     * @returns A function to unsubscribe from the event
+     *
+     * @Example:
+     * const unsubscribe = pubSub.subscribe('userLogin', (data) => {
+     *   console.log(`User ${data.username} logged in`);
+     * });
+     */
+    subscribe<K extends keyof IEventMap>(eventType: K, callback: PSCallback<IEventMap[K]>): PSUnsubscribe;
+    /**
+     * Publish an event
+     * @param eventType - The type of event to publish
+     * @param data - The data to be passed to the event subscribers
+     *
+     * @Example:
+     * pubSub.publish('userLogin', { username: 'john_doe', timestamp: Date.now() });
+     */
+    publish<K extends keyof IEventMap>(eventType: K, data: IEventMap[K]): void;
+}
+/**
+ * Usage Example:
+ *
+ * interface IEventMap {
+ *   userLogin: { username: string; timestamp: number };
+ *   pageView: { url: string; timestamp: number };
+ * }
+ *
+ * const pubSub = new PubSub<IEventMap>();
+ *
+ * // Subscribe to events
+ * const unsubscribeLogin = pubSub.subscribe('userLogin', (data) => {
+ *   console.log(`User ${data.username} logged in at ${new Date(data.timestamp)}`);
+ * });
+ *
+ * pubSub.subscribe('pageView', (data) => {
+ *   console.log(`Page ${data.url} viewed at ${new Date(data.timestamp)}`);
+ * });
+ *
+ * // Publish events
+ * pubSub.publish('userLogin', { username: 'john_doe', timestamp: Date.now() });
+ * pubSub.publish('pageView', { url: '/home', timestamp: Date.now() });
+ *
+ * // Unsubscribe from an event
+ * unsubscribeLogin();
+ */

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;
@@ -11,6 +11,7 @@ export interface ISpotEvent {
     url: string;
 }
 export interface ISpot {
+    id: string;
     events: ISpotEvent[];
     spot: RMN_SPOT_TYPE;
     variant: SpotVariantType;
@@ -30,7 +31,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,30 +1,45 @@
 import type { IAuthCredentials } from 'modules/auth';
-import type { IInjectSpotElement, IInjectSpotElementConfig, IRmnCreateSpotElementConfig } from 'modules/element';
+import type { IInjectSpotElementParams, IRmnCreateSpotElementConfig } from 'modules/element';
+import { EventService } from 'modules/event';
 import type { ISpot, ISpots, ISpotSelectionParams } from 'modules/selection';
 import type { IRmnClient, IRmnConfig } from 'types';
 export declare class LiquidCommerceRmnClient implements IRmnClient {
     private readonly selectionService;
     private readonly elementService;
+    private readonly eventService;
     constructor(auth: IAuthCredentials);
     /**
      * Makes a selection request on our server based on the provided data.
      *
      * 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>;
+    /**
+     * Returns the event manager instance.
+     *
+     * @return {EventService} - The event manager instance.
+     */
+    eventManager(): EventService;
+    /**
+     * 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.
      *
@@ -46,14 +61,17 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      * @return {void}
      */
     private injectOneSpotElement;
+    private eventSpotElement;
     /**
-     * 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}
      */
-    private normalizeDataSpotType;
+    private preventDuplicateSpotPlacementIds;
 }
 /**
  * Creates a new instance of the RmnClient.

package/dist/types/types.d.ts

@@ -1,12 +1,15 @@
-export type { IInjectSpotElement, IInjectSpotElementConfig, IRmnCreateSpotElementConfig, } from 'modules/element';
+import type { EventService } 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 { 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>;
+    eventManager(): EventService;
 }
 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.5",
   "homepage": "https://docs.liquidcommerce.co/rmn-sdk",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",