onesignal-vue 1.0.1 → 2.0.0-beta.1

package/README.md

@@ -13,12 +13,25 @@ You can find more information on OneSignal [here](https://onesignal.com/).
 * 🏠 [Homepage](https://onesignal.com)
 * 🖤 [npm](https://www.npmjs.com/package/onesignal-vue)
 
+> 🚧 Version 2 now in Beta! 
+See our [migration guide](./MigrationGuide.md) to get started.
+
 ## Contents
 - [Install](#install)
 - [Usage](#usage)
 - [API](#onesignal-api)
 - [Advanced Usage](#advanced-usage)
 
+---
+## Vue Compatibility
+Make sure you install a plugin version compatible with your Vue environment.
+
+| Vue | OneSignal Plugin |
+|-----|------------------|
+| 2   | onesignal-vue              |
+| 3   | [onesignal-vue3](https://github.com/OneSignal/onesignal-vue3)               |
+
+
 ---
 ## Install
 
@@ -119,43 +132,43 @@ This package includes Typescript support.
 
 ```ts
 interface IOneSignal {
-  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): 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?: 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(): 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>
+  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?: 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(): 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>;
 }
 ```
 
@@ -211,6 +224,3 @@ This project is [Modified MIT](https://github.com/OneSignal/onesignal-vue/blob/m
 
 
 Enjoy!
-
-
-Enjoy!

package/dist/index.d.ts

@@ -1,118 +1,140 @@
-declare const VueApp: any;
-declare module 'vue/types/vue' {
-    interface Vue {
-        $OneSignal: IOneSignal;
-    }
-}
-declare global {
-    interface Window {
-        OneSignal: 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;
-    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: () => 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?: 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(): 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 OneSignalVuePlugin: {
-    install(app: typeof VueApp): void;
-};
-export default OneSignalVuePlugin;
+declare const VueApp: any;
+declare module 'vue/types/vue' {
+    interface Vue {
+        $OneSignal: IOneSignalOneSignal;
+    }
+}
+declare global {
+    interface Window {
+        OneSignalDeferred?: OneSignalDeferredLoadedCallback[];
+        safari?: {
+            pushNotification: any;
+        };
+    }
+}
+type Action<T> = (item: T) => void;
+interface AutoPromptOptions {
+    force?: boolean;
+    forceSlidedownOverNative?: boolean;
+    slidedownPromptOptions?: IOneSignalAutoPromptOptions;
+}
+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;
+}
+type PushSubscriptionNamespaceProperties = {
+    id: string | null | undefined;
+    token: string | null | undefined;
+    optedIn: boolean;
+};
+type SubscriptionChangeEvent = {
+    previous: PushSubscriptionNamespaceProperties;
+    current: PushSubscriptionNamespaceProperties;
+};
+type NotificationEventName = 'click' | 'willDisplay' | 'dismiss' | 'permissionChange' | 'permissionPromptDisplay';
+type SlidedownEventName = 'slidedownShown';
+type OneSignalDeferredLoadedCallback = (onesignal: IOneSignalOneSignal) => void;
+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 IOneSignalOneSignal {
+    login(externalId: string, jwtToken?: string): Promise<void>;
+    logout(): Promise<void>;
+    init(options: IInitObject): Promise<void>;
+    setConsentGiven(consent: boolean): Promise<void>;
+    setConsentRequired(requiresConsent: boolean): Promise<void>;
+    Slidedown: IOneSignalSlidedown;
+    Notifications: IOneSignalNotifications;
+    Session: IOneSignalSession;
+    User: IOneSignalUser;
+    Debug: IOneSignalDebug;
+    [index: string]: any;
+}
+interface IOneSignalNotifications {
+    setDefaultUrl(url: string): Promise<void>;
+    setDefaultTitle(title: string): Promise<void>;
+    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;
+    [index: string]: any;
+}
+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;
+    [index: string]: any;
+}
+interface IOneSignalDebug {
+    setLogLevel(logLevel: string): void;
+    [index: string]: any;
+}
+interface IOneSignalSession {
+    sendOutcome(outcomeName: string, outcomeWeight?: number): Promise<void>;
+    sendUniqueOutcome(outcomeName: string): Promise<void>;
+    [index: string]: any;
+}
+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;
+    [index: string]: any;
+}
+interface IOneSignalPushSubscription {
+    optIn(): Promise<void>;
+    optOut(): Promise<void>;
+    addEventListener(event: 'subscriptionChange', listener: (change: SubscriptionChangeEvent) => void): void;
+    removeEventListener(event: 'subscriptionChange', listener: (change: SubscriptionChangeEvent) => void): void;
+    [index: string]: any;
+}
+declare const OneSignalVuePlugin: {
+    install(app: typeof VueApp): void;
+};
+export default OneSignalVuePlugin;