├── .gitignore
├── sample-builds
    ├── npm
    │   ├── src
    │   │   ├── react-app-env.d.ts
    │   │   ├── index.tsx
    │   │   └── App.tsx
    │   ├── public
    │   │   ├── service-worker.js
    │   │   └── index.html
    │   ├── README.md
    │   ├── tsconfig.json
    │   └── package.json
    ├── segment
    │   ├── src
    │   │   ├── react-app-env.d.ts
    │   │   ├── index.tsx
    │   │   └── App.tsx
    │   ├── public
    │   │   ├── service-worker.js
    │   │   └── index.html
    │   ├── README.md
    │   ├── tsconfig.json
    │   └── package.json
    ├── google-tag-manager
    │   ├── src
    │   │   ├── react-app-env.d.ts
    │   │   ├── index.tsx
    │   │   └── App.tsx
    │   ├── public
    │   │   ├── service-worker.js
    │   │   └── index.html
    │   ├── README.md
    │   ├── tsconfig.json
    │   └── package.json
    └── cdn
    │   ├── service-worker.js
    │   └── index.html
├── snippets
    ├── README.md
    ├── no-amd-library.js
    ├── service-worker-skip-waiting.js
    ├── alternate-push-domain-status.html
    ├── alternate-push-domain-registration.html
    └── loading-snippet.js
├── .github
    ├── assets
    │   ├── logo-dark.png
    │   ├── logo-light.png
    │   └── lighthouse-score.svg
    ├── ISSUE_TEMPLATE
    │   ├── config.yml
    │   ├── feature.yml
    │   └── bug.yml
    └── issue_template.md
├── LICENSE
├── README.md
├── UPGRADE_GUIDE.md
└── CHANGELOG.md


/.gitignore:
--------------------------------------------------------------------------------
1 | 
2 | 


--------------------------------------------------------------------------------
/sample-builds/npm/src/react-app-env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="react-scripts" />
2 | 


--------------------------------------------------------------------------------
/sample-builds/segment/src/react-app-env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="react-scripts" />
2 | 


--------------------------------------------------------------------------------
/snippets/README.md:
--------------------------------------------------------------------------------
1 | ## Snippets
2 | 
3 | Code snippets used by https://braze.com/docs
4 | 


--------------------------------------------------------------------------------
/snippets/no-amd-library.js:
--------------------------------------------------------------------------------
1 | https://js.appboycdn.com/web-sdk/6.4/braze.no-amd.min.js
2 | 


--------------------------------------------------------------------------------
/sample-builds/google-tag-manager/src/react-app-env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="react-scripts" />
2 | 


--------------------------------------------------------------------------------
/.github/assets/logo-dark.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/braze-inc/braze-web-sdk/HEAD/.github/assets/logo-dark.png


--------------------------------------------------------------------------------
/.github/assets/logo-light.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/braze-inc/braze-web-sdk/HEAD/.github/assets/logo-light.png


--------------------------------------------------------------------------------
/sample-builds/cdn/service-worker.js:
--------------------------------------------------------------------------------
1 | self.importScripts('https://js.appboycdn.com/web-sdk/6.4/service-worker.js');
2 | 


--------------------------------------------------------------------------------
/sample-builds/npm/public/service-worker.js:
--------------------------------------------------------------------------------
1 | self.importScripts("https://js.appboycdn.com/web-sdk/6.4/service-worker.js");
2 | 


--------------------------------------------------------------------------------
/sample-builds/segment/public/service-worker.js:
--------------------------------------------------------------------------------
1 | self.importScripts("https://js.appboycdn.com/web-sdk/6.4/service-worker.js");
2 | 


--------------------------------------------------------------------------------
/sample-builds/google-tag-manager/public/service-worker.js:
--------------------------------------------------------------------------------
1 | self.importScripts("https://js.appboycdn.com/web-sdk/6.4/service-worker.js");
2 | 


--------------------------------------------------------------------------------
/snippets/service-worker-skip-waiting.js:
--------------------------------------------------------------------------------
1 | self.addEventListener("install", event => {
2 |   event.stopImmediatePropagation();
3 | });
4 | self.importScripts("https://js.appboycdn.com/web-sdk/6.4/service-worker.js");
5 | 


--------------------------------------------------------------------------------
/sample-builds/npm/src/index.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import ReactDOM from 'react-dom/client';
 3 | import App from './App';
 4 | 
 5 | const root = ReactDOM.createRoot(
 6 |   document.getElementById('root') as HTMLElement
 7 | );
 8 | root.render(
 9 |   <React.StrictMode>
10 |     <App />
11 |   </React.StrictMode>
12 | );
13 | 


--------------------------------------------------------------------------------
/sample-builds/segment/README.md:
--------------------------------------------------------------------------------
1 | # Segment Integration Sample App
2 | 
3 | This is a simple sample app created with [Create React App](https://github.com/facebook/create-react-app) that demonstrates sending events to Braze via Segment.
4 | 
5 | ## Running the App
6 | 
7 | Run `yarn run:prod` to create a production build and serve it at [http://localhost:3000](http://localhost:3000).
8 | 


--------------------------------------------------------------------------------
/sample-builds/npm/README.md:
--------------------------------------------------------------------------------
1 | # Braze Web SDK Webpack Sample App
2 | 
3 | This is a simple sample app created with [Create React App](https://github.com/facebook/create-react-app) that demonstrates using the Braze Web SDK with tree-shaking and dynamic imports.
4 | 
5 | ## Running the App
6 | 
7 | Run `yarn run:prod` to create a production build and serve it at [http://localhost:3000](http://localhost:3000).
8 | 


--------------------------------------------------------------------------------
/sample-builds/google-tag-manager/README.md:
--------------------------------------------------------------------------------
1 | # Google Tag Manager Integration Sample App
2 | 
3 | This is a simple sample app created with [Create React App](https://github.com/facebook/create-react-app) that demonstrates sending events to Braze via Google Tag Manager.
4 | 
5 | ## Running the App
6 | 
7 | Run `yarn start` to create a production build and serve it at [http://localhost:3000](http://localhost:3000).
8 | 


--------------------------------------------------------------------------------
/sample-builds/segment/src/index.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import ReactDOM from 'react-dom/client';
 3 | import App from './App';
 4 | 
 5 | declare global {
 6 |   interface Window { analytics: any; }
 7 | }
 8 | 
 9 | const root = ReactDOM.createRoot(
10 |   document.getElementById('root') as HTMLElement
11 | );
12 | root.render(
13 |   <React.StrictMode>
14 |     <App />
15 |   </React.StrictMode>
16 | );
17 | 


--------------------------------------------------------------------------------
/sample-builds/npm/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="utf-8" />
 5 |     <meta name="viewport" content="width=device-width, initial-scale=1" />
 6 |     <title>Braze Web SDK Sample Integration</title>
 7 |   </head>
 8 |   <body>
 9 |     <noscript>You need to enable JavaScript to run this app.</noscript>
10 |     <div id="root"></div>
11 |   </body>
12 | </html>
13 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | blank_issues_enabled: false
2 | contact_links:
3 |   - name: Braze Support
4 |     url: https://www.braze.com/docs/support_contact
5 |     about: Contact Braze Support for company or campaign-specific troubleshooting
6 |   - name: Security Issues
7 |     url: https://www.braze.com/docs/developer_guide/disclosures/security_and_vulnerability_disclosure/
8 |     about: Please report security vulnerabilities here.
9 | 


--------------------------------------------------------------------------------
/sample-builds/google-tag-manager/src/index.tsx:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | import ReactDOM from "react-dom/client";
 3 | import App from "./App";
 4 | 
 5 | declare global {
 6 |   interface Window {
 7 |     dataLayer: any[];
 8 |   }
 9 | }
10 | 
11 | const root = ReactDOM.createRoot(
12 |   document.getElementById("root") as HTMLElement
13 | );
14 | root.render(
15 |   <React.StrictMode>
16 |     <App />
17 |   </React.StrictMode>
18 | );
19 | 


--------------------------------------------------------------------------------
/sample-builds/npm/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "target": "es5",
 4 |     "lib": [
 5 |       "dom",
 6 |       "dom.iterable",
 7 |       "esnext"
 8 |     ],
 9 |     "allowJs": true,
10 |     "skipLibCheck": true,
11 |     "esModuleInterop": true,
12 |     "allowSyntheticDefaultImports": true,
13 |     "strict": true,
14 |     "forceConsistentCasingInFileNames": true,
15 |     "noFallthroughCasesInSwitch": true,
16 |     "module": "esnext",
17 |     "moduleResolution": "node",
18 |     "resolveJsonModule": true,
19 |     "isolatedModules": true,
20 |     "noEmit": true,
21 |     "jsx": "react-jsx"
22 |   },
23 |   "include": [
24 |     "src"
25 |   ]
26 | }
27 | 


--------------------------------------------------------------------------------
/sample-builds/segment/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "target": "es5",
 4 |     "lib": [
 5 |       "dom",
 6 |       "dom.iterable",
 7 |       "esnext"
 8 |     ],
 9 |     "allowJs": true,
10 |     "skipLibCheck": true,
11 |     "esModuleInterop": true,
12 |     "allowSyntheticDefaultImports": true,
13 |     "strict": true,
14 |     "forceConsistentCasingInFileNames": true,
15 |     "noFallthroughCasesInSwitch": true,
16 |     "module": "esnext",
17 |     "moduleResolution": "node",
18 |     "resolveJsonModule": true,
19 |     "isolatedModules": true,
20 |     "noEmit": true,
21 |     "jsx": "react-jsx"
22 |   },
23 |   "include": [
24 |     "src"
25 |   ]
26 | }
27 | 


--------------------------------------------------------------------------------
/sample-builds/google-tag-manager/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "target": "es5",
 4 |     "lib": [
 5 |       "dom",
 6 |       "dom.iterable",
 7 |       "esnext"
 8 |     ],
 9 |     "allowJs": true,
10 |     "skipLibCheck": true,
11 |     "esModuleInterop": true,
12 |     "allowSyntheticDefaultImports": true,
13 |     "strict": true,
14 |     "forceConsistentCasingInFileNames": true,
15 |     "noFallthroughCasesInSwitch": true,
16 |     "module": "esnext",
17 |     "moduleResolution": "node",
18 |     "resolveJsonModule": true,
19 |     "isolatedModules": true,
20 |     "noEmit": true,
21 |     "jsx": "react-jsx"
22 |   },
23 |   "include": [
24 |     "src"
25 |   ]
26 | }
27 | 


--------------------------------------------------------------------------------
/snippets/alternate-push-domain-status.html:
--------------------------------------------------------------------------------
 1 | <script src="https://js.appboycdn.com/web-sdk/6.4/braze.min.js"></script>
 2 | <script>
 3 |   // initialize Braze
 4 |   braze.initialize("YOUR-API-KEY", {
 5 |     baseUrl: "YOUR-SDK-BASE-URL",
 6 |     enableLogging: true
 7 |   });
 8 | 
 9 |   // listen for a request from our insecure page
10 |   window.addEventListener("message", event => {
11 |     if (event.origin === "http://insecure.com") {
12 |       // when they ask for push status, retrieve from Braze SDK
13 |       if (event.data.type === "get_push_status") {
14 |         // send the parent window (insecure.com) the results
15 |         window.top.postMessage(
16 |           {
17 |             type: "set_push_status",
18 |             isPushPermissionGranted: braze.isPushPermissionGranted()
19 |           },
20 |           event.origin
21 |         );
22 |       }
23 |     }
24 |   });
25 | </script>
26 | 


--------------------------------------------------------------------------------
/sample-builds/google-tag-manager/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <!-- Google Tag Manager -->
 5 |     <script>
 6 |       (function(w, d, s, l, i) {
 7 |         w[l] = w[l] || [];
 8 |         w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
 9 |         var f = d.getElementsByTagName(s)[0],
10 |           j = d.createElement(s),
11 |           dl = l != "dataLayer" ? "&l=" + l : "";
12 |         j.async = true;
13 |         j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
14 |         f.parentNode.insertBefore(j, f);
15 |       })(window, document, "script", "dataLayer", "GTM-T3MZB46");
16 |     </script>
17 |     <!-- End Google Tag Manager -->
18 |     <meta charset="utf-8" />
19 |     <meta name="viewport" content="width=device-width, initial-scale=1" />
20 |     <title>Google Tag Manager Integration Demo</title>
21 |   </head>
22 |   <body>
23 |     <noscript>You need to enable JavaScript to run this app.</noscript>
24 |     <div id="root"></div>
25 |   </body>
26 | </html>
27 | 


--------------------------------------------------------------------------------
/sample-builds/npm/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "braze-webpack-sample",
 3 |   "version": "0.1.0",
 4 |   "private": true,
 5 |   "dependencies": {
 6 |     "@braze/web-sdk": "6.4.0",
 7 |     "@types/node": "^16.7.13",
 8 |     "@types/react": "^18.0.0",
 9 |     "@types/react-dom": "^18.0.0",
10 |     "react": "^18.1.0",
11 |     "react-dom": "^18.1.0",
12 |     "react-scripts": "5.0.1",
13 |     "typescript": "^4.4.2"
14 |   },
15 |   "resolutions": {
16 |     "error-ex": "1.3.2",
17 |     "is-arrayish": "0.3.2",
18 |     "debug": "4.4.1"
19 |   },
20 |   "scripts": {
21 |     "start": "react-scripts start",
22 |     "build": "react-scripts build",
23 |     "run:prod": "yarn && yarn build && npx serve -s build"
24 |   },
25 |   "eslintConfig": {
26 |     "extends": [
27 |       "react-app",
28 |       "react-app/jest"
29 |     ]
30 |   },
31 |   "browserslist": {
32 |     "production": [
33 |       ">0.2%",
34 |       "not dead",
35 |       "not op_mini all"
36 |     ],
37 |     "development": [
38 |       "last 1 chrome version",
39 |       "last 1 firefox version",
40 |       "last 1 safari version"
41 |     ]
42 |   }
43 | }
44 | 


--------------------------------------------------------------------------------
/.github/assets/lighthouse-score.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="132" height="20" role="img" aria-label="lighthouse score: 100"><title>lighthouse score: 100</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="132" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="101" height="20" fill="#555"/><rect x="101" width="31" height="20" fill="#007ec6"/><rect width="132" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="515" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="910">lighthouse score</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="910">lighthouse score</text><text aria-hidden="true" x="1155" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">100</text><text x="1155" y="140" transform="scale(.1)" fill="#fff" textLength="210">100</text></g></svg>


--------------------------------------------------------------------------------
/sample-builds/segment/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "segment-integration-sample",
 3 |   "version": "0.1.0",
 4 |   "private": true,
 5 |   "publishConfig": {
 6 |     "registry": "https://registry.npmjs.org"
 7 |   },
 8 |   "dependencies": {
 9 |     "@types/node": "^16.7.13",
10 |     "@types/react": "^18.0.0",
11 |     "@types/react-dom": "^18.0.0",
12 |     "react": "^18.1.0",
13 |     "react-dom": "^18.1.0",
14 |     "react-scripts": "5.0.1",
15 |     "typescript": "^4.4.2"
16 |   },
17 |   "resolutions": {
18 |     "error-ex": "1.3.2",
19 |     "is-arrayish": "0.3.2",
20 |     "debug": "4.4.1"
21 |   },
22 |   "scripts": {
23 |     "start": "react-scripts start",
24 |     "build": "react-scripts build",
25 |     "run:prod": "yarn && yarn build && npx serve -s build"
26 |   },
27 |   "eslintConfig": {
28 |     "extends": [
29 |       "react-app",
30 |       "react-app/jest"
31 |     ]
32 |   },
33 |   "browserslist": {
34 |     "production": [
35 |       ">0.2%",
36 |       "not dead",
37 |       "not op_mini all"
38 |     ],
39 |     "development": [
40 |       "last 1 chrome version",
41 |       "last 1 firefox version",
42 |       "last 1 safari version"
43 |     ]
44 |   }
45 | }
46 | 


--------------------------------------------------------------------------------
/sample-builds/google-tag-manager/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "google-tag-manager-integration-sample",
 3 |   "version": "0.1.0",
 4 |   "private": true,
 5 |   "publishConfig": {
 6 |     "registry": "https://registry.npmjs.org"
 7 |   },
 8 |   "resolutions": {
 9 |     "error-ex": "1.3.2",
10 |     "is-arrayish": "0.3.2",
11 |     "debug": "4.4.1"
12 |   },
13 |   "dependencies": {
14 |     "@types/node": "^16.7.13",
15 |     "@types/react": "^18.0.0",
16 |     "@types/react-dom": "^18.0.0",
17 |     "react": "^18.1.0",
18 |     "react-dom": "^18.1.0",
19 |     "react-scripts": "5.0.1",
20 |     "typescript": "^4.4.2"
21 |   },
22 |   "scripts": {
23 |     "start": "react-scripts start",
24 |     "build": "react-scripts build",
25 |     "run:prod": "yarn && yarn build && npx serve -s build"
26 |   },
27 |   "eslintConfig": {
28 |     "extends": [
29 |       "react-app",
30 |       "react-app/jest"
31 |     ]
32 |   },
33 |   "browserslist": {
34 |     "production": [
35 |       ">0.2%",
36 |       "not dead",
37 |       "not op_mini all"
38 |     ],
39 |     "development": [
40 |       "last 1 chrome version",
41 |       "last 1 firefox version",
42 |       "last 1 safari version"
43 |     ]
44 |   }
45 | }
46 | 


--------------------------------------------------------------------------------
/sample-builds/segment/src/App.tsx:
--------------------------------------------------------------------------------
 1 | function App() {
 2 | 
 3 |   const identifyCalls = () => {
 4 |     window.analytics.identify('g8gf2389986', {
 5 |       name: 'John Doe',
 6 |       email: 'jdoe@example.com'
 7 |     });
 8 |   };
 9 | 
10 |   const trackCalls = () => {
11 |     window.analytics.track('Signed Up', {
12 |       plan: 'Enterprise'
13 |     });
14 |   };
15 | 
16 |   const orderCompletedCalls = () => {
17 |     window.analytics.track('Order Completed', {
18 |       products: [
19 |         {
20 |           product_id: "testProductID",
21 |           price: "2.0"
22 |         }
23 |       ]
24 |     });
25 |   };
26 | 
27 |   return (
28 |     <div className="App">
29 |       <header className="App-header">
30 |         <p>
31 |           This is a sample app demonstrating Segment integration with Braze.
32 |         </p>
33 |         <button onClick={identifyCalls}>Identify Calls</button>
34 |         <br />
35 |         <br />
36 |         <button onClick={trackCalls}>Track Calls</button>
37 |         <br />
38 |         <br />
39 |         <button onClick={orderCompletedCalls}>Order Completed Calls</button>
40 |       </header>
41 |     </div>
42 |   );
43 | }
44 | 
45 | export default App;
46 | 


--------------------------------------------------------------------------------
/snippets/alternate-push-domain-registration.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 |   <head>
 3 |     <title>Opt-In for Push</title>
 4 |     <script src="https://js.appboycdn.com/web-sdk/6.4/braze.min.js"></script>
 5 |   </head>
 6 |   <body>
 7 |     <button id="opt-in">Opt In For Push</button>
 8 |     <script>
 9 |       // initialize Braze
10 |       braze.initialize("YOUR-API-KEY", {
11 |         baseUrl: "YOUR-SDK-BASE-URL",
12 |         enableLogging: true
13 |       });
14 |       // parse the `external_id` from the URL parameters
15 |       const external_id =
16 |         (
17 |           location.search
18 |             .substring(1)
19 |             .split("&")
20 |             .find(param => param.startsWith("external_id=")) || ""
21 |         ).split("=")[1] || "";
22 |       if (external_id) {
23 |         braze.changeUser(external_id);
24 |       }
25 |       braze.automaticallyShowInAppMessages();
26 |       braze.openSession();
27 | 
28 |       // when the user click's our Opt In button, prompt for permission
29 |       document.getElementById("opt-in").onclick = function() {
30 |         braze.requestPushPermission(
31 |           () => {
32 |             window.alert(`You are registered for push!`);
33 |             window.close();
34 |           },
35 |           () => {
36 |             window.alert(`Something went wrong.`);
37 |           }
38 |         );
39 |       };
40 |     </script>
41 |   </body>
42 | </html>
43 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature.yml:
--------------------------------------------------------------------------------
 1 | name: ✅ Feature Request
 2 | description: Request New SDK Features
 3 | title: '[Feature]: '
 4 | labels: ["feature-request"]
 5 | body:
 6 |   - type: markdown
 7 |     attributes:
 8 |       value: |
 9 |         :point_right: You can also submit feature requests in our [Public Roadmap Portal](https://dashboard.braze.com/resources/roadmap)
10 |   - type: textarea
11 |     id: problem
12 |     attributes:
13 |       label: What problem are you facing?
14 |       description: Help us understand what you're unable to accomplish, or what's difficult with your integration
15 |       placeholder: |
16 |         ex: I am unable to accomplish XYZ today, since the SDK does not allow me to...
17 |     validations:
18 |       required: true
19 |   - type: textarea
20 |     id: workarounds
21 |     attributes:
22 |       label: Workarounds
23 |       description: Are there any workarounds you can use? How complicated are they?
24 |     validations:
25 |       required: true
26 |   - type: textarea
27 |     id: ideal_solution
28 |     attributes:
29 |       label: Ideal Solution
30 |       description: What would your ideal solution look like?
31 |     validations:
32 |       required: false
33 |   - type: textarea
34 |     id: other_information
35 |     attributes:
36 |       label: Other Information
37 |       description: Any additional information you'd like to share?
38 |     validations:
39 |       required: false
40 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2025 Braze, Inc.
 2 | All rights reserved.
 3 | 
 4 | * Use of source code or binaries contained within Braze’s SDKS are permitted only to enable use of the Braze platform by current customers of Braze.
 5 | * Modification of source code and inclusion in mobile apps or web sites is only permitted provided that all other conditions set forth herein are met.
 6 | * Neither the name of Braze nor the names of any of its contributors may be used to endorse or promote products derived from this software without the express prior written permission of Braze.
 7 | * Redistribution of source code or binaries is strictly prohibited except with the express prior written permission of Braze. Any such redistribution must retain the above copyright notice, this list of conditions and the following disclaimer.
 8 | 
 9 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE USER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
10 | 


--------------------------------------------------------------------------------
/sample-builds/segment/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <script>
 5 |       !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware"];analytics.factory=function(e){return function(){var t=Array.prototype.slice.call(arguments);t.unshift(e);analytics.push(t);return analytics}};for(var e=0;e<analytics.methods.length;e++){var key=analytics.methods[e];analytics[key]=analytics.factory(key)}analytics.load=function(key,e){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.src="https://cdn.segment.com/analytics.js/v1/" + key + "/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(t,n);analytics._loadOptions=e};analytics._writeKey="qdlCzchOpq4jnlfGWA04qGgMOMTcFHwd";;analytics.SNIPPET_VERSION="4.15.3";
 6 |       analytics.load("qdlCzchOpq4jnlfGWA04qGgMOMTcFHwd");
 7 |       analytics.page();
 8 |       }}();
 9 |     </script>
10 |     <meta charset="utf-8" />
11 |     <meta name="viewport" content="width=device-width, initial-scale=1" />
12 |     <title>Segment Integration Demo</title>
13 |   </head>
14 |   <body>
15 |     <noscript>You need to enable JavaScript to run this app.</noscript>
16 |     <div id="root"></div>
17 |   </body>
18 | </html>
19 | 


--------------------------------------------------------------------------------
/sample-builds/npm/src/App.tsx:
--------------------------------------------------------------------------------
 1 | import { useEffect } from "react";
 2 | 
 3 | import {
 4 |   initialize,
 5 |   automaticallyShowInAppMessages,
 6 |   openSession,
 7 |   getUser
 8 | } from "@braze/web-sdk";
 9 | 
10 | function App() {
11 |   useEffect(() => {
12 |     initialize("e491231d-c4ae-466d-8f7f-ba8ad308f12a", {
13 |       enableLogging: true,
14 |       baseUrl: "sdk.iad-01.braze.com",
15 |       // Warning: Using the serviceWorkerLocation option limits the scope of push notifications on your site. See
16 |       // https://js.appboycdn.com/web-sdk/6.4/doc/module-appboy.html#initialize for more details.
17 |       // If in doubt, omit this option and use the default location of /service-worker.js
18 |       serviceWorkerLocation: "/service-worker.js",
19 |       safariWebsitePushId: "web.com.braze.sample-build"
20 |     });
21 |     automaticallyShowInAppMessages();
22 |     openSession();
23 |     getUser()?.setCustomUserAttribute("visited sample-build", new Date());
24 |   }, []);
25 | 
26 |   const handleRegisterPushClick = async () => {
27 |     // use webpackExports magic comment to dynamically import while still getting the benefits of tree-shaking
28 |     const {
29 |       requestPushPermission,
30 |       logCustomEvent,
31 |       requestImmediateDataFlush
32 |     } = await import(
33 |       /* webpackExports: ["requestPushPermission", "logCustomEvent", "requestImmediateDataFlush"] */
34 |       "@braze/web-sdk"
35 |     );
36 |     requestPushPermission(() => {
37 |       logCustomEvent("send me push");
38 |       requestImmediateDataFlush();
39 |     });
40 |   };
41 | 
42 |   return (
43 |     <div>
44 |       This is a sample integration of the Braze Web SDK, with web push
45 |       integrated.
46 |       <br />
47 |       <br />
48 |       <button onClick={handleRegisterPushClick}>Send Me A Sample Push</button>
49 |     </div>
50 |   );
51 | }
52 | 
53 | export default App;
54 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug.yml:
--------------------------------------------------------------------------------
 1 | name: 🐞 Bug report
 2 | description: File a Bug Report for unexpected or incorrect SDK Behavior
 3 | title: '[Bug]: '
 4 | labels: ["bug"]
 5 | body:
 6 |   - type: markdown
 7 |     attributes:
 8 |       value: |
 9 |         Thanks for taking the time to fill out this bug report!
10 | 
11 |         :warning: Please consider contacting [Braze Support](https://www.braze.com/docs/support_contact) for in-depth troubleshooting and to avoid leaking private information to our public Github issues.
12 |   - type: input
13 |     id: sdk_version
14 |     attributes:
15 |       label: Braze Web SDK Version
16 |       placeholder: ex. 3.5.0
17 |     validations:
18 |       required: true
19 |   - type: dropdown
20 |     id: integration_method
21 |     attributes:
22 |       label: Integration Method
23 |       multiple: false
24 |       options:
25 |         - CDN
26 |         - NPM
27 |         - Google Tag Manager
28 |         - Segment
29 |         - mParticle
30 |         - Tealium
31 |         - Other (please specify)
32 |     validations:
33 |       required: true
34 |   - type: dropdown
35 |     id: browser
36 |     attributes:
37 |       label: Browser
38 |       description: Which browsers can you reproduce this on?
39 |       multiple: true
40 |       options:
41 |         - Chrome
42 |         - Firefox
43 |         - Safari
44 |         - Edge
45 |         - Other
46 |     validations:
47 |       required: true
48 |   - type: textarea
49 |     id: repro_steps
50 |     attributes:
51 |       label: Steps To Reproduce
52 |       description: Please provide a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
53 |       placeholder: |
54 |         Example:
55 |           ```
56 |           import braze from "@braze/web-sdk"
57 |           braze.subscribeToInAppMessage(function(inAppMessage) {
58 |             braze.showInAppMessage(inAppMessage);
59 |           });
60 |           ```
61 |     validations:
62 |       required: true
63 |   - type: textarea
64 |     id: expected_behavior
65 |     attributes:
66 |       label: Expected Behavior
67 |       description: What did you expect to happen?
68 |     validations:
69 |       required: true
70 |   - type: textarea
71 |     id: actual_behavior
72 |     attributes:
73 |       label: Actual Incorrect Behavior
74 |       description: What incorrect behavior happened instead?
75 |     validations:
76 |       required: true
77 |   - type: textarea
78 |     id: verbose_logs
79 |     attributes:
80 |       label: Verbose Logs
81 |       description: Please set "enableLogging" to true in initialization option and paste verbose log output. This will be automatically formatted into code, so no need for backticks.
82 |       render: shell
83 |   - type: textarea
84 |     id: other_info
85 |     attributes:
86 |       label: Additional Information
87 |       description: Anything else you'd like to share?
88 | 


--------------------------------------------------------------------------------
/.github/issue_template.md:
--------------------------------------------------------------------------------
 1 | <!--
 2 | Thank you for opening an issue with Braze!
 3 | 
 4 | If you are experiencing issues with our product, please consider directing your issue to support@braze.com, as that is the best channel for solving integration issues. Please see the bottom for more explanation.
 5 | 
 6 | For other items, like requests for modifications to our SDK or bug reports, please follow the following guidelines while submitting:
 7 | -->
 8 | 
 9 | * [ ] I have checked [Braze's documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup/) and am still experiencing the issue.
10 | 
11 | # Report
12 | 
13 | ## Describe your environment.
14 | 
15 | 
16 |  Info                       | Value                               |
17 | ----------------------------|-------------------------------------|
18 |  SDK Version                | e.g. 3.2.0
19 |  Browser Affected           | e.g. Chrome / Safari / Firefox / all
20 |  Affected Browser Version   | e.g. 87 / 14.2 / 89 / any
21 |  Operating System Affected  | e.g. Windows / Mac / iOS / Android / any
22 |  Integration Method         | e.g. npm / CDN / Google Tag Manager
23 |  Repro rate                 | e.g. All the time (100%) / Sometimes x% / Only once
24 | 
25 | 
26 | ## What did you do?
27 | 
28 | <!--
29 | ℹ Please replace this with what you did.
30 | Example: Integrated Braze through npm and followed the docs to integrate.
31 | -->
32 | 
33 | ## What did you expect to happen?
34 | 
35 | <!--
36 | ℹ Please replace this with what you expected to happen.
37 | Example: Braze SDK is integrated properly and creating sessions.
38 | -->
39 | 
40 | ## What happened instead?
41 | 
42 | <!--
43 | ℹ Please replace this with what happened instead.
44 | Example: Braze SDK doesn't create any sessions for the test user.
45 | -->
46 | 
47 | ## Steps to reproduce
48 | 
49 | <!--
50 | ℹ Please give us detailed steps so we can reproduce the issue on our end. This is very important and will help speed up the investigation a lot.
51 | Example:
52 | - Install Braze through `yarn add @braze/web-sdk`
53 | - Add `appboy.intialize` to the home page and call `openSession`.
54 | - Load the website.
55 | -->
56 | 
57 | ## Code Snippet
58 | 
59 | <!--
60 | ℹ Please send us all code snippets that are relevant to the issue.
61 | -->
62 | 
63 | ## Are you doing any feature customizations that may relate to the issue? Can you share the code snippet?
64 | 
65 | <!--
66 | ℹ Please provide any code snippets that can help us understand or reproduce the issue.
67 | -->
68 | 
69 | ## Project that demonstrates the issue
70 | 
71 | <!--
72 | ℹ If available, please link to a project we can download that reproduces the issue.
73 | -->
74 | 
75 | <!--
76 | support@braze.com is our preferred channel for integration issues for several reasons, including: 1) we optimize that channel to solve integration issues so that it is faster and more robust 2) that channel has no risk of leaking sensitive data and integration issues often require logs and other information that could contain private data.
77 | -->
78 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <p align="center">
 2 |   <img width="480" alt="Braze Logo" src=".github/assets/logo-light.png#gh-light-mode-only" />
 3 |   <img width="480" alt="Braze Logo" src=".github/assets/logo-dark.png#gh-dark-mode-only" />
 4 | </p>
 5 | 
 6 | 
 7 | # Braze Web SDK [![latest](https://img.shields.io/github/v/tag/braze-inc/braze-web-sdk?label=latest%20release&color=300266)](https://github.com/braze-inc/braze-web-sdk/releases) [![Static Badge](https://img.shields.io/badge/TSDoc-801ed7)](https://js.appboycdn.com/web-sdk/6.4/doc/modules/braze.html) ![lighthouse score](.github/assets/lighthouse-score.svg)
 8 | 
 9 | - [Braze User Guide](https://www.braze.com/docs/user_guide/introduction/ "Braze User Guide")
10 | - [Braze Developer Guide](https://www.braze.com/docs/developer_guide/sdk_integration/?sdktab=web "Braze Developer Guide")
11 | 
12 | ## Quickstart
13 | 
14 | ``` shell
15 | npm install --save @braze/web-sdk
16 | # or, using yarn:
17 | # yarn add @braze/web-sdk
18 | ```
19 | 
20 | ``` typescript
21 | import * as braze from "@braze/web-sdk";
22 | 
23 | // initialize the SDK
24 | braze.initialize('YOUR-API-KEY-HERE', {
25 |     baseUrl: "YOUR-SDK-ENDPOINT-HERE",
26 | });
27 | 
28 | braze.changeUser('Jane Doe');
29 | ```
30 | 
31 | ## Libraries
32 | 
33 | | Name | Description | npm | CDN URL
34 | | ---- | ----------- | --- | -------
35 | | Full | Full SDK with UI. When using the npm version, Javascript bundlers will remove any unused code including the UI. | `@braze/web-sdk` | https://js.appboycdn.com/web-sdk/6.4/braze.min.js
36 | | Core | Contains the SDK without UI. You will need to implement your own UI for In-App Messaging and Content Cards when using this version of the SDK. Our UI elements are fully customizable via css, so we generally recommend integration of the full library instead. | N/A | https://js.appboycdn.com/web-sdk/6.4/braze.core.min.js
37 | | No-AMD | Contains the full SDK without AMD support. This is useful if your site uses RequireJS or another AMD module-loader, but you prefer to load the SDK through the CDN. | N/A | https://js.appboycdn.com/web-sdk/6.4/braze.no-amd.min.js
38 | 
39 | ## Supported Browsers
40 | 
41 | ### CDN Version
42 | 
43 | - Modern Chromium based browsers (Chrome, Edge, Opera)
44 | - Firefox
45 | - Safari
46 | 
47 | ### NPM Version
48 | 
49 | - Modern Chromium based browsers (Chrome, Edge, Opera)
50 | - Firefox
51 | - Safari
52 | 
53 | # Debugging / Troubleshooting
54 | 
55 | Pass the option `enableLogging: true` to the initialize function (`braze.initialize('YOUR-API-KEY-HERE', { baseUrl: 'YOUR-SDK-ENDPOINT', enableLogging: true });`) to cause Braze to log to the javascript console. This is valuable for development but is visible to all users,
56 | so remove this option or [provide an alternate logger](https://js.appboycdn.com/web-sdk/6.4/doc/modules/braze.html#setlogger) before you release your page to production.
57 | 
58 | ## Font Awesome
59 | 
60 | Braze uses [Font Awesome](http://fortawesome.github.io/Font-Awesome/) 4.7.0 for in-app message icons. To disable loading Font Awesome, use the `doNotLoadFontAwesome` initialization option. Check out the [cheat sheet](http://fortawesome.github.io/Font-Awesome/cheatsheet/) to browse available icons.
61 | 
62 | ## Contact
63 | 
64 | If you have questions, please contact [support@braze.com](mailto:support@braze.com).


--------------------------------------------------------------------------------
/sample-builds/google-tag-manager/src/App.tsx:
--------------------------------------------------------------------------------
  1 | function App() {
  2 |   const changeUser = () => {
  3 |     window.dataLayer.push({
  4 |       event: "identify",
  5 |       userId: "abc"
  6 |     });
  7 |   };
  8 | 
  9 |   const logCustomEvent = () => {
 10 |     window.dataLayer.push({
 11 |       event: "add to cart"
 12 |     });
 13 |   };
 14 | 
 15 |   const logPurchase = () => {
 16 |     window.dataLayer.push({
 17 |       event: "purchase",
 18 |       productId: "abc",
 19 |       price: 100,
 20 |       currency: "usd",
 21 |       quantity: 1
 22 |     });
 23 |   };
 24 | 
 25 |   const disable = () => {
 26 |     window.dataLayer.push({
 27 |       event: "disable"
 28 |     });
 29 |   };
 30 |   const enable = () => {
 31 |     window.dataLayer.push({
 32 |       event: "enable"
 33 |     });
 34 |   };
 35 | 
 36 |   const logEcommerceEvent = () => {
 37 |     window.dataLayer.push({ ecommerce: null }); // Clear the previous ecommerce object.
 38 |     window.dataLayer.push({
 39 |       event: "ecommerce",
 40 |       ecommerce: {
 41 |         transaction_id: "T_12345",
 42 |         affiliation: "Google Merchandise Store",
 43 |         value: 25.42,
 44 |         tax: 4.9,
 45 |         shipping: 5.99,
 46 |         currency: "USD",
 47 |         coupon: "SUMMER_SALE",
 48 |         items: [
 49 |           {
 50 |             item_id: "SKU_12345",
 51 |             item_name: "Stan and Friends Tee",
 52 |             affiliation: "Google Merchandise Store",
 53 |             coupon: "SUMMER_FUN",
 54 |             currency: "USD",
 55 |             discount: 2.22,
 56 |             index: 0,
 57 |             item_brand: "Google",
 58 |             item_category: "Apparel",
 59 |             item_category2: "Adult",
 60 |             item_category3: "Shirts",
 61 |             item_category4: "Crew",
 62 |             item_category5: "Short sleeve",
 63 |             item_list_id: "related_products",
 64 |             item_list_name: "Related Products",
 65 |             item_variant: "green",
 66 |             location_id: "L_12345",
 67 |             price: 9.99,
 68 |             quantity: 1
 69 |           },
 70 |           {
 71 |             item_id: "SKU_12346",
 72 |             item_name: "Google Grey Women's Tee",
 73 |             affiliation: "Google Merchandise Store",
 74 |             coupon: "SUMMER_FUN",
 75 |             currency: "USD",
 76 |             discount: 3.33,
 77 |             index: 1,
 78 |             item_brand: "Google",
 79 |             item_category: "Apparel",
 80 |             item_category2: "Adult",
 81 |             item_category3: "Shirts",
 82 |             item_category4: "Crew",
 83 |             item_category5: "Short sleeve",
 84 |             item_list_id: "related_products",
 85 |             item_list_name: "Related Products",
 86 |             item_variant: "gray",
 87 |             location_id: "L_12345",
 88 |             price: 20.99,
 89 |             promotion_id: "P_12345",
 90 |             promotion_name: "Summer Sale",
 91 |             quantity: 1
 92 |           }
 93 |         ]
 94 |       }
 95 |     });
 96 |   };
 97 | 
 98 |   return (
 99 |     <div className="App">
100 |       <header className="App-header">
101 |         <p>
102 |           This is a sample app demonstrating the Google Tag Manager integration
103 |           with Braze.
104 |         </p>
105 |         <button onClick={changeUser}>Change User</button>
106 |         <br />
107 |         <br />
108 |         <button onClick={logCustomEvent}>Log Custom Event</button>
109 |         <br />
110 |         <br />
111 |         <button onClick={logPurchase}>Log Purchase</button>
112 |         <br />
113 |         <br />
114 |         <button onClick={logEcommerceEvent}>Log E-Commerce Purchase</button>
115 |         <br />
116 |         <br />
117 |         <button onClick={disable}>Disable SDK</button>
118 |         <br />
119 |         <br />
120 |         <button onClick={enable}>Enable SDK</button>
121 |       </header>
122 |     </div>
123 |   );
124 | }
125 | 
126 | export default App;
127 | 


--------------------------------------------------------------------------------
/snippets/loading-snippet.js:
--------------------------------------------------------------------------------
1 | <script type="text/javascript">
2 |   +function(a,p,P,b,y){a.braze={};a.brazeQueue=[];for(var s="BrazeSdkMetadata DeviceProperties Card Card.prototype.dismissCard Card.prototype.removeAllSubscriptions Card.prototype.removeSubscription Card.prototype.subscribeToClickedEvent Card.prototype.subscribeToDismissedEvent Card.fromContentCardsJson ImageOnly CaptionedImage ClassicCard ControlCard ContentCards ContentCards.prototype.getUnviewedCardCount ControlMessage InAppMessage InAppMessage.SlideFrom InAppMessage.ClickAction InAppMessage.DismissType InAppMessage.OpenTarget InAppMessage.ImageStyle InAppMessage.Orientation InAppMessage.TextAlignment InAppMessage.CropType InAppMessage.prototype.closeMessage InAppMessage.prototype.removeAllSubscriptions InAppMessage.prototype.removeSubscription InAppMessage.prototype.subscribeToClickedEvent InAppMessage.prototype.subscribeToDismissedEvent InAppMessage.fromJson FullScreenMessage ModalMessage HtmlMessage SlideUpMessage User User.Genders User.NotificationSubscriptionTypes User.prototype.addAlias User.prototype.addToCustomAttributeArray User.prototype.addToSubscriptionGroup User.prototype.getUserId User.prototype.getUserId User.prototype.incrementCustomUserAttribute User.prototype.removeFromCustomAttributeArray User.prototype.removeFromSubscriptionGroup User.prototype.setCountry User.prototype.setCustomLocationAttribute User.prototype.setCustomUserAttribute User.prototype.setDateOfBirth User.prototype.setEmail User.prototype.setEmailNotificationSubscriptionType User.prototype.setFirstName User.prototype.setGender User.prototype.setHomeCity User.prototype.setLanguage User.prototype.setLastKnownLocation User.prototype.setLastName User.prototype.setPhoneNumber User.prototype.setPushNotificationSubscriptionType User.prototype.setLineId InAppMessageButton InAppMessageButton.prototype.removeAllSubscriptions InAppMessageButton.prototype.removeSubscription InAppMessageButton.prototype.subscribeToClickedEvent FeatureFlag FeatureFlag.prototype.getStringProperty FeatureFlag.prototype.getNumberProperty FeatureFlag.prototype.getBooleanProperty FeatureFlag.prototype.getImageProperty FeatureFlag.prototype.getJsonProperty FeatureFlag.prototype.getTimestampProperty Banner Banner.prototype.getStringProperty Banner.prototype.getNumberProperty Banner.prototype.getBooleanProperty Banner.prototype.getImageProperty Banner.prototype.getJsonProperty Banner.prototype.getTimestampProperty automaticallyShowInAppMessages hideContentCards showContentCards showInAppMessage deferInAppMessage toggleContentCards changeUser destroy getDeviceId getDeviceId initialize isPushBlocked isPushPermissionGranted isPushSupported logCardDismissal logContentCardImpressions logContentCardClick logBannerImpressions logBannerClick logCustomEvent logInAppMessageButtonClick logInAppMessageClick logInAppMessageHtmlClick logInAppMessageImpression logPurchase openSession requestPushPermission removeAllSubscriptions removeSubscription requestContentCardsRefresh refreshFeatureFlags requestImmediateDataFlush enableSDK isDisabled setLogger setSdkAuthenticationSignature addSdkMetadata disableSDK subscribeToContentCardsUpdates subscribeToInAppMessage subscribeToSdkAuthenticationFailures toggleLogging unregisterPush wipeData handleBrazeAction subscribeToFeatureFlagsUpdates getAllFeatureFlags logFeatureFlagImpression requestBannersRefresh insertBanner getAllBanners subscribeToBannersUpdates isInitialized".split(" "),i=0;i<s.length;i++){for(var m=s[i],k=a.braze,l=m.split("."),j=0;j<l.length-1;j++)k=k[l[j]];k[l[j]]=(new Function("return function "+m.replace(/\./g,"_")+"(){window.brazeQueue.push(arguments); return true}"))()}window.braze.getDeferredInAppMessage=function(){return new window.braze.InAppMessage};window.braze.getCachedContentCards=function(){return new window.braze.ContentCards};window.braze.getUser=function(){return new window.braze.User};window.braze.getFeatureFlag=function(){return new window.braze.FeatureFlag};window.braze.getBanner=function(){return new window.braze.Banner};window.braze.newBannerFromJson=function(){return new window.braze.Banner};(y=p.createElement(P)).type='text/javascript';
3 |     y.src='https://js.appboycdn.com/web-sdk/6.4/braze.min.js';
4 |     y.async=1;(b=p.getElementsByTagName(P)[0]).parentNode.insertBefore(y,b)
5 |   }(window,document,'script');
6 | </script>
7 | 


--------------------------------------------------------------------------------
/sample-builds/cdn/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <!-- This is a sample integration of the Braze Web SDK.
 3 |      Visit https://js.appboycdn.com/web-sdk/latest/sample-build/index.html to see a deployed instance of this page
 4 | -->
 5 | <html>
 6 |   <head>
 7 |     <title>Braze Web SDK Sample Integration</title>
 8 |     <script type="text/javascript">
 9 |       +function(a,p,P,b,y){a.braze={};a.brazeQueue=[];for(var s="BrazeSdkMetadata DeviceProperties Card Card.prototype.dismissCard Card.prototype.removeAllSubscriptions Card.prototype.removeSubscription Card.prototype.subscribeToClickedEvent Card.prototype.subscribeToDismissedEvent Card.fromContentCardsJson ImageOnly CaptionedImage ClassicCard ControlCard ContentCards ContentCards.prototype.getUnviewedCardCount ControlMessage InAppMessage InAppMessage.SlideFrom InAppMessage.ClickAction InAppMessage.DismissType InAppMessage.OpenTarget InAppMessage.ImageStyle InAppMessage.Orientation InAppMessage.TextAlignment InAppMessage.CropType InAppMessage.prototype.closeMessage InAppMessage.prototype.removeAllSubscriptions InAppMessage.prototype.removeSubscription InAppMessage.prototype.subscribeToClickedEvent InAppMessage.prototype.subscribeToDismissedEvent InAppMessage.fromJson FullScreenMessage ModalMessage HtmlMessage SlideUpMessage User User.Genders User.NotificationSubscriptionTypes User.prototype.addAlias User.prototype.addToCustomAttributeArray User.prototype.addToSubscriptionGroup User.prototype.getUserId User.prototype.getUserId User.prototype.incrementCustomUserAttribute User.prototype.removeFromCustomAttributeArray User.prototype.removeFromSubscriptionGroup User.prototype.setCountry User.prototype.setCustomLocationAttribute User.prototype.setCustomUserAttribute User.prototype.setDateOfBirth User.prototype.setEmail User.prototype.setEmailNotificationSubscriptionType User.prototype.setFirstName User.prototype.setGender User.prototype.setHomeCity User.prototype.setLanguage User.prototype.setLastKnownLocation User.prototype.setLastName User.prototype.setPhoneNumber User.prototype.setPushNotificationSubscriptionType User.prototype.setLineId InAppMessageButton InAppMessageButton.prototype.removeAllSubscriptions InAppMessageButton.prototype.removeSubscription InAppMessageButton.prototype.subscribeToClickedEvent FeatureFlag FeatureFlag.prototype.getStringProperty FeatureFlag.prototype.getNumberProperty FeatureFlag.prototype.getBooleanProperty FeatureFlag.prototype.getImageProperty FeatureFlag.prototype.getJsonProperty FeatureFlag.prototype.getTimestampProperty Banner Banner.prototype.getStringProperty Banner.prototype.getNumberProperty Banner.prototype.getBooleanProperty Banner.prototype.getImageProperty Banner.prototype.getJsonProperty Banner.prototype.getTimestampProperty automaticallyShowInAppMessages hideContentCards showContentCards showInAppMessage deferInAppMessage toggleContentCards changeUser destroy getDeviceId getDeviceId initialize isPushBlocked isPushPermissionGranted isPushSupported logCardDismissal logContentCardImpressions logContentCardClick logBannerImpressions logBannerClick logCustomEvent logInAppMessageButtonClick logInAppMessageClick logInAppMessageHtmlClick logInAppMessageImpression logPurchase openSession requestPushPermission removeAllSubscriptions removeSubscription requestContentCardsRefresh refreshFeatureFlags requestImmediateDataFlush enableSDK isDisabled setLogger setSdkAuthenticationSignature addSdkMetadata disableSDK subscribeToContentCardsUpdates subscribeToInAppMessage subscribeToSdkAuthenticationFailures toggleLogging unregisterPush wipeData handleBrazeAction subscribeToFeatureFlagsUpdates getAllFeatureFlags logFeatureFlagImpression requestBannersRefresh insertBanner getAllBanners subscribeToBannersUpdates isInitialized".split(" "),i=0;i<s.length;i++){for(var m=s[i],k=a.braze,l=m.split("."),j=0;j<l.length-1;j++)k=k[l[j]];k[l[j]]=(new Function("return function "+m.replace(/\./g,"_")+"(){window.brazeQueue.push(arguments); return true}"))()}window.braze.getDeferredInAppMessage=function(){return new window.braze.InAppMessage};window.braze.getCachedContentCards=function(){return new window.braze.ContentCards};window.braze.getUser=function(){return new window.braze.User};window.braze.getFeatureFlag=function(){return new window.braze.FeatureFlag};window.braze.getBanner=function(){return new window.braze.Banner};window.braze.newBannerFromJson=function(){return new window.braze.Banner};(y=p.createElement(P)).type='text/javascript';
10 |         y.src='https://js.appboycdn.com/web-sdk/6.4/braze.min.js';
11 |         y.async=1;(b=p.getElementsByTagName(P)[0]).parentNode.insertBefore(y,b)
12 |       }(window,document,'script');
13 | 
14 |       // See https://js.appboycdn.com/web-sdk/6.4/doc/modules/braze.html#initialize for initialization options
15 |       braze.initialize('e491231d-c4ae-466d-8f7f-ba8ad308f12a', {
16 |         enableLogging: true,
17 |         baseUrl: 'sdk.iad-01.braze.com',
18 |         // Warning: Using the serviceWorkerLocation option limits the scope of push notifications on your site. See
19 |         // https://js.appboycdn.com/web-sdk/6.4/doc/modules/braze.html#initialize for more details.
20 |         // If in doubt, omit this option and use the default location of /service-worker.js
21 |         serviceWorkerLocation: document.location.pathname.replace('index.html', 'service-worker.js'),
22 |         safariWebsitePushId: 'web.com.braze.sample-build'
23 |       });
24 |       braze.automaticallyShowInAppMessages();
25 |       braze.openSession();
26 |       braze.getUser().setCustomUserAttribute('visited sample-build', new Date());
27 |     </script>
28 |   </head>
29 |   <body>
30 |     This is a sample integration of the Braze Web SDK, with web push integrated.
31 |     <br/><br/>
32 |     <!-- This App Group has a triggered push campaign tied to the "send me push" custom event -->
33 |     <button onclick="braze.requestPushPermission(function() {braze.logCustomEvent('send me push');braze.requestImmediateDataFlush();});">Send Me A Sample Push</button>
34 |   </body>
35 | </html>
36 | 


--------------------------------------------------------------------------------
/UPGRADE_GUIDE.md:
--------------------------------------------------------------------------------
  1 | # Upgrade Guide
  2 | 
  3 | ## V5 to V6
  4 | 
  5 | Version 6 of the Braze Web SDK (`@braze/web-sdk`) removes the legacy News Feed feature and deprecated banner APIs, introduces stricter typings, and makes small rendering changes for improved accessibility.
  6 | 
  7 | ### V6 Breaking Changes
  8 | 
  9 | #### Behavioral Changes
 10 | 
 11 | - The [`insertBanner()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#insertbanner) method now automatically tracks impressions and clicks. The separate `Banner.html`, `logBannerClick()`, and `logBannerImpressions()` APIs have been removed.
 12 | - The images in In-App Messages with `cropType: CENTER_CROP` (e.g. `FullScreenMessage`) are now rendered using an `<img>` tag instead of a `<span>`. This improves accessibility but may require updating CSS customizations that target `.ab-center-cropped-img`.
 13 | - TypeScript typings now reflect that some methods return `undefined` when the SDK has not been initialized. This can surface new TypeScript compile-time errors if your code assumed a value. Add guards/optional chaining, or refine types where needed.
 14 | 
 15 | #### Removed APIs
 16 | 
 17 | The following methods and properties have been removed:
 18 | 
 19 | | API                                                                                   | Details                                                                                                                                                                                                                                                                                                        |
 20 | | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 21 | | `braze.Banner.html` / `braze.logBannerClick()` / `braze.logBannerImpressions()`                                                            |   Replaced by [`insertBanner()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#insertbanner), which handles rendering, impressions, and clicks.                                                                                                                                                                                                                                                         |
 22 | | Legacy News Feed (`braze.Feed class`)                                                      | Fully removed, along with: `destroyFeed()`, `getCachedFeed()`, `logFeedDisplayed()`, `requestFeedRefresh()`, `showFeed()`, `subscribeToFeedUpdates()`, `toggleFeed`().                                                                                                                                                      |
 23 | | `logCardClick()` / `logCardImpressions()`                              | Use [`logContentCardClick()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcontentcardclick) and [`logContentCardImpressions()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcontentcardimpressions) instead.                                                                                                |
 24 | | `Card.created` and `Card.categories`                                                           | Fields used by legacy News Feed and removed from `Card` subclasses.
 25 | | `ImageOnly.linkText` (and constructor param)                                                           | Unused and removed.
 26 | 
 27 | ---
 28 | 
 29 | ## V4 to V5
 30 | 
 31 | Version 5 of the Braze Web SDK (`@braze/web-sdk`) includes a few functional improvements and removal of previously deprecated APIs, thus improving the bundle size.
 32 | 
 33 | ### V5 Breaking Changes
 34 | 
 35 | #### Behavioral Changes
 36 | 
 37 | - The [`subscribeToFeatureFlagsUpdates()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#subscribetofeatureflagsupdates) callback will now always be called, regardless of refresh success/failure. If there is a failure in receiving updates, the callback will be called with currently cached feature flags.
 38 | - The [`getFeatureFlag()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#getfeatureflag) method now returns `null` if the feature flag does not exist.
 39 | - The SDK no longer throws runtime errors anywhere. If Braze methods are called prior to initialization, a warning will be logged to the console instead.
 40 | - The SDK no longer adds default Braze in-app message styles to custom HTML in-app messages. These styles were previously used by legacy in-app message types.
 41 | 
 42 | #### Removed APIs
 43 | 
 44 | The following methods and properties have been removed:
 45 | 
 46 | | API                                                                                   | Details                                                                                                                                                                                                                                                                                                        |
 47 | | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 48 | | `braze.logContentCardsDisplayed()`                                                              | Obsolete, no-op method that has been deprecated since 4.0.4.                                                                                                                                                                                                                                                                      |
 49 | | `enableHtmlInAppMessages` initialization option                                                      | Deprecated since 3.3.0 in favor of [`allowUserSuppliedJavascript`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions) option which has the same functionality                                                                                                                                                         |
 50 | | `braze.Banner` class                               | Deprecated since 4.9.0 in favor of [`braze.ImageOnly`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.imageonly.html) with the same functionality                                                                                                     |
 51 | | `ab-banner` CSS classname                                                           | This is part of `braze.Banner` class removal. CSS customizations should instead target `ab-image-only` CSS class.                                                                                                                                                                                                                                                                                          |
 52 | 
 53 | ---
 54 | 
 55 | ## V3 to V4
 56 | 
 57 | - [Tree-Shaking Benefits](#tree-shaking)
 58 | - [Breaking Changes](#v4-breaking-changes)
 59 | 
 60 | Version 4 of the Braze Web SDK (`@braze/web-sdk` package) now supports tree-shaking 🎉 and has been rewritten as native, side-effect free ES Modules.
 61 | 
 62 | You can now `import` individual methods and classes, or use wildcard syntax to import the entire SDK. In both approaches, your javascript module bundlers can remove any unused code resulting in faster website performance.
 63 | 
 64 | ```typescript
 65 | import * as braze from "@braze/web-sdk";
 66 | 
 67 | // or, if you prefer to import individual modules:
 68 | // import { initialize } from "@braze/web-sdk";
 69 | 
 70 | braze.initialize("YOUR-API-KEY", { baseUrl: "YOUR-SDK-ENDPOINT" });
 71 | braze.automaticallyShowInAppMessages();
 72 | braze.subscribeToContentCardsUpdates(function(contentCards) {
 73 |   console.log(contentCards);
 74 | });
 75 | braze.openSession();
 76 | ```
 77 | 
 78 | ### Tree-Shaking
 79 | 
 80 | Version 4 has been rewritten as individually exported ES Modules. If you use a modern javascript bundler (like [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org/)) you can benefit from "tree-shaking", which automatically removes unused SDK code to make your website more performant.
 81 | 
 82 | The table below shows how many kilobytes you may save as a result of upgrading to v4. Note that these are estimates, and your bundle sizes may vary based on your webpage structure and the individual methods you actually use.
 83 | 
 84 | For context, version `@braze/web-sdk@3.5` and `@braze/web-sdk-core@3.5` weigh in at `51.9kB` and `37.3kB` respectively, whereas v4 starts at `25.5kB` and builds based on features you use. The "Estimated Savings" column compares `@braze/web-sdk@3.5` to importing only the given feature.
 85 | 
 86 | | Module or Feature     | Estimated Size (gzipped) | Estimated Savings                  |
 87 | | --------------------- | ------------------------ | ---------------------------------- |
 88 | | Analytics             | `0.9kB`                  | ~ 49.1% reduction (`26.4kB` total) |
 89 | | Push                  | `2.4kB`                  | ~ 46.2% reduction (`27.9kB` total) |
 90 | | Content Cards (no UI) | `4.5kB`                  | ~ 44.1% reduction (`29.0kB` total) |
 91 | | Content Cards UI      | `12.0kB`                 | ~ 27.7% reduction (`37.5kB` total) |
 92 | | In-App Messages UI    | `12.7kB`                 | ~ 26.4% reduction (`38.2kB` total) |
 93 | 
 94 | **Notes**:
 95 | 
 96 | - "Analytics" was measured by including `logCustomEvent`, `setCustomUserAttribute`, and `changeUser` methods.
 97 | - "In-App Messages UI" was measured by including `automaticallyShowInAppMessages` or `showInAppMessage`
 98 | - "Content Cards UI" was measured by including `showContentCards`, `hideContentCards` or `toggleContentCards`
 99 | - "Push" was measured by including `requestPushPermission`
100 | 
101 | ### V4 Breaking Changes
102 | 
103 | #### Behavioral Changes
104 | 
105 | - The `automaticallyShowInAppMessages()` or `subscribeToInAppMessage()` methods must be called prior to `openSession()` to ensure session-start triggered messages are processed.
106 | - Content Cards will now only refresh on session start if `subscribeToContentCardsUpdates()` is called prior to `openSession`. You can manually refresh Content Cards using `requestContentCardsRefresh()`.
107 | 
108 | #### Renamed APIs
109 | 
110 | The following methods have been renamed:
111 | 
112 | | Old (v3.x)                                   | New (v4.0)                                                                                                                          |
113 | | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
114 | | `appboy.registerAppboyPushMessages()`        | [`requestPushPermission()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#requestpushpermission)                   |
115 | | `appboy.unregisterAppboyPushMessages()`      | [`unregisterPush()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#unregisterpush)                                 |
116 | | `appboy.automaticallyShowNewInAppMessages()` | [`automaticallyShowInAppMessages()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#automaticallyshowinappmessages) |
117 | | `appboy.toggleAppboyLogging()`               | [`toggleLogging()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#togglelogging)                                   |
118 | | `appboy.display.*`                           | The `appboy.display` namespace has been removed. To upgrade, find and replace all references to `appboy.display.` with `braze.`     |
119 | 
120 | #### Removed APIs
121 | 
122 | The following methods and properties have been removed:
123 | 
124 | | API                                                                                   | Details                                                                                                                                                                                                                                                                                                        |
125 | | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
126 | | `appboy.isPushGranted()`                                                              | Deprecated since 1.6.2 in favor of [`isPushPermissionGranted()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#ispushpermissiongranted)                                                                                                                                                       |
127 | | `appboy.subscribeToNewInAppMessages()`                                                | Deprecated since 2.4.0 in favor of [`subscribeToInAppMessage()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#subscribetoinappmessage)                                                                                                                                                       |
128 | | `appboy.trackLocation()`                                                              | Deprecated since 3.3.0 in favor of using the native Geolocation API and passing the location data to [`User.setLastKnownLocation()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.user.html#setlastknownlocation). The corresponding `appboyBridge.trackLocation()` method has also been removed. |
129 | | `appboy.stopWebTracking()`                                                            | Deprecated since 3.5.0 in favor of using [`disableSDK()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#disablesdk)                                                                                                                                                                           |
130 | | `appboy.resumeWebTracking()`                                                          | Deprecated since 3.5.0 in favor of using [`enableSDK()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#enablesdk)                                                                                                                                                                             |
131 | | `safariWebsitePushId` parameter from the `appboy.registerAppboyPushMessages()` method | Deprecated & undocumented since 1.6.1 in favor of the [`initialization option`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions) with the same name                                                                                                                       |
132 | | `devicePropertyWhitelist` initialization option                                       | Deprecated since 3.1.0 in favor of [`devicePropertyAllowlist`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions) which has the same functionality                                                                                                                          |
133 | | `language` initialization option                                                      | Use the [`localization`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions) option which has the same functionality                                                                                                                                                         |
134 | | `cardId` and `campaignId` properties of In-App Messages                               | If you are manually constructing instances of `InAppMessage` subclasses, you will need to update the constructors ([docs](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.inappmessage.html))                                                                                                        |
135 | | `User.setAvatarImageUrl()`                                                            | Method no longer used                                                                                                                                                                                                                                                                                          |
136 | 
137 | ---
138 | 
139 | ## V2 to V3
140 | 
141 | - [Breaking Changes](#v3-breaking-changes)
142 | 
143 | Version 3 of the Braze Web SDK (`@braze/web-sdk`) now comes bundled with TypeScript definitions!
144 | 
145 | The TypeScript defintions include documentation and autocomplete in IDEs that support it, even if your project does not use TypeScript.
146 | 
147 | **Note**: The SDK loading snippet has been updated. If you integrate the Braze Web SDK using the CDN, you must [update the loading snippet](https://github.com/braze-inc/braze-web-sdk/tree/1feef199dd5eae15479db80524bb934c3b40f548#alternative-cdn-installation) when upgrading to 3.0.
148 | 
149 | ### V3 Breaking Changes
150 | 
151 | The following breaking changes have been made to allow for a better TypeScript experience:
152 | 
153 | | API                             | details                                                                                                                                                                                                                                                                 |
154 | | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
155 | | `appboy.ab`                     | The `ab` namespace has been removed. To upgrade, find and replace all references to `appboy.ab` with `appboy`                                                                                                                                                           |
156 | | `InAppMessage.Button`           | Renamed to `InAppMessageButton`. To upgrade, find and replace all references to `InAppMessage.Button` with `InAppMessageButton`                                                                                                                                         |
157 | | `openSession(callback)`         | The `callback` parameter has been removed since v2.3.1.                                                                                                                                                                                                                 |
158 | | `changeUser(callback)`          | The `callback` parameter has been removed since v2.3.1.                                                                                                                                                                                                                 |
159 | | `baseUrl` initialization option | Now **required** to initialize the SDK. If your integration did not already provide the `baseUrl` option, it should now be set to the previous default value of `sdk.iad-01.braze.com` (e.g, `appboy.initialize('YOUR-API-KEY', { baseUrl: 'sdk.iad-01.braze.com' });`) |
160 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
   1 | ## 6.4.0
   2 | 
   3 | ##### Added
   4 | - Added methods [`braze.logBannerImpressions()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logbannerimpressions) and [`braze.logBannerClick()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logbannerclick) to allow integrators to manually log both the banner impression and click events. These methods should only be called if you're bypassing [`insertBanner`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#insertbanner) and building custom UI for banners similar to other channels.
   5 | 
   6 | ##### Fixed
   7 | - Fixed an issue where In-App Messages for the previous user were still displayed after changing users.
   8 | 
   9 | ## 6.3.1
  10 | 
  11 | ##### Fixed
  12 | - Fixed an issue where banner impressions were not cleared from local storage when a new session was opened.
  13 | 
  14 | ## 6.3.0
  15 | 
  16 | ##### Added
  17 | - Exposed `NotificationSubscriptionTypes` in `brazeBridge`.
  18 | - Added support for detection of ChatGPT Atlas browser.
  19 | - Improved crawler bot detection.
  20 | 
  21 | ## 6.2.0
  22 | 
  23 | ##### Added
  24 | - Updated platform detection for the `Coolita` and `WhaleTV` Smart TV platforms, which are now classified as `Other Smart TV`.
  25 | 
  26 | ## 6.1.0
  27 | 
  28 | ##### Added
  29 | - Added support for [`Banner`](https://js.appboycdn.com/web-sdk-develop/latest/doc/classes/braze.banner.html) properties.
  30 | 
  31 | ##### Changed
  32 | - The default client-side rate limiting value for Banners refresh has been increased. For more information on SDK rate limiting, please refer to the [Braze Developer Guide](https://www.braze.com/docs/developer_guide/sdk_integration/rate_limits#braze-sdk-rate-limits)
  33 | 
  34 | ##### Fixed
  35 | - Fixed an issue where Banner serialization keys were inconsistent between SDK versions, which could cause Banners to display incorrectly until the first Banners refresh after a version upgrade.
  36 | - Fixed an issue where PetalBot and Meta web crawlers were not properly detected.
  37 | 
  38 | ## 6.0.0
  39 | 
  40 | ##### ⚠️ Breaking
  41 | - Removed the `Banner.html` property, `logBannerClick`, and `logBannerImpressions` methods. Instead, use [`insertBanner`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#insertbanner) which automatically handles impression and click tracking.
  42 | - Removed support for the legacy News Feed feature.
  43 | This includes removal of the `Feed` class, and the following associated methods:
  44 |   - `destroyFeed()`
  45 |   - `getCachedFeed()`
  46 |   - `logFeedDisplayed()`
  47 |   - `requestFeedRefresh()`
  48 |   - `showFeed()`
  49 |   - `subscribeToFeedUpdates()`
  50 |   - `toggleFeed()`
  51 |   - `logCardClick()` (replaced by [`logContentCardClick()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcontentcardclick))
  52 |   - `logCardImpressions()` (replaced by [`logContentCardImpressions()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcontentcardimpressions))
  53 | -  The `created` and `categories` fields that were used by legacy News Feed cards have been removed from [`Card`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.card.html) subclasses.
  54 |   - The `linkText` field was also removed from the [`ImageOnly`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.imageonly.html) Card subclass and its constructor.
  55 | - Clarified definitions and updated types to note that certain SDK methods explicitly return `undefined` when the SDK is not initialized, aligning the typings with actual runtime behavior. This could introduce new TypeScript errors in projects that relied on the previous (incomplete) typings.
  56 | - The images of In-App Messages with `cropType` of `CENTER_CROP` (e.g. `FullScreenMessage` by default) are now rendered via an `<img>` tag instead of `<span>` for improved accessibility. This may break existing CSS customizations for the `.ab-center-cropped-img` class or its children.
  57 | 
  58 | ##### Added
  59 | - Added `imageAltText` and `language` fields to the following classes:
  60 |   - Cards: [`CaptionedImage`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.captionedimage.html), [`ImageOnly`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.imageonly.html), and [`ClassicCard`]
  61 |   - In-App Messages: [`ModalMessage`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.modalmessage.html), [`FullScreenMessage`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.fullscreenmessage.html), and [`SlideUpMessage`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.slideupmessage.html)
  62 | - When available, the default UI will use these fields to set the alternate text of images and the `lang` attribute, respectively, of In-App Messages and Cards.
  63 | - Improved the accessibility of In-App Messages and Content Cards when displayed by the default UI.
  64 | 
  65 | ##### Changed
  66 | - Any new session subscriptions now immediately invoke the callback if a new session has already started.
  67 | 
  68 | ##### Fixed
  69 | - Subscription methods now correctly trigger refreshes when `openSession()` is called, even if `changeUser()` was called first.
  70 | - Fixed an issue where Banners could display with a small amount of whitespace at the bottom.
  71 | - Fixed an issue where the `messageExtras` field was missing from the type definitions of InAppMessage classes.
  72 | 
  73 | ## 5.9.1
  74 | 
  75 | ##### Fixed
  76 | - Fixed an issue where rate limit state persisted across users and sessions causing requests to be incorrectly rate limited at session start.
  77 | 
  78 | ## 5.9.0
  79 | 
  80 | ##### Added
  81 | - Added `brazeBridge.setBannerHeight()` to allow Banners to resize dynamically.
  82 | 
  83 | ##### Fixed
  84 | - Fixed an edge case with retry logic for Feature Flags, Content Cards and Banners network requests.
  85 | 
  86 | ## 5.8.1
  87 | 
  88 | ##### Fixed
  89 | - Fixed an issue with the npm version of the Web SDK that prevented Banner clicks from being logged.
  90 | 
  91 | ## 5.8.0
  92 | 
  93 | ##### Changed
  94 | - The [`insertBanner`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#insertbanner) method now accepts a `null` or `undefined` banner argument.
  95 | - [`requestBannersRefresh`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#requestbannersrefresh) now waits for the initial response from the backend and tries again if Banners are enabled.
  96 | 
  97 | ##### Fixed
  98 | - Fixed a race condition causing "not enabled" messages to be logged for Banners and Feature Flags methods on the user's first session.
  99 | 
 100 | ## 5.7.0
 101 | 
 102 | ##### Added
 103 | - Added a method [`User.setLineId`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.user.html#setlineid) used to set the user's [LINE](https://www.braze.com/docs/user_guide/message_building_by_channel/line) User ID.
 104 | 
 105 | ##### Fixed
 106 | - Fixed an issue where the chevron icon pointed in the wrong direction on SlideUp in-app messages when using RTL languages.
 107 | 
 108 | ##### Changed
 109 | - The SDK now respects the `retry-after` header returned by the Braze platform when determining how long to wait before retrying a request.
 110 | 
 111 | ## 5.6.1
 112 | 
 113 | ##### Fixed
 114 | - Fixed an issue where the Tizen operating system was not accurately reported in device properties.
 115 | 
 116 | ## 5.6.0
 117 | 
 118 | ##### Added
 119 | - Added support for the Banners campaign type.
 120 | 
 121 | ##### Fixed
 122 | - Fixed an issue where the SDK could erroneously request a triggers refresh even if no session is started.
 123 | - Fixed an issue where `ControlMessage` instances would allow multiple impressions.
 124 | 
 125 | ## 5.5.0
 126 | 
 127 | ##### Changed
 128 | - The SDK now rate limits Content Cards impressions to correspond to expected human behavior.
 129 | 
 130 | ## 5.4.0
 131 | 
 132 | ##### Added
 133 | - Added support for right-to-left languages to the built-in UI for In-App Messages and Content Cards.
 134 | - Introduced a new initialization option [`serviceWorkerScope`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions) that can be used to override the default scope of the service worker.
 135 | - Added a method [`braze.isInitialized()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#isinitialized) that returns whether the SDK has been initialized.
 136 | - Added a new custom event named `braze.initialized` that is dispatched on the `window` object when the Braze initialization completes.
 137 | 
 138 | ## 5.3.2
 139 | 
 140 | ##### Fixed
 141 | - Fixed a regression introduced in 5.2.0 that could cause HTML In-App Messages to render incorrectly when an external script is loaded synchronously.
 142 | 
 143 | ## 5.3.1
 144 | 
 145 | ##### Fixed
 146 | - Fixed an issue where a custom `serviceWorkerLocation` was not used when calling `unregisterPush`.
 147 | 
 148 | ## 5.3.0
 149 | 
 150 | ##### Added
 151 | - Added the following methods to the `FeatureFlag` class to support the upcoming expansion of feature flag property types:
 152 |   - [`getJsonProperty()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.featureflag.html#getjsonproperty)
 153 |   - [`getImageProperty()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.featureflag.html#getimageproperty)
 154 |   - [`getTimestampProperty()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.featureflag.html#gettimestampproperty)
 155 | 
 156 | ##### Fixed
 157 | - Fixed an issue where `e.preventDefault()` could be called on events that were not cancelable.
 158 | 
 159 | ## 5.2.0
 160 | 
 161 | ##### Added
 162 | - Added a [`deviceId`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions) initialization option. This can be used to set device ID of the user that would be used after initialization.
 163 | - Added support for the `message_extras` liquid tag for in-app messages.
 164 | 
 165 | ##### Changed
 166 | - The SDK will now persist and send the user's alias in all backend requests if it has been set, until the user is identified via an external ID. This alias will no longer be sent in requests once the user is identified and is not compatible with SDK authentication.
 167 | - The SDK will now check for existing permissions before requesting push permissions.
 168 | 
 169 | ##### Fixed
 170 | - Fixed an issue where `unregisterPush()` failed to invoke the `successCallback()` function in some cases where the user has already unsubscribed to push.
 171 | - Fixed an issue where characters `|` and `:` were not supported in the `userId`.
 172 | - Fixed an issue where HTML In-App Messages that used module script tags were not supported.
 173 | 
 174 | ## 5.1.1
 175 | 
 176 | ##### Fixed
 177 | - Fixed an issue where content cards sync request count persisted across users causing requests to be incorrectly rate limited.
 178 | 
 179 | ## 5.1.0
 180 | 
 181 | ##### Changed
 182 | - The [`subscribeToFeatureFlagsUpdates()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#subscribetofeatureflagsupdates) callback will be triggered first with cached feature flags only if this cache is from the current session.
 183 | 
 184 | ##### Fixed
 185 | - Fixed an issue where in-app messages failed to render a transparent background when using color-scheme.
 186 | - Fixed an issue where impressions for a given feature flag ID were limited to once-per-user instead of once-per-session.
 187 | 
 188 | ## 5.0.1
 189 | 
 190 | ##### Fixed
 191 | - Fixed a bug where toggling `noCookies` initialization option from true to false did not create all the necessary cookies.
 192 | - Fixed an issue where user attributes could not be nulled out by setting a specific null value.
 193 | 
 194 | ## 5.0.0
 195 | 
 196 | ##### ⚠️ Breaking
 197 | - The [`subscribeToFeatureFlagsUpdates()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#subscribetofeatureflagsupdates) callback will now always be called, regardless of refresh success/failure. If there is a failure in receiving updates, the callback will be called with currently cached feature flags.
 198 | - The [`getFeatureFlag()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#getfeatureflag) method now returns a null if the feature flag does not exist, or if feature flags are disabled.
 199 | - Removed `logContentCardsDisplayed()` method that was previously deprecated in 4.0.4.
 200 | - Removed the deprecated initialization option `enableHtmlInAppMessages`. This should be replaced with the `allowUserSuppliedJavascript` option instead.
 201 | - Removed `Banner` class that was previously deprecated in 4.9.0 in favor of [`ImageOnly`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.imageonly.html).
 202 | - Removed `ab-banner` CSS classname as part of `Banner` class removal. CSS customizations should instead target the `ab-image-only` class.
 203 | - The SDK no longer throws runtime errors anywhere. If Braze methods are called prior to initialization, a warning will be logged to the console instead.
 204 | - The SDK no longer adds default Braze in-app message styles to custom HTML in-app messages. These styles were previously used by legacy in-app message types.
 205 | 
 206 | ## 4.10.2
 207 | 
 208 | ##### Fixed
 209 | - Fixed a CSS templating issue in the npm version of the SDK introduced in 4.10.1 that caused in-app messages to display without the expected styles when using Braze built-in UI.
 210 | 
 211 | ## 4.10.1
 212 | 
 213 | ##### Fixed
 214 | - Fixed an issue where user attributes could not be nulled out by setting a specific null value.
 215 | 
 216 | ## 4.10.0
 217 | 
 218 | ##### Added
 219 | - Added a new [`appVersionNumber`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions) initialization option for [targeting via numerical comparison](https://www.braze.com/docs/user_guide/engagement_tools/campaigns/ideas_and_strategies/new_features/).
 220 | 
 221 | ##### Changed
 222 | - The SDK now ensures that cached messages for user (content cards, deferred in-app message, and feature flags) are cleared upon `changeUser()`.
 223 | - [`getDeviceId`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#getdeviceid) and [`getUserId`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.user.html#getuserid) now return results directly. Their callback parameters are deprecated and will be removed in a future major version.
 224 | 
 225 | ## 4.9.0
 226 | 
 227 | ##### Added
 228 | - Introduced a new [`ImageOnly`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.imageonly.html) Card subclass, which has the same functionality as the [`Banner`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.banner.html) class.
 229 | - Added a new `ab-image-only` CSS class to `Banner` and `ImageOnly` cards when displayed through the built-in UI. New CSS customizations should target this class. The `ab-banner` classname will remain on both card types until the `Banner` class is removed in a future release.
 230 | - Introduced two new methods [`deferInAppMessage()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#deferinappmessage) and [`getDeferredInAppMessage()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#getdeferredinappmessage) that can be used together to delay the display of an in-app message for a future pageload.
 231 |   - [`deferInAppMessage()`] method defers the given in-app message.
 232 |   - The deferred in-app message can be retrieved by calling the  [`getDeferredInAppMessage`] method.
 233 | 
 234 | ##### Changed
 235 | - Deprecated the [`Banner`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.banner.html) class.
 236 | 
 237 | ##### Fixed
 238 | - Fixed an issue where in-app messages with images would fail to display when a parent node is supplied to `showInAppMessage()` and the parent node has not been attached to the DOM before the display callback is invoked.
 239 | - Fixed an issue where the callbacks passed to `requestContentCardsRefresh()` were sometimes not triggered when this call was queued behind another `requestContentCardsRefresh()` or `subscribeToContentCardsUpdates()` request.
 240 | - Fixed an issue where `dismissCard()` did not work as expected on cached content cards.
 241 | - Fixed an issue where calling `destroy()` soonafter `wipeData()` incorrectly created a device ID cookie.
 242 | 
 243 | ## 4.8.3
 244 | 
 245 | ##### Fixed
 246 | - Fixed an issue where `manageServiceWorkerExternally` initialization option failed to register service-worker when trying to register from a path higher than the service-worker location.
 247 | 
 248 | ## 4.8.2
 249 | 
 250 | ##### Fixed
 251 | - Fixed an issue where slow / failed image loading prevents subsequent in-app messages from displaying.
 252 | - Fixed a regression introduced in 4.8.0 where push notifications failed to display in Safari versions <= 15.
 253 | 
 254 | ## 4.8.1
 255 | 
 256 | ##### Fixed
 257 | - Fixed an issue where content cards were sometimes not marked as read upon card impression.
 258 | - Improved the typings for the `isControl` field on In-App Message and Card classes.
 259 | 
 260 | ## 4.8.0
 261 | 
 262 | ##### Changed
 263 | - The [`subscribeToFeatureFlagsUpdates`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#subscribetofeatureflagsupdates) callback will now always be called first with the currently cached feature flags, and when feature flag updates are available.
 264 | 
 265 | ##### Fixed
 266 | - Fixed the return type for [`subscribeToContentCardsUpdates()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#subscribetocontentcardsupdates).
 267 | - Fixed the return type for [`subscribeToFeatureFlagsUpdates()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#subscribetofeatureflagsupdates).
 268 | - Improved type definitions in Card, InAppMessage and InAppMessageButton classes:
 269 |   - Fixed return types for [`Card.subscribeToClickedEvent()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.card.html#subscribetoclickedevent) and [`Card.subscribeToDismissedEvent()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.card.html#subscribetodismissedevent).
 270 |   - Fixed return types for [`InAppMessage.subscribeToClickedEvent()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.inappmessage.html#subscribetoclickedevent) and [`InAppMessage.subscribeToDismissedEvent()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.inappmessage.html#subscribetodismissedevent).
 271 |   - Fixed return type for [`InAppMessageButton.subscribeToClickedEvent()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.inappmessagebutton.html#subscribetoclickedevent).
 272 |   - Fixed type definition of [`InAppMessage.extras`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.inappmessage.html#extras).
 273 | 
 274 | ## 4.7.2
 275 | 
 276 | ##### Fixed
 277 | - Fixed a regression with the noCookies option which caused some localStorage keys to be persisted in cookie storage.
 278 | 
 279 | ## 4.7.1
 280 | 
 281 | ##### Fixed
 282 | - Improved the type definition of [`Card.extras`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.card.html).
 283 | - Fixed a regression introduced in 4.0.0 where the `manageServiceWorkerExternally` and `disablePushTokenMaintenance` initialization options could not work as expected.
 284 | 
 285 | ## 4.7.0
 286 | 
 287 | ##### Added
 288 | - [`User.setCustomUserAttribute`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.user.html#setcustomuserattribute) now accepts nested custom attributes and arrays of objects.
 289 |   - Adds a `merge` parameter that specifies whether the value should be merged with the existing value on the backend. If `false` (default), any existing attribute will be overwritten. If `true`, existing objects and arrays of objects will be merged. To update an array of objects, follow the guidelines in our [public docs](https://www.braze.com/docs/user_guide/data_and_analytics/custom_data/custom_attributes/array_of_objects/#usage-examples).
 290 | 
 291 | ##### Fixed
 292 | - Fixed an issue where [`requestPushPermission`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#requestpushpermission) did not call the `deniedCallback` if the SDK encountered certain errors when registering push.
 293 | - Fixed an issue where `requestPushPermission` did not log a message if push is not supported on the user's browser.
 294 | - Fixed an incorrect typing in `subscribeToSdkAuthenticationFailures`.
 295 | 
 296 | ## 4.6.3
 297 | 
 298 | ##### Fixed
 299 | - Fixed an issue preventing Feature Flags refreshes when SDK Authentication errors occur.
 300 | 
 301 | ## 4.6.2
 302 | 
 303 | ##### Changed
 304 | - Removed legacy email capture CSS. This is not a breaking change, as all existing web email capture campaigns have been migrated to the new universal email capture type on the Braze backend. This change results in ~1KB size reduction for those using the built-in In-App Message UI.
 305 | 
 306 | ## 4.6.1
 307 | 
 308 | ##### Fixed
 309 | - Improved the type definition of [`FeatureFlag.properties`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.featureflag.html).
 310 | 
 311 | ## 4.6.0
 312 | 
 313 | ##### Added
 314 | - Added a method [`braze.logContentCardClick()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcontentcardclick) to log that the user clicked on the given Content Card. This method is equivalent to calling [`braze.logCardClick()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcardclick) with parameter `forContentCards = true`.
 315 | - Added support for the upcoming Braze Feature Flags product.
 316 | 
 317 | ##### Changed
 318 | - Improved the check for duplicate in-app messages at display time.
 319 | 
 320 | ## 4.5.1
 321 | 
 322 | ##### Fixed
 323 | - Fixed an issue where sites with globally-scoped `svg` and `img` CSS caused certain elements of the built-in UI to display incorrectly.
 324 | 
 325 | ## 4.5.0
 326 | 
 327 | ##### Added
 328 | - Added `isControl` property to [`ContentCard`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.card.html) base model, to easily determine whether the card is a control card.
 329 | - Added `isControl` property to [`InAppMessage`](https://js.appboycdn.com/web-sdk/latest/doc/classes/braze.inappmessage.html) base model, to easily determine whether the message is a control in-app-message.
 330 | 
 331 | ##### Changed
 332 | - Improved the reliability of in-app message impression logging in edge cases.
 333 | 
 334 | ## 4.4.0
 335 | 
 336 | ##### Added
 337 | - A message is now logged if an IAM is triggered but not displayed because neither `automaticallyShowInAppMessages()` nor `subscribeToInAppMessage()` were called.
 338 | 
 339 | ##### Changed
 340 | - IndexedDB connections now close after a transaction has been completed.
 341 | 
 342 | ##### Fixed
 343 | - Fixed an issue introduced in 4.0.0 where In-App Message closing animations did not work as expected.
 344 | 
 345 | ## 4.3.0
 346 | 
 347 | ##### Added
 348 | - Added [`brazeBridge.changeUser(id: string, sdkAuthSignature?: string)`](https://www.braze.com/docs/user_guide/message_building_by_channel/in-app_messages/customize/html_in-app_messages/#bridge) to HTML In-App Messages.
 349 | - Added the ability to include a custom pathname in the `baseUrl` [initialization option](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions).
 350 | 
 351 | ## 4.2.1
 352 | 
 353 | ##### Fixed
 354 | - Fixed an issue introduced in 4.0.3, where IAM displays could sometimes fail due to an internal race condition.
 355 | 
 356 | ## 4.2.0
 357 | 
 358 | ##### Added
 359 | - Added support for Content Cards to evaluate Retry-After headers.
 360 | 
 361 | ## 4.1.0
 362 | 
 363 | ##### Added
 364 | - Added a method [`braze.logContentCardImpressions()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcontentcardimpressions) to log that the user saw the given Content Cards. This method is equivalent to calling [`braze.logCardImpressions()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcardimpressions) with parameter `forContentCards = true`.
 365 | 
 366 | ##### Fixed
 367 | - Fixed an issue where calling `unregisterPush()` when the user is already unregistered would fail to execute the success callback function.
 368 | 
 369 | ## 4.0.6
 370 | 
 371 | ##### Fixed
 372 | - Fixed an issue introduced in 4.0.0 that incorrectly failed to display valid IAMs with an unknown Braze Action type error.
 373 | 
 374 | ## 4.0.5
 375 | 
 376 | ##### Fixed
 377 | - Fixed an issue introduced in 4.0.0 that prevented the SDK from running with certain rollup.js configurations.
 378 | 
 379 | ## 4.0.4
 380 | 
 381 | ##### Changed
 382 | - Deprecated and changed the obsolete [logContentCardsDisplayed](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcontentcardsdisplayed) method to a no-op. Card impressions should be logged using [logCardImpressions](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#logcardimpressions).
 383 | 
 384 | ##### Fixed
 385 | - Fixed an issue introduced in 4.0.0 that prevented control in-app message impressions from being logged.
 386 | 
 387 | ## 4.0.3
 388 | 
 389 | ##### Fixed
 390 | - Fixed an issue introduced in 4.0.0 where Safari push did not work unless the full `baseUrl` (e.g. `https://sdk.iad-01.braze.com/api/v3`) was specified in the initialization options.
 391 | - The SDK will now ignore In-App Messages containing a push prompt Braze Action for users who have already registered for push or whose browser does not support push.
 392 | 
 393 | ## 4.0.2
 394 | 
 395 | ##### Changed
 396 | - Cookies set by the Braze Web SDK now expire after 400 days per the recommendation of the [HTTP Working Group's draft RFC 6265](https://httpwg.org/http-extensions/draft-ietf-httpbis-rfc6265bis.html#section-4.1.2.2)
 397 | 
 398 | ##### Fixed
 399 | - Removed usages of the nullish coalescing operator for better compatibility with various webpack configurations.
 400 | 
 401 | ## 4.0.1
 402 | 
 403 | ##### Fixed
 404 | - The `created` field is now set for `Card` objects when using Content Cards.
 405 | - Added `"type": "module"` to the package.json so frameworks like Next.js recognize the SDK as an ES Module.
 406 | 
 407 | ## 4.0.0
 408 | 
 409 | ##### ⚠️ Breaking
 410 | - See our [upgrade guide](https://github.com/braze-inc/braze-web-sdk/blob/master/UPGRADE_GUIDE.md) for more information on how to migrate from v3.
 411 | - The `appboy-web-sdk`, `@braze/web-sdk-core`, and `@braze/web-sdk-no-amd` npm packages are deprecated in favor of the `@braze/web-sdk` package and will no longer receive updates.
 412 | - The SDK's exported object has been renamed from `appboy` to `braze`. CDN users must update their loading snippet when upgrading to 4.0.
 413 | - The file name for the bundled version of the SDK has changed to `braze.min.js`. CDN users must ensure that the URL points to this new file name when upgrading to 4.0.
 414 | - The Braze Web SDK now supports importing individual features and methods as native ES Modules that can be tree-shaken. For example, if you only use In-App Messages with a custom UI, you can now import our `InAppMessage` classes and `subscribeToInAppMesssage()` and Javascript module bundlers such as webpack will remove any unused code. If you prefer to continue using a compiled version of the SDK, it can be found through our CDN.
 415 | - The prefix for SDK logs has changed from `Appboy` to `Braze`. If you use the `Appboy` prefix as a filter in your logging tools, you should update it to include `Braze`.
 416 | - As a result of the above changes, many of our method signatures have changed. See our [upgrade guide](https://github.com/braze-inc/braze-web-sdk/blob/master/UPGRADE_GUIDE.md) for more information on how to migrate.
 417 | - Dropped support for Internet Explorer.
 418 | 
 419 | ##### Changed
 420 | - Updated default z-index of `InAppMessage` to 9001. This can be still be overwritten using the [inAppMessageZIndex](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#initializationoptions) initialization option.
 421 | 
 422 | ##### Added
 423 | - Introduced support for the new Braze Actions feature. When displaying In-App Messages and Content Cards through our built-in UI, this feature requires no additional code.
 424 | - Added [`braze.handleBrazeAction()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#handlebrazeaction) to handle Braze Action URLs when using a custom UI.
 425 | 
 426 | ## 3.5.1
 427 | 
 428 | ##### Changed
 429 | - Added Shopify to [`BrazeSdkMetadata`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.brazesdkmetadata.html)
 430 | 
 431 | ## 3.5.0
 432 | 
 433 | ##### Added
 434 | - Added [`appboy.addSdkMetadata()`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#addsdkmetadata) to allow self reporting of SDK Metadata fields via the [`appboy.BrazeSdkMetadata`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.brazesdkmetadata.html) enum.
 435 | - Deprecated the [`appboy.stopWebTracking()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#stopWebTracking) method in favor of using [`appboy.disableSDK()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#disableSDK), which has the same functionality.
 436 | - Deprecated the [`appboy.resumeWebTracking()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#resumeWebTracking) method in favor of using [`appboy.enableSDK()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#enableSDK), which has the same functionality.
 437 | - Added getter method [`appboy.isDisabled()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#isDisabled) to determine if SDK has been disabled via [`appboy.disableSDK()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#disableSDK).
 438 | - Accessibility improvements to in-app messages with scrollable text.
 439 | 
 440 | ##### Changed
 441 | - Calling `changeUser()` with an SDK Authentication signature will now update the signature when it is called with the current user's ID.
 442 | 
 443 | ##### Fixed
 444 | - Fixed an issue where removing the `ab-pause-scrolling` class was not sufficient to allow scrolling on touchscreen devices during the display of an in-app message.
 445 | 
 446 | ## 3.4.1
 447 | 
 448 | ##### Fixed
 449 | - Fixed an issue introduced in 3.3.0 where event timestamps could become incorrect when a network request fails and the event is placed back in the queue.
 450 | 
 451 | ## 3.4.0
 452 | 
 453 | ##### Added
 454 | - Added [`User.addToSubscriptionGroup()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.user.html#addtosubscriptiongroup) and [`User.removeFromSubscriptionGroup()`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.user.html#removefromsubscriptiongroup) to manage SMS/Email Subscription Groups.
 455 | 
 456 | ##### Changed
 457 | - Cards with subclass [`ControlCard`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.controlcard.html) are no longer counted in [`Feed.getUnreadCardCount`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.feed.html#getunreadcardcount) or [`ContentCards.getUnviewedCardCount`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.contentcards.html#getunviewedcardcount).
 458 | 
 459 | ##### Fixed
 460 | - Fixed an issue where globally-scoped CSS could cause the text and close button of In-App Messages to display incorrectly when using the built-in UI.
 461 | - Fixed an accessibility issue with Content Cards where some feed children did not have the `article` role.
 462 | - Fixed an issue where service worker network requests, including push click analytics, could not be made when SDK Authentication is enabled. If SDK Authentication is enabled and the service worker does not have a valid authentication signature, push click analytics will now be sent to the backend on the user's next session.
 463 | - Fixed an issue where network requests that failed due to SDK Authentication errors did not use exponential backoff for retries.
 464 | - Fixed an issue where iPads would be detected as Mac devices when using the "Request Desktop Site" iOS feature.
 465 | - Fixed an issue where `aspectRatio` had an incorrect type in `Card` subclasses.
 466 | 
 467 | ## 3.3.0
 468 | 
 469 | ##### Added
 470 | - Introduced support for new SDK Authentication feature.
 471 | - Introduced an [`inAppMessageZIndex`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#initializationoptions.__type.inappmessagezindex) initialization option that allows you to easily customize the z-index of In-App Messages displayed by the built-in UI.
 472 | - Added `successCallback` and `errorCallback` parameters to [`requestContentCardsRefresh`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#requestcontentcardsrefresh).
 473 | - The SDK now logs deprecation warnings for deprecated methods and initialization options when logging is enabled.
 474 | - Added support for `brazeBridge`, which has the same API as `appboyBridge`. `appboyBridge` is now deprecated but will continue to function.
 475 | - Introduced support for the upcoming nested properties feature in [`appboy.logCustomEvent`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#logcustomevent) and [`appboy.logPurchase`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#logpurchase).
 476 | 
 477 | ##### Changed
 478 | - Removed `appboyQueue` replay snippet from the `npm` publication of the SDK. This avoids possible race conditions when referencing the SDK simultaneously from `npm` and the CDN, and removes use of `eval` from the `npm` package
 479 | - [`appboy.logCustomEvent`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#logcustomevent) and [`appboy.logPurchase`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#logpurchase) now impose a 50KB limit on custom properties. If the supplied properties are too large, the event is not logged.
 480 | - Deprecated the [`trackLocation`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#tracklocation) method in favor of using the native Geolocation API and passing the location data to ['User.setLastKnownLocation`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.user.html#setlastknownlocation). See our [public docs](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/analytics/location_tracking/) for more information.
 481 | - Deprecated the [`enableHtmlInAppMessages`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#initializationoptions.__type.enablehtmlinappmessages) initialization option in favor of [`allowUserSuppliedJavascript`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#initializationoptions.__type.enablehtmlinappmessages). These options are functionally equivalent and no other changes are required.
 482 | 
 483 | ##### Fixed
 484 | - Fixed incorrect typing for [`User.setCountry`](https://js.appboycdn.com/web-sdk/latest/doc/classes/appboy.user.html#setcountry).
 485 | - Added missing `dismissed` property to TypeScript definition and docs for `Card` subclasses.
 486 | 
 487 | ## 3.2.0
 488 | 
 489 | ##### Added
 490 | - Added an optional `parentNode` parameter to [`appboy.display.hideContentCards`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.display.html#hidecontentcards) that allows you to specify a particular Content Cards feed to hide.
 491 | 
 492 | ##### Changed
 493 | - Cookies set by the SDK are now renewed when a new session is started. This fixes an issue where the SDK would stop setting cookies that had been deleted or expired when identification information existed in localStorage, preventing cross-subdomain identification from functioning in certain circumstances.
 494 | - Increased clickable area of all buttons in the built-in UI to be at least 45x45px to comply with mobile accessibility best-practices. This includes some minor changes to the Content Cards and News Feed UI to accommodate the larger buttons.
 495 | 
 496 | ##### Fixed
 497 | - Fixed an issue where some network requests fail on websites using certain libraries that overwrite the native Promise object.
 498 | 
 499 | ## 3.1.2
 500 | 
 501 | ##### Fixed
 502 | - Added default `alt` text to In-App Message and Content Card images to improve screen-reader experience.
 503 | - Improved the display of different aspect ratios for `ClassicCard` images when using the built-in UI.
 504 | - Fixed a regression introduced in 3.1.0 where the SDK would sometimes make multiple network requests when starting a new session.
 505 | - Fixed an issue where globally-scoped `float` CSS caused certain elements of the built-in UI to display incorrectly.
 506 | - Fixed an incorrect TypeScript definition for `DeviceProperties`.
 507 | 
 508 | ## 3.1.1
 509 | 
 510 | ##### Fixed
 511 | - Fixed an issue where a javascript error could be thrown when showing Content Cards or In-App Messages in certain environments where `this` is undefined.
 512 | 
 513 | ## 3.1.0
 514 | 
 515 | ##### Added
 516 | - Added a [`devicePropertyAllowlist`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#initializationoptions.__type.devicepropertyallowlist) initialization option. This new initialization option has the same functionality as `devicePropertyWhitelist`, which is now deprecated and will be removed in a future release.
 517 | 
 518 | ##### Changed
 519 | - Relaxed the email address validation used by the SDK in favor of the more accurate Braze backend validation. Valid addresses with unusual structures or international characters which were previously rejected will now be accepted.
 520 | 
 521 | ##### Fixed
 522 | - Fixed an issue where the SDK was improperly handling session starts when switching between subdomains, causing a short delay in triggering in-app messages.
 523 | 
 524 | ## 3.0.1
 525 | 
 526 | ##### Fixed
 527 | - Fixed incorrect type definitions for the `extras` property of Card and In-App Message classes.
 528 | - Fixed a regression introduced in 2.5.0 where the functionality of the `manageServiceWorkerExternally` and `disablePushTokenMaintenance` initialization options were swapped.
 529 | 
 530 | ## 3.0.0
 531 | 
 532 | ##### ⚠️ Breaking
 533 | - The Braze Web SDK now comes bundled with TypeScript definitions in the `@braze` NPM packages. The TypeScript defintions include documentation and autocomplete in IDEs that support it, even if your project does not use TypeScript.
 534 | - The following breaking changes have been made to allow for a better TypeScript experience:
 535 |   - The `ab` namespace has been removed. To migrate from previous integrations, you can simply find and replace all references to `appboy.ab` with `appboy`.
 536 |   - `InAppMessage.Button` has been renamed to `InAppMessageButton`. To migrate from previous integrations, you can simply find and replace all references to `InAppMessage.Button` with `InAppMessageButton`.
 537 | - Due to the above changes, the SDK loading snippet has been updated. If you integrate the Braze Web SDK using the CDN, you must [update the loading snippet](https://github.com/Appboy/appboy-web-sdk#Alternative-CDN-installation) when upgrading to 3.0.
 538 | - The `baseUrl` option to [`appboy.initialize`](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#initialize) is now required to initialize the SDK. If your integration did not already provide the `baseUrl` option, it should now be set to the previous default value of `sdk.iad-01.braze.com` (e.g, `appboy.initialize('YOUR-API-KEY', { baseUrl: 'sdk.iad-01.braze.com' });`).
 539 | - Removed the `messagingReadyCallback` from `openSession` and `changeUser`. Since 2.3.1, the SDK handles events that occur during the asynchronous portion of these calls gracefully, and ensures internally that only the latest messaging will be triggered. Any code previously being invoked inside this callback may be safely placed directly after the openSession or changeUser call.
 540 | 
 541 | ##### Changed
 542 | - The Braze Web SDK has brand new docs, which can be found [here](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html). Any URLs from the previous docs will redirect to the appropriate location.
 543 | 
 544 | ##### Fixed
 545 | - Fixed an issue where browser version was incorrectly reported in Android Webview.
 546 | 
 547 | ## 2.7.1
 548 | 
 549 | ##### Fixed
 550 | - Fixed a regression introduced in 2.5.0 where the functionality of the `manageServiceWorkerExternally` and `disablePushTokenMaintenance` initialization options were swapped.
 551 | 
 552 | ## 2.7.0
 553 | 
 554 | ##### Added
 555 | - Added [`appboyBridge.getUser().addAlias(alias, label)`](https://www.braze.com/docs/user_guide/message_building_by_channel/in-app_messages/customize/#javascript-bridge) to HTML In-App Messages.
 556 | 
 557 | ##### Changed
 558 | - The Braze Web SDK now uses [User-Agent Client Hints](https://wicg.github.io/ua-client-hints/#interface) for device detection when available. When using User-Agent Client Hints, browser version detection is limited to the significant version (e.g., 85 instead of 85.0.123.0). Note that this upgrade will be necessary to ensure accurate operating system detection in upcoming versions of Chromium-based browsers.
 559 | - Cards received from the Content Cards test send feature of the Braze dashboard are no longer removed when the SDK receives an update to the user's Content Cards.
 560 | 
 561 | ##### Fixed
 562 | - Removed code that could result in javascript errors in certain webpack configurations where the `global` object is not accessible by the SDK.
 563 | - Fixed an issue where the `ab.Card` methods `removeAllSubscriptions`, `removeSubscription`, `subscribeToClickedEvent`, and `subscribeToDismissedEvent` were minified, resulting in `undefined` when called.
 564 | 
 565 | ## 2.6.0
 566 | 
 567 | ##### Added
 568 | - Introduced new NPM packages under the `@braze` scope. The core and full versions of the SDK as well as the service worker are now published in their own packages, resulting in a drastically reduced install size compared to the `appboy-web-sdk` package. This is not a breaking change for existing NPM integrations and we will continue to publish the `appboy-web-sdk` package to maintain backwards compatibility. See the README for integration details.
 569 | - Added [`appboyBridge.getUser().setLanguage(language)`](https://www.braze.com/docs/user_guide/message_building_by_channel/in-app_messages/customize/#javascript-bridge) to HTML In-App Messages.
 570 | 
 571 | ##### Changed
 572 | - The new HTML In-App Message type now allows multiple clicks to be logged for a given message.
 573 | 
 574 | ##### Fixed
 575 | - Made push-related methods more defensive against edge-cases where `Notification` is not defined.
 576 | - Fixed an issue where unexpected backend responses could result in a javascript error.
 577 | - Fixed an issue in recent versions of Safari where calling `appboy.registerAppboyPushMessages` would throw a javascript error if the user did not allow websites to ask for permission to send notifications.
 578 | 
 579 | ## 2.5.2
 580 | 
 581 | ##### Fixed
 582 | - Fixed an issue that could cause some prerender user agents to fail to be appropriately recognized as a web crawler.
 583 | 
 584 | ##### Changed
 585 | - Data will now be flushed to the Braze backend every 3 seconds on Safari (down from 10 seconds) due to new privacy features that clear localStorage after 7 days of inactivity.
 586 | 
 587 | ## 2.5.1
 588 | 
 589 | ##### Fixed
 590 | - Fixed an issue in Content Cards where `getUnviewedCardCount()` returns `undefined`. This issue was introduced in 2.5.0.
 591 | 
 592 | ## 2.5.0
 593 | 
 594 | ##### Added
 595 | - Introduced support for upcoming HTML In-App Message templates.
 596 | - Added [`appboyBridge.logClick()`](https://www.braze.com/docs/user_guide/message_building_by_channel/in-app_messages/customize/#javascript-bridge) to HTML In-App Messages.
 597 | - Expanded browser detection to include UC Browser and newer versions of Microsoft Edge that are based on Chromium.
 598 | - Added a new variant of the SDK that allows sites using RequireJS to load the SDK through another method, such as NPM or a `<script>` tag. See the [README](https://github.com/Appboy/appboy-web-sdk#alternative-no-amd-installation) for more information.
 599 | - Added an optional callback to [`appboy.requestImmediateDataFlush`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.requestImmediateDataFlush) that is invoked when the flush is complete.
 600 | - Added Czech and Ukrainian language support for Braze UI elements.
 601 | 
 602 | ##### Changed
 603 | - Decreased the size of the service worker by 20%.
 604 | 
 605 | ##### Fixed
 606 | - Fixed an issue where refreshing Content Cards or News Feed while the feed is showing could cause multiple impressions to be logged for the same card.
 607 | - Fixed a bug where calling `setEmail` with an email address containing capital letters could sometimes be incorrectly rejected.
 608 | - Fixed a bug where refreshing Content Cards would incorrectly set the `clicked` attribute of the cards to `false`.
 609 | - Fixed a bug where providing `serviceWorkerLocation` with an absolute URL containing a protocol and hostname would result in an error being logged when calling `appboy.registerAppboyPushMessages`.
 610 | - Fixed an issue where calling `appboy.registerAppboyPushMessages` in recent versions of Firefox would not show the notification prompt.
 611 | - Fixed a timing issue where creating a reference to `window.appboy` and then using that reference asynchronously could sometimes cause javascript errors when using the default integration snippet.
 612 | 
 613 | ## 2.4.3
 614 | 
 615 | ##### Fixed
 616 | - Fixed a bug that would cause `appboy.registerAppboyPushMessages` to fail when called immediately on a user's first session.
 617 | - Fixed an issue where using both the `manageServiceWorkerExternally` and `serviceWorkerLocation` initialization options would cause the SDK to not register for push if the provided service worker location was in a sub-directory.
 618 | - Fixed an issue where `appboy.registerAppboyPushMessages` could throw an exception if an error occured while updating a previously registered service worker.
 619 | 
 620 | ## 2.4.2
 621 | 
 622 | ##### Fixed
 623 | - Fixed a bug introduced in 2.4.1 that would focus inline feeds, causing the page to scroll when content cards are shown out of view.
 624 | 
 625 | ## 2.4.1
 626 | 
 627 | #### Breaking
 628 | - Accessibility updates in this release have changed headers to use `h1` tags and close buttons to use `button` tags (instead of `div` and `span` respectively). As a result, any CSS customizations which rely upon `div` or `span` elements within `.ab-feed` or `.ab-in-app-message` should be updated to use classes instead.
 629 | 
 630 | ##### Added
 631 | - Introduced a [`dismissCard`](https://js.appboycdn.com/web-sdk/latest/doc/ab.Card.html#dismissCard) method that can be used to dismiss a card programmatically.
 632 | - Improved accessibility throughout the SDK:
 633 |   - Used `h1` tags for headers and `button` tags for close buttons
 634 |   - Added ARIA attributes
 635 |   - Improved the experience when tabbing through elements
 636 |   - We now restore the user's previously focused element after closing In-App Messages
 637 | 
 638 | ##### Fixed
 639 | - Fixed a bug introduced in 2.4.0 that could cause a javascript error in integrations that only include the core library. This error would occur when a Content Card with a URL is received.
 640 | 
 641 | ## 2.4.0
 642 | 
 643 | ##### Breaking
 644 | - Removed the Feedback feature and `appboy.submitFeedback` method from the SDK.
 645 | 
 646 | ##### Added
 647 | - Improved browser detection to account for the Smart TV landscape.
 648 | - Added logic to automatically renew push subscriptions when they are expired or older than 6 months.
 649 | - Introduced a `contentSecurityNonce` initialization option for sites with a Content Security Policy. See the [`appboy.initialize`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) documentation for more info.
 650 | - Introduced a `disablePushTokenMaintenance` initialization option for sites that have users with Web Push permission granted, but do not wish to use Web Push with Braze. See the [`appboy.initialize`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) documentation for more info.
 651 | - Introduced a `manageServiceWorkerExternally` initialization option for sites that have their own service worker already. See the [`appboy.initialize`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) documentation for more info.
 652 | - Deprecated the `subscribeToNewInAppMessages` method in favor of the new [`subscribeToInAppMessage`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.subscribeToInAppMessage) method, which has a simpler interface.
 653 | 
 654 | ##### Fixed
 655 | - Improved support for In-App Messages on “notched” devices (for example, iPhone X, Pixel 3XL).
 656 | - The logic that prevents the page behind a modal or fullscreen In-App Message from scrolling now functions correctly on iOS.
 657 | - Fixed a caching bug that could cause In-App Messages, Content Cards, and News Feed Cards received by one instance of the Braze SDK to not be seen by another simultaneously running instance of the Braze SDK.
 658 | - Fixed a bug that would cause redundant network activity for new users on their first session ever.
 659 | - Fixed a bug that would cause push registration that occurs immediately on a user's first session to fail.
 660 | - Introduced the `allowUserSuppliedJavascript` initialization option, which is an alias for the existing `enableHtmlInAppMessages` option, and disabled the ability to use `javascript:` URIs in In-App Message and Content Card click actions unless one of these options is provided.
 661 | 
 662 | ##### Changed
 663 | - Improved the look and feel of Content Card dismissals and Content Card and News Feed animations to match the latest In-App Message styles.
 664 | - The `baseUrl` configuration option for `appboy.initialize` is now more flexible in the values that it can accept.
 665 | - Cookies set by the Braze Web SDK now expire after 1 year.
 666 | 
 667 | ## 2.3.4
 668 | 
 669 | ##### Fixed
 670 | - Fix regression introduced in 2.3.3 that could prevent analytics from being logged from the service worker.
 671 | 
 672 | ## 2.3.3
 673 | 
 674 | ##### Fixed
 675 | - Improved some In-App Message CSS styles to be more resilient against conflicts with any page-wide CSS.
 676 | - Improved the resiliency of the code that allows body content to scroll again when modal or fullscreen in-app messages are dismissed.
 677 | 
 678 | ## 2.3.2
 679 | 
 680 | ##### Added
 681 | - Added support for an improved integration snippet which is capable of stubbing the interface before the SDK loads in Google Tag Manager.
 682 | 
 683 | ## 2.3.1
 684 | 
 685 | ##### Added
 686 | - Introduced new `closeMessage` method on `ab.InAppMessage` objects to enable integrations to programmatically close messages if desired.
 687 | - The Braze Web SDK now automatically enqueues trigger events that occur while triggers are being synced with the Braze backend, and replays them when the sync is complete. This fixes a race condition that could cause users to inadvertantly miss messages when trigger events occur directly after calling `openSession` or `changeUser`. This change obsoletes usage of the `messagingReadyCallback`, which is now deprecated (but will continue to function).
 688 | 
 689 | ##### Fixed
 690 | - Fixed an issue which prevented tall `ab.HtmlMessage` objects from scrolling on iOS.
 691 | - Fixed "Object doesn't support this action" error in Internet Explorer 11 or older when showing `ab.HtmlMessage` objects.
 692 | 
 693 | ## 2.3.0
 694 | 
 695 | ##### Added
 696 | - Improved the look and feel of In-App Messages to adhere to the latest UX and UI best practices. Changes affect font sizes, padding, and responsiveness across all message types. Now supports button border styling.
 697 | 
 698 | ##### Fixed
 699 | - This feature, which regressed in 2.1.0, has been restored: when you call `appboy.openSession`, if the user has previously granted the site permission to send push, Braze will now automatically send the user's push token to Braze backend. This will allow users to continue to receive push messages if they manually remove push permission and then subsequently manually reenable it - and will also cause user push tokens to automatically migrate to Braze over time when moving to Braze from a previously-integrated third-party push provider.
 700 | 
 701 | ## 2.2.7
 702 | 
 703 | ##### Added
 704 | - HTML In-App Messages now emit an `ab.BridgeReady` event when the `appboyBridge` variable is available for use inside your HTML, allowing you to use `appboyBridge` immediately when an in-app message is shown. To utilize this event in your HTML In-App Messages, use `window.addEventListener('ab.BridgeReady', function() {/*Use appboyBridge here*/}, false);`.
 705 | 
 706 | ##### Changed
 707 | - Changed usages of `Date.now()` to `new Date().valueOf()` to allow the Braze SDK to sit side-by-side with legacy 3rd party libraries that monkey-patched `Date.now()` before ECMASCRIPT 5 defined it.
 708 | 
 709 | ## 2.2.6
 710 | 
 711 | ##### Added
 712 | - Added `clicked` property to Content Cards which returns true if this card has ever been clicked on this device.
 713 | 
 714 | ##### Changed
 715 | - Improved in-app message triggering logic to fall back to lower priority messages when the Braze server aborts templating (e.g. from a Connected Content abort in the message body, or because the user is no longer in the correct Segment for the message)
 716 | - Improved in-app message triggering logic to retry user personalization when communication with the Braze server fails due to network connectivity issues.
 717 | - The Braze Web SDK now only stores cookies for the most recently-used API Key (app). This reduces cookie storage usage for domains that are configured against many Braze apps.
 718 | 
 719 | ## 2.2.5
 720 | 
 721 | ##### Added
 722 | - Added `devicePropertyWhitelist` property to the options for `appboy.initialize()`, which can be used to filter what device properties get collected.
 723 | 
 724 | ## 2.2.4
 725 | 
 726 | ##### Added
 727 | - Added support for richer custom styling through CSS in in-app messages.
 728 | 
 729 | ##### Changed
 730 | - Subtle visual polish to the News Feed and Content Cards
 731 | 
 732 | ## 2.2.3
 733 | 
 734 | ##### Added
 735 | - Added support for tracking custom location attributes. See the [`ab.User.setCustomLocationAttribute`](https://js.appboycdn.com/web-sdk/latest/doc/ab.User.html#setCustomLocationAttribute) documentation for more information.
 736 | - When calling `appboy.registerAppboyPushMessages` with a `deniedCallback`, that `deniedCallback` will now be invoked (with a `temporary` parameter of `true`) for temporary denials, where the browser has automatically denied permission on behalf of the user after multiple ignored attempts to register for push, but will allow attempts again in the future - probably in about a week.
 737 | - Added `appboyBridge.web.trackLocation()` in HTML in-app messages. This enables HTML in-app message soft location tracking prompts.
 738 | 
 739 | ##### Fixed
 740 | - News Feed and Content Cards clicks and impressions will now be logged multiple times for a given card (if they in fact occur multiple times). Impressions will still only be logged for a given card once per viewing of the feed (regardless of how many times it scrolls in and out of view).
 741 | - Improved logic around IndexedDB to better catch and log errors (prevents security errors with disabled cookies on certain browsers, or from Safari's "Intelligent Tracking Prevention" when integrated in an iFrame).
 742 | - Worked around [this Chrome Bug](https://bugs.chromium.org/p/chromium/issues/detail?id=811403) which could cause device detection to throw "Unsupported time zone specified undefined" on Linux-based systems with certain settings.
 743 | - Fixed an issue where the messagingReadyCallback would not get fired if changeUser was called with an empty ID.
 744 | 
 745 | ##### Changed
 746 | - Data will now be flushed to the Braze backend every three seconds when localStorage is not available.
 747 | - Improved triggered in-app message re-eligibility logic to better handle templating failures.
 748 | 
 749 | 
 750 | ## 2.2.2
 751 | 
 752 | ##### Added
 753 | - Updated push token handling to automatically remove blocked users from the pushable audience on session start.
 754 | 
 755 | ##### Fixed
 756 | - Fixed issue in Content Cards where the `getUnviewedCardCount` method on `ab.ContentCards` could not be invoked properly.
 757 | - Fixed a bug where the [`addAlias` method](https://js.appboycdn.com/web-sdk/latest/doc/ab.User.html#addAlias) was returning an object instead of a boolean value.
 758 | - Fixed issue which could prevent Content Cards from syncing properly on IE 11 and Safari.
 759 | 
 760 | ##### Changed
 761 | - Various user attribute methods now support setting null (`setFirstName`, `setLastName`, `setCountry`, `setHomeCity`, `setPhoneNumber`, `setEmail`, `setGender`, `setLanguage`, and `setDateOfBirth`) by passing in an explicit null value.
 762 | 
 763 | ## 2.2.1
 764 | 
 765 | ##### Fixed
 766 | - Prevent push received/clicked analytics from being sent to the Braze backend when `appboy.stopWebTracking` has been called.
 767 | 
 768 | ## 2.2.0
 769 | 
 770 | ##### Added
 771 | - Introduced support for Content Cards, which will eventually replace the existing News Feed feature and adds significant capability.
 772 | - Added support for web push on Accelerated Mobile Pages (AMP). See https://www.braze.com/documentation/Web/#amp-support for setup information.
 773 | 
 774 | ##### Fixed
 775 | - Fixed an issue where in-app messages triggered on session start could potentially be templated with the old user's attributes.
 776 | 
 777 | ##### Removed
 778 | - Removed `appboy.requestInAppMessageRefresh()` and support for legacy in-app messages - these were long-deprecated and have been supplanted by [triggered in-app messages](https://www.braze.com/documentation/Web/#in-app-messages-triggered).
 779 | 
 780 | ## 2.1.1
 781 | 
 782 | ##### Fixed
 783 | - Prevent push received/clicked analytics from being sent to the Braze backend when `appboy.stopWebTracking` has been called.
 784 | 
 785 | ## 2.1.0
 786 | 
 787 | ##### Added
 788 | - Added [`appboy.wipeData()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#wipeData) to allow deletion of locally stored SDK data. After calling this method, users will appear as a new anonymous user on a new device.
 789 | 
 790 | ##### Fixed
 791 | - Improved push registration and unregistration
 792 |   - [`appboy.registerAppboyPushMessages`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#registerAppboyPushMessages) will now set the user's subscription status to "OPTED_IN" only at times when they've just accepted the permission prompt.
 793 |   - [`appboy.unregisterAppboyPushMessages`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#unregisterAppboyPushMessages) will now persist across sessions and user changes (until [`appboy.registerAppboyPushMessages`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#registerAppboyPushMessages) is called again).
 794 |   - [`appboy.registerAppboyPushMessages`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#registerAppboyPushMessages) will cause push prompts to be shown shown more reliably in situations where the user has ignored them in the past. Logging around dismissing (as opposed to accepting or blocking) push prompts has been improved.
 795 | - Fixed a bug with [`appboy.changeUser`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#changeUser) where `messagingReadyCallback` would not fire when the supplied `userId` was the current user.
 796 | 
 797 | ##### Changed
 798 | - Updated from FontAwesome 4.3.0 to FontAwesome 4.7.0. Integrations that wish to maintain older versions should pass in `doNotLoadFontAwesome` as `true` during initialization and load their desired version.
 799 | - The Braze SDK will automatically load FontAwesome unless `doNotLoadFontAwesome` is explicitly passed in as `true` during initialization, regardless of whether fontawesome.css or fontawesome.min.css are already on the page.
 800 | 
 801 | ## 2.0.9
 802 | 
 803 | ##### Fixed
 804 | - Prevent push received/clicked analytics from being sent to the Braze backend when `appboy.stopWebTracking` has been called.
 805 | 
 806 | ## 2.0.8
 807 | 
 808 | ##### Added
 809 | - Added defensive guards against any possibility of sessions expiring in less than 1 second or of creating multiple session events in rapid succession if scripted in parallel across many open tabs.
 810 | 
 811 | 
 812 | ## 2.0.7
 813 | 
 814 | ##### Added
 815 | - Added support for [Voluntary Application Server Identification (VAPID) for Web Push](https://tools.ietf.org/html/rfc8292):
 816 |   - Will be required for Microsoft Edge's upcoming Web Push support, and possibly other browsers in the future.
 817 |   - Allows importing of VAPID-enabled push tokens generated by other push providers, given the corresponding keypair (support@braze.com).
 818 |   - Happens transparently in the background and does not require an integration update.
 819 |   - Once the browser landscape has sufficiently matured, this will eventually obviate the need to supply a `gcm_sender_id` in your site's `manifest.json`.
 820 | 
 821 | ##### Changed
 822 | - [`appboy.unregisterAppboyPushMessages`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#unregisterAppboyPushMessages) now accepts optional `successCallback` and `errorCallback` arguments to signal completion, as it functions asynchronously.
 823 | 
 824 | ## 2.0.6
 825 | 
 826 | ##### Fixed
 827 | - Fixed a javascript error introduced in 2.0.5 when logging in the service worker.
 828 | 
 829 | ## 2.0.5
 830 | 
 831 | ##### Added
 832 | - Added Location Tracking - See [`appboy.trackLocation()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#trackLocation) for more information.
 833 | - `appboy.user.setGender` now supports more gender options. See the [`Genders` enum documentation](https://js.appboycdn.com/web-sdk/latest/doc/ab.User.html#toc4) for more information.
 834 | - Added [`appboy.stopWebTracking()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#stopWebTracking) and [`appboy.resumeWebTracking()`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#resumeWebTracking) to allow user opt-outs.
 835 | - Improved accessibility for in-app messages and news feed by focusing on elements where appropriate, allowing users to tab through various buttons, and adding labels where appropriate.
 836 | 
 837 | ##### Fixed
 838 | - Fixed a bug that caused `appboy.display.automaticallyShowNewInAppMessages()` not to function correctly when called after calling `appboy.destroy()` and then calling `appboy.initialize()` a second time.
 839 | - The `openSession` and `changeUser` methods now take a `messagingReadyCallback` that executes when the Braze Web SDK is ready to show messaging data to this user. This fixes a race condition where custom events could be logged before in-app messages had been fetched from the Braze backend and users would not see intended messaging.
 840 | 
 841 | ##### Changed
 842 | - Deprecated the `submitFeedback` method. The feedback feature is disabled for new accounts, and will be removed in a future SDK release.
 843 | 
 844 | ## 2.0.4
 845 | 
 846 | ##### Changed
 847 | - Renamed documentation references from Appboy to Braze. This is not a breaking change.
 848 | 
 849 | ## 2.0.3
 850 | 
 851 | ##### Fixed
 852 | - Fixed a null reference error when replaying calls made using the new integration snippet on IE 11.
 853 | 
 854 | ## 2.0.2
 855 | 
 856 | ##### Fixed
 857 | - Fixed an issue with our minification that would cause the Braze Web SDK to leak polyfill functions into the global namespace.
 858 | 
 859 | ## 2.0.1
 860 | 
 861 | ##### Fixed
 862 | - Fixed automatic css loading when used in combination with the doNotLoadFontAwesome initialization option.
 863 | 
 864 | ## 2.0.0
 865 | 
 866 | ##### Breaking
 867 | - Braze now automatically loads required CSS styles. You must remove all references to appboy.min.css from your site.
 868 | - The `getUserId` method now takes a callback which it invokes with the userId, instead of returning a value directly. This is necessary to ensure the proper replaying of calls made to `appboy` before the SDK has fully loaded. Where before, you would do `var userId = appboy.getUser().getUserId();`, now do `appboy.getUser().getUserId(function(userId) { console.log(userId); })`  See the [`getUserId method documentation`](https://js.appboycdn.com/web-sdk/latest/doc/ab.User.html#getUserId) for more information.
 869 | - The `getDeviceId` method now takes a callback which it invokes with the deviceId, instead of returning a value directly. This is necessary to ensure the proper replaying of calls made to `appboy` before the SDK has fully loaded. See the [`getDeviceId method documentation`](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#getDeviceId) for more information.
 870 | 
 871 | ##### Changed
 872 | - [The default Braze integration snippet](https://github.com/Appboy/appboy-web-sdk#getting-started) has been updated for best-practices compliance, resilience, and performance. Using this new snippet, calls may be made to `appboy` before the SDK has fully loaded, and will be replayed automatically when the SDK loads. We recommend that you update your site's integration to the new snippet for optimal behavior, but this is not a breaking change, and is not required.
 873 | 
 874 | ##### Added
 875 | - If you are using a front-end packager such as [Browserify](http://browserify.org/) or [Webpack](https://webpack.github.io/), [the NPM integration instructions](https://github.com/Appboy/appboy-web-sdk#Alternative-NPM-installation) have been updated to meet your use-case.
 876 | 
 877 | ## 1.6.14
 878 | 
 879 | ##### Added
 880 | - Added the user agent for the https://prerender.io/ crawler to the list of known web crawlers.
 881 | - Added [`ab.User.setLanguage`](https://js.appboycdn.com/web-sdk/latest/doc/ab.User.html#setLanguage) method to allow explicit control over the language you use in the Braze dashboard to localize your messaging content.
 882 | 
 883 | ##### Fixed
 884 | - Fixed array validation on pages where the Array type has been modified by other scripts.
 885 | 
 886 | ##### Changed
 887 | - Marked the 'touchstart' listener in in-app messages as 'passive' for performance and PWA compliance.
 888 | 
 889 | ## 1.6.13
 890 | 
 891 | ##### Added
 892 | - Contains service-worker support for Web Push notifications that require user interaction to be dismissed.
 893 | 
 894 | ##### Fixed
 895 | - Improved time zone recognition on modern browsers to prevent possible ambiguity between different zones with similar UTC offsets.
 896 | - Broadened detection of the Android OS to better recognize newer hardware and as-of-yet unreleased hardware on an ongoing basis.
 897 | - Fixed data-formation error when pending additions or removals to a custom attribute array were re-enqueued following a Braze backend outage or otherwise failed data flush.
 898 | 
 899 | ##### Changed
 900 | - We now allow a value of 0 for the `minimumIntervalBetweenTriggerActionsInSeconds` option for `appboy.initialize`
 901 | 
 902 | ## 1.6.12
 903 | 
 904 | ##### Added
 905 | - Introduced `noCookies` option. By default, the Braze SDK will store small amounts of data (user ids, session ids), in cookies. This is done to allow Braze to recognize users and sessions across different subdomains of your site. If this presents a problem for you, pass `true` for this option to disable cookie storage and rely entirely on HTML 5 localStorage to identify users and sessions. The downside of this configuration is that you will be unable to recognize users across subdomains of your site.
 906 | - Added user aliasing capability. Aliases can be used in the API and dashboard to identify users in addition to their ID.  See the [`addAlias method documentation`](https://js.appboycdn.com/web-sdk/latest/doc/ab.User.html#addAlias) for more information.
 907 | 
 908 | ##### Fixed
 909 | - Fixed issue in which the local cache of seen in-app messages and news feed cards was being cleared when the anonymous user was identified, allowing certain items to be retriggered or appear unread.
 910 | 
 911 | ## 1.6.11
 912 | 
 913 | ##### Added
 914 | - When you call `appboy.openSession`, if the user has previously granted the site permission to send push, Braze will now automatically send the user's push token to Braze backend. This will allow users to continue to receive push messages if they manually remove push permission and then subsequently manually reenable it - and will also cause user push tokens to automatically migrate to Braze over time when moving to Braze from a previously-integrated third-party push provider.
 915 | 
 916 | ##### Fixed
 917 | - IMPORTANT: Due to a behavioral change in Chrome 59, to reliably receive notifications, you must update the service worker from https://js.appboycdn.com/web-sdk/1.6/service-worker.js.
 918 | - `appboy.display.automaticallyShowNewInAppMessages()` may now be safely called multiple times on the same `appboy` instance.
 919 | 
 920 | ## 1.6.10
 921 | 
 922 | ##### Fixed
 923 | - A bug in our documentation for soft push prompts could cause Control Group stats to fail. If you previously implemented soft push prompts, please refer to the latest version of our documentation: https://www.braze.com/documentation/Web/#soft-push-prompts
 924 | 
 925 | ## 1.6.9
 926 | 
 927 | ##### Added
 928 | - Added support for `appboyBridge.web.registerAppboyPushMessages` to allow HTML in-app messages to request push permission from the user.
 929 | 
 930 | ## 1.6.8
 931 | 
 932 | ##### Fixed
 933 | - Fixed "Notification is not defined" error when calling `appboy.isPushPermissionGranted`/`appboy.isPushBlocked` on Chrome versions prior to 46.
 934 | 
 935 | ## 1.6.7
 936 | 
 937 | ##### Added
 938 | - The Braze Web SDK now supports HTML content in-app messages. For your security, these must be enabled by supplying the `enableHtmlInAppMessages` configuration option when calling `appboy.initialize`.
 939 | 
 940 | ##### Fixed
 941 | - The News Feed css is now defensive against any global box-sizing css rules that may exist on your site, and handles classic card image styling more gracefully.
 942 | - On mobile devices, Fullscreen in-app messages' close buttons are sized relative to the entire device - this ensures touchable targets on high-resolution phones.
 943 | - Improved positioning of Modal in-app messages to ensure visibility and attractive positioning across all browsers.
 944 | 
 945 | ## 1.6.6
 946 | 
 947 | ##### Fixed
 948 | - Fixed a data-storage issue where a small number of users impacted by the issue fixed in 1.6.5 may record a new session on page load after upgrading to 1.6.5.
 949 | 
 950 | ## 1.6.5
 951 | 
 952 | ##### Fixed
 953 | - Cookies are now stored with path=/ for sitewide accessibility, ensuring that identification persists sitewide in all situations. This fixes an issue introduced in 1.6.0.
 954 | 
 955 | ## 1.6.4
 956 | 
 957 | ##### Added
 958 | - The Braze Web SDK now ignores web crawler activity by default - this saves datapoints, makes analytics more accurate, and may improve page rank (this change can be reversed with the `allowCrawlerActivity` initialization option).
 959 | 
 960 | ##### Fixed
 961 | - Fixed an issue where in-app messages triggered off of push clicks wouldn't fire because the push click happened before the in-app message configuration was synced to the device.
 962 | - Increased defensiveness against corrupted localStorage or cookie data.
 963 | 
 964 | ##### Changed
 965 | - Increased the size of in-app message close buttons on mobile browsers slightly to make an easier touch target.
 966 | - Updated `appboy.registerAppboyPushMessages` to flush subscriptions to the server immediately.
 967 | 
 968 | ## 1.6.3
 969 | 
 970 | ##### Changed
 971 | - Further improved the layout of Fullscreen in-app messages on short desktop screens.
 972 | 
 973 | ## 1.6.2
 974 | 
 975 | ##### Changed
 976 | - Deprecated the `appboy.isPushGranted` method in favor of the new `appboy.isPushPermissionGranted`. The old method was inappropriately testing whether the browser has an active push subscription, and not doing the intended test of whether the user has granted push **permission**. The old method will be removed in an upcoming release.
 977 | 
 978 | ## 1.6.1
 979 | 
 980 | ##### Fixed
 981 | - Improved Modal in-app message layout to prevent text-view scrolling until necessary.
 982 | 
 983 | ##### Changed
 984 | - Deprecated the `safariWebsitePushId` parameter to `appboy.registerAppboyPushMessages` and `appboy.isPushGranted` in favor of the new `safariWebsitePushId` option to `appboy.initialize`. If you implement Safari push, you should convert your integration to use the new initialization option - support for the parameters will be removed in a future release. This is not yet a breaking change.
 985 | - Polished Fullscreen in-app message display on desktop browsers to reduce unused whitespace when the content is small enough not to scroll.
 986 | 
 987 | ## 1.6.0
 988 | 
 989 | ##### Fixed
 990 | - Fixed an edge-case that could cause SlideUp in-app messages to appear offscreen if many were triggered in rapid succession.
 991 | 
 992 | ##### Changed
 993 | - Improved ability to consistently identify users, devices, and sessions across subdomains by preferring domain-wide cookies for ID storage (over the previously-preferred localStorage).
 994 | 
 995 | ## 1.5.1
 996 | 
 997 | ##### Fixed
 998 | - Fixed a rendering issue that could cause FullScreen in-app messages to appear partially off-screen on very short browser windows.
 999 | 
1000 | ## 1.5.0
1001 | 
1002 | ##### Added
1003 | - Added support for upgraded in-app messages including image-only messages, improved image sizing/cropping, text scrolling, text alignment, configurable orientation, and configurable frame color.
1004 | - Added support for in-app messages triggered on custom event properties, purchase properties, and in-app message clicks.
1005 | - Improved support for templated in-app messages.
1006 | - Added appboy.isPushGranted() method, useful for migrating existing push subscriptions from another third-party provider to Braze.
1007 | - Added language localization - language is detected automatically from the browser or can be specified explicitly via the `language` initialization option.
1008 | 
1009 | ## 1.4.2
1010 | 
1011 | ##### Added
1012 | - Added additional logging information for Safari push.
1013 | 
1014 | ## 1.4.1
1015 | 
1016 | ##### Added
1017 | - Added a more explicit error when attempting to call registerAppboyPushMessages on Safari without supplying a safariWebsitePushID.
1018 | 
1019 | ## 1.4.0
1020 | 
1021 | ##### Added
1022 | - Added support for Safari push messages.
1023 | - If you version your website, you may now optionally pass the version to Braze via the new `appVersion` initialization option.
1024 | - The News Feed now displays a timed-out message to users if the refresh fails (due to network or back end outages).
1025 | - Browser version will now be reported as part of the user's device information along with browser.
1026 | - Added ability to specify on a message-by-message basis whether in-app message clicks should open in a new tab or same tab.
1027 | 
1028 | ##### Fixed
1029 | - Fixed an issue which caused emoji in web push messages to be broken on Firefox.
1030 | 
1031 | ##### Changed
1032 | - Overhauled the browser detection code for improved reliability.
1033 | 
1034 | ## 1.3.3
1035 | 
1036 | ##### Added
1037 |   - Added a new `serviceWorkerLocation` initialization option. See JSDocs for more information.
1038 | 
1039 | ## 1.3.2
1040 | 
1041 | ##### Added
1042 | - Added support for Braze Feedback through the new appboy.submitFeedback method.
1043 | 
1044 | ##### Fixed
1045 | - In-App Messages now track click analytics even when the click action is "None."
1046 | - Prevent Mobile Safari in Private Browsing mode from throwing an exception. This issue was introduced in 1.3.0.
1047 | 
1048 | ## 1.3.1
1049 | 
1050 | ##### Fixed
1051 | - Prevent Firefox from throwing an exception when in Private Browsing mode. This issue was introduced in 1.3.0.
1052 | 
1053 | ## 1.3.0
1054 | 
1055 | ##### Breaking
1056 | - The `inAppMessages` parameter to `appboy.subscribeToNewInAppMessages` subscribers may now contain `ab.ControlMessage` objects.
1057 | 
1058 | ##### Added
1059 | - Adds support for triggered in-app messages.
1060 | 
1061 | ##### Fixed
1062 | - Fixed a bug where news feed cards weren't always immediately being marked as read during scrolling.
1063 | 
1064 | ##### Changed
1065 | - All iOS devices will now report their OS as "iOS" instead of "iPhone/iPod" or "iPad".
1066 | 
1067 | ## 1.2.2
1068 | 
1069 | ##### Fixed
1070 | - Fixed a javascript error that could occur when attempting to showFeed before the body has loaded.
1071 | - Made in-app message buttons explicitly display:inline-block so that they still display correctly if the site is styling buttons as display:block.
1072 | 
1073 | ## 1.2.1
1074 | 
1075 | ##### Fixed
1076 | - The service worker now reads Braze's backend URL from IndexedDB, which allows web push to function for clients with custom Braze endpoints.
1077 | - isPushBlocked now returns false when isPushSupported is false instead of erroring.
1078 | 
1079 | ## 1.2.0
1080 | 
1081 | ##### Breaking
1082 | - Restyled the news feed for improved legibility with a wider variety of card content. If you have existing news feed css customization this may be a breaking change.
1083 | 
1084 | ##### Added
1085 | - Supports web push (on browsers implementing the w3c spec, with or without payloads - i.e. Chrome, Firefox).
1086 | - Introduced appboy.toggleFeed as a convenience method - it simply calls appboy.showFeed or appboy.destroyFeed based on whether there's currently a feed showing.
1087 | 
1088 | ##### Fixed
1089 | - Buttonless FullScreen and Modal messages now respect body click actions from the dashboard.
1090 | 
1091 | ##### Changed
1092 | - To reduce the datapoint impact of the high number of anonymous users on the web, in-app messages are no longer. automatically refreshed for new, anonymous users on their first openSession call. You can override this behavior and force an in-app message refresh by manually calling appboy.requestInAppMessageRefresh.
1093 | - In-App Messages may now be dismissed with a click on the greyed-out background of the page. This behavior may be prevented by passing requireExplicitInAppMessageDismissal:true to `appboy.initialize`.
1094 | 
1095 | ## 1.1.1
1096 | 
1097 | ##### Added
1098 | - Expanded browser detection to recognize more niche browsers.
1099 | 
1100 | ##### Fixed
1101 | - Fixed an issue which would cause some Android devices to be detected as Linux.
1102 | 
1103 | ## 1.1.0
1104 | 
1105 | ##### Added
1106 | - Introduced `appboy.logFeedDisplayed`, which is called automatically when using `appboy.display.showFeed`.
1107 | 
1108 | ##### Fixed
1109 | - Fixed a race condition which could cause events to be double-counted if the user had the site open in very many tabs at once.
1110 | 
1111 | ##### Changed
1112 | - News feed and in-app message links now open in the same tab.
1113 | 
1114 | ## 1.0.1
1115 | 
1116 | ##### Fixed
1117 | - The SDK now logs correctly to the console when enableLogging is true (or toggleAppboyLogging has been called) and no custom logger has been specified.
1118 | 
1119 | ## 1.0.0
1120 | 
1121 | ##### Added
1122 | - Respect blacklisted custom events, attributes, and purchases.
1123 | 
1124 | ##### Removed
1125 | - Removed the setBio method on ab.User in accordance with the deprecation of that user property across the Braze platform.
1126 | 
1127 | ## 0.2.4
1128 | 
1129 | ##### Fixed
1130 | - Fixed an issue which was causing the in-app message refresh throttle not to persist beyond a single page load.
1131 | 
1132 | ## 0.2.3
1133 | 
1134 | ##### Added
1135 | - Introduce `appboy.display.destroyFeed` method to allow integrators to implement a toggle feed button or otherwise hide the feed from code.
1136 | 
1137 | ##### Fixed
1138 | - Prevent potential race condition which could cause news feed cards to not be marked as read for a short amount of time.
1139 | 
1140 | ##### Removed
1141 | - Remove the news feed z-index. If necessary, the z-index can be set manually via CSS: `.ab-feed { z-index: }`.
1142 | 
1143 | ## 0.2.2
1144 | 
1145 | ##### Fixed
1146 | - Fix issue where already-cached news feed cards were not properly having impressions logged when the news feed was first shown.
1147 | 
1148 | ##### Changed
1149 | - Minor improvements to In-App Message styling.
1150 | 
1151 | ## 0.2.1
1152 | 
1153 | ##### Added
1154 | - Give the news feed a z-index just below bootstrap modal backdrops.
1155 | 
1156 | ##### Fixed
1157 | - Support legacy Internet Explorer (complete IE9 support, generally functional IE8 support).
1158 | 
1159 | ##### Changed
1160 | - Ignore in-app messages with an unknown type (prevents future message types from be inappropriately displayed on versions of the sdk which don't yet support them).
1161 | 
1162 | ## 0.2.0
1163 | 
1164 | ##### Added
1165 | - Added Braze news feed support.
1166 | 
1167 | ## 0.1.5
1168 | 
1169 | ##### Fixed
1170 | - Correctly identify IE11.
1171 | 
1172 | ## 0.1.4
1173 | 
1174 | ##### Fixed
1175 | - Fixed issue where SlideUp message clicks with a clickAction of URI were not being respected.
1176 | - Fixed issue where Date custom attributes, custom event properties, and purchase properties were not being recognized as Dates by the Braze platform.
1177 | 
1178 | ## 0.1.3
1179 | 
1180 | ##### Added
1181 | - Add support for more purchase currencies, allow lowercase currencies.
1182 | 
1183 | ##### Changed
1184 | - Use millisecond precision when logging events.
1185 | 
1186 | ## 0.1.2
1187 | 
1188 | ##### Changed
1189 | - Introduce optional doNotLoadFontAwesome initialization option and additionally don't load FontAwesome if fontawesome.css or fontawesome.min.css are already on the page.
1190 | - More minor improvements to In-App Message styling.
1191 | 
1192 | ## 0.1.1
1193 | 
1194 | ##### Changed
1195 | - Various minor improvements to SlideUp styling.
1196 | 
1197 | ## 0.1.0
1198 | 
1199 | ##### Added
1200 | - Support in-app messages.
1201 | 
1202 | ## 0.0.5
1203 | 
1204 | ##### Fixed
1205 | - Fixed critical issue which caused browser tabs to become unresponsive with no network connection.
1206 | 
1207 | ## 0.0.4
1208 | 
1209 | ##### Fixed
1210 | - Defend against NS_ERROR_FILE_CORRUPTED (corrupted browser SQLite database) and more generally against inability to use localStorage.
1211 | 
1212 | ## 0.0.3
1213 | 
1214 | ##### Changed
1215 | - Provide better backend error messages.
1216 | 
1217 | ## 0.0.2
1218 | 
1219 | ##### Fixed
1220 | - Fixed a bug where due to minification, locally stored data was version-specific.
1221 | 
1222 | ## 0.0.1
1223 | 
1224 | ##### Fixed
1225 | - Fixed bug where multibyte UTF-8 characters were being rejected for various attributes.
1226 | - Harden usage of localStorage slightly.
1227 | 
1228 | ##### Changed
1229 | - Allow setLogger to be called before initialize.
1230 | 
1231 | ## 0.0.0
1232 | 
1233 | - Initial release with core functionality.
1234 | 


--------------------------------------------------------------------------------