react-onesignal 2.0.1 → 2.0.4

package/LICENSE

@@ -0,0 +1,24 @@
+Modified MIT License
+
+Copyright 2022 OneSignal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+1. The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+2. All copies of substantial portions of the Software may only be used in connection
+with services provided by OneSignal.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -28,7 +28,6 @@ Version 2.0 was recently released. Read the [Migration Guide](https://github.com
 
 You can use `yarn` or `npm`.
 
-
 ### Yarn
 
 ```bash
@@ -71,9 +70,27 @@ OneSignal.init({ appId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }).then(() => {
 })
 ```
 
-### Options
+### Init Options
 You can pass other [options](https://documentation.onesignal.com/docs/web-push-sdk#init) to the `init` function. Use these options to configure personalized prompt options, auto-resubscribe, and more.
 
+**Service Worker Params**
+You can customize the location and filenames of service worker assets. You are also able to specify the specific scope that your service worker should control. You can read more [here](https://documentation.onesignal.com/docs/onesignal-service-worker-faq#sdk-parameter-reference-for-service-workers).
+
+In this distribution, you can specify the parameters via the following:
+
+| Field                      | Details                                                                                                                |
+|----------------------------|------------------------------------------------------------------------------------------------------------------------|
+| `serviceWorkerParam`       | Use to specify the scope, or the path the service worker has control of.  Example:  `{ scope: "/js/push/onesignal/" }` |
+| `serviceWorkerPath`        | The path to the service worker file.                                                                                   |
+
+### Service Worker File
+If you haven't done so already, you will need to add the [OneSignal Service Worker file](https://github.com/OneSignal/OneSignal-Website-SDK/files/7585231/OneSignal-Web-SDK-HTTPS-Integration-Files.zip) to your site ([learn more](https://documentation.onesignal.com/docs/web-push-quickstart#step-6-upload-files)).
+
+The OneSignal SDK file must be publicly accessible. You can put them in your top-level root or a subdirectory. However, if you are placing the file not on top-level root make sure to specify the path via the service worker params in the init options (see section above).
+
+**Tip:**
+Visit `https://yoursite.com/OneSignalSDKWorker.js` in the address bar to make sure the files are being served successfully.
+
 ---
 ## OneSignal API
 ### Typescript
@@ -81,43 +98,43 @@ This package includes Typescript support.
 
 ```ts
 interface OneSignal {
-  init(options?: any): Promise<void>
-  on(event: string, listener: Function): void
-  off(event: string, listener: Function): void
-  once(event: string, listener: Function): void
-  isPushNotificationsEnabled(callback?: Action<boolean>): Promise<boolean>
-  showHttpPrompt(options?: AutoPromptOptions): void
-  registerForPushNotifications(options?: RegisterOptions): Promise<void>
-  setDefaultNotificationUrl(url: string): void
-  setDefaultTitle(title: string): void
-  getTags(callback?: Action<any>): void
-  sendTag(key: string,  value: any,  callback?: Action<Object>): Promise<Object | null>
-  sendTags(tags: TagsObject<any>,  callback?: Action<Object>): Promise<Object | null>
-  deleteTag(tag: string): Promise<Array<string>>
-  deleteTags(tags: Array<string>,  callback?: Action<Array<string>>): Promise<Array<string>>
-  addListenerForNotificationOpened(callback?: Action<Notification>): void
-  setSubscription(newSubscription: boolean): Promise<void>
-  showHttpPermissionRequest(options?: AutoPromptOptions): Promise<any>
-  showNativePrompt(): Promise<void>
-  showSlidedownPrompt(options?: AutoPromptOptions): Promise<void>
-  showCategorySlidedown(options?: AutoPromptOptions): Promise<void>
-  showSmsSlidedown(options?: AutoPromptOptions): Promise<void>
-  showEmailSlidedown(options?: AutoPromptOptions): Promise<void>
-  showSmsAndEmailSlidedown(options?: AutoPromptOptions): Promise<void>
-  getNotificationPermission(onComplete?: Function): Promise<NotificationPermission>
-  getUserId(callback?: Action<string | undefined | null>): Promise<string | undefined | null>
-  getSubscription(callback?: Action<boolean>): Promise<boolean>
-  setEmail(email: string,  options?: SetEmailOptions): Promise<string|null>
-  setSMSNumber(smsNumber: string,  options?: SetSMSOptions): Promise<string | null>
-  logoutEmail(): void
-  logoutSMS(): void
-  setExternalUserId(externalUserId: string | undefined | null,  authHash?: string): Promise<void>
-  removeExternalUserId(): Promise<void>
-  getExternalUserId(): Promise<string | undefined | null>
-  provideUserConsent(consent: boolean): Promise<void>
-  getEmailId(callback?: Action<string | undefined>): Promise<string | null | undefined>
-  getSMSId(callback?: Action<string | undefined>): Promise<string | null | undefined>
-  sendOutcome(outcomeName: string,  outcomeWeight?: number | undefined): Promise<void>
+  init(options: IInitObject): Promise<void>;
+  on(event: string, listener: () => void): void;
+  off(event: string, listener: () => void): void;
+  once(event: string, listener: () => void): void;
+  isPushNotificationsEnabled(callback?: Action<boolean>): Promise<boolean>;
+  showHttpPrompt(options?: AutoPromptOptions): Promise<void>;
+  registerForPushNotifications(options?: RegisterOptions): Promise<void>;
+  setDefaultNotificationUrl(url: string): Promise<void>;
+  setDefaultTitle(title: string): Promise<void>;
+  getTags(callback?: Action<any>): Promise<void>;
+  sendTag(key: string, value: any, callback?: Action<Object>): Promise<Object | null>;
+  sendTags(tags: TagsObject<any>, callback?: Action<Object>): Promise<Object | null>;
+  deleteTag(tag: string): Promise<Array<string>>;
+  deleteTags(tags: Array<string>, callback?: Action<Array<string>>): Promise<Array<string>>;
+  addListenerForNotificationOpened(callback?: Action<Notification>): Promise<void>;
+  setSubscription(newSubscription: boolean): Promise<void>;
+  showHttpPermissionRequest(options?: AutoPromptOptions): Promise<any>;
+  showNativePrompt(): Promise<void>;
+  showSlidedownPrompt(options?: AutoPromptOptions): Promise<void>;
+  showCategorySlidedown(options?: AutoPromptOptions): Promise<void>;
+  showSmsSlidedown(options?: AutoPromptOptions): Promise<void>;
+  showEmailSlidedown(options?: AutoPromptOptions): Promise<void>;
+  showSmsAndEmailSlidedown(options?: AutoPromptOptions): Promise<void>;
+  getNotificationPermission(onComplete?: Action<NotificationPermission>): Promise<NotificationPermission>;
+  getUserId(callback?: Action<string | undefined | null>): Promise<string | undefined | null>;
+  getSubscription(callback?: Action<boolean>): Promise<boolean>;
+  setEmail(email: string, options?: SetEmailOptions): Promise<string | null>;
+  setSMSNumber(smsNumber: string, options?: SetSMSOptions): Promise<string | null>;
+  logoutEmail(): Promise<void>;
+  logoutSMS(): Promise<void>;
+  setExternalUserId(externalUserId: string | undefined | null, authHash?: string): Promise<void>;
+  removeExternalUserId(): Promise<void>;
+  getExternalUserId(): Promise<string | undefined | null>;
+  provideUserConsent(consent: boolean): Promise<void>;
+  getEmailId(callback?: Action<string | undefined>): Promise<string | null | undefined>;
+  getSMSId(callback?: Action<string | undefined>): Promise<string | null | undefined>;
+  sendOutcome(outcomeName: string, outcomeWeight?: number | undefined): Promise<void>;
 }
 ```
 
@@ -127,10 +144,18 @@ See the official [OneSignal WebSDK reference](https://documentation.onesignal.co
 ---
 ## Advanced Usage
 ### Events and Event Listeners
-You can also listen for native OneSignal events like `subscriptionChange`.
+Use listeners to react to OneSignal-related events:
+
+* `subscriptionChange`
+* `permissionPromptDisplay`
+* `notificationPermissionChange`
+* `popoverShown`
+* `customPromptClick`
+* `notificationDisplay`
+* `notificationDismiss`
 
 **Example**
-```
+```js
 OneSignal.on('subscriptionChange', function(isSubscribed) {
   console.log("The user's subscription state is now:", isSubscribed);
 });
@@ -138,9 +163,42 @@ OneSignal.on('subscriptionChange', function(isSubscribed) {
 
 See the [OneSignal WebSDK Reference](https://documentation.onesignal.com/docs/web-push-sdk) for all available event listeners.
 
+## Troubleshooting
+### `window.OneSignal already defined as 'object'!`
+You will get this error if you initialize twice. Make sure you are only initializing one time. When wrapped with `React.StrictMode`, your app might be rendering twice.
+
+## Example App
+This repo includes an `example` React application implementing OneSignal. It was created using `create-react-app`. The app uses this repository's root level directory as the `react-onesignal` package and will bundle any changes on every run.
+
 ---
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/OneSignal/react-onesignal/issues).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## OneSignal
+
+* [Website](https://onesignal.com)
+* Twitter: [@onesignal](https://twitter.com/onesignal)
+* Github: [@OneSignal](https://github.com/OneSignal)
+* LinkedIn: [@onesignal](https://linkedin.com/company/onesignal)
+
+## Discord
+Reach out to us via our [Discord server](https://discord.com/invite/EP7gf6Uz7G)!
+
+## 📝 License
+
+Copyright © 2022 [OneSignal](https://github.com/OneSignal).<br />
+This project is [Modified MIT](https://github.com/OneSignal/react-onesignal/blob/master/LICENSE) licensed.
+
 ## Thanks
 Special thanks to [pedro-lb](https://github.com/pedro-lb) and others for work on the project this package is [based on](https://github.com/pedro-lb/react-onesignal).
 <a href="https://github.com/onesignal/react-onesignal/graphs/contributors">
   <img src="https://user-images.githubusercontent.com/11739227/119415383-1d354700-bcb7-11eb-946d-01c40cd07010.png" />
-</a>
+</a>
+
+Enjoy!

package/dist/index.d.ts

@@ -0,0 +1,105 @@
+declare type Action<T> = (item: T) => void;
+interface AutoPromptOptions {
+    force?: boolean;
+    forceSlidedownOverNative?: boolean;
+    slidedownPromptOptions?: IOneSignalAutoPromptOptions;
+}
+interface RegisterOptions {
+    modalPrompt?: boolean;
+    httpPermissionRequest?: boolean;
+    slidedown?: boolean;
+    autoAccept?: boolean;
+}
+interface SetSMSOptions {
+    identifierAuthHash?: string;
+}
+interface SetEmailOptions {
+    identifierAuthHash?: string;
+    emailAuthHash?: string;
+}
+interface TagsObject<T> {
+    [key: string]: T;
+}
+interface IOneSignalAutoPromptOptions {
+    force?: boolean;
+    forceSlidedownOverNative?: boolean;
+    isInUpdateMode?: boolean;
+    categoryOptions?: IOneSignalCategories;
+}
+interface IOneSignalCategories {
+    positiveUpdateButton: string;
+    negativeUpdateButton: string;
+    savingButtonText: string;
+    errorButtonText: string;
+    updateMessage: string;
+    tags: IOneSignalTagCategory[];
+}
+interface IOneSignalTagCategory {
+    tag: string;
+    label: string;
+    checked?: boolean;
+}
+interface IInitObject {
+    appId: string;
+    subdomainName?: string;
+    requiresUserPrivacyConsent?: boolean;
+    promptOptions?: object;
+    welcomeNotification?: object;
+    notifyButton?: object;
+    persistNotification?: boolean;
+    webhooks?: object;
+    autoResubscribe?: boolean;
+    autoRegister?: boolean;
+    notificationClickHandlerMatch?: string;
+    notificationClickHandlerAction?: string;
+    serviceWorkerParam?: {
+        scope: string;
+    };
+    serviceWorkerPath?: string;
+    serviceWorkerUpdaterPath?: string;
+    path?: string;
+    allowLocalhostAsSecureOrigin?: boolean;
+    [key: string]: any;
+}
+interface IOneSignal {
+    init(options: IInitObject): Promise<void>;
+    on(event: string, listener: (eventData?: any) => void): void;
+    off(event: string, listener: (eventData?: any) => void): void;
+    once(event: string, listener: (eventData?: any) => void): void;
+    isPushNotificationsEnabled(callback?: Action<boolean>): Promise<boolean>;
+    showHttpPrompt(options?: AutoPromptOptions): Promise<void>;
+    registerForPushNotifications(options?: RegisterOptions): Promise<void>;
+    setDefaultNotificationUrl(url: string): Promise<void>;
+    setDefaultTitle(title: string): Promise<void>;
+    getTags(callback?: Action<any>): Promise<void>;
+    sendTag(key: string, value: any, callback?: Action<Object>): Promise<Object | null>;
+    sendTags(tags: TagsObject<any>, callback?: Action<Object>): Promise<Object | null>;
+    deleteTag(tag: string): Promise<Array<string>>;
+    deleteTags(tags: Array<string>, callback?: Action<Array<string>>): Promise<Array<string>>;
+    addListenerForNotificationOpened(callback?: Action<Notification>): Promise<void>;
+    setSubscription(newSubscription: boolean): Promise<void>;
+    showHttpPermissionRequest(options?: AutoPromptOptions): Promise<any>;
+    showNativePrompt(): Promise<void>;
+    showSlidedownPrompt(options?: AutoPromptOptions): Promise<void>;
+    showCategorySlidedown(options?: AutoPromptOptions): Promise<void>;
+    showSmsSlidedown(options?: AutoPromptOptions): Promise<void>;
+    showEmailSlidedown(options?: AutoPromptOptions): Promise<void>;
+    showSmsAndEmailSlidedown(options?: AutoPromptOptions): Promise<void>;
+    getNotificationPermission(onComplete?: Action<NotificationPermission>): Promise<NotificationPermission>;
+    getUserId(callback?: Action<string | undefined | null>): Promise<string | undefined | null>;
+    getSubscription(callback?: Action<boolean>): Promise<boolean>;
+    setEmail(email: string, options?: SetEmailOptions): Promise<string | null>;
+    setSMSNumber(smsNumber: string, options?: SetSMSOptions): Promise<string | null>;
+    logoutEmail(): Promise<void>;
+    logoutSMS(): Promise<void>;
+    setExternalUserId(externalUserId: string | undefined | null, authHash?: string): Promise<void>;
+    removeExternalUserId(): Promise<void>;
+    getExternalUserId(): Promise<string | undefined | null>;
+    provideUserConsent(consent: boolean): Promise<void>;
+    getEmailId(callback?: Action<string | undefined>): Promise<string | null | undefined>;
+    getSMSId(callback?: Action<string | undefined>): Promise<string | null | undefined>;
+    sendOutcome(outcomeName: string, outcomeWeight?: number | undefined): Promise<void>;
+    [index: string]: Function;
+}
+declare const OneSignalReact: IOneSignal;
+export default OneSignalReact;