react-onesignal 3.0.0 → 3.1.1

package/.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GH_WEB_SHIM_PUSH_TOKEN }}
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_WEB_SHIM_PUSH_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_WEB_SHIM_PUSH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_WEB_SHIM_PUSH_TOKEN }}
+        run: |
+          npx -p semantic-release \
+              -p @semantic-release/changelog \
+              -p @semantic-release/git \
+              -p @semantic-release/github \
+              -p @semantic-release/npm \
+              -p conventional-changelog-conventionalcommits \
+              semantic-release

package/.releaserc.json

@@ -0,0 +1,133 @@
+{
+    "branches": [
+      "main"
+    ],
+    "tagFormat": "${version}",
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "minor"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "perf",
+              "release": "patch"
+            },
+            {
+              "type": "refactor",
+              "release": "patch"
+            },
+            {
+              "type": "style",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "build",
+              "release": "patch"
+            },
+            {
+              "type": "ci",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "scope": "deps",
+              "release": "patch"
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "writerOpts": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation",
+                "hidden": false
+              },
+              {
+                "type": "deps",
+                "section": "Dependency Updates",
+                "hidden": false
+              },
+              {
+                "type": "chore",
+                "hidden": true
+              },
+              {
+                "type": "style",
+                "hidden": true
+              },
+              {
+                "type": "refactor",
+                "hidden": true
+              },
+              {
+                "type": "perf",
+                "hidden": true
+              },
+              {
+                "type": "test",
+                "hidden": true
+              }
+            ]
+          }
+        }
+      ],
+      [
+        "@semantic-release/changelog",
+        {
+          "changelogFile": "CHANGELOG.md",
+          "changelogTitle": "# Changelog"
+        }
+      ],
+      [
+        "@semantic-release/npm",
+        {
+          "pkgRoot": "."
+        }
+      ],
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "dist/**",
+            "package.json",
+            "CHANGELOG.md"
+          ],
+          "message": "chore(release): ${nextRelease.version}\n\n${nextRelease.notes} [skip ci]"
+        }
+      ],
+      "@semantic-release/github"
+    ]
+  }

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [3.1.1](https://github.com/OneSignal/react-onesignal/compare/3.1.0...3.1.1) (2025-03-14)
+
+## [3.1.0](https://github.com/OneSignal/react-onesignal/compare/3.0.1...3.1.0) (2025-03-14)
+
+### Features
+
+* sync with web-shim-codegen v3.0.1 ([93627ba](https://github.com/OneSignal/react-onesignal/commit/93627ba19f6aac555b68ef726b7d6ae9c4aa2a31)), closes [#143](https://github.com/OneSignal/react-onesignal/issues/143)

package/dist/index.d.ts

@@ -78,7 +78,7 @@ interface IOSNotification {
      * If this value is the same as existing notification, it will replace it
      * Can be set when creating the notification with "Web Push Topic" on the dashboard
      * or web_push_topic from the REST API.
-    */
+     */
     readonly topic?: string;
     /**
      * Custom object that was sent with the notification;
@@ -136,6 +136,13 @@ interface NotificationClickEvent {
     readonly notification: IOSNotification;
     readonly result: NotificationClickResult;
 }
+declare type UserChangeEvent = {
+    current: UserNamespaceProperties;
+};
+declare type UserNamespaceProperties = {
+    onesignalId: string | undefined;
+    externalId: string | undefined;
+};
 interface IInitObject {
     appId: string;
     subdomainName?: string;
@@ -149,12 +156,13 @@ interface IInitObject {
     autoRegister?: boolean;
     notificationClickHandlerMatch?: string;
     notificationClickHandlerAction?: string;
+    path?: string;
     serviceWorkerParam?: {
         scope: string;
     };
     serviceWorkerPath?: string;
+    serviceWorkerOverrideForTypical?: boolean;
     serviceWorkerUpdaterPath?: string;
-    path?: string;
     allowLocalhostAsSecureOrigin?: boolean;
     [key: string]: any;
 }
@@ -197,6 +205,8 @@ interface IOneSignalSession {
     sendUniqueOutcome(outcomeName: string): Promise<void>;
 }
 interface IOneSignalUser {
+    onesignalId: string | undefined;
+    externalId: string | undefined;
     PushSubscription: IOneSignalPushSubscription;
     addAlias(label: string, id: string): void;
     addAliases(aliases: {
@@ -214,6 +224,13 @@ interface IOneSignalUser {
     }): void;
     removeTag(key: string): void;
     removeTags(keys: string[]): void;
+    getTags(): {
+        [key: string]: string;
+    };
+    addEventListener(event: 'change', listener: (change: UserChangeEvent) => void): void;
+    removeEventListener(event: 'change', listener: (change: UserChangeEvent) => void): void;
+    setLanguage(language: string): void;
+    getLanguage(): string;
 }
 interface IOneSignalPushSubscription {
     id: string | null | undefined;

package/dist/index.es.js

@@ -6,7 +6,7 @@ let isOneSignalInitialized = false;
 // to disambiguate between a CDN load failure and a delayed call to
 // OneSignal#init.
 let isOneSignalScriptFailed = false;
-if (window) {
+if (typeof window !== 'undefined') {
     window.OneSignalDeferred = window.OneSignalDeferred || [];
     addSDKScript();
 }
@@ -87,12 +87,12 @@ function oneSignalLogin(externalId, jwtToken) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.login(externalId, jwtToken)
-                    .then((value) => resolve(value))
+                OneSignal.login(externalId, jwtToken).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -105,12 +105,12 @@ function oneSignalLogout() {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.logout()
-                    .then((value) => resolve(value))
+                OneSignal.logout().then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -123,12 +123,12 @@ function oneSignalSetConsentGiven(consent) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.setConsentGiven(consent)
-                    .then((value) => resolve(value))
+                OneSignal.setConsentGiven(consent).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -141,12 +141,12 @@ function oneSignalSetConsentRequired(requiresConsent) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.setConsentRequired(requiresConsent)
-                    .then((value) => resolve(value))
+                OneSignal.setConsentRequired(requiresConsent).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -159,12 +159,12 @@ function slidedownPromptPush(options) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptPush(options)
-                    .then((value) => resolve(value))
+                OneSignal.Slidedown.promptPush(options).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -177,12 +177,12 @@ function slidedownPromptPushCategories(options) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptPushCategories(options)
-                    .then((value) => resolve(value))
+                OneSignal.Slidedown.promptPushCategories(options).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -195,12 +195,12 @@ function slidedownPromptSms(options) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptSms(options)
-                    .then((value) => resolve(value))
+                OneSignal.Slidedown.promptSms(options).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -213,12 +213,12 @@ function slidedownPromptEmail(options) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptEmail(options)
-                    .then((value) => resolve(value))
+                OneSignal.Slidedown.promptEmail(options).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -231,12 +231,12 @@ function slidedownPromptSmsAndEmail(options) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptSmsAndEmail(options)
-                    .then((value) => resolve(value))
+                OneSignal.Slidedown.promptSmsAndEmail(options).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -261,12 +261,12 @@ function notificationsSetDefaultUrl(url) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Notifications.setDefaultUrl(url)
-                    .then((value) => resolve(value))
+                OneSignal.Notifications.setDefaultUrl(url).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -279,12 +279,12 @@ function notificationsSetDefaultTitle(title) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Notifications.setDefaultTitle(title)
-                    .then((value) => resolve(value))
+                OneSignal.Notifications.setDefaultTitle(title).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -297,12 +297,12 @@ function notificationsRequestPermission() {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Notifications.requestPermission()
-                    .then((value) => resolve(value))
+                OneSignal.Notifications.requestPermission().then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -327,12 +327,12 @@ function sessionSendOutcome(outcomeName, outcomeWeight) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Session.sendOutcome(outcomeName, outcomeWeight)
-                    .then((value) => resolve(value))
+                OneSignal.Session.sendOutcome(outcomeName, outcomeWeight).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -345,12 +345,12 @@ function sessionSendUniqueOutcome(outcomeName) {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Session.sendUniqueOutcome(outcomeName)
-                    .then((value) => resolve(value))
+                OneSignal.Session.sendUniqueOutcome(outcomeName).then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -431,16 +431,50 @@ function userRemoveTags(keys) {
         OneSignal.User.removeTags(keys);
     });
 }
+function userGetTags() {
+    var _a;
+    let retVal;
+    (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+        retVal = OneSignal.User.getTags();
+    });
+    return retVal;
+}
+function userAddEventListener(event, listener) {
+    var _a;
+    (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+        OneSignal.User.addEventListener(event, listener);
+    });
+}
+function userRemoveEventListener(event, listener) {
+    var _a;
+    (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+        OneSignal.User.removeEventListener(event, listener);
+    });
+}
+function userSetLanguage(language) {
+    var _a;
+    (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+        OneSignal.User.setLanguage(language);
+    });
+}
+function userGetLanguage() {
+    var _a;
+    let retVal;
+    (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+        retVal = OneSignal.User.getLanguage();
+    });
+    return retVal;
+}
 function pushSubscriptionOptIn() {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.User.PushSubscription.optIn()
-                    .then((value) => resolve(value))
+                OneSignal.User.PushSubscription.optIn().then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -453,12 +487,12 @@ function pushSubscriptionOptOut() {
     return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
-            reject();
+            reject(new Error('OneSignal script failed to load.'));
+            return;
         }
         try {
             (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.User.PushSubscription.optOut()
-                    .then((value) => resolve(value))
+                OneSignal.User.PushSubscription.optOut().then(() => resolve())
                     .catch((error) => reject(error));
             });
         }
@@ -495,6 +529,8 @@ const PushSubscriptionNamespace = {
     removeEventListener: pushSubscriptionRemoveEventListener,
 };
 const UserNamespace = {
+    get onesignalId() { var _a, _b; return (_b = (_a = window.OneSignal) === null || _a === void 0 ? void 0 : _a.User) === null || _b === void 0 ? void 0 : _b.onesignalId; },
+    get externalId() { var _a, _b; return (_b = (_a = window.OneSignal) === null || _a === void 0 ? void 0 : _a.User) === null || _b === void 0 ? void 0 : _b.externalId; },
     addAlias: userAddAlias,
     addAliases: userAddAliases,
     removeAlias: userRemoveAlias,
@@ -507,6 +543,11 @@ const UserNamespace = {
     addTags: userAddTags,
     removeTag: userRemoveTag,
     removeTags: userRemoveTags,
+    getTags: userGetTags,
+    addEventListener: userAddEventListener,
+    removeEventListener: userRemoveEventListener,
+    setLanguage: userSetLanguage,
+    getLanguage: userGetLanguage,
     PushSubscription: PushSubscriptionNamespace,
 };
 const SessionNamespace = {