@liquidcommercedev/rmn-sdk 1.1.6 → 1.1.8

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.1.8](https://github.com/liquidcommerce/rmn-sdk/compare/v1.1.7...v1.1.8) (2024-09-27)
+
+
+### Bug Fixes
+
+* new rb templates ([#30](https://github.com/liquidcommerce/rmn-sdk/issues/30)) ([7137d13](https://github.com/liquidcommerce/rmn-sdk/commit/7137d13513a0f9fa0175ec1e96331852e372aa94))
+
+## [1.1.7](https://github.com/liquidcommerce/rmn-sdk/compare/v1.1.6...v1.1.7) (2024-09-24)
+
+
+### Bug Fixes
+
+* types fix & designs update ([#29](https://github.com/liquidcommerce/rmn-sdk/issues/29)) ([2242b9b](https://github.com/liquidcommerce/rmn-sdk/commit/2242b9b1afc8b6db49a421cece71509c1fba872f))
+
 ## [1.1.6](https://github.com/liquidcommerce/rmn-sdk/compare/v1.1.5...v1.1.6) (2024-09-23)
 
 

package/dist/index.d.ts

@@ -1,4 +1,12 @@
 declare enum RMN_SPOT_TYPE {
+    RB_HOMEPAGE_HERO_THREE_TILE = "rbHomepageHeroThreeTile",
+    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",
@@ -6,9 +14,6 @@ declare enum RMN_SPOT_TYPE {
     LARGE_LEADERBOARD = "largeLeaderboard",
     WIDE_SKYSCRAPER = "wideSkyscraper",
     IN_TEXT = "inText",
-    /**
-     *  CURRENTLY NOT SUPPORTED YET
-     * */
     SMALL_RECTANGLE = "smallRectangle",
     MEDIUM_RECTANGLE = "mediumRectangle",
     BANNER = "banner",
@@ -38,11 +43,7 @@ declare enum RMN_FILTER_PROPERTIES {
     TYPE = "type",
     CLASSIFICATION = "classification",
     HOLIDAY = "holiday",
-    EXACT_MATCH = "exactMatch",
-    PUBLISHERS = "publishers",
-    DEVICE_TYPE = "deviceType",
-    BROWSER_TYPE = "browserType",
-    LOCATION = "location"
+    PUBLISHERS = "publishers"
 }
 
 declare enum RMN_ENV {
@@ -59,21 +60,30 @@ interface IAuthCredentials {
     env: RMN_ENV;
 }
 
-type SpotsFilterType = {
-    [key in RMN_FILTER_PROPERTIES]: IFilterPropertiesType[key];
+type RmnFilterType = {
+    [key in RMN_FILTER_PROPERTIES]?: string[];
 };
 type SpotFilterType = {
     spot: RMN_SPOT_TYPE | string;
     count: number;
-} & Partial<Omit<SpotsFilterType, RMN_FILTER_PROPERTIES.KEYWORDS>>;
+    exactMatch?: string;
+} & Omit<RmnFilterType, RMN_FILTER_PROPERTIES.KEYWORDS>;
 type SpotIdentifierType = RMN_SPOT_TYPE | `${RMN_SPOT_TYPE}${number}`;
-type SpotType = RMN_SPOT_TYPE | SpotFilterType | string;
-type SpotVariantType = `${RMN_SPOT_TYPE}V${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}`;
 type SpotEventType = Record<number, string>;
 
 interface ISpotSelectionParams {
-    spots: SpotType[];
-    filter?: Partial<SpotsFilterType>;
+    spots: RmnSpotType[];
+    filter?: Partial<RmnFilterType>;
 }
 interface ISpot {
     clickUrl: string;
@@ -83,28 +93,17 @@ interface ISpot {
     variant: SpotVariantType;
     width: number;
     height: number;
-    headline?: string;
-    body?: string;
-    image?: string;
-    image2?: string;
-    buttonText?: string;
-    upc?: string;
+    preHeader?: string;
+    header?: string;
+    description?: string;
+    primaryImage?: string;
+    secondaryImage?: string;
+    mobilePrimaryImage?: string;
+    mobileSecondaryImage?: string;
+    ctaText?: string;
+    productUpcs?: string[];
     customData?: Record<string, any>;
 }
-interface IFilterPropertiesType {
-    [RMN_FILTER_PROPERTIES.EXACT_MATCH]: string;
-    [RMN_FILTER_PROPERTIES.KEYWORDS]: string[];
-    [RMN_FILTER_PROPERTIES.PARENTCO]: string[];
-    [RMN_FILTER_PROPERTIES.BRAND]: string[];
-    [RMN_FILTER_PROPERTIES.CATEGORY]: string[];
-    [RMN_FILTER_PROPERTIES.TYPE]: string[];
-    [RMN_FILTER_PROPERTIES.CLASSIFICATION]: string[];
-    [RMN_FILTER_PROPERTIES.HOLIDAY]: string[];
-    [RMN_FILTER_PROPERTIES.PUBLISHERS]: string[];
-    [RMN_FILTER_PROPERTIES.DEVICE_TYPE]: string[];
-    [RMN_FILTER_PROPERTIES.BROWSER_TYPE]: string[];
-    [RMN_FILTER_PROPERTIES.LOCATION]: string[];
-}
 type ISpots = Record<SpotIdentifierType, ISpot[]>;
 
 interface IRmnClient {
@@ -116,8 +115,8 @@ interface IRmnConfig {
 }
 
 declare class LiquidCommerceRmnClient implements IRmnClient {
-    private spotSelectionService;
-    private spotHtmlService;
+    private readonly spotSelectionService;
+    private readonly spotHtmlService;
     constructor(auth: IAuthCredentials);
     /**
      * Makes a selection request on our server based on the provided data.
@@ -164,4 +163,4 @@ declare function RmnClient(apiKey: string, config: IRmnConfig): Promise<IRmnClie
  */
 declare function RmnCreateSpotElement(spot: ISpot, fluid?: boolean): HTMLElement | null;
 
-export { type IRmnClient, type IRmnConfig, type ISpot, type ISpotSelectionParams, LiquidCommerceRmnClient, RMN_ENV, RMN_FILTER_PROPERTIES, RMN_SPOT_TYPE, RmnClient, RmnCreateSpotElement };
+export { type IRmnClient, type IRmnConfig, type ISpot, type ISpotSelectionParams, type ISpots, LiquidCommerceRmnClient, RMN_ENV, RMN_FILTER_PROPERTIES, RMN_SPOT_TYPE, RmnClient, RmnCreateSpotElement, type RmnFilterType, type RmnSpotType };