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

package/dist/types/enums.d.ts

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

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

@@ -1,12 +1,12 @@
 import type { ICreateElementConfig } from 'modules/element';
-export type CarouselNavPosition = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'middle-left' | 'middle-right' | 'middle-sides';
+export type CarouselNavPositionType = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'middle-left' | 'middle-right' | 'middle-sides';
 export interface ICarouselDotOptions {
-    position: CarouselNavPosition;
+    position: CarouselNavPositionType;
     color: string;
     activeColor: string;
 }
 export interface ICarouselButtonOptions {
-    position: CarouselNavPosition;
+    position: CarouselNavPositionType;
     together: boolean;
     textColor: string;
     backgroundColor: string;

package/dist/types/modules/element/component/utils.d.ts

@@ -0,0 +1 @@
+export declare function calculateScaleFactor(elementScale: number): number;

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

@@ -13,6 +13,7 @@ export interface ISpotOverlay {
     colorStop: string;
 }
 export interface IInjectSpotElementConfig {
+    fluid?: boolean;
     url?: string;
     colors?: ISpotColors;
     minScale?: number;
@@ -27,6 +28,7 @@ export interface IInjectSpotElement {
     filter?: Partial<RmnFilterType>;
 }
 export interface ICreateElementConfig {
+    spot?: RMN_SPOT_TYPE;
     width: number;
     height: number;
     fluid?: boolean;

package/dist/types/modules/element/template/template.service.d.ts

@@ -1,10 +1,11 @@
 import type { ISpot } from 'types';
 import type { ISpotTemplateConfig } from './template.type';
 /**
- * Creates the spot html string based on the provided spot data.
+ * Returns the HTML element for the given spot.
  *
- * @param {ISpot} spot - The spot data.
+ * @param {ISpot} spot - The spot object.
+ * @param {ISpotTemplateConfig} config - The spot template configuration.
  *
- * @return {string} - The spot html string.
+ * @return {HTMLElement | null} - The HTML element for the given spot or null if the spot template is not found.
  */
 export declare const SPOT_TEMPLATE_HTML_ELEMENT: (spot: ISpot, config?: ISpotTemplateConfig) => HTMLElement | null;

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

@@ -1,5 +1,58 @@
 import type { RMN_SPOT_EVENT } from 'enums';
+import type { ISpot } from '../selection';
 export interface IFireEventParams {
     event: RMN_SPOT_EVENT;
     eventUrl: string;
 }
+export interface IMountedEvent {
+    placementId: string;
+    spotId: string;
+    spotType: string;
+    spotVariant: string;
+    element: HTMLElement;
+}
+export interface IUnMountedEvent {
+    placementId: string;
+    spotId: string;
+}
+export interface IClickEvent {
+    placementId: string;
+    spotId: string;
+    element: HTMLElement;
+}
+export interface IImpressionEvent {
+    placementId: string;
+    spotId: string;
+    element: HTMLElement;
+}
+export interface IAddToCartEvent {
+    placementId: string;
+    spotId: string;
+}
+export interface IAddToWishlistEvent {
+    placementId: string;
+    spotId: string;
+}
+export interface IPurchaseEvent {
+    placementId: string;
+    spotId: string;
+}
+export interface IBuyNowEvent {
+    placementId: string;
+    spotId: string;
+}
+export interface IEventMap {
+    [RMN_SPOT_EVENT.MOUNTED]: IMountedEvent;
+    [RMN_SPOT_EVENT.UNMOUNTED]: IUnMountedEvent;
+    [RMN_SPOT_EVENT.CLICK]: IClickEvent;
+    [RMN_SPOT_EVENT.IMPRESSION]: IImpressionEvent;
+    [RMN_SPOT_EVENT.ADD_TO_CART]: IAddToCartEvent;
+    [RMN_SPOT_EVENT.ADD_TO_WISHLIST]: IAddToWishlistEvent;
+    [RMN_SPOT_EVENT.PURCHASE]: IPurchaseEvent;
+    [RMN_SPOT_EVENT.BUY_NOW]: IBuyNowEvent;
+}
+export interface IRegisterSpotParams {
+    placementId: string;
+    element: HTMLElement;
+    spot: ISpot;
+}

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/index.d.ts

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

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

@@ -11,6 +11,7 @@ export interface ISpotEvent {
     url: string;
 }
 export interface ISpot {
+    id: string;
     events: ISpotEvent[];
     spot: RMN_SPOT_TYPE;
     variant: SpotVariantType;

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

@@ -1,10 +1,12 @@
 import type { IAuthCredentials } from 'modules/auth';
 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.
@@ -24,6 +26,12 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      * @return {Promise<void>} - A promise that resolves when the spot elements are injected.
      */
     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.
      *
@@ -53,6 +61,7 @@ export declare class LiquidCommerceRmnClient implements IRmnClient {
      * @return {void}
      */
     private injectOneSpotElement;
+    private eventSpotElement;
     /**
      * Prevents duplicate placement ids in the inject data.
      *

package/dist/types/types.d.ts

@@ -1,4 +1,6 @@
-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';
@@ -7,6 +9,7 @@ import type { ISpots, ISpotSelectionParams } from 'modules/selection';
 export interface IRmnClient {
     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.4",
+  "version": "1.4.6-beta.6",
   "homepage": "https://docs.liquidcommerce.co/rmn-sdk",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",