@liquidcommercedev/rmn-sdk 1.4.0 → 1.4.1-beta.1

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [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)
 
 

package/README.md

@@ -61,7 +61,7 @@ import { RmnClient } from '@liquidcommercedev/rmn-sdk';
 import { RmnClient } from '@liquidcommercedev/rmn-sdk';
 // Your Account token provided to you through your account representative
 const client = await RmnClient('YOUR_API_KEY', {
-  env: 'dev'
+  env: 'staging'
 });
 ```
 
@@ -78,17 +78,12 @@ An example use case for LiquidCommerce's `spotSelection({})` method.
 import RmnClient from '@liquidcommercedev/rmn-sdk';
 // Your Account token provided to you through your account representative
 const client = await RmnClient('YOUR_API_KEY', {
-  env: 'dev'
+  env: 'staging'
 });
 
-const { spots } = await client.spotSelection({
+const spots = await client.spotSelection({
   "spots": ['billboard', 'leaderboard']
 });
 
-console.log('spots: ', spots);
-```
-
->
-> **CURRENTLY IN PRIVATE BETA UNDERGOING FINAL UAT FOR PRODUCTION RELEASE.**
->
->
+console.log({ spots });
+```

package/dist/index.d.ts

@@ -48,6 +48,8 @@ declare enum RMN_FILTER_PROPERTIES {
     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",
@@ -97,8 +99,6 @@ interface ISpotEvent {
     url: string;
 }
 interface ISpot {
-    clickUrl: string;
-    impressionUrl: string;
     events: ISpotEvent[];
     spot: RMN_SPOT_TYPE;
     variant: SpotVariantType;
@@ -119,11 +119,16 @@ interface ISpot {
     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, fluid?: boolean): HTMLElement | null;
+    createSpotElement(spot: ISpot, config?: ICreateSpotElementConfig): HTMLElement | null;
 }
 interface IRmnConfig {
     env: RMN_ENV;
@@ -149,11 +154,14 @@ declare class LiquidCommerceRmnClient implements IRmnClient {
      * 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 {boolean} fluid - If the spot should be fluid or not.
+     * @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, fluid?: boolean): HTMLElement | null;
+    createSpotElement(spot: ISpot, config?: ICreateSpotElementConfig): HTMLElement | null;
 }
 /**
  * Creates a new instance of the RmnClient.
@@ -172,10 +180,13 @@ declare function RmnClient(apiKey: string, config: IRmnConfig): Promise<IRmnClie
  * 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 {boolean} fluid - If the spot should be fluid or not.
+ * @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, fluid?: boolean): HTMLElement | null;
+declare function RmnCreateSpotElement(spot: ISpot, config?: ICreateSpotElementConfig): HTMLElement | null;
 
-export { 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 };
+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 };