@liquidcommercedev/rmn-sdk 1.4.1 → 1.4.2-beta.2

package/CHANGELOG.md

@@ -1,75 +0,0 @@
-## [1.4.1](https://github.com/liquidcommerce/rmn-sdk/compare/v1.4.0...v1.4.1) (2024-10-08)
-
-
-### Bug Fixes
-
-* fixes ([116ba93](https://github.com/liquidcommerce/rmn-sdk/commit/116ba930a9d38e231e1248ad73a38d344992498b))
-* fixes ([169dab1](https://github.com/liquidcommerce/rmn-sdk/commit/169dab1b780a7594eaff5610b32299a64d849a8a))
-* readme fix ([8af0252](https://github.com/liquidcommerce/rmn-sdk/commit/8af0252e7108b88f7438c39780024a9757f63e4d))
-* spot config - redirect on click ([55517f7](https://github.com/liquidcommerce/rmn-sdk/commit/55517f754bd0c1c2a91967fc79b54699a13771de))
-
-## [1.4.1-beta.1](https://github.com/liquidcommerce/rmn-sdk/compare/v1.4.0...v1.4.1-beta.1) (2024-10-08)
-
-
-### Bug Fixes
-
-* fixes ([116ba93](https://github.com/liquidcommerce/rmn-sdk/commit/116ba930a9d38e231e1248ad73a38d344992498b))
-* fixes ([169dab1](https://github.com/liquidcommerce/rmn-sdk/commit/169dab1b780a7594eaff5610b32299a64d849a8a))
-* readme fix ([8af0252](https://github.com/liquidcommerce/rmn-sdk/commit/8af0252e7108b88f7438c39780024a9757f63e4d))
-* spot config - redirect on click ([55517f7](https://github.com/liquidcommerce/rmn-sdk/commit/55517f754bd0c1c2a91967fc79b54699a13771de))
-
-# [1.4.0](https://github.com/liquidcommerce/rmn-sdk/compare/v1.3.1...v1.4.0) (2024-10-03)
-
-
-### Features
-
-* added events type ([278cf44](https://github.com/liquidcommerce/rmn-sdk/commit/278cf449619218b6826a1f0ca141fc988007987a))
-* button on hover color ([70b1839](https://github.com/liquidcommerce/rmn-sdk/commit/70b1839100709b5a41a3d1ba14eae56d4f05889c))
-* design changes ([2142ee5](https://github.com/liquidcommerce/rmn-sdk/commit/2142ee5685250636a2ab728f424d67dcb101e097))
-* export event interface ([0ca5a76](https://github.com/liquidcommerce/rmn-sdk/commit/0ca5a762d5906de82073627a4e1f016462f2a6c9))
-* fix fonts ([2d65e44](https://github.com/liquidcommerce/rmn-sdk/commit/2d65e44e8b24d446c78ad97005db2bb8c1004c92))
-* new spot content and design fixes and new rb variant ([2efd32d](https://github.com/liquidcommerce/rmn-sdk/commit/2efd32db2264920f9653c1436b670043ad9f5723))
-* new variant design ([11623b9](https://github.com/liquidcommerce/rmn-sdk/commit/11623b99ba3a74d3c92d87b32da139bd97f1a339))
-* remove filter blur ([355a302](https://github.com/liquidcommerce/rmn-sdk/commit/355a30270d8a8388fbef8bcccab2491518015006))
-* support cta color ([a2df5eb](https://github.com/liquidcommerce/rmn-sdk/commit/a2df5eb3a9d15a0719c408936aa4781f09190673))
-* support cta color ([26a637e](https://github.com/liquidcommerce/rmn-sdk/commit/26a637e90ad54dee5acb36b35177c45a8c6b72f2))
-
-# [1.4.0-beta.1](https://github.com/liquidcommerce/rmn-sdk/compare/v1.3.1...v1.4.0-beta.1) (2024-10-03)
-
-
-### Features
-
-* added events type ([278cf44](https://github.com/liquidcommerce/rmn-sdk/commit/278cf449619218b6826a1f0ca141fc988007987a))
-* button on hover color ([70b1839](https://github.com/liquidcommerce/rmn-sdk/commit/70b1839100709b5a41a3d1ba14eae56d4f05889c))
-* design changes ([2142ee5](https://github.com/liquidcommerce/rmn-sdk/commit/2142ee5685250636a2ab728f424d67dcb101e097))
-* export event interface ([0ca5a76](https://github.com/liquidcommerce/rmn-sdk/commit/0ca5a762d5906de82073627a4e1f016462f2a6c9))
-* fix fonts ([2d65e44](https://github.com/liquidcommerce/rmn-sdk/commit/2d65e44e8b24d446c78ad97005db2bb8c1004c92))
-* new spot content and design fixes and new rb variant ([2efd32d](https://github.com/liquidcommerce/rmn-sdk/commit/2efd32db2264920f9653c1436b670043ad9f5723))
-* new variant design ([11623b9](https://github.com/liquidcommerce/rmn-sdk/commit/11623b99ba3a74d3c92d87b32da139bd97f1a339))
-* remove filter blur ([355a302](https://github.com/liquidcommerce/rmn-sdk/commit/355a30270d8a8388fbef8bcccab2491518015006))
-* support cta color ([a2df5eb](https://github.com/liquidcommerce/rmn-sdk/commit/a2df5eb3a9d15a0719c408936aa4781f09190673))
-* support cta color ([26a637e](https://github.com/liquidcommerce/rmn-sdk/commit/26a637e90ad54dee5acb36b35177c45a8c6b72f2))
-
-## [1.3.1](https://github.com/liquidcommerce/rmn-sdk/compare/v1.3.0...v1.3.1) (2024-10-01)
-
-
-### Bug Fixes
-
-* build ([5b022a2](https://github.com/liquidcommerce/rmn-sdk/commit/5b022a28d803a746e4fa9eedfc3d4275d91639df))
-* relase fix ([ba74044](https://github.com/liquidcommerce/rmn-sdk/commit/ba74044787c47d446ce8b6688c547a5d968583a0))
-* release ([1cd4844](https://github.com/liquidcommerce/rmn-sdk/commit/1cd4844a126786f4336f16517dde6219a25632e1))
-* release ([fd7d22f](https://github.com/liquidcommerce/rmn-sdk/commit/fd7d22f9226ceeb2bdec7185400751129e5a7b6a))
-* revert back release ([97340e6](https://github.com/liquidcommerce/rmn-sdk/commit/97340e6feca451487ab99f74c1d5bde45111c8ef))
-* template border radius ([985f94d](https://github.com/liquidcommerce/rmn-sdk/commit/985f94dc98f637be09bb5c746375cf6dcfe9a799))
-
-## [1.3.1-beta.1](https://github.com/liquidcommerce/rmn-sdk/compare/v1.3.0...v1.3.1-beta.1) (2024-10-01)
-
-
-### Bug Fixes
-
-* build ([5b022a2](https://github.com/liquidcommerce/rmn-sdk/commit/5b022a28d803a746e4fa9eedfc3d4275d91639df))
-* relase fix ([ba74044](https://github.com/liquidcommerce/rmn-sdk/commit/ba74044787c47d446ce8b6688c547a5d968583a0))
-* release ([1cd4844](https://github.com/liquidcommerce/rmn-sdk/commit/1cd4844a126786f4336f16517dde6219a25632e1))
-* release ([fd7d22f](https://github.com/liquidcommerce/rmn-sdk/commit/fd7d22f9226ceeb2bdec7185400751129e5a7b6a))
-* revert back release ([97340e6](https://github.com/liquidcommerce/rmn-sdk/commit/97340e6feca451487ab99f74c1d5bde45111c8ef))
-* template border radius ([985f94d](https://github.com/liquidcommerce/rmn-sdk/commit/985f94dc98f637be09bb5c746375cf6dcfe9a799))

package/dist/index.d.ts

@@ -1,192 +0,0 @@
-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"
-}
-declare enum RMN_FILTER_PROPERTIES {
-    KEYWORDS = "keywords",
-    PARENTCO = "parentCo",
-    BRAND = "brand",
-    CATEGORY = "category",
-    TYPE = "type",
-    CLASSIFICATION = "classification",
-    HOLIDAY = "holiday",
-    PUBLISHERS = "publishers",
-    SECTION = "section"
-}
-declare enum RMN_SPOT_EVENT {
-    IMPRESSION = "IMPRESSION",
-    CLICK = "CLICK",
-    PURCHASE = "PURCHASE",
-    ADD_TO_CART = "ADD_TO_CART",
-    ADD_TO_WISHLIST = "ADD_TO_WISHLIST",
-    BUY_NOW = "BUY_NOW"
-}
-
-declare enum RMN_ENV {
-    LOCAL = "local",
-    DEVELOPMENT = "development",
-    STAGING = "staging",
-    PRODUCTION = "production"
-}
-
-interface IAuthCredentials {
-    authenticated: boolean;
-    token: string;
-    apiKey: string;
-    env: RMN_ENV;
-}
-
-type RmnFilterType = {
-    [key in RMN_FILTER_PROPERTIES]?: string[];
-};
-type SpotFilterType = {
-    spot: RMN_SPOT_TYPE | string;
-    count: number;
-    exactMatch?: string;
-} & Omit<RmnFilterType, RMN_FILTER_PROPERTIES.KEYWORDS>;
-type SpotIdentifierType = RMN_SPOT_TYPE | `${RMN_SPOT_TYPE}${number}`;
-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];
-};
-type IABSpotTypeKeys = keyof {
-    [K in keyof typeof RMN_SPOT_TYPE as K extends `RB_${string}` ? never : K]: (typeof RMN_SPOT_TYPE)[K];
-};
-type RBSpotTypeValues = (typeof RMN_SPOT_TYPE)[RBSpotTypeKeys];
-type IABSpotTypeValues = (typeof RMN_SPOT_TYPE)[IABSpotTypeKeys];
-type SpotVariantType = RBSpotTypeValues | `${IABSpotTypeValues}V${number}`;
-
-interface ISpotSelectionParams {
-    spots: RmnSpotType[];
-    filter?: Partial<RmnFilterType>;
-}
-interface ISpotEvent {
-    event: RMN_SPOT_EVENT;
-    url: string;
-}
-interface ISpot {
-    events: ISpotEvent[];
-    spot: RMN_SPOT_TYPE;
-    variant: SpotVariantType;
-    width: number;
-    height: number;
-    preHeader?: string;
-    header?: string;
-    description?: string;
-    ctaText?: string;
-    textColor?: string;
-    backgroundColor?: string;
-    ctaTextColor?: string;
-    ctaBorderColor?: string;
-    primaryImage?: string;
-    secondaryImage?: string;
-    mobilePrimaryImage?: string;
-    mobileSecondaryImage?: string;
-    productUpcs?: string[];
-    env: RMN_ENV;
-}
-interface ICreateSpotElementConfig {
-    fluid?: boolean;
-    customHtmlElement?: HTMLElement;
-    redirectOnClick?: boolean;
-}
-type ISpots = Record<SpotIdentifierType, ISpot[]>;
-
-interface IRmnClient {
-    spotSelection(data: ISpotSelectionParams): Promise<ISpots>;
-    createSpotElement(spot: ISpot, config?: ICreateSpotElementConfig): HTMLElement | null;
-}
-interface IRmnConfig {
-    env: RMN_ENV;
-}
-
-declare class LiquidCommerceRmnClient implements IRmnClient {
-    private readonly spotSelectionService;
-    private readonly spotHtmlService;
-    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.
-     *
-     * @return {Promise<ISpots>} - The spots response object.
-     */
-    spotSelection(data: ISpotSelectionParams): Promise<ISpots>;
-    /**
-     * Creates the spot html element based on the provided data using shadow dom.
-     *
-     * This method is useful when you are initializing the client in a browser environment, so you can create the spot html element directly from the RmnClient instance.
-     *
-     * @param {ISpot} spot - The spot data.
-     * @param {ICreateSpotElementConfig} config - The configuration object.
-     * @param {ICreateSpotElementConfig.fluid} config.fluid - If the spot should be fluid or not.
-     * @param {ICreateSpotElementConfig.customHtmlElement} config.customHtmlElement - Use a custom html element.
-     * @param {ICreateSpotElementConfig.redirectOnClick} config.redirectOnClick - If the spot should redirect on click.
-     *
-     * @return {HTMLElement | null} - The spot html element or null if the browser environment is not available.
-     */
-    createSpotElement(spot: ISpot, config?: ICreateSpotElementConfig): HTMLElement | null;
-}
-/**
- * Creates a new instance of the RmnClient.
- *
- * @param {string} apiKey - The api key.
- * @param {IRmnConfig} config - The configuration object.
- *
- * @return {Promise<IRmnClient>} - The RmnClient instance.
- */
-declare function RmnClient(apiKey: string, config: IRmnConfig): Promise<IRmnClient>;
-/**
- * Creates the spot html element based on the provided data using shadow dom.
- *
- * This method is useful when you are initializing the client in a non-browser environment.
- * When you request a spot selection, you will receive the spot data in server-side and return them back to the client.
- * Then you can use this function to create the spot html element based on the provided data without the need of the RmnClient instance.
- *
- * @param {ISpot} spot - The spot data.
- * @param {ICreateSpotElementConfig} config - The configuration object.
- * @param {ICreateSpotElementConfig.fluid} config.fluid - If the spot should be fluid or not.
- * @param {ICreateSpotElementConfig.customHtmlElement} config.customHtmlElement - Use a custom html element.
- * @param {ICreateSpotElementConfig.redirectOnClick} config.redirectOnClick - If the spot should redirect on click.
- *
- * @return {HTMLElement | null} - The spot html element or null if the browser environment is not available.
- */
-declare function RmnCreateSpotElement(spot: ISpot, config?: ICreateSpotElementConfig): HTMLElement | null;
-
-export { type ICreateSpotElementConfig, type IRmnClient, type IRmnConfig, type ISpot, type ISpotEvent, type ISpotSelectionParams, type ISpots, LiquidCommerceRmnClient, RMN_ENV, RMN_FILTER_PROPERTIES, RMN_SPOT_EVENT, RMN_SPOT_TYPE, RmnClient, RmnCreateSpotElement, type RmnFilterType, type RmnSpotType };