@liquidcommercedev/rmn-sdk 1.4.6 → 1.5.0-beta.2

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

@@ -0,0 +1,49 @@
+export declare class UniqueIdGenerator {
+    private static readonly epoch;
+    private static readonly nodeBits;
+    private static readonly sequenceBits;
+    private static lastTimestamp;
+    private static sequence;
+    private static nodeId;
+    private static readonly base32Chars;
+    /**
+     * Initialize the generator with a node ID
+     * @param nodeId Number between 0-1023 to identify this instance
+     */
+    static initialize(nodeId?: number): void;
+    /**
+     * Convert a number to base32 string with specified length
+     */
+    private static toBase32;
+    /**
+     * Generate a cryptographically secure random number
+     */
+    private static getSecureRandom;
+    /**
+     * Wait until next millisecond
+     */
+    private static waitNextMillis;
+    /**
+     * Generates a highly unique ID with the following format:
+     * TTTTTTTTTTCCCCNNNNNRRRR
+     * T: Timestamp (10 chars)
+     * C: Counter (4 chars)
+     * N: Node ID (5 chars)
+     * R: Random (4 chars)
+     *
+     * Total length: 23 characters, always uppercase alphanumeric
+     */
+    static generate(): string;
+    /**
+     * Validates if a string matches the expected ID format
+     */
+    static isValid(id: string): boolean;
+    /**
+     * Decode base32 string to number
+     */
+    private static decodeBase32;
+    /**
+     * Extract timestamp from ID
+     */
+    static getTimestamp(id: string): Date;
+}

package/dist/types/enums.d.ts

@@ -1,4 +1,62 @@
-export * from './modules/spot/spot.enum';
+export declare enum RMN_SPOT_TYPE {
+    RB_HOMEPAGE_HERO_THREE_TILE = "rbHomepageHeroThreeTile",
+    RB_HOMEPAGE_HERO_TWO_TILE = "rbHomepageHeroTwoTile",
+    RB_HOMEPAGE_HERO_FULL_IMAGE = "rbHomepageHeroFullImage",
+    RB_LARGE_CATEGORY_IMAGE_TOUT = "rbLargeCategoryImageTout",
+    RB_SMALL_DISCOVER_TOUT = "rbSmallDiscoverTout",
+    RB_SMALL_CATEGORY_IMAGE_TOUT = "rbSmallCategoryImageTout",
+    RB_COLLECTION_BANNER_WITHOUT_TEXT_BLOCK = "rbCollectionBannerWithoutTextBlock",
+    RB_PRODUCT_UPCS = "rbProductUpcs",
+    RB_NAVIGATION_BANNER = "rbNavigationBanner",
+    BILLBOARD = "billboard",
+    LARGE_RECTANGLE = "largeRectangle",
+    VERTICAL_RECTANGLE = "verticalRectangle",
+    SQUARE = "square",
+    LARGE_LEADERBOARD = "largeLeaderboard",
+    WIDE_SKYSCRAPER = "wideSkyscraper",
+    IN_TEXT = "inText",
+    SMALL_RECTANGLE = "smallRectangle",
+    MEDIUM_RECTANGLE = "mediumRectangle",
+    BANNER = "banner",
+    LEADERBOARD = "leaderboard",
+    SKYSCRAPER = "skyscraper",
+    HALF_PAGE = "halfPage",
+    SMALL_SQUARE = "smallSquare",
+    VERTICAL_BANNER = "verticalBanner",
+    BUTTON_2 = "button2",
+    MICRO_BAR = "microBar",
+    POP_UP = "popUp",
+    PORTRAIT = "portrait",
+    SMARTPHONE_BANNER_1 = "smartphoneBanner1",
+    SMARTPHONE_BANNER_2 = "smartphoneBanner2",
+    MOBILE_PHONE_INTERSTITIAL_1 = "mobilePhoneInterstitial1",
+    MOBILE_PHONE_INTERSTITIAL_2 = "mobilePhoneInterstitial2",
+    MOBILE_PHONE_INTERSTITIAL_3 = "mobilePhoneInterstitial3",
+    FEATURE_PHONE_SMALL_BANNER = "featurePhoneSmallBanner",
+    FEATURE_PHONE_MEDIUM_BANNER = "featurePhoneMediumBanner",
+    FEATURE_PHONE_LARGE_BANNER = "featurePhoneLargeBanner"
+}
+export declare enum RMN_FILTER_PROPERTIES {
+    KEYWORDS = "keywords",
+    PAGE_LOCATION = "pageLocation",
+    PARENTCO = "parentCo",
+    BRAND = "brand",
+    CATEGORY = "category",
+    TYPE = "type",
+    CLASSIFICATION = "classification",
+    HOLIDAY = "holiday",
+    PUBLISHERS = "publishers",
+    SECTION = "section"
+}
+export declare enum RMN_SPOT_EVENT {
+    LIFECYCLE_STATE = "LIFECYCLE_STATE",
+    IMPRESSION = "IMPRESSION",
+    CLICK = "CLICK",
+    PURCHASE = "PURCHASE",
+    ADD_TO_CART = "ADD_TO_CART",
+    ADD_TO_WISHLIST = "ADD_TO_WISHLIST",
+    BUY_NOW = "BUY_NOW"
+}
 export declare enum RMN_ENV {
     LOCAL = "local",
     DEVELOPMENT = "development",

package/dist/types/index.umd.d.ts

@@ -1,2 +1,2 @@
-import { RmnClient, RmnCreateSpotElement } from './index';
-export { RmnClient, RmnCreateSpotElement };
+import { RmnClient, RmnCreateSpotElement, RmnEventManager } from './index';
+export { RmnClient, RmnCreateSpotElement, RmnEventManager };

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

@@ -0,0 +1,3 @@
+import type { ICustomCarouselElement } from './carousel.interface';
+declare let CarouselElement: new () => ICustomCarouselElement;
+export { CarouselElement };

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

@@ -0,0 +1,35 @@
+import type { ICreateElementConfig } from 'modules/element';
+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: CarouselNavPositionType;
+    color: string;
+    activeColor: string;
+    size: 'small' | 'base' | 'large';
+    opacity: number;
+}
+export interface ICarouselButtonOptions {
+    position: CarouselNavPositionType;
+    together: boolean;
+    textColor: string;
+    backgroundColor: string;
+    borderRadius: string;
+    size: 'small' | 'base' | 'large';
+    opacity: number;
+    prev: string;
+    next: string;
+}
+export interface ICarouselOptions {
+    autoplay?: boolean;
+    interval?: number;
+    useDots?: ICarouselDotOptions | boolean;
+    useButtons?: ICarouselButtonOptions | boolean;
+}
+export type ICustomCarouselElementData = ICreateElementConfig & ICarouselOptions;
+export interface ICustomCarouselElement extends HTMLElement {
+    data: ICustomCarouselElementData;
+    slides: HTMLElement[];
+}
+export interface ICreateCarouselElementParams {
+    slides: HTMLElement[];
+    config: ICreateElementConfig;
+}

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

@@ -0,0 +1,2 @@
+import type { ICustomCarouselElementData } from './carousel.interface';
+export declare const CAROUSEL_COMPONENT_STYLE: ({ width, height, fluid }: ICustomCarouselElementData) => string;

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

@@ -0,0 +1,3 @@
+export * from './carousel.component';
+export * from './carousel.interface';
+export * from './carousel.style';

package/dist/types/modules/element/component/spot/index.d.ts

@@ -0,0 +1,2 @@
+export * from './spot.component';
+export * from './spot.interface';

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

@@ -0,0 +1,3 @@
+import type { ICustomSpotElement } from './spot.interface';
+declare let SpotElement: new () => ICustomSpotElement;
+export { SpotElement };

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

@@ -0,0 +1,10 @@
+import type { ICreateElementConfig } from 'modules/element';
+export type ICustomSpotElementData = ICreateElementConfig;
+export interface ICustomSpotElement extends HTMLElement {
+    data: ICustomSpotElementData;
+    content: HTMLElement;
+}
+export interface ICreateSpotElementParams {
+    content: HTMLElement;
+    config: ICreateElementConfig;
+}

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

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

package/dist/types/modules/{spot/html/constants/html.constant.d.ts → element/element.constant.d.ts}

@@ -1,8 +1,5 @@
+export declare const SPOT_ELEMENT_TAG = "spot-element";
+export declare const CAROUSEL_ELEMENT_TAG = "spot-carousel-element";
 export declare const GFONT_PRECONNECT = "\n  <link rel=\"preconnect\" href=\"https://fonts.googleapis.com\">\n  <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n";
 export declare const GFONT_SOURCE_SANS_3 = "\n  <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css2?family=Source+Sans+3:ital,wght@0,200..900;1,200..900&display=swap\">\n";
 export declare const GFONT_CORMORANT = "\n  <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css2?family=Cormorant:ital,wght@0,300..700;1,300..700&family=Source+Sans+3:ital,wght@0,200..900;1,200..900&display=swap\">\n";
-export declare const SPOT_ELEMENT_TEMPLATE: (width: number, height: number, hasCustomContent: boolean) => {
-    style: HTMLStyleElement;
-    wrapper: HTMLDivElement;
-    slot: HTMLSlotElement;
-};

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

@@ -0,0 +1,52 @@
+import type { RMN_SPOT_TYPE } from 'enums';
+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;
+    ctaTextColor?: string;
+    ctaBorderColor?: string;
+}
+export interface ISpotOverlay {
+    size: 'small' | 'base' | 'large';
+    color: string;
+    opacity: 'light' | 'medium' | 'dark';
+}
+export interface IInjectSpotElementConfig {
+    fluid?: boolean;
+    url?: string;
+    colors?: ISpotColors;
+    minScale?: number;
+    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 {
+    spot?: RMN_SPOT_TYPE;
+    width: number;
+    height: number;
+    fluid?: boolean;
+    minScale: number;
+}
+export interface IInjectSpotElementParams {
+    inject: IInjectSpotElement[];
+    config?: IInjectSpotElementConfig;
+    filter?: Partial<RmnFilterType>;
+}
+export interface IElementService {
+    createSpotElement(params: ICreateSpotElementParams): HTMLElement | null;
+    createCarouselElement(params: ICreateCarouselElementParams): HTMLElement | null;
+}
+export interface IRmnCreateSpotElementConfig {
+    fluid?: boolean;
+    colors?: ISpotColors;
+    overlay?: ISpotOverlay;
+    minScale?: number;
+}

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

@@ -0,0 +1,40 @@
+import type { ISpot } from 'modules/selection';
+import type { ICreateCarouselElementParams } from './component/carousel';
+import type { ICreateSpotElementParams } from './component/spot';
+import type { IElementService, ISpotColors } from './element.interface';
+export declare class ElementService implements IElementService {
+    static getInstance(): ElementService;
+    /**
+     * Creates the html element based on the provided data, content and configs using shadow dom.
+     *
+     * This method is only available in browser environments.
+     *
+     * @param {ICreateSpotElementParams} params - The parameters to create the final element.
+     *
+     * @return {HTMLElement | null} - The html element or null if the browser environment is not available.
+     */
+    createSpotElement({ content, config }: ICreateSpotElementParams): HTMLElement | null;
+    /**
+     * Creates the carousel html element based on the provided slides and configs using shadow dom.
+     *
+     * This method is only available in browser environments.
+     *
+     * @param {ICreateCarouselElementParams} params - The parameters to create the final element.
+     *
+     * @return {HTMLElement | null} - The html element or null if the browser environment is not available.
+     */
+    createCarouselElement({ slides, config, }: ICreateCarouselElementParams): HTMLElement | null;
+    /**
+     * Overrides the spot colors with the provided colors.
+     *
+     * @param {ISpot} spot - The spot data.
+     * @param {ISpotColors} colors - The colors to override.
+     *
+     * @return {ISpot} - The spot data with the colors overridden.
+     */
+    overrideSpotColors(spot: ISpot, colors?: ISpotColors): ISpot;
+    /**
+     * @returns {boolean} - True if the browser environment is available and the element is defined.
+     */
+    private ensureBrowserEnvironmentAndDefineElement;
+}

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

@@ -0,0 +1,3 @@
+export * from './element.constant';
+export * from './element.interface';
+export * from './element.service';

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

@@ -0,0 +1,4 @@
+import type { ISpotOverlay } from '../element.interface';
+export declare function convertHexToRgba(hex: string, opacity?: number): string;
+export declare function generateGradientColor(overlay?: ISpotOverlay, fallback?: string): string;
+export declare function spotHtmlStringToElement(htmlString: string): HTMLElement;

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

@@ -0,0 +1 @@
+export * from './template.service';

package/dist/types/modules/element/template/reservebar/collection-banner-without-text-block.template.d.ts

@@ -0,0 +1,3 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from '../template.type';
+export declare function rbCollectionBannerWithoutTextBlockTemplate(spot: ISpot, config: ISpotTemplateConfig): string;

package/dist/types/modules/element/template/reservebar/homepage-hero-full-image.template.d.ts

@@ -0,0 +1,3 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from '../template.type';
+export declare function rbHomepageHeroFullImageTemplate(spot: ISpot, config: ISpotTemplateConfig): string;

package/dist/types/modules/element/template/reservebar/homepage-hero-three-tile.template.d.ts

@@ -0,0 +1,3 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from '../template.type';
+export declare function rbHomepageHeroThreeTileTemplate(spot: ISpot, config: ISpotTemplateConfig): string;

package/dist/types/modules/element/template/reservebar/homepage-hero-two-tile.template.d.ts

@@ -0,0 +1,3 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from '../template.type';
+export declare function rbHomepageHeroTwoTileTemplate(spot: ISpot, config: ISpotTemplateConfig): string;

package/dist/types/modules/element/template/reservebar/large-category-image-tout.template.d.ts

@@ -0,0 +1,3 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from '../template.type';
+export declare function rbLargeCategoryImageToutTemplate(spot: ISpot, config: ISpotTemplateConfig): string;

package/dist/types/modules/element/template/reservebar/navigation-banner.template.d.ts

@@ -0,0 +1,3 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from '../template.type';
+export declare function rbNavigationBannerTemplate(spot: ISpot, config: ISpotTemplateConfig): string;

package/dist/types/modules/element/template/reservebar/small-category-image-tout.template.d.ts

@@ -0,0 +1,3 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from '../template.type';
+export declare function rbSmallCategoryImageToutTemplate(spot: ISpot, config: ISpotTemplateConfig): string;

package/dist/types/modules/element/template/reservebar/small-discover-tout.template.d.ts

@@ -0,0 +1,3 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from '../template.type';
+export declare function rbSmallDiscoverToutTemplate(spot: ISpot, config: ISpotTemplateConfig): string;

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

@@ -0,0 +1,11 @@
+import type { ISpot } from 'types';
+import type { ISpotTemplateConfig } from './template.type';
+/**
+ * Returns the HTML element for the given spot.
+ *
+ * @param {ISpot} spot - The spot object.
+ * @param {ISpotTemplateConfig} config - The spot template configuration.
+ *
+ * @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/element/template/template.type.d.ts

@@ -0,0 +1,11 @@
+import type { RMN_SPOT_TYPE } from 'enums';
+import type { SpotVariantType } from 'modules/selection';
+import type { ISpot } from 'types';
+import type { ISpotOverlay } from '../element.interface';
+export interface ISpotTemplateConfig {
+    overlay?: ISpotOverlay;
+    prefix?: string;
+}
+export type TemplateFunction = (spot: ISpot, config: ISpotTemplateConfig) => string;
+export type SpotTypeTemplate = Partial<Record<SpotVariantType, TemplateFunction>>;
+export type SpotTemplates = Record<RMN_SPOT_TYPE, SpotTypeTemplate>;

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

@@ -0,0 +1 @@
+export declare const EVENT_API_PATH = "/spots/event";

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

@@ -0,0 +1,72 @@
+import type { RMN_SPOT_EVENT } from 'enums';
+import type { ISpot } from '../selection';
+export interface IFireEventParams {
+    event: RMN_SPOT_EVENT;
+    eventUrl: string;
+}
+export interface ILSIdentifier {
+    placementId: string;
+    spotId: string;
+    spotType: string;
+}
+export interface ILSDom {
+    visibleOnViewport: boolean;
+    spotElement?: HTMLElement;
+}
+export interface ILSState {
+    mounted: boolean;
+    unmounted: boolean;
+    loading: boolean;
+    error?: string;
+}
+export interface ILSDisplayConfig {
+    isCarousel: boolean;
+    isCarouselItem: boolean;
+    isSingleItem: boolean;
+}
+export interface ILifecycleState {
+    identifier: Partial<ILSIdentifier>;
+    dom?: Partial<ILSDom>;
+    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 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.LIFECYCLE_STATE]: ILifecycleState;
+    [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;
+    spotElement: HTMLElement;
+    spot: ISpot;
+}

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

@@ -0,0 +1,47 @@
+import { RMN_SPOT_EVENT } from 'enums';
+import type { IEventMap, ILifecycleState, IRegisterSpotParams } from './event.interface';
+export declare class EventService {
+    private static instance;
+    private pubSub;
+    private localStorage;
+    private intersectionObserver;
+    private spotStates;
+    private activeSpots;
+    private constructor();
+    static getInstance(): EventService;
+    subscribe(eventType: RMN_SPOT_EVENT, callback: (data: IEventMap[RMN_SPOT_EVENT]) => void): () => void;
+    publish(eventType: RMN_SPOT_EVENT, data: IEventMap[RMN_SPOT_EVENT]): void;
+    registerSpot(params: IRegisterSpotParams): void;
+    unregisterSpot(placementId: string): void;
+    /**
+     * Updates the state of a spot.
+     *
+     * @param {string} placementId - The placement ID of the spot.
+     * @param {Partial<ILifecycleState>} updates - The updates to apply to the spot state.
+     * @param {boolean} publish - Whether to publish the updated state.
+     *
+     * @returns {void}
+     */
+    handleSpotState(placementId: string, updates: Partial<ILifecycleState>, publish?: boolean): void;
+    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/helpers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './intersection.service';
+export * from './localstorage.service';
+export * from './resize.service';

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

@@ -0,0 +1,8 @@
+export declare class IntersectionObserverService {
+    private observers;
+    private defaultOptions;
+    constructor(defaultOptions?: IntersectionObserverInit);
+    observe(element: HTMLElement, callback: (entry: IntersectionObserverEntry) => void, options?: IntersectionObserverInit): void;
+    unobserve(element: HTMLElement): void;
+    unobserveAll(): void;
+}

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

@@ -0,0 +1,26 @@
+import type { RMN_SPOT_TYPE } from 'enums';
+import type { ISpotEvent } from 'modules/selection';
+export interface ILocalStorageSpot {
+    spotId: string;
+    spotType: RMN_SPOT_TYPE;
+    events: ISpotEvent[];
+    productIds: Array<string | number>;
+    createdAt?: number;
+}
+export declare class LocalStorage {
+    private spots;
+    private static instance;
+    private static readonly localStorageKey;
+    private static readonly spotExpirationTime;
+    private constructor();
+    static getInstance(): LocalStorage;
+    private syncLocalStorage;
+    setSpot(spotId: string, data: ILocalStorageSpot): void;
+    getSpot(spotId: string): ILocalStorageSpot | undefined;
+    removeSpot(spotId: string): void;
+    private updateLocalStorage;
+    clearLocalStorage(): void;
+    private removeExpiredSpots;
+    private mapToObj;
+    private objToMap;
+}

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

@@ -0,0 +1,30 @@
+export interface IResizeSize {
+    width: number;
+    height: number;
+}
+export interface IResizeOptions {
+    element: HTMLElement;
+    maxSize: IResizeSize;
+    minScale: number;
+}
+export interface ISizeChangedEvent extends CustomEvent {
+    detail: {
+        width: number;
+        height: number;
+        newWidth: number;
+        newHeight: number;
+        scale: number;
+    };
+}
+export declare class ResizeObserverService {
+    private element;
+    private container;
+    private resizeObserver;
+    private maxSize;
+    private minSize;
+    private aspectRatio;
+    constructor({ element, maxSize, minScale }: IResizeOptions);
+    private setDimensions;
+    private updateElementSize;
+    disconnect(): void;
+}

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

@@ -0,0 +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,69 @@
+/**
+ * Callback function type for event subscribers
+ * @template T The type of data the callback receives
+ */
+export type PubSubCallback<T> = (data: T) => void;
+/**
+ * Function type for unsubscribing from an event
+ */
+export type PubSubUnsubscribe = () => 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> {
+    private static instance;
+    static getInstance<IEventMap>(): 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: PubSubCallback<IEventMap[K]>): PubSubUnsubscribe;
+    /**
+     * 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();
+ */