feat: sync with web-shim-codegen v3.0.1

Author: OneSignal

.eslintrc.cjs

@@ -0,0 +1,38 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    es6: true,
+    node: true,
+    worker: true,
+  },
+  settings: {
+    "import/resolver": {
+      node: {
+        paths: ["src"],
+        extensions: [".js", ".ts"],
+      },
+    },
+  },
+  globals: {
+    Atomics: "readonly",
+    SharedArrayBuffer: "readonly",
+  },
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: "module",
+  },
+  plugins: ["@typescript-eslint"],
+  extends: ["plugin:@typescript-eslint/recommended"],
+  rules: {
+    "prefer-destructuring": 0,
+    "no-param-reassign": 0,
+    "import/extensions": 0,
+    "dot-notation": 0,
+    "no-continue": 0,
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": ["error"],
+    "no-prototype-builtins": "warn",
+  },
+};

.gitignore

@@ -16,4 +16,6 @@ dist
 .env.test.local
 .env.production.local
 
-npm-debug.log*
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

index.ts

@@ -120,16 +120,16 @@ const isPushSupported = (): boolean => {
   return isPushNotificationsSupported();
 }
 
-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' | 'foregroundWillDisplay' | 'dismiss' | 'permissionChange' | 'permissionPromptDisplay';
-type SlidedownEventName = 'slidedownShown';
-type OneSignalDeferredLoadedCallback = (onesignal: IOneSignalOneSignal) => void;
-interface IOSNotification {
+export interface AutoPromptOptions { force?: boolean; forceSlidedownOverNative?: boolean; slidedownPromptOptions?: IOneSignalAutoPromptOptions; }
+export interface IOneSignalAutoPromptOptions { force?: boolean; forceSlidedownOverNative?: boolean; isInUpdateMode?: boolean; categoryOptions?: IOneSignalCategories; }
+export interface IOneSignalCategories { positiveUpdateButton: string; negativeUpdateButton: string; savingButtonText: string; errorButtonText: string; updateMessage: string; tags: IOneSignalTagCategory[]; }
+export interface IOneSignalTagCategory { tag: string; label: string; checked?: boolean; }
+export type PushSubscriptionNamespaceProperties = { id: string | null | undefined; token: string | null | undefined; optedIn: boolean; };
+export type SubscriptionChangeEvent = { previous: PushSubscriptionNamespaceProperties; current: PushSubscriptionNamespaceProperties; };
+export type NotificationEventName = 'click' | 'foregroundWillDisplay' | 'dismiss' | 'permissionChange' | 'permissionPromptDisplay';
+export type SlidedownEventName = 'slidedownShown';
+export type OneSignalDeferredLoadedCallback = (onesignal: IOneSignalOneSignal) => void;
+export interface IOSNotification {
   /**
    * The OneSignal notification id;
    *  - Primary id on OneSignal's REST API and dashboard
@@ -191,7 +191,7 @@ interface IOSNotification {
   readonly confirmDelivery: boolean;
 }
 
-interface IOSNotificationActionButton {
+export interface IOSNotificationActionButton {
   /**
    * Any unique identifier to represent which button was clicked. This is typically passed back to the service worker
    * and host page through events to identify which button was clicked.
@@ -212,50 +212,232 @@ interface IOSNotificationActionButton {
   readonly launchURL?: string;
 }
 
-interface NotificationClickResult {
+export interface NotificationClickResult {
   readonly actionId?: string;
   readonly url?: string;
 }
 
-type NotificationEventTypeMap = {
+export type NotificationEventTypeMap = {
   'click': NotificationClickEvent;
   'foregroundWillDisplay': NotificationForegroundWillDisplayEvent;
   'dismiss': NotificationDismissEvent;
   'permissionChange': boolean;
   'permissionPromptDisplay': void;
 };
 
-interface NotificationForegroundWillDisplayEvent {
+export interface NotificationForegroundWillDisplayEvent {
   readonly notification: IOSNotification;
   preventDefault(): void;
 }
 
-interface NotificationDismissEvent {
+export interface NotificationDismissEvent {
   notification: IOSNotification;
 }
 
-interface NotificationClickEvent {
+export interface NotificationClickEvent {
   readonly notification: IOSNotification;
   readonly result: NotificationClickResult;
 }
 
-type UserChangeEvent = {
+export type UserChangeEvent = {
   current: UserNamespaceProperties;
 };
-type UserNamespaceProperties = {
+export type UserNamespaceProperties = {
   onesignalId: string | undefined;
   externalId: string | undefined;
 };
 
-interface IInitObject {
+export interface IInitObject {
   appId: string;
   subdomainName?: string;
   requiresUserPrivacyConsent?: boolean;
-  promptOptions?: object;
-  welcomeNotification?: object;
-  notifyButton?: object;
+  promptOptions?: {
+    slidedown: {
+      prompts: {
+        /**
+         * Whether to automatically display the prompt.
+         * `true` will display the prompt based on the delay options.
+         * `false` will prevent the prompt from displaying until the Slidedowns methods are used.
+         */
+        autoPrompt: boolean;
+
+        /**
+         * Only available for type: category. Up to 10 categories.
+         * @example
+         *  categories: [{ tag: 'local_news', label: 'Local News' }] // The user will be tagged with local_news but will see "Local News" in the prompt.
+         */
+        categories: {
+          /** Should identify the action. */
+          tag: string;
+
+          /** What the user will see. */
+          label: string;
+        }[];
+
+        /**
+         * The delay options for the prompt.
+         * @example delay: { pageViews: 3, timeDelay: 20 } // The user will not be shown the prompt until 20 seconds after the 3rd page view.
+         */
+        delay: {
+          /** The number of pages a user needs to visit before the prompt is displayed. */
+          pageViews?: number;
+
+          /** The number of seconds a user needs to wait before the prompt is displayed.Both options must be satisfied for the prompt to display */
+          timeDelay?: number;
+        };
+
+        /**
+         * The text to display in the prompt.
+         */
+        text?: {
+          /** The callout asking the user to opt-in. Up to 90 characters. */
+          actionMessage?: string;
+
+          /** Triggers the opt-in. Up to 15 characters. */
+          acceptButton?: string;
+
+          /** Cancels opt-in. Up to 15 characters. */
+          cancelMessage?: string;
+
+          /** The message of the confirmation prompt displayed after the email and/or phone number is provided. Up to 90 characters. */
+          confirmMessage?: string;
+
+          /** Identifies the email text field. Up to 15 characters. */
+          emailLabel?: string;
+
+          /** Cancels the category update. Up to 15 characters. */
+          negativeUpdateButton?: string;
+
+          /** Saves the updated category tags. Up to 15 characters. */
+          positiveUpdateButton?: string;
+
+          /** Identifies the phone number text field. Up to 15 characters. */
+          smsLabel?: string;
+
+          /** A different message shown to subscribers presented the prompt again to update categories. Up to 90 characters. */
+          updateMessage?: string;
+        };
+
+        /**
+         * The type of prompt to display.
+         * `push` which is the Slide Prompt without categories.
+         * `category` which is the Slide Prompt with categories.
+         * `sms` only asks for phone number.
+         * `email` only asks for email address.
+         * `smsAndEmail` asks for both phone number and email address.
+         */
+        type: 'push' | 'category' | 'sms' | 'email' | 'smsAndEmail';
+      }[];
+    };
+  };
+  welcomeNotification?: {
+    /**
+     * Disables sending a welcome notification to new site visitors. If you want to disable welcome notifications, this is the only option you need.
+     */
+    disabled?: boolean;
+
+    /**
+     * The welcome notification's message. You can localize this to your own language.
+     * If left blank or set to blank, the default of 'Thanks for subscribing!' will be used.
+     */
+    message: string;
+
+    /**
+     * The welcome notification's title. You can localize this to your own language. If not set, or left blank, the site's title will be used.
+     * Set to one space ' ' to clear the title, although this is not recommended.
+     */
+    title?: string;
+
+    /**
+     * By default, clicking the welcome notification does not open any link.
+     * This is recommended because the user has just visited your site and subscribed.
+     */
+    url: string;
+  };
+
+  /**
+   * Will enable customization of the notify/subscription bell button.
+   */
+  notifyButton?: {
+    /**
+     * A function you define that returns true to show the Subscription Bell, or false to hide it.
+     * Typically used the hide the Subscription Bell after the user is subscribed.
+     * This function is not re-evaluated on every state change; this function is only evaluated once when the Subscription Bell begins to show.
+     */
+    displayPredicate?: () => boolean | Promise<boolean>;
+
+    /**
+     * Enable the Subscription Bell. The Subscription Bell is otherwise disabled by default.
+     */
+    enable?: boolean;
+
+    /** Specify CSS-valid pixel offsets using bottom, left, and right. */
+    offset?: { bottom: string; left: string; right: string };
+
+    /**
+     * If `true`, the Subscription Bell will display an icon that there is 1 unread message.
+     * When hovering over the Subscription Bell, the user will see custom text set by message.prenotify.
+     */
+    prenotify: boolean;
+
+    /** Either `bottom-left` or `bottom-right`. The Subscription Bell will be fixed at this location on your page. */
+    position?: 'bottom-left' | 'bottom-right';
+
+    /**  Set `false` to hide the 'Powered by OneSignal' text in the Subscription Bell dialog popup. */
+    showCredit: boolean;
+
+    /**
+     * The Subscription Bell will initially appear at one of these sizes, and then shrink down to size `small` after the user subscribes.
+     */
+    size?: 'small' | 'medium' | 'large';
+
+    /** Customize the Subscription Bell text. */
+    text: {
+      'dialog.blocked.message': string;
+      'dialog.blocked.title': string;
+      'dialog.main.button.subscribe': string;
+      'dialog.main.button.unsubscribe': string;
+      'dialog.main.title': string;
+      'message.action.resubscribed': string;
+      'message.action.subscribed': string;
+      'message.action.subscribing': string;
+      'message.action.unsubscribed': string;
+      'message.prenotify': string;
+      'tip.state.blocked': string;
+      'tip.state.subscribed': string;
+      'tip.state.unsubscribed': string;
+    };
+  };
+
   persistNotification?: boolean;
-  webhooks?: object;
+  webhooks?: {
+    /**
+     * Enable this setting only if your server has CORS enabled and supports non-simple CORS requests.
+     * If this setting is disabled, your webhook will not need CORS to receive data, but it will not receive the custom headers.
+     * The simplest option is to leave it disabled.
+     * @default false
+     */
+    cors: boolean;
+
+    /**
+     * This event occurs after a notification is clicked.
+     * @example https://site.com/hook
+     */
+    'notification.clicked'?: string;
+
+    /**
+     * This event occurs after a notification is intentionally dismissed by the user (clicking the notification body or one of the notification action buttons does not trigger the dismissed webhook),
+     * after a group of notifications are all dismissed (with this notification as part of that group), or after a notification expires on its own time and disappears. This event is supported on Chrome only.
+     * @example https://site.com/hook
+     */
+    'notification.dismissed'?: string;
+
+    /**
+     * This event occurs after a notification is displayed.
+     * @example https://site.com/hook
+     */
+    'notification.willDisplay'?: string;
+  };
   autoResubscribe?: boolean;
   autoRegister?: boolean;
   notificationClickHandlerMatch?: string;
@@ -269,7 +451,7 @@ interface IInitObject {
   [key: string]: any;
 }
 
-interface IOneSignalOneSignal {
+export interface IOneSignalOneSignal {
 	Slidedown: IOneSignalSlidedown;
 	Notifications: IOneSignalNotifications;
 	Session: IOneSignalSession;
@@ -281,7 +463,7 @@ interface IOneSignalOneSignal {
 	setConsentGiven(consent: boolean): Promise<void>;
 	setConsentRequired(requiresConsent: boolean): Promise<void>;
 }
-interface IOneSignalNotifications {
+export interface IOneSignalNotifications {
 	permissionNative: NotificationPermission;
 	permission: boolean;
 	setDefaultUrl(url: string): Promise<void>;
@@ -291,7 +473,7 @@ interface IOneSignalNotifications {
 	addEventListener<K extends NotificationEventName>(event: K, listener: (obj: NotificationEventTypeMap[K]) => void): void;
 	removeEventListener<K extends NotificationEventName>(event: K, listener: (obj: NotificationEventTypeMap[K]) => void): void;
 }
-interface IOneSignalSlidedown {
+export interface IOneSignalSlidedown {
 	promptPush(options?: AutoPromptOptions): Promise<void>;
 	promptPushCategories(options?: AutoPromptOptions): Promise<void>;
 	promptSms(options?: AutoPromptOptions): Promise<void>;
@@ -300,14 +482,14 @@ interface IOneSignalSlidedown {
 	addEventListener(event: SlidedownEventName, listener: (wasShown: boolean) => void): void;
 	removeEventListener(event: SlidedownEventName, listener: (wasShown: boolean) => void): void;
 }
-interface IOneSignalDebug {
+export interface IOneSignalDebug {
 	setLogLevel(logLevel: string): void;
 }
-interface IOneSignalSession {
+export interface IOneSignalSession {
 	sendOutcome(outcomeName: string, outcomeWeight?: number): Promise<void>;
 	sendUniqueOutcome(outcomeName: string): Promise<void>;
 }
-interface IOneSignalUser {
+export interface IOneSignalUser {
 	onesignalId: string | undefined;
 	externalId: string | undefined;
 	PushSubscription: IOneSignalPushSubscription;
@@ -329,7 +511,7 @@ interface IOneSignalUser {
 	setLanguage(language: string): void;
 	getLanguage(): string;
 }
-interface IOneSignalPushSubscription {
+export interface IOneSignalPushSubscription {
 	id: string | null | undefined;
 	token: string | null | undefined;
 	optedIn: boolean | undefined;

package.json

@@ -2,7 +2,7 @@
   "name": "@onesignal/onesignal-vue3",
   "version": "2.1.0",
   "description": "Vue 3 OneSignal Plugin: Make it easy to integrate OneSignal with your Vue App!",
-  "author": "rgomezp",
+  "type": "module",
   "contributors": [
     {
       "name": "Rodrigo Gomez-Palacio"