react-onesignal - npm Package Compare versions

Comparing version 1.6.11 to 1.7.0

dist/index.es.js

@@ -201,2 +201,38 @@ import { useRef, useEffect, useState } from 'react';
 /**
+ * Shows a sliding modal prompt on the page for users.
+ */
+var showSlidedownPrompt = function (options) { return new Promise(function (resolve, reject) {
+    var oneSignal = getOneSignalInstance();
+    if (!oneSignal) {
+        reject(new Error(ONESIGNAL_NOT_SETUP_ERROR));
+        return;
+    }
+    try {
+        oneSignal.showSlidedownPrompt(options)
+            .then((function (value) { return resolve(value); }))
+            .catch(function (error) { return reject(error); });
+    }
+    catch (error) {
+        reject(error);
+    }
+}); };
+/**
+ * Shows a category sliding modal prompt on the page for users.
+ */
+var showCategorySlidedown = function (options) { return new Promise(function (resolve, reject) {
+    var oneSignal = getOneSignalInstance();
+    if (!oneSignal) {
+        reject(new Error(ONESIGNAL_NOT_SETUP_ERROR));
+        return;
+    }
+    try {
+        oneSignal.showCategorySlidedown(options)
+            .then((function (value) { return resolve(value); }))
+            .catch(function (error) { return reject(error); });
+    }
+    catch (error) {
+        reject(error);
+    }
+}); };
+/**
  * Check if the user has already accepted push notifications and
@@ -437,2 +473,4 @@ * successfully registered with Google's FCM server and OneSignal's
     registerForPushNotifications: registerForPushNotifications,
+    showSlidedownPrompt: showSlidedownPrompt,
+    showCategorySlidedown: showCategorySlidedown,
     isPushNotificationsEnabled: isPushNotificationsEnabled,
@@ -439,0 +477,0 @@ isPushNotificationsSupported: isPushNotificationsSupported,

dist/index.js

@@ -205,2 +205,38 @@ 'use strict';
 /**
+ * Shows a sliding modal prompt on the page for users.
+ */
+var showSlidedownPrompt = function (options) { return new Promise(function (resolve, reject) {
+    var oneSignal = getOneSignalInstance();
+    if (!oneSignal) {
+        reject(new Error(ONESIGNAL_NOT_SETUP_ERROR));
+        return;
+    }
+    try {
+        oneSignal.showSlidedownPrompt(options)
+            .then((function (value) { return resolve(value); }))
+            .catch(function (error) { return reject(error); });
+    }
+    catch (error) {
+        reject(error);
+    }
+}); };
+/**
+ * Shows a category sliding modal prompt on the page for users.
+ */
+var showCategorySlidedown = function (options) { return new Promise(function (resolve, reject) {
+    var oneSignal = getOneSignalInstance();
+    if (!oneSignal) {
+        reject(new Error(ONESIGNAL_NOT_SETUP_ERROR));
+        return;
+    }
+    try {
+        oneSignal.showCategorySlidedown(options)
+            .then((function (value) { return resolve(value); }))
+            .catch(function (error) { return reject(error); });
+    }
+    catch (error) {
+        reject(error);
+    }
+}); };
+/**
  * Check if the user has already accepted push notifications and
@@ -441,2 +477,4 @@ * successfully registered with Google's FCM server and OneSignal's
     registerForPushNotifications: registerForPushNotifications,
+    showSlidedownPrompt: showSlidedownPrompt,
+    showCategorySlidedown: showCategorySlidedown,
     isPushNotificationsEnabled: isPushNotificationsEnabled,
@@ -443,0 +481,0 @@ isPushNotificationsSupported: isPushNotificationsSupported,

dist/oneSignal.d.ts

@@ -1,2 +0,2 @@
-import { IOneSignal, OneSignalOptions, IOneSignalEvent } from './oneSignal.types';
+import { IOneSignal, OneSignalOptions, IOneSignalEvent, IOneSignalAutoPromptOptions } from './oneSignal.types';
 /**
@@ -15,2 +15,4 @@ * Gets the window OneSignal instance.
     registerForPushNotifications: () => Promise<any>;
+    showSlidedownPrompt: (options?: IOneSignalAutoPromptOptions | undefined) => Promise<void>;
+    showCategorySlidedown: (options?: IOneSignalAutoPromptOptions | undefined) => Promise<void>;
     isPushNotificationsEnabled: () => Promise<boolean>;
@@ -17,0 +19,0 @@ isPushNotificationsSupported: () => boolean | null;

dist/oneSignal.types.d.ts

 export interface IOneSignal {
     notificationPermission: string[];
     registerForPushNotifications: () => Promise<any>;
+    showSlidedownPrompt: (options?: IOneSignalAutoPromptOptions) => Promise<any>;
+    showCategorySlidedown: (options?: IOneSignalAutoPromptOptions) => Promise<any>;
     getNotificationPermission: () => Promise<string>;
@@ -57,1 +59,20 @@ isPushNotificationsEnabled: () => Promise<boolean>;
 }
+export interface IOneSignalTagCategory {
+    tag: string;
+    label: string;
+    checked?: boolean;
+}
+export interface IOneSignalCategories {
+    positiveUpdateButton: string;
+    negativeUpdateButton: string;
+    savingButtonText: string;
+    errorButtonText: string;
+    updateMessage: string;
+    tags: IOneSignalTagCategory[];
+}
+export interface IOneSignalAutoPromptOptions {
+    force?: boolean;
+    forceSlidedownOverNative?: boolean;
+    isInUpdateMode?: boolean;
+    categoryOptions?: IOneSignalCategories;
+}

package.json

 {
   "name": "react-onesignal",
-  "version": "1.6.11",
+  "version": "1.7.0",
   "description": "React OneSignal Module: Make it easy to integrate OneSignal with your React App!",
@@ -5,0 +5,0 @@ "author": "pedro-lb",

src/oneSignal.ts

@@ -1,2 +0,4 @@
-import { IOneSignal, OneSignalOptions, IOneSignalEvent } from './oneSignal.types';
+import {
+  IOneSignal, OneSignalOptions, IOneSignalEvent, IOneSignalAutoPromptOptions,
+} from './oneSignal.types';
 
@@ -250,2 +252,46 @@ const DEFAULT_BASE_SCRIPT_ID = 'react-onesignal-base';
 /**
+ * Shows a sliding modal prompt on the page for users.
+ */
+const showSlidedownPrompt = (
+  options?: IOneSignalAutoPromptOptions,
+) => new Promise<void>((resolve, reject) => {
+  const oneSignal = getOneSignalInstance();
+
+  if (!oneSignal) {
+    reject(new Error(ONESIGNAL_NOT_SETUP_ERROR));
+    return;
+  }
+
+  try {
+    oneSignal.showSlidedownPrompt(options)
+      .then(((value) => resolve(value)))
+      .catch((error) => reject(error));
+  } catch (error) {
+    reject(error);
+  }
+});
+
+/**
+ * Shows a category sliding modal prompt on the page for users.
+ */
+const showCategorySlidedown = (
+  options?: IOneSignalAutoPromptOptions,
+) => new Promise<void>((resolve, reject) => {
+  const oneSignal = getOneSignalInstance();
+
+  if (!oneSignal) {
+    reject(new Error(ONESIGNAL_NOT_SETUP_ERROR));
+    return;
+  }
+
+  try {
+    oneSignal.showCategorySlidedown(options)
+      .then(((value) => resolve(value)))
+      .catch((error) => reject(error));
+  } catch (error) {
+    reject(error);
+  }
+});
+
+/**
  * Check if the user has already accepted push notifications and
@@ -515,2 +561,4 @@ * successfully registered with Google's FCM server and OneSignal's
   registerForPushNotifications,
+  showSlidedownPrompt,
+  showCategorySlidedown,
   isPushNotificationsEnabled,
@@ -517,0 +565,0 @@ isPushNotificationsSupported,

src/oneSignal.types.ts

 export interface IOneSignal {
   notificationPermission: string[];
   registerForPushNotifications: () => Promise<any>;
+  showSlidedownPrompt: (options?: IOneSignalAutoPromptOptions) => Promise<any>;
+  showCategorySlidedown: (options?: IOneSignalAutoPromptOptions) => Promise<any>;
   getNotificationPermission: () => Promise<string>;
@@ -61,1 +63,23 @@ isPushNotificationsEnabled: () => Promise<boolean>;
 }
+
+export interface IOneSignalTagCategory {
+  tag: string;
+  label: string;
+  checked?: boolean;
+}
+
+export interface IOneSignalCategories {
+  positiveUpdateButton: string;
+  negativeUpdateButton: string;
+  savingButtonText: string;
+  errorButtonText: string;
+  updateMessage: string;
+  tags: IOneSignalTagCategory[];
+}
+
+export interface IOneSignalAutoPromptOptions {
+  force?: boolean;
+  forceSlidedownOverNative?: boolean;
+  isInUpdateMode?: boolean;
+  categoryOptions?: IOneSignalCategories;
+}

No alert changes

Improved metrics

Total package byte prevSize

124616

increased by8.18%

Lines of code

1923

increased by9.2%

No dependency changes