@braze/web-sdk 4.10.1 → 5.0.1

package/index.d.ts

@@ -1,12 +1,12 @@
 /*
-* Type definitions for @braze/web-sdk v4.10.1
+* Type definitions for @braze/web-sdk v5.0.1
 * 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 */
-// declare module Braze {
+
 /**
  * Enum to represent the accepted SDK Metadata tags. See `addSdkMetadata` for more info.
  *
@@ -126,83 +126,7 @@ export class Card {
   /** Whether this card is a ControlCard. */
   isControl: boolean;
 
-  // static fromContentCardsJson(jsonData: Record<string, unknown>): Card | undefined;
-}
-
-/**
- * @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.
-   *  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 ImageOnly extends Card {
@@ -474,18 +398,18 @@ export class ControlCard extends Card {
 
 export class ContentCards {
   /**
-   *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
+   *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `ImageOnly`).
    *    If you use Braze's UI to render content cards, you generally shouldn't need to
    *    interact with this class, but if you are building your own content cards class manually, use
    *    `getCachedContentCards` to get the most recent ContentCards object.
    *
-   * @param cards - Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
+   * @param cards - Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `ImageOnly`).
    * @param lastUpdated - When this collection of cards was received from Braze servers. If null, it means the
    *    content cards are still being fetched for this user.
    */
   constructor(cards: Card[], lastUpdated: Date | null);
 
-  /** Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`). */
+  /** Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `ImageOnly`). */
   cards: Card[];
 
   /**
@@ -503,19 +427,19 @@ export class ContentCards {
 
 export class Feed {
   /**
-   *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
+   *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `ImageOnly`).
    *    Subscribe to receive feed updates via `subscribeToFeedUpdates`,
    *    or get the currently cached feed with `getCachedFeed`.
    *
    * @param cards - Array of `Card` descendents (`ClassicCard`, `CaptionedImage`,
-   *   `Banner`). Can be passed directly to `showFeed`.
+   *   `ImageOnly`). Can be passed directly to `showFeed`.
    * @param lastUpdated - When this collection of cards was received from Braze servers. If null, it means the
    *   feed has never been fetched for this user.
    */
   constructor(cards: Card[], lastUpdated: Date | null);
 
   /**
-   * Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
+   * Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `ImageOnly`).
    *    Can be passed directly to `showFeed`.
    */
   cards: Card[];
@@ -729,7 +653,7 @@ export class InAppMessage {
    */
   subscribeToDismissedEvent(subscriber: () => void): string | null;
 
-  // static fromJson(jsonData: Record<string, unknown>): InAppMessage | undefined;
+
 }
 
 export class FullScreenMessage extends InAppMessage {
@@ -2020,11 +1944,6 @@ export function logContentCardImpressions(contentCards: Card[]): boolean;
  */
 export function logContentCardClick(contentCard: Card): boolean;
 
-/**
- * @deprecated This method has been deprecated and is currently a no-op.
- */
-export function logContentCardsDisplayed(): boolean;
-
 /**
  * Reports that the current user performed a custom named event.
  *
@@ -2164,7 +2083,7 @@ export function openSession(): void;
  * - 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/4.10/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.0/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2404,9 +2323,10 @@ export function handleBrazeAction(
  * Gets a feature flag by its ID.
  *
  * @param id - The ID of the feature flag.
- * @returns - An object of type `FeatureFlag`.
+ * @returns - An object of type `FeatureFlag`, if feature flag with given ID exists. The method returns null if feature flag does not exist,
+ *    or if feature flags are disabled. Returns undefined if the SDK has not been initialized.
  */
-export function getFeatureFlag(id: string): FeatureFlag;
+export function getFeatureFlag(id: string): FeatureFlag | null | undefined;
 
 /**
  * Subscribe to feature flag updates. The subscriber callback will be called whenever feature flags are updated. This method
@@ -2414,8 +2334,9 @@ export function getFeatureFlag(id: string): FeatureFlag;
  *
  * @param subscriber - The callback function to handle new feature flags. This function is always called first with the
  *   available cached list of `FeatureFlag` objects, and will also be called when feature flag updates are available.
- *   If you want to be notified when a refresh has completed
- *   regardless of whether new feature flags are available, you should use the `successCallback` of `refreshFeatureFlags`.
+ *   If there is a failure in receiving updates, this function will be called with the cached list of `FeatureFlag` objects.
+ *   If you want to be notified when a refresh has completed regardless of whether new feature flags are available,
+ *   you should use the `successCallback` of `refreshFeatureFlags`.
  *
  * @returns The identifier of the subscription created. This can be passed to `removeSubscription` to cancel the subscription.
  *    Returns undefined if the SDK has not been initialized.
@@ -2454,10 +2375,10 @@ export type InitializationOptions = {
    */
   allowCrawlerActivity?: boolean;
   /**
-   * By default, the Braze Web SDK does not allow user-supplied Javascript click actions, as it allows Braze dashboard
-   *   users to run Javascript on your site. To indicate that you trust the Braze dashboard users to write non-malicious
-   *   Javascript click actions, set this property to true. If `enableHtmlInAppMessages` is true, this option will also be
-   *   set to true.
+   * By default, the Braze Web SDK does not allow user-supplied Javascript click actions or enable HTML in-app messages,
+   *   as they allow Braze dashboard users to run Javascript on your site.
+   *   To indicate that you trust the Braze dashboard users to write non-malicious
+   *   Javascript click actions, set this property to true.
    */
   allowUserSuppliedJavascript?: boolean;
   /**
@@ -2468,6 +2389,8 @@ export type InitializationOptions = {
   /**
    * A numerical app version value which can be used for user segmentation. This value must be sent with four fields, such as
    * "1.2.3.4", otherwise it will be ignored.
+   * 
+   * Note: `appVersion` must also be set, either with the same value or a unique name for this version.
    */
   appVersionNumber?: string;
   /**
@@ -2504,14 +2427,6 @@ export type InitializationOptions = {
    *   is loaded on your site - otherwise in-app messages may not render correctly.
    */
   doNotLoadFontAwesome?: boolean;
-  /**
-   * By default, the Braze Web SDK does not enable HTML in-app messages, as they allow Braze dashboard users to run Javascript
-   *   on your site. To indicate that you trust the Braze dashboard users to write non-malicious HTML in-app messages, set this
-   *   property to true. If `allowUserSuppliedJavascript` is set to true, this option will also be set to true.
-   *
-   * @deprecated This initialization option is deprecated in favor of `allowUserSuppliedJavascript`.
-   */
-  enableHtmlInAppMessages?: boolean;
   /**
    * Set to true to enable logging by default. Note that this will cause Braze to log to the javascript console, which is visible
    *   to all users! You should probably remove this or provide an alternate logger with `setLogger` before you release
@@ -2543,7 +2458,7 @@ export type InitializationOptions = {
    *   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/4.10/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.0/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;
@@ -2596,7 +2511,7 @@ export type InitializationOptions = {
    */
   sessionTimeoutInSeconds?: number;
 };
-// }
 
-// export = Braze;
-// export as namespace Braze;
+
+
+

package/package.json

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

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

@@ -1 +1,8 @@
-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,Yo:ke};export default r;
+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, es: Oe, ts: Oe.ep, j: Ue, Yo: ke };
+export default r;

package/shared-lib/encoding-utils.js

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

package/shared-lib/event-types.js

@@ -1 +1,34 @@
-const De={CustomEvent:"ce",Pr:"p",Mu:"pc",cc:"ca",Ka:"i",qs:"ie",P:"cci",T:"ccic",$:"ccc",H:"ccd",Wl:"ss",xl:"se",Vi:"si",Li:"sc",Qi:"sbc",Ki:"sfe",eo:"iec",Lu:"lr",Tu:"uae",R:"ci",B:"cc",Ru:"lcaa",Pu:"lcar",Xn:"inc",Jn:"add",Qn:"rem",Hn:"set",Kn:"ncam",Nu:"sgu",Fr:"ffi"},Be={Br:"feed_displayed",dc:"content_cards_displayed"};export{De as EventTypes,Be as InternalEventTypes};
+const De = {
+    CustomEvent: "ce",
+    Pr: "p",
+    Mu: "pc",
+    cc: "ca",
+    Ka: "i",
+    qs: "ie",
+    P: "cci",
+    T: "ccic",
+    $: "ccc",
+    H: "ccd",
+    Wl: "ss",
+    xl: "se",
+    Vi: "si",
+    Li: "sc",
+    Qi: "sbc",
+    Ki: "sfe",
+    eo: "iec",
+    Lu: "lr",
+    Tu: "uae",
+    R: "ci",
+    B: "cc",
+    Ru: "lcaa",
+    Pu: "lcar",
+    Xn: "inc",
+    Jn: "add",
+    Qn: "rem",
+    Hn: "set",
+    Kn: "ncam",
+    Nu: "sgu",
+    Fr: "ffi",
+  },
+  Be = { Br: "feed_displayed", dc: "content_cards_displayed" };
+export { De as EventTypes, Be as InternalEventTypes };

package/shared-lib/guid.js

@@ -1 +1,10 @@
-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 Ge;
+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 Ge;