react-onesignal 2.0.3 → 3.0.0-beta.1

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
@@ -99,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>;
 }
 ```
 
@@ -145,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);
 });
@@ -156,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

@@ -1,25 +1,17 @@
+declare global {
+    interface Window {
+        OneSignalDeferred?: OneSignalDeferredLoadedCallback[];
+        safari?: {
+            pushNotification: any;
+        };
+    }
+}
 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;
@@ -39,6 +31,18 @@ interface IOneSignalTagCategory {
     label: string;
     checked?: boolean;
 }
+declare type PushSubscriptionNamespaceProperties = {
+    id: string | null | undefined;
+    token: string | null | undefined;
+    optedIn: boolean;
+};
+declare type SubscriptionChangeEvent = {
+    previous: PushSubscriptionNamespaceProperties;
+    current: PushSubscriptionNamespaceProperties;
+};
+declare type NotificationEventName = 'click' | 'willDisplay' | 'dismiss' | 'permissionChange' | 'permissionPromptDisplay';
+declare type SlidedownEventName = 'slidedownShown';
+declare type OneSignalDeferredLoadedCallback = (onesignal: IOneSignalOneSignal) => void;
 interface IInitObject {
     appId: string;
     subdomainName?: string;
@@ -61,45 +65,61 @@ interface IInitObject {
     allowLocalhostAsSecureOrigin?: boolean;
     [key: string]: any;
 }
-interface IOneSignal {
+interface IOneSignalOneSignal {
+    login(externalId: string, jwtToken?: string): Promise<void>;
+    logout(): 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>;
+    setConsentGiven(consent: boolean): Promise<void>;
+    setConsentRequired(requiresConsent: boolean): Promise<void>;
+    Slidedown: IOneSignalSlidedown;
+    Notifications: IOneSignalNotifications;
+    Session: IOneSignalSession;
+    User: IOneSignalUser;
+    Debug: IOneSignalDebug;
+}
+interface IOneSignalNotifications {
+    setDefaultUrl(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;
+    isPushSupported(): boolean;
+    getPermissionStatus(onComplete: Action<NotificationPermission>): Promise<NotificationPermission>;
+    requestPermission(): Promise<void>;
+    addEventListener(event: NotificationEventName, listener: (obj: any) => void): void;
+    removeEventListener(event: NotificationEventName, listener: (obj: any) => void): void;
+}
+interface IOneSignalSlidedown {
+    promptPush(options?: AutoPromptOptions): Promise<void>;
+    promptPushCategories(options?: AutoPromptOptions): Promise<void>;
+    promptSms(options?: AutoPromptOptions): Promise<void>;
+    promptEmail(options?: AutoPromptOptions): Promise<void>;
+    promptSmsAndEmail(options?: AutoPromptOptions): Promise<void>;
+    addEventListener(event: SlidedownEventName, listener: (wasShown: boolean) => void): void;
+    removeEventListener(event: SlidedownEventName, listener: (wasShown: boolean) => void): void;
+}
+interface IOneSignalDebug {
+    setLogLevel(logLevel: string): void;
+}
+interface IOneSignalSession {
+    sendOutcome(outcomeName: string, outcomeWeight?: number): Promise<void>;
+    sendUniqueOutcome(outcomeName: string): Promise<void>;
+}
+interface IOneSignalUser {
+    addAlias(label: string, id: string): void;
+    addAliases(aliases: {
+        [key: string]: string;
+    }): void;
+    removeAlias(label: string): void;
+    removeAliases(labels: string[]): void;
+    addEmail(email: string): void;
+    removeEmail(email: string): void;
+    addSms(smsNumber: string): void;
+    removeSms(smsNumber: string): void;
+    PushSubscription: IOneSignalPushSubscription;
+}
+interface IOneSignalPushSubscription {
+    optIn(): Promise<void>;
+    optOut(): Promise<void>;
+    addEventListener(event: 'subscriptionChange', listener: (change: SubscriptionChangeEvent) => void): void;
+    removeEventListener(event: 'subscriptionChange', listener: (change: SubscriptionChangeEvent) => void): void;
 }
-declare const OneSignalReact: IOneSignal;
-export default OneSignalReact;
+declare const OneSignal: IOneSignalOneSignal;
+export default OneSignal;