@capacitor/push-notifications 1.0.3 → 1.0.8

package/CHANGELOG.md

@@ -3,6 +3,55 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.8](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/push-notifications@1.0.7...@capacitor/push-notifications@1.0.8) (2022-01-10)
+
+**Note:** Version bump only for package @capacitor/push-notifications
+
+
+
+
+
+## [1.0.7](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/push-notifications@1.0.6...@capacitor/push-notifications@1.0.7) (2021-11-03)
+
+**Note:** Version bump only for package @capacitor/push-notifications
+
+
+
+
+
+## [1.0.6](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/push-notifications@1.0.5...@capacitor/push-notifications@1.0.6) (2021-10-14)
+
+
+### Bug Fixes
+
+* remove postpublish scripts ([#656](https://github.com/ionic-team/capacitor-plugins/issues/656)) ([ed6ac49](https://github.com/ionic-team/capacitor-plugins/commit/ed6ac499ebf4a47525071ccbfc36c27503e11f60))
+
+
+
+
+
+## [1.0.5](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/push-notifications@1.0.4...@capacitor/push-notifications@1.0.5) (2021-10-13)
+
+
+### Bug Fixes
+
+* correct addListeners links ([#655](https://github.com/ionic-team/capacitor-plugins/issues/655)) ([f9871e7](https://github.com/ionic-team/capacitor-plugins/commit/f9871e7bd53478addb21155e148829f550c0e457))
+
+
+
+
+
+## [1.0.4](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/push-notifications@1.0.3...@capacitor/push-notifications@1.0.4) (2021-09-01)
+
+
+### Bug Fixes
+
+* **push-notifications:** Throw errors if missing mandatory channel fields ([#576](https://github.com/ionic-team/capacitor-plugins/issues/576)) ([50f4e70](https://github.com/ionic-team/capacitor-plugins/commit/50f4e7026e5cae5f0871d4863bfab36989208064))
+
+
+
+
+
 ## [1.0.3](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/push-notifications@1.0.2...@capacitor/push-notifications@1.0.3) (2021-07-07)
 
 **Note:** Version bump only for package @capacitor/push-notifications

package/CapacitorPushNotifications.podspec

@@ -7,10 +7,10 @@ Pod::Spec.new do |s|
   s.version = package['version']
   s.summary = package['description']
   s.license = package['license']
-  s.homepage = package['repository']['url']
+  s.homepage = 'https://capacitorjs.com'
   s.author = package['author']
-  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
-  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.source = { :git => 'https://github.com/ionic-team/capacitor-plugins.git', :tag => package['name'] + '@' + package['version'] }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}', 'push-notifications/ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target  = '12.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'

package/README.md

@@ -109,6 +109,49 @@ On Android, there are various system and app states that can affect the delivery
 
 ---
 
+## Example
+
+```typescript
+import { PushNotifications } from '@capacitor/push-notifications';
+
+const addListeners = async () => {
+  await PushNotifications.addListener('registration', token => {
+    console.info('Registration token: ', token.value);
+  });
+
+  await PushNotifications.addListener('registrationError', err => {
+    console.error('Registration error: ', err.error);
+  });
+
+  await PushNotifications.addListener('pushNotificationReceived', notification => {
+    console.log('Push notification received: ', notification);
+  });
+
+  await PushNotifications.addListener('pushNotificationActionPerformed', notification => {
+    console.log('Push notification action performed', notification.actionId, notification.inputValue);
+  });
+}
+
+const registerNotifications = async () => {
+  let permStatus = await PushNotifications.checkPermissions();
+
+  if (permStatus.receive === 'prompt') {
+    permStatus = await PushNotifications.requestPermissions();
+  }
+
+  if (permStatus.receive !== 'granted') {
+    throw new Error('User denied permissions!');
+  }
+
+  await PushNotifications.register();
+}
+
+const getDeliveredNotifications = async () => {
+  const notificationList = await PushNotifications.getDeliveredNotifications();
+  console.log('delivered notifications', notificationList);
+}
+```
+
 ## API
 
 <docgen-index>
@@ -122,10 +165,10 @@ On Android, there are various system and app states that can affect the delivery
 * [`listChannels()`](#listchannels)
 * [`checkPermissions()`](#checkpermissions)
 * [`requestPermissions()`](#requestpermissions)
-* [`addListener('registration', ...)`](#addlistenerregistration-)
-* [`addListener('registrationError', ...)`](#addlistenerregistrationerror-)
-* [`addListener('pushNotificationReceived', ...)`](#addlistenerpushnotificationreceived-)
-* [`addListener('pushNotificationActionPerformed', ...)`](#addlistenerpushnotificationactionperformed-)
+* [`addListener('registration', ...)`](#addlistenerregistration)
+* [`addListener('registrationError', ...)`](#addlistenerregistrationerror)
+* [`addListener('pushNotificationReceived', ...)`](#addlistenerpushnotificationreceived)
+* [`addListener('pushNotificationActionPerformed', ...)`](#addlistenerpushnotificationactionperformed)
 * [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
@@ -475,11 +518,15 @@ Remove all native listeners for this plugin.
 
 #### Importance
 
+The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)
+
 <code>1 | 2 | 3 | 4 | 5</code>
 
 
 #### Visibility
 
+The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)
+
 <code>-1 | 0 | 1</code>
 
 

package/android/src/main/java/com/capacitorjs/plugins/pushnotifications/NotificationChannelManager.java

@@ -38,11 +38,26 @@ public class NotificationChannelManager {
     public void createChannel(PluginCall call) {
         if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O) {
             JSObject channel = new JSObject();
-            channel.put(CHANNEL_ID, call.getString(CHANNEL_ID));
-            channel.put(CHANNEL_NAME, call.getString(CHANNEL_NAME));
+            if (call.getString(CHANNEL_ID) != null) {
+                channel.put(CHANNEL_ID, call.getString(CHANNEL_ID));
+            } else {
+                call.reject("Channel missing identifier");
+                return;
+            }
+            if (call.getString(CHANNEL_NAME) != null) {
+                channel.put(CHANNEL_NAME, call.getString(CHANNEL_NAME));
+            } else {
+                call.reject("Channel missing name");
+                return;
+            }
+            if (call.getInt(CHANNEL_IMPORTANCE) != null) {
+                channel.put(CHANNEL_IMPORTANCE, call.getInt(CHANNEL_IMPORTANCE));
+            } else {
+                call.reject("Channel missing importance");
+                return;
+            }
             channel.put(CHANNEL_DESCRIPTION, call.getString(CHANNEL_DESCRIPTION, ""));
             channel.put(CHANNEL_VISIBILITY, call.getInt(CHANNEL_VISIBILITY, NotificationCompat.VISIBILITY_PUBLIC));
-            channel.put(CHANNEL_IMPORTANCE, call.getInt(CHANNEL_IMPORTANCE));
             channel.put(CHANNEL_SOUND, call.getString(CHANNEL_SOUND, null));
             channel.put(CHANNEL_VIBRATE, call.getBoolean(CHANNEL_VIBRATE, false));
             channel.put(CHANNEL_USE_LIGHTS, call.getBoolean(CHANNEL_USE_LIGHTS, false));

package/dist/docs.json

@@ -199,7 +199,7 @@
           "PluginListenerHandle",
           "Token"
         ],
-        "slug": "addlistenerregistration-"
+        "slug": "addlistenerregistration"
       },
       {
         "name": "addListener",
@@ -227,7 +227,7 @@
         "complexTypes": [
           "PluginListenerHandle"
         ],
-        "slug": "addlistenerregistrationerror-"
+        "slug": "addlistenerregistrationerror"
       },
       {
         "name": "addListener",
@@ -256,7 +256,7 @@
           "PluginListenerHandle",
           "PushNotificationSchema"
         ],
-        "slug": "addlistenerpushnotificationreceived-"
+        "slug": "addlistenerpushnotificationreceived"
       },
       {
         "name": "addListener",
@@ -285,7 +285,7 @@
           "PluginListenerHandle",
           "ActionPerformed"
         ],
-        "slug": "addlistenerpushnotificationactionperformed-"
+        "slug": "addlistenerpushnotificationactionperformed"
       },
       {
         "name": "removeAllListeners",
@@ -735,7 +735,7 @@
     {
       "name": "Importance",
       "slug": "importance",
-      "docs": "",
+      "docs": "The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)",
       "types": [
         {
           "text": "1",
@@ -762,7 +762,7 @@
     {
       "name": "Visibility",
       "slug": "visibility",
-      "docs": "",
+      "docs": "The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)",
       "types": [
         {
           "text": "-1",

package/dist/esm/definitions.d.ts

@@ -325,7 +325,15 @@ export interface Channel {
      */
     vibration?: boolean;
 }
+/**
+ * The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)
+ * @since 1.0.0
+ */
 export declare type Importance = 1 | 2 | 3 | 4 | 5;
+/**
+ * The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)
+ * @since 1.0.0
+ */
 export declare type Visibility = -1 | 0 | 1;
 export interface ListChannelsResult {
     /**

package/dist/plugin.js

@@ -9,5 +9,5 @@ var capacitorPushNotifications = (function (exports, core) {
 
 	return exports;
 
-}({}, capacitorExports));
+})({}, capacitorExports);
 //# sourceMappingURL=plugin.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/push-notifications",
-  "version": "1.0.3",
+  "version": "1.0.8",
   "description": "The Push Notifications API provides access to native push notifications.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -33,7 +33,7 @@
     "verify:android": "cd android && ./gradlew clean build test && cd ..",
     "verify:web": "npm run build",
     "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
-    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- autocorrect --format",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
     "eslint": "eslint . --ext ts",
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
     "swiftlint": "node-swiftlint",
@@ -41,13 +41,14 @@
     "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "publish:cocoapod": "pod trunk push ./CapacitorPushNotifications.podspec --allow-warnings"
   },
   "devDependencies": {
     "@capacitor/android": "^3.0.0",
     "@capacitor/cli": "^3.0.0",
     "@capacitor/core": "^3.0.0",
-    "@capacitor/docgen": "0.0.17",
+    "@capacitor/docgen": "0.0.18",
     "@capacitor/ios": "^3.0.0",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",
@@ -79,5 +80,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "671617ad0a766b122a262c468aa19d0558876be2"
+  "gitHead": "e5b333320426ee120d4504c68c02bd5538b21c51"
 }