@braze/web-sdk 4.8.2 → 4.9.0

package/index.d.ts

@@ -1,10 +1,11 @@
 /*
-* Type definitions for @braze/web-sdk v4.8.2
+* Type definitions for @braze/web-sdk v4.9.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2023 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
 */
 
+/* eslint-disable no-unused-vars, no-use-before-define */
 
   /**
    * Enum to represent the accepted SDK Metadata tags. See `addSdkMetadata` for more info.
@@ -57,7 +58,7 @@
 
   /**
    * Abstract base for news feed and Content Cards cards. Use subclasses `ClassicCard`, `CaptionedImage`,
-   *   `Banner`, and `ControlCard`.
+   *   `ImageOnly`, and `ControlCard`.
    */
   export class Card {
     /**
@@ -128,6 +129,9 @@
 
   }
 
+  /**
+   * @deprecated This class has been deprecated in favor of `ImageOnly`.
+   */
   export class Banner extends Card {
     /**
      * A card with only an image, which can be passed to `showFeed` or handled manually.
@@ -201,6 +205,79 @@
     clicked: boolean;
   }
 
+  export class ImageOnly extends Card {
+    /**
+     * A card with only an image, which can be passed to `showFeed` or handled manually.
+     *  Subscribe to receive new cards via `subscribeToFeedUpdates`
+     *
+     * @param id - The id of the card. This will be reported back to Braze with events for analytics purposes.
+     * @param viewed - Whether this card has been shown to the user.
+     * @param imageUrl - The url for this card's image.
+     * @param created - When this card was created.
+     * @param updated - When this card was last modified.
+     * @param categories - Purely for organization in your custom implementation, these categories can be set in
+     *   the dashboard composer.
+     * @param expiresAt - When this card expires and should stop being shown to the user.
+     * @param url - A url to open when this card is clicked.
+     * @param linkText - The display text for the url.
+     * @param aspectRatio - The aspect ratio for this card's image. This field is meant to serve as a hint before
+     *   image loading completes. Note that the field may not be supplied in certain circumstances.
+     * @param extras - Object of string/string key/value pairs.
+     * @param pinned - Whether to pin this card to the top of the view.
+     * @param dismissible - Whether to allow the user to dismiss this card, removing it from the view.
+     * @param clicked - Whether this card has ever been clicked on this device.
+     */
+    constructor(
+      id?: string,
+      viewed?: boolean,
+      imageUrl?: string,
+      created?: Date,
+      updated?: Date,
+      categories?: string[],
+      expiresAt?: Date,
+      url?: string,
+      linkText?: string,
+      aspectRatio?: number,
+      extras?: Record<string, string>,
+      pinned?: boolean,
+      dismissible?: boolean,
+      clicked?: boolean
+    );
+
+    /** The url for this card's image. */
+    imageUrl?: string;
+
+    /** When this card was created. */
+    created: Date | null;
+
+    /**
+     * Purely for organization in your custom implementation, these categories can be set in
+     *   the dashboard composer.
+     */
+    categories: string[];
+
+    /** A url to open when this card is clicked. */
+    url?: string;
+
+    /** The display text for the url. */
+    linkText?: string;
+
+    /**
+     * The aspect ratio for this card's image. This field is meant to serve as a hint before image loading completes.
+     * Note that the field may not be supplied in certain circumstances.
+     * */
+    aspectRatio: number | null;
+
+    /** Whether this card has been dismissed. */
+    dismissed: boolean;
+
+    /** Whether to allow the user to dismiss this card, removing it from the view. */
+    dismissible: boolean;
+
+    /** Whether this card has ever been clicked on this device. */
+    clicked: boolean;
+  }
+
   export class CaptionedImage extends Card {
     /**
      * A card with a large image and descriptive text, which can be passed to `showFeed` or handled manually.
@@ -1641,6 +1718,35 @@
     onDisplayCallback?: () => void
   ): boolean;
 
+  /**
+   * Defers the display of given in-app message for a future pageload.
+   * The deferred in-app message can be retrieved by calling `getDeferredInAppMessage`,
+   *  and displayed using `showInAppMessage`.
+   *  Deferring an in-app message will overwrite any previously deferred in-app message.
+   * 
+   * Note: Be sure to subscribe to clicked / dismissed events on this in-app message only after retrieving it using `getDeferredInAppMessage`. 
+   *  Any subscriptions made before calling `deferInAppMessage` will not be persisted.
+   *  Also note that the in-app message deferred here will be cleared out when in-app message triggers have been refreshed from the Braze backend.
+   * 
+   * @param inAppMessage - The message to defer for later display.
+   * 
+   * @returns Whether or not the message was successfully deferred. 
+   * Returns undefined if the SDK has not been initialized.
+   */
+  export function deferInAppMessage(
+    inAppMessage: InAppMessage
+  ): boolean | undefined;
+
+  /**
+   * Retrieves the in-app message that was most recently deferred for display with `deferInAppMessage`.
+   * 
+   * Note: Retrieving the deferred in-app message here will clear it from storage.
+   * 
+   * @returns The deferred in-app message if it exists, or returns null. 
+   * Returns undefined if the SDK has not been initialized.
+   */
+  export function getDeferredInAppMessage(): InAppMessage | null | undefined;
+
   /**
    * Toggle the display of Braze content cards, showing them if they are not shown, and hiding them if they are. If you
    *    wish to display multiple content cards feeds on a page simultaneously, you should use `showContentCards` and `hideContentCards`
@@ -1993,8 +2099,8 @@
    * When a new session is opened, this refreshes In-App Messages. Content Cards are refreshed automatically if
    * the `subscribeToContentCardsUpdates` has been registered prior to `openSession`. If the user has previously
    * granted the site permission to send push, automatically sends the push registration to the Braze backend.
-   * 
-   * Be sure to call `openSession` at the end of your initialization code section, after any calls to `changeUser` or subscribing to Content Cards, 
+   *
+   * Be sure to call `openSession` at the end of your initialization code section, after any calls to `changeUser` or subscribing to Content Cards,
    * In-App Message, and Feature Flag updates. Calling `openSession` before `changeUser` may result in a second session start event.
    */
   export function openSession(): void;
@@ -2011,7 +2117,7 @@
    * - Create a `service-worker.js` file with the content below and place it in the root directory of your website:
    *
    * ```
-   * self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.8/service-worker.js');
+   * self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.9/service-worker.js');
    * ```
    *
    * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2270,6 +2376,15 @@
    * @returns - A list of `FeatureFlag` objects.
    */
    export function getAllFeatureFlags(): FeatureFlag[];
+  
+  /**
+   * Logs impression for a given feature flag.
+   *
+   * @param featureFlagId - ID of the feature flag that has received the impression.
+   * 
+   * @returns - Whether or not the impression was successfully logged. Returns undefined if the SDK has not been initialized.
+   */
+   export function logFeatureFlagImpression(featureFlagId: string): boolean | undefined;
 
   /**
    * Supported initialization options
@@ -2367,7 +2482,7 @@
      *   lifecycle of, set this option to true and the Braze SDK will not register or unregister a service worker. If you set this
      *   option to true, in order for push to function correctly you must register the service worker yourself BEFORE calling
      *   `requestPushPermission`, and ensure that it contains Braze's service worker code, either with
-     *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.8/service-worker.js');` or by including the content
+     *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.9/service-worker.js');` or by including the content
      *   of that file directly. When this option is true, the `serviceWorkerLocation` option is irrelevant and is ignored.
      */
     manageServiceWorkerExternally?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@braze/web-sdk",
-  "version": "4.8.2",
+  "version": "4.9.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/braze-shared-lib.js

@@ -1,8 +1,8 @@
-import je from "./encoding-utils.js";
-import { EventTypes as ve, InternalEventTypes as De } from "./event-types.js";
-import Be from "./guid.js";
-import Ae from "./indexed-db-adapter.js";
-import Ge from "./logger.js";
-import Oe from "./supported-options.js";
-const r = { xn: je, q: ve, Cr: De, Z: Be, xt: Ae, zt: Ae.ep, j: Ge, xo: Oe };
+import ve from "./encoding-utils.js";
+import { EventTypes as De, InternalEventTypes as Be } from "./event-types.js";
+import Ge from "./guid.js";
+import Oe from "./indexed-db-adapter.js";
+import Ue from "./logger.js";
+import ke from "./supported-options.js";
+const r = { On: ve, q: De, Cr: Be, Z: Ge, xt: Oe, zt: Oe.ep, j: Ue, Jo: ke };
 export default r;

package/shared-lib/encoding-utils.js

@@ -1,5 +1,5 @@
-const je = {
-  _n: function(t) {
+const ve = {
+  Fn: function (t) {
     const r = (t + "=".repeat((4 - (t.length % 4)) % 4))
         .replace(/\-/g, "+")
         .replace(/_/g, "/"),
@@ -7,6 +7,6 @@ const je = {
       o = new Uint8Array(n.length);
     for (let t = 0; t < n.length; ++t) o[t] = n.charCodeAt(t);
     return o;
-  }
+  },
 };
-export default je;
+export default ve;

package/shared-lib/event-types.js

@@ -1,33 +1,34 @@
-const ve = {
+const De = {
     CustomEvent: "ce",
     Pr: "p",
-    du: "pc",
+    $u: "pc",
     dc: "ca",
-    ka: "i",
-    Is: "ie",
+    Va: "i",
+    qs: "ie",
     P: "cci",
     T: "ccic",
     $: "ccc",
     H: "ccd",
     Wl: "ss",
     xl: "se",
-    _i: "si",
-    Ii: "sc",
-    Mi: "sbc",
-    Ze: "sfe",
-    ro: "iec",
-    au: "lr",
-    Zh: "uae",
+    Vi: "si",
+    Li: "sc",
+    Qi: "sbc",
+    Ki: "sfe",
+    eo: "iec",
+    Su: "lr",
+    ju: "uae",
     R: "ci",
     B: "cc",
-    gu: "lcaa",
-    fu: "lcar",
-    Rn: "inc",
-    Bn: "add",
-    Ln: "rem",
-    Fn: "set",
-    $n: "ncam",
-    pu: "sgu"
+    Au: "lcaa",
+    qu: "lcar",
+    Xn: "inc",
+    Jn: "add",
+    Qn: "rem",
+    Hn: "set",
+    Kn: "ncam",
+    Cu: "sgu",
+    Fr: "ffi",
   },
-  De = { Ar: "feed_displayed", Cc: "content_cards_displayed" };
-export { ve as EventTypes, De as InternalEventTypes };
+  Be = { Br: "feed_displayed", vc: "content_cards_displayed" };
+export { De as EventTypes, Be as InternalEventTypes };

package/shared-lib/guid.js

@@ -1,10 +1,10 @@
-const Be = {
-  Y: () => {
-    const t = t => {
-      const e = (Math.random().toString(16) + "000000000").substr(2, 8);
-      return t ? "-" + e.substr(0, 4) + "-" + e.substr(4, 4) : e;
+const Ge = {
+  Y: function () {
+    const t = (t = !1) => {
+      const n = (Math.random().toString(16) + "000000000").substr(2, 8);
+      return t ? "-" + n.substr(0, 4) + "-" + n.substr(4, 4) : n;
     };
     return t() + t(!0) + t(!0) + t();
-  }
+  },
 };
-export default Be;
+export default Ge;