@sudoplatform/sudo-notification 1.0.2 → 2.0.0

package/types/public/sudoNotificationClient.d.ts

@@ -3,6 +3,7 @@ import { CanonicalPushSubscriptionJSON } from '../private/types/canonicalPushSub
 import { NotificationConfiguration } from './types/notificationConfiguration';
 import { NotificationDeviceInfo } from './types/notificationDeviceInfo';
 import { SudoNotificationClientOptions } from './types/sudoNotificationClientOptions';
+import { UserAndDeviceNotificationConfiguration } from './types/userAndDeviceNotificationConfiguration';
 /**
  * Client used to interface with the Sudo Notification Platform service.
  *
@@ -55,7 +56,34 @@ export interface SudoNotificationClient {
      */
     getNotificationConfiguration(deviceInfo: NotificationDeviceInfo): Promise<NotificationConfiguration>;
     /**
-     * Set the notification configuration for the user.
+     * Get the user's current set of notification configurations for a push
+     * subscription at user level.
+     *
+     * Returns undefined if no user level notification configuration has been set.
+     *
+     * @param bundleId
+     *    Reverse DNS name idenfifying the application. For example
+     *    com.sudoplatform.examples.notification.
+     *
+     * @throws {@link UserInfoReadError} if the retrieval of user level information fails for some reason
+     */
+    getUserNotificationConfiguration(bundleId: string): Promise<NotificationConfiguration | undefined>;
+    /**
+     * Get the user's current set of notification configurations for a push
+     * subscription at user level and device level.
+     *
+     * @param deviceInfo Information that identifies the user's device and application
+     *
+     * @throws {@link DeviceReadError} if the retrieval of device information fails for some reason
+     * @throws {@link UserInfoReadError} if the retrieval of user level information fails for some reason
+     */
+    getUserAndDeviceNotificationConfiguration(deviceInfo: NotificationDeviceInfo): Promise<UserAndDeviceNotificationConfiguration>;
+    /**
+     * Set the notification configuration for the user's device.
+     *
+     * Any device specific configuration is evaluated first. Evaluation of
+     * rules will fall back to user level settings if there is no matching
+     * device rule or it is just a catch-all rule that matches.
      *
      * @param deviceInfo Information that identifies the user's device and application
      *
@@ -63,6 +91,20 @@ export interface SudoNotificationClient {
      * @throws {@link SchemaValidationError} if the retrieval fails for some other reason
      */
     setNotificationConfiguration(deviceInfo: NotificationDeviceInfo, config: NotificationConfiguration): Promise<void>;
+    /**
+     * Set the notification configuration for the user across all devices.
+     *
+     * Any device specific configuration is evaluated first. Evaluation of
+     * rules will fall back to user level settings if there is no matching
+     * device rule or it is just a catch-all rule that matches.
+     *
+     * @param bundleId
+     *    Reverse DNS name idenfifying the application. For example
+     *    com.sudoplatform.examples.notification.
+     *
+     * @throws {@link SchemaValidationError} if the retrieval fails for some other reason
+     */
+    setUserNotificationConfiguration(bundleId: string, config: NotificationConfiguration): Promise<void>;
     /** @ignore */
     sendTestNotification(input: SendTestNotificationInput): Promise<boolean>;
 }
@@ -96,7 +138,11 @@ export declare class DefaultSudoNotificationClient implements SudoNotificationCl
     updatePushSubscription(deviceInfo: NotificationDeviceInfo, pushSubscription: PushSubscription): Promise<void>;
     deregisterPushSubscription(deviceInfo: NotificationDeviceInfo): Promise<void>;
     getNotificationConfiguration(deviceInfo: NotificationDeviceInfo): Promise<NotificationConfiguration>;
+    getUserNotificationConfiguration(bundleId: string): Promise<NotificationConfiguration | undefined>;
+    getUserAndDeviceNotificationConfiguration(deviceInfo: NotificationDeviceInfo): Promise<UserAndDeviceNotificationConfiguration>;
     setNotificationConfiguration(deviceInfo: NotificationDeviceInfo, config: NotificationConfiguration): Promise<void>;
+    setUserNotificationConfiguration(bundleId: string, config: NotificationConfiguration): Promise<void>;
+    private setUserOrDeviceNotificationConfiguration;
     /** @ignore */
     sendTestNotification(input: SendTestNotificationInput): Promise<boolean>;
     /**

package/types/public/types/index.d.ts

@@ -9,3 +9,4 @@ export * from './sudoNotification';
 export * from './sudoNotificationClientOptions';
 export * from './sudoNotificationData';
 export * from './sudoNotificationFilterClient';
+export * from './userAndDeviceNotificationConfiguration';

package/types/public/types/userAndDeviceNotificationConfiguration.d.ts

@@ -0,0 +1,18 @@
+import { NotificationConfiguration } from './notificationConfiguration';
+/**
+ * Result of call to getUserAndDeviceNotificationConfiguration
+ */
+export interface UserAndDeviceNotificationConfiguration {
+    /**
+     * User level notification configuration or undefined if no
+     * user level notification configuration has been set.
+     */
+    user?: NotificationConfiguration;
+    /**
+     * Device level notification configuration or undefined if no
+     * device level notification configuration has been set, or
+     * no device information was provided when calling
+     * getUserAndDeviceNotificationConfiguration.
+     */
+    device?: NotificationConfiguration;
+}