onesignal-vue 1.0.0-beta2 → 1.0.1

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

@@ -1,4 +1,7 @@
-# onesignal-vue
+<h1 align="center">welcome to onesignal-vue 👋</h1>
+
+[![npm version](https://img.shields.io/npm/v/onesignal-vue.svg)](https://www.npmjs.com/package/onesignal-vue) [![npm downloads](https://img.shields.io/npm/dm/onesignal-vue.svg)](https://www.npmjs.com/package/onesignal-vue)
+
 Vue OneSignal Plugin: Make it easy to integrate OneSignal with your Vue App!
 
 This is a JavaScript module that can be used to easily include [OneSignal](https://onesignal.com/) code in a website or app that uses Vue for its front-end codebase.
@@ -7,6 +10,9 @@ OneSignal is the world's leader for Mobile Push Notifications, Web Push, and In-
 
 You can find more information on OneSignal [here](https://onesignal.com/).
 
+* 🏠 [Homepage](https://onesignal.com)
+* 🖤 [npm](https://www.npmjs.com/package/onesignal-vue)
+
 ## Contents
 - [Install](#install)
 - [Usage](#usage)
@@ -88,6 +94,24 @@ export default {
 ### 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
@@ -141,10 +165,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);
 });
@@ -152,4 +184,33 @@ OneSignal.on('subscriptionChange', function(isSubscribed) {
 
 See the [OneSignal WebSDK Reference](https://documentation.onesignal.com/docs/web-push-sdk) for all available event listeners.
 
+---
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/OneSignal/onesignal-vue/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/onesignal-vue/blob/main/LICENSE) licensed.
+
+
+Enjoy!
+
+
 Enjoy!

package/dist/index.d.ts

@@ -9,9 +9,7 @@ declare global {
         OneSignal: any;
     }
 }
-interface Action<T> {
-    (item: T): void;
-}
+declare type Action<T> = (item: T) => void;
 interface AutoPromptOptions {
     force?: boolean;
     forceSlidedownOverNative?: boolean;
@@ -47,16 +45,38 @@ interface IOneSignalCategories {
     updateMessage: string;
     tags: IOneSignalTagCategory[];
 }
-export interface 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?: any): Promise<void>;
-    on(event: string, listener: Function): void;
-    off(event: string, listener: Function): void;
-    once(event: string, listener: Function): 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>;

package/dist/index.es.js

@@ -8569,7 +8569,6 @@ var setupOneSignalIfMissing = function () {
 };
 /* O N E S I G N A L   A P I  */
 function init(options) {
-    if (options === void 0) { options = {}; }
     return new Promise(function (resolve) {
         if (isOneSignalInitialized) {
             return;
@@ -8593,7 +8592,7 @@ function init(options) {
 function on(event, listener) {
     if (!doesOneSignalExist()) {
         vueOneSignalFunctionQueue.push({
-            name: "on",
+            name: 'on',
             args: arguments,
         });
         return;
@@ -8605,7 +8604,7 @@ function on(event, listener) {
 function off(event, listener) {
     if (!doesOneSignalExist()) {
         vueOneSignalFunctionQueue.push({
-            name: "off",
+            name: 'off',
             args: arguments,
         });
         return;
@@ -8617,7 +8616,7 @@ function off(event, listener) {
 function once$1(event, listener) {
     if (!doesOneSignalExist()) {
         vueOneSignalFunctionQueue.push({
-            name: "once",
+            name: 'once',
             args: arguments,
         });
         return;
@@ -8630,7 +8629,7 @@ function isPushNotificationsEnabled(callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "isPushNotificationsEnabled",
+                name: 'isPushNotificationsEnabled',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8647,7 +8646,7 @@ function showHttpPrompt(options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "showHttpPrompt",
+                name: 'showHttpPrompt',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8664,7 +8663,7 @@ function registerForPushNotifications(options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "registerForPushNotifications",
+                name: 'registerForPushNotifications',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8681,7 +8680,7 @@ function setDefaultNotificationUrl(url) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "setDefaultNotificationUrl",
+                name: 'setDefaultNotificationUrl',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8698,7 +8697,7 @@ function setDefaultTitle(title) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "setDefaultTitle",
+                name: 'setDefaultTitle',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8715,7 +8714,7 @@ function getTags(callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "getTags",
+                name: 'getTags',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8732,7 +8731,7 @@ function sendTag(key, value, callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "sendTag",
+                name: 'sendTag',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8749,7 +8748,7 @@ function sendTags(tags, callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "sendTags",
+                name: 'sendTags',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8766,7 +8765,7 @@ function deleteTag(tag) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "deleteTag",
+                name: 'deleteTag',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8783,7 +8782,7 @@ function deleteTags(tags, callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "deleteTags",
+                name: 'deleteTags',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8800,7 +8799,7 @@ function addListenerForNotificationOpened(callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "addListenerForNotificationOpened",
+                name: 'addListenerForNotificationOpened',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8817,7 +8816,7 @@ function setSubscription(newSubscription) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "setSubscription",
+                name: 'setSubscription',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8834,7 +8833,7 @@ function showHttpPermissionRequest(options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "showHttpPermissionRequest",
+                name: 'showHttpPermissionRequest',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8851,7 +8850,7 @@ function showNativePrompt() {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "showNativePrompt",
+                name: 'showNativePrompt',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8868,7 +8867,7 @@ function showSlidedownPrompt(options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "showSlidedownPrompt",
+                name: 'showSlidedownPrompt',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8885,7 +8884,7 @@ function showCategorySlidedown(options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "showCategorySlidedown",
+                name: 'showCategorySlidedown',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8902,7 +8901,7 @@ function showSmsSlidedown(options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "showSmsSlidedown",
+                name: 'showSmsSlidedown',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8919,7 +8918,7 @@ function showEmailSlidedown(options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "showEmailSlidedown",
+                name: 'showEmailSlidedown',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8936,7 +8935,7 @@ function showSmsAndEmailSlidedown(options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "showSmsAndEmailSlidedown",
+                name: 'showSmsAndEmailSlidedown',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8953,7 +8952,7 @@ function getNotificationPermission(onComplete) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "getNotificationPermission",
+                name: 'getNotificationPermission',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8970,7 +8969,7 @@ function getUserId(callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "getUserId",
+                name: 'getUserId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -8987,7 +8986,7 @@ function getSubscription(callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "getSubscription",
+                name: 'getSubscription',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9004,7 +9003,7 @@ function setEmail(email, options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "setEmail",
+                name: 'setEmail',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9021,7 +9020,7 @@ function setSMSNumber(smsNumber, options) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "setSMSNumber",
+                name: 'setSMSNumber',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9038,7 +9037,7 @@ function logoutEmail() {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "logoutEmail",
+                name: 'logoutEmail',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9055,7 +9054,7 @@ function logoutSMS() {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "logoutSMS",
+                name: 'logoutSMS',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9072,7 +9071,7 @@ function setExternalUserId(externalUserId, authHash) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "setExternalUserId",
+                name: 'setExternalUserId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9089,7 +9088,7 @@ function removeExternalUserId() {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "removeExternalUserId",
+                name: 'removeExternalUserId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9106,7 +9105,7 @@ function getExternalUserId() {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "getExternalUserId",
+                name: 'getExternalUserId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9123,7 +9122,7 @@ function provideUserConsent(consent) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "provideUserConsent",
+                name: 'provideUserConsent',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9140,7 +9139,7 @@ function getEmailId(callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "getEmailId",
+                name: 'getEmailId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9157,7 +9156,7 @@ function getSMSId(callback) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "getSMSId",
+                name: 'getSMSId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -9174,7 +9173,7 @@ function sendOutcome(outcomeName, outcomeWeight) {
     return new Promise(function (resolve, reject) {
         if (!doesOneSignalExist()) {
             vueOneSignalFunctionQueue.push({
-                name: "sendOutcome",
+                name: 'sendOutcome',
                 args: arguments,
                 promiseResolver: resolve,
             });