@capacitor/push-notifications - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+# [0.3.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/push-notifications@0.2.0...@capacitor/push-notifications@0.3.0) (2021-01-14)
+
+**Note:** Version bump only for package @capacitor/push-notifications
+
+
+
+
+
 # [0.2.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/push-notifications@0.1.0...@capacitor/push-notifications@0.2.0) (2021-01-13)
@@ -8,0 +16,0 @@

dist/docs.json

@@ -541,4 +541,6 @@ {
           "docs": "The level of interruption for notifications posted to this channel.",
-          "complexTypes": [],
-          "type": "1 | 2 | 5 | 4 | 3"
+          "complexTypes": [
+            "Importance"
+          ],
+          "type": "Importance"
         },
@@ -554,4 +556,6 @@ {
           "docs": "The visibility of notifications posted to this channel.\n\nThis setting is for whether notifications posted to this channel appear on\nthe lockscreen or not, and if so, whether they appear in a redacted form.",
-          "complexTypes": [],
-          "type": "0 | 1 | -1 | undefined"
+          "complexTypes": [
+            "Visibility"
+          ],
+          "type": "Visibility"
         },
@@ -730,2 +734,48 @@ {
     {
+      "name": "Importance",
+      "slug": "importance",
+      "docs": "",
+      "types": [
+        {
+          "text": "1",
+          "complexTypes": []
+        },
+        {
+          "text": "2",
+          "complexTypes": []
+        },
+        {
+          "text": "3",
+          "complexTypes": []
+        },
+        {
+          "text": "4",
+          "complexTypes": []
+        },
+        {
+          "text": "5",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "Visibility",
+      "slug": "visibility",
+      "docs": "",
+      "types": [
+        {
+          "text": "-1",
+          "complexTypes": []
+        },
+        {
+          "text": "0",
+          "complexTypes": []
+        },
+        {
+          "text": "1",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
       "name": "PermissionState",
@@ -732,0 +782,0 @@ "slug": "permissionstate",

dist/esm/definitions.d.ts

@@ -251,3 +251,3 @@ import type { PermissionState, PluginListenerHandle } from '@capacitor/core';
      */
-    importance: 1 | 2 | 3 | 4 | 5;
+    importance: Importance;
     /**
@@ -261,3 +261,3 @@ * The visibility of notifications posted to this channel.
      */
-    visibility?: -1 | 0 | 1;
+    visibility?: Visibility;
     /**
@@ -288,2 +288,4 @@ * Whether notifications posted to this channel should display notification
 }
+export declare type Importance = 1 | 2 | 3 | 4 | 5;
+export declare type Visibility = -1 | 0 | 1;
 export interface ListChannelsResult {
@@ -290,0 +292,0 @@ /**

package.json

 {
   "name": "@capacitor/push-notifications",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The Push Notifications API provides access to native push notifications.",
@@ -47,7 +47,7 @@ "main": "dist/plugin.cjs.js",
   "devDependencies": {
-    "@capacitor/android": "^3.0.0-alpha.14",
-    "@capacitor/cli": "^3.0.0-alpha.14",
-    "@capacitor/core": "^3.0.0-alpha.12",
+    "@capacitor/android": "^3.0.0-beta.1",
+    "@capacitor/cli": "^3.0.0-beta.1",
+    "@capacitor/core": "^3.0.0-beta.1",
     "@capacitor/docgen": "0.0.14",
-    "@capacitor/ios": "^3.0.0-alpha.14",
+    "@capacitor/ios": "^3.0.0-beta.1",
     "@ionic/eslint-config": "^0.3.0",
@@ -65,3 +65,3 @@ "@ionic/prettier-config": "~1.0.1",
   "peerDependencies": {
-    "@capacitor/core": "^3.0.0-alpha.12"
+    "@capacitor/core": "^3.0.0-beta.1"
   },
@@ -84,3 +84,3 @@ "prettier": "@ionic/prettier-config",
   },
-  "gitHead": "98290e6c0292ea17b7a5d178919664a9062405d5"
+  "gitHead": "6c724997284ac8fded5553b0e510c85055f74105"
 }

README.md

@@ -368,13 +368,13 @@ # @capacitor/push-notifications
 
-| Prop              | Type                               | Description                                                                                                                                                                                                                                                | Since |
-| ----------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
-| **`id`**          | <code>string</code>                | The channel identifier.                                                                                                                                                                                                                                    | 1.0.0 |
-| **`name`**        | <code>string</code>                | The human-friendly name of this channel (presented to the user).                                                                                                                                                                                           | 1.0.0 |
-| **`description`** | <code>string</code>                | The description of this channel (presented to the user).                                                                                                                                                                                                   | 1.0.0 |
-| **`sound`**       | <code>string</code>                | The sound that should be played for notifications posted to this channel. Notification channels with an importance of at least `3` should have a sound. The file name of a sound file should be specified relative to the android app `res/raw` directory. | 1.0.0 |
-| **`importance`**  | <code>1 \| 2 \| 5 \| 4 \| 3</code> | The level of interruption for notifications posted to this channel.                                                                                                                                                                                        | 1.0.0 |
-| **`visibility`**  | <code>0 \| 1 \| -1</code>          | The visibility of notifications posted to this channel. This setting is for whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form.                                               | 1.0.0 |
-| **`lights`**      | <code>boolean</code>               | Whether notifications posted to this channel should display notification lights, on devices that support it.                                                                                                                                               | 1.0.0 |
-| **`lightColor`**  | <code>string</code>                | The light color for notifications posted to this channel. Only supported if lights are enabled on this channel and the device supports it. Supported color formats are `#RRGGBB` and `#RRGGBBAA`.                                                          | 1.0.0 |
-| **`vibration`**   | <code>boolean</code>               | Whether notifications posted to this channel should vibrate.                                                                                                                                                                                               | 1.0.0 |
+| Prop              | Type                                              | Description                                                                                                                                                                                                                                                | Since |
+| ----------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`id`**          | <code>string</code>                               | The channel identifier.                                                                                                                                                                                                                                    | 1.0.0 |
+| **`name`**        | <code>string</code>                               | The human-friendly name of this channel (presented to the user).                                                                                                                                                                                           | 1.0.0 |
+| **`description`** | <code>string</code>                               | The description of this channel (presented to the user).                                                                                                                                                                                                   | 1.0.0 |
+| **`sound`**       | <code>string</code>                               | The sound that should be played for notifications posted to this channel. Notification channels with an importance of at least `3` should have a sound. The file name of a sound file should be specified relative to the android app `res/raw` directory. | 1.0.0 |
+| **`importance`**  | <code><a href="#importance">Importance</a></code> | The level of interruption for notifications posted to this channel.                                                                                                                                                                                        | 1.0.0 |
+| **`visibility`**  | <code><a href="#visibility">Visibility</a></code> | The visibility of notifications posted to this channel. This setting is for whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form.                                               | 1.0.0 |
+| **`lights`**      | <code>boolean</code>                              | Whether notifications posted to this channel should display notification lights, on devices that support it.                                                                                                                                               | 1.0.0 |
+| **`lightColor`**  | <code>string</code>                               | The light color for notifications posted to this channel. Only supported if lights are enabled on this channel and the device supports it. Supported color formats are `#RRGGBB` and `#RRGGBBAA`.                                                          | 1.0.0 |
+| **`vibration`**   | <code>boolean</code>                              | Whether notifications posted to this channel should vibrate.                                                                                                                                                                                               | 1.0.0 |
 
@@ -422,2 +422,12 @@
 
+#### Importance
+
+<code>1 | 2 | 3 | 4 | 5</code>
+
+
+#### Visibility
+
+<code>-1 | 0 | 1</code>
+
+
 #### PermissionState
@@ -424,0 +434,0 @@

No alert changes

Improved metrics

Total package byte prevSize

87582

increased by1.66%

Lines of code

1477

increased by3.65%

Number of lines in readme file

436

increased by2.35%

No dependency changes