@onesignal/onesignal-vue3 1.0.2 → 2.0.0-beta.2

package/dist/index.d.ts

@@ -1,12 +1,16 @@
 import { App } from 'vue';
 declare module '@vue/runtime-core' {
     interface ComponentCustomProperties {
-        $OneSignal: IOneSignal;
+        $OneSignal: IOneSignalOneSignal;
     }
 }
 declare global {
     interface Window {
-        OneSignal: any;
+        OneSignalDeferred?: OneSignalDeferredLoadedCallback[];
+        OneSignal?: IOneSignalOneSignal;
+        safari?: {
+            pushNotification: any;
+        };
     }
 }
 declare type Action<T> = (item: T) => void;
@@ -15,22 +19,6 @@ interface AutoPromptOptions {
     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;
@@ -50,6 +38,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;
@@ -72,47 +72,66 @@ interface IInitObject {
     allowLocalhostAsSecureOrigin?: boolean;
     [key: string]: any;
 }
-interface IOneSignal {
+interface IOneSignalOneSignal {
+    Slidedown: IOneSignalSlidedown;
+    Notifications: IOneSignalNotifications;
+    Session: IOneSignalSession;
+    User: IOneSignalUser;
+    Debug: IOneSignalDebug;
+    login(externalId: string, jwtToken?: string): Promise<void>;
+    logout(): Promise<void>;
     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>;
+    setConsentGiven(consent: boolean): Promise<void>;
+    setConsentRequired(requiresConsent: boolean): Promise<void>;
+}
+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 {
+    PushSubscription: IOneSignalPushSubscription;
+    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;
+}
+interface IOneSignalPushSubscription {
+    id: string | null | undefined;
+    token: string | null | undefined;
+    optedIn: boolean | undefined;
+    optIn(): Promise<void>;
+    optOut(): Promise<void>;
+    addEventListener(event: 'subscriptionChange', listener: (change: SubscriptionChangeEvent) => void): void;
+    removeEventListener(event: 'subscriptionChange', listener: (change: SubscriptionChangeEvent) => void): void;
 }
-export declare const useOneSignal: () => IOneSignal;
+export declare const useOneSignal: () => IOneSignalOneSignal;
 declare const OneSignalVuePlugin: {
     install(app: App, options: IInitObject): void;
 };