add channels method

Author: cbaker6

index.d.ts

@@ -139,6 +139,20 @@ export class Provider extends EventEmitter {
    */
   send(notification: Notification, recipients: string|string[]): Promise<Responses>;
 
+  /**
+   * Manage channels using a specific action.
+   *
+   * An "action" specifies what to do with the channel.
+   */
+  manageChannels(notification: Notification, bundleId: string, action: ChannelAction): Promise<Responses>;
+
+  /**
+   * Broadcast to a channel.
+   *
+   * An "action" specifies what to do with the channel.
+   */
+  broadcast(notification: Notification, bundleId: string): Promise<Responses>;
+
   /**
    * Set an info logger, and optionally an errorLogger to separately log errors.
    *
@@ -178,6 +192,8 @@ export class MultiProvider extends EventEmitter {
   shutdown(callback?: () => void): void;
 }
 
+export type ChannelAction = 'create' | 'read' | 'readAll' | 'delete';
+
 export type NotificationPushType = 'background' | 'alert' | 'voip' | 'pushtotalk' | 'liveactivity' | 'location' | 'complication' | 'fileprovider' | 'mdm';
 
 export interface NotificationAlertOptions {

lib/client.js

@@ -192,7 +192,7 @@ module.exports = function (dependencies) {
       const subDirectoryInformation = this.makeSubDirectoryTypeObject(type, subDirectory);
       const error = {
         ...subDirectoryInformation,
-        error: new VError(`the type "${type}" is invalid`),
+        error: new VError(`the type "${type}" is not supported`),
       };
       return Promise.resolve(error);
     }

lib/provider.js

@@ -1,4 +1,5 @@
 const EventEmitter = require('events');
+const VError = require('verror');
 
 module.exports = function (dependencies) {
   const Client = dependencies.Client;
@@ -42,6 +43,51 @@ module.exports = function (dependencies) {
     });
   };
 
+  Provider.prototype.manageChannels = function manageChannels(notification, bundleId, action) {
+    let type = 'channels';
+    let method = 'post';
+
+    switch (action) {
+      case 'create':
+        if (notification['push-type'] == null) {
+          // Add live activity push type if it's not already provided.
+          // Live activity is the only current type supported.
+          // Note, this seems like it should be lower cased, but the
+          // docs shows it in the current format.
+          notification['push-type'] = 'LiveActivity';
+        }
+        type = 'channels';
+        method = 'post';
+        break;
+      case 'read':
+        type = 'channels';
+        method = 'get';
+        break;
+      case 'readAll':
+        type = 'allChannels';
+        method = 'get';
+        break;
+      case 'delete':
+        type = 'channels';
+        method = 'delete';
+        break;
+      default: {
+        const error = {
+          bundleId,
+          error: new VError(`the action "${action}" is not supported`),
+        };
+        return Promise.resolve(error);
+      }
+    }
+
+    const builtNotification = {
+      headers: notification.headers(),
+      body: notification.compile(),
+    };
+
+    return this.client.write(builtNotification, bundleId, type, method);
+  };
+
   Provider.prototype.broadcast = function broadcast(notification, bundleId) {
     const builtNotification = {
       headers: notification.headers(),