@aws-amplify/notifications 1.0.25 → 1.0.26-unstable.1116fef.4

package/lib-esm/InAppMessaging/types.d.ts

@@ -1,46 +1,38 @@
-import { NotificationsCategory } from '../types';
-import { AWSPinpointProviderConfig } from './Providers/AWSPinpointProvider/types';
-export declare type NotificationsSubcategory = 'InAppMessaging';
-export declare type UserInfo = {
-    attributes?: Record<string, string[]>;
-    demographic?: {
-        appVersion?: string;
-        locale?: string;
-        make?: string;
-        model?: string;
-        modelVersion?: string;
-        platform?: string;
-        platformVersion?: string;
-        timezone?: string;
-    };
-    location?: {
-        city?: string;
-        country?: string;
-        latitude?: number;
-        longitude?: number;
-        postalCode?: string;
-        region?: string;
-    };
-    metrics?: Record<string, number>;
-};
+import { EventListener } from '../common';
+import { AWSPinpointProviderConfig } from '../common/AWSPinpointProviderCommon/types';
+import { NotificationsProvider, NotificationsSubCategory as NotificationsSubCategories, UserInfo } from '../types';
+export declare type NotificationsSubCategory = Extract<NotificationsSubCategories, 'InAppMessaging'>;
+export interface InAppMessagingInterface {
+    configure: (config: InAppMessagingConfig) => InAppMessagingConfig;
+    getModuleName: () => NotificationsSubCategory;
+    getPluggable: (providerName: string) => InAppMessagingProvider;
+    addPluggable: (pluggable: InAppMessagingProvider) => void;
+    removePluggable: (providerName: string) => void;
+    syncMessages: () => Promise<void[]>;
+    clearMessages: () => Promise<void[]>;
+    dispatchEvent: (event: InAppMessagingEvent) => Promise<void>;
+    identifyUser: (userId: string, userInfo: UserInfo) => Promise<void[]>;
+    onMessageReceived: (handler: OnMessageInteractionEventHandler) => EventListener<OnMessageInteractionEventHandler>;
+    onMessageDisplayed: (handler: OnMessageInteractionEventHandler) => EventListener<OnMessageInteractionEventHandler>;
+    onMessageDismissed: (handler: OnMessageInteractionEventHandler) => EventListener<OnMessageInteractionEventHandler>;
+    onMessageActionTaken: (handler: OnMessageInteractionEventHandler) => EventListener<OnMessageInteractionEventHandler>;
+    notifyMessageInteraction: (message: InAppMessage, type: InAppMessageInteractionEvent) => void;
+    setConflictHandler: (handler: InAppMessageConflictHandler) => void;
+}
+export interface InAppMessagingProvider extends NotificationsProvider {
+    getSubCategory(): NotificationsSubCategory;
+    getInAppMessages(): Promise<any>;
+    processInAppMessages(messages: InAppMessage[], event: InAppMessagingEvent): Promise<InAppMessage[]>;
+}
+export interface InAppMessagingConfig {
+    listenForAnalyticsEvents?: boolean;
+    AWSPinpoint?: AWSPinpointProviderConfig;
+}
 export declare type InAppMessagingEvent = {
     name: string;
     attributes?: Record<string, string>;
     metrics?: Record<string, number>;
 };
-export interface InAppMessagingConfig {
-    listenForAnalyticsEvents?: boolean;
-    AWSPinpoint?: AWSPinpointProviderConfig;
-}
-export interface InAppMessagingProvider {
-    configure(config: object): object;
-    getCategory(): NotificationsCategory;
-    getSubCategory(): NotificationsSubcategory;
-    getProviderName(): string;
-    getInAppMessages(): Promise<any>;
-    processInAppMessages(messages: InAppMessage[], event: InAppMessagingEvent): Promise<InAppMessage[]>;
-    identifyUser(userId: string, userInfo: UserInfo): Promise<void>;
-}
 export declare type InAppMessageLayout = 'BOTTOM_BANNER' | 'CAROUSEL' | 'FULL_SCREEN' | 'MIDDLE_BANNER' | 'MODAL' | 'TOP_BANNER';
 export declare type InAppMessageAction = 'CLOSE' | 'DEEP_LINK' | 'LINK';
 export declare type InAppMessageTextAlign = 'center' | 'left' | 'right';
@@ -85,10 +77,6 @@ export interface InAppMessage {
     metadata?: any;
 }
 export declare type OnMessageInteractionEventHandler = (message: InAppMessage) => any;
-export interface OnMessageInteractionEventListener {
-    handleEvent: OnMessageInteractionEventHandler;
-    remove: () => void;
-}
 export declare enum InAppMessageInteractionEvent {
     MESSAGE_RECEIVED = "MESSAGE_RECEIVED_EVENT",
     MESSAGE_DISPLAYED = "MESSAGE_DISPLAYED_EVENT",

package/lib-esm/InAppMessaging/types.js

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export var InAppMessageInteractionEvent;
 (function (InAppMessageInteractionEvent) {
     InAppMessageInteractionEvent["MESSAGE_RECEIVED"] = "MESSAGE_RECEIVED_EVENT";

package/lib-esm/InAppMessaging/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/InAppMessaging/types.ts"],"names":[],"mappings":"AAwIA,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACvC,2EAA2C,CAAA;IAC3C,6EAA6C,CAAA;IAC7C,6EAA6C,CAAA;IAC7C,mFAAmD,CAAA;AACpD,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/InAppMessaging/types.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAmItC,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACvC,2EAA2C,CAAA;IAC3C,6EAA6C,CAAA;IAC7C,6EAA6C,CAAA;IAC7C,mFAAmD,CAAA;AACpD,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC"}

package/lib-esm/Notifications.d.ts

@@ -1,8 +1,10 @@
-import InAppMessaging from './InAppMessaging';
-import { NotificationsCategory, NotificationsConfig } from './types';
+import { InAppMessagingInterface as InAppMessaging } from './InAppMessaging/types';
+import { PushNotificationInterface as PushNotification } from './PushNotification/types';
+import { NotificationsCategory, NotificationsConfig, UserInfo } from './types';
 declare class NotificationsClass {
     private config;
     private inAppMessaging;
+    private pushNotification?;
     constructor();
     /**
      * Get the name of the module category
@@ -15,6 +17,8 @@ declare class NotificationsClass {
      */
     configure: ({ Notifications: config }?: NotificationsConfig) => Record<string, any>;
     get InAppMessaging(): InAppMessaging;
+    get Push(): PushNotification;
+    identifyUser: (userId: string, userInfo: UserInfo) => Promise<void[]>;
 }
 declare const Notifications: NotificationsClass;
 export default Notifications;

package/lib-esm/Notifications.js

@@ -1,8 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { __assign } from "tslib";
+import { __assign, __awaiter, __generator } from "tslib";
 import { Amplify, ConsoleLogger as Logger } from '@aws-amplify/core';
-import InAppMessaging from './InAppMessaging';
+import InAppMessagingClass from './InAppMessaging';
 var logger = new Logger('Notifications');
 var NotificationsClass = /** @class */ (function () {
     function NotificationsClass() {
@@ -18,9 +18,46 @@ var NotificationsClass = /** @class */ (function () {
             logger.debug('configure Notifications', config);
             // Configure sub-categories
             _this.inAppMessaging.configure(_this.config.InAppMessaging);
+            if (_this.config.Push) {
+                try {
+                    var PushNotification = require('./PushNotification').default;
+                    _this.pushNotification = new PushNotification();
+                    _this.pushNotification.configure(_this.config.Push);
+                }
+                catch (err) {
+                    logger.error(err);
+                }
+            }
             return _this.config;
         };
-        this.inAppMessaging = new InAppMessaging();
+        this.identifyUser = function (userId, userInfo) {
+            var identifyFunctions = [];
+            if (_this.inAppMessaging) {
+                identifyFunctions.push(_this.inAppMessaging.identifyUser);
+            }
+            if (_this.pushNotification) {
+                identifyFunctions.push(_this.pushNotification.identifyUser);
+            }
+            return Promise.all(identifyFunctions.map(function (identifyFunction) { return __awaiter(_this, void 0, void 0, function () {
+                var err_1;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            _a.trys.push([0, 2, , 3]);
+                            return [4 /*yield*/, identifyFunction(userId, userInfo)];
+                        case 1:
+                            _a.sent();
+                            return [3 /*break*/, 3];
+                        case 2:
+                            err_1 = _a.sent();
+                            logger.error('Failed to identify user', err_1);
+                            throw err_1;
+                        case 3: return [2 /*return*/];
+                    }
+                });
+            }); }));
+        };
+        this.inAppMessaging = new InAppMessagingClass();
     }
     /**
      * Get the name of the module category
@@ -36,6 +73,14 @@ var NotificationsClass = /** @class */ (function () {
         enumerable: true,
         configurable: true
     });
+    Object.defineProperty(NotificationsClass.prototype, "Push", {
+        get: function () {
+            var _a;
+            return (_a = this.pushNotification) !== null && _a !== void 0 ? _a : {};
+        },
+        enumerable: true,
+        configurable: true
+    });
     return NotificationsClass;
 }());
 var Notifications = new NotificationsClass();

package/lib-esm/Notifications.js.map

@@ -1 +1 @@
-{"version":3,"file":"Notifications.js","sourceRoot":"","sources":["../src/Notifications.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC,OAAO,EAAE,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAG9C,IAAM,MAAM,GAAG,IAAI,MAAM,CAAC,eAAe,CAAC,CAAC;AAE3C;IAIC;QAAA,iBAEC;QALO,WAAM,GAAwB,EAAE,CAAC;QAezC;;;WAGG;QACH,cAAS,GAAG,UAAC,EAAmD;gBAAjD,gDAAqB;YACnC,KAAI,CAAC,MAAM,yBAAQ,KAAI,CAAC,MAAM,GAAK,MAAM,CAAE,CAAC;YAE5C,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;YAEhD,2BAA2B;YAC3B,KAAI,CAAC,cAAc,CAAC,SAAS,CAAC,KAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAE1D,OAAO,KAAI,CAAC,MAAM,CAAC;QACpB,CAAC,CAAC;QAxBD,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,0CAAa,GAAb;QACC,OAAO,eAAe,CAAC;IACxB,CAAC;IAiBD,sBAAI,8CAAc;aAAlB;YACC,OAAO,IAAI,CAAC,cAAc,CAAC;QAC5B,CAAC;;;OAAA;IACF,yBAAC;AAAD,CAAC,AAlCD,IAkCC;AAED,IAAM,aAAa,GAAG,IAAI,kBAAkB,EAAE,CAAC;AAE/C,eAAe,aAAa,CAAC;AAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC"}
+{"version":3,"file":"Notifications.js","sourceRoot":"","sources":["../src/Notifications.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC,OAAO,EAAE,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,mBAAmB,MAAM,kBAAkB,CAAC;AAKnD,IAAM,MAAM,GAAG,IAAI,MAAM,CAAC,eAAe,CAAC,CAAC;AAE3C;IAKC;QAAA,iBAEC;QANO,WAAM,GAAwB,EAAE,CAAC;QAgBzC;;;WAGG;QACH,cAAS,GAAG,UAAC,EAAmD;gBAAjD,gDAAqB;YACnC,KAAI,CAAC,MAAM,yBAAQ,KAAI,CAAC,MAAM,GAAK,MAAM,CAAE,CAAC;YAE5C,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;YAEhD,2BAA2B;YAC3B,KAAI,CAAC,cAAc,CAAC,SAAS,CAAC,KAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAE1D,IAAI,KAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACrB,IAAI;oBACH,IAAM,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC;oBAC/D,KAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC;oBAC/C,KAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;iBAClD;gBAAC,OAAO,GAAG,EAAE;oBACb,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBAClB;aACD;YAED,OAAO,KAAI,CAAC,MAAM,CAAC;QACpB,CAAC,CAAC;QAUF,iBAAY,GAAG,UAAC,MAAc,EAAE,QAAkB;YACjD,IAAM,iBAAiB,GAAe,EAAE,CAAC;YACzC,IAAI,KAAI,CAAC,cAAc,EAAE;gBACxB,iBAAiB,CAAC,IAAI,CAAC,KAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;aACzD;YACD,IAAI,KAAI,CAAC,gBAAgB,EAAE;gBAC1B,iBAAiB,CAAC,IAAI,CAAC,KAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;aAC3D;YACD,OAAO,OAAO,CAAC,GAAG,CACjB,iBAAiB,CAAC,GAAG,CAAC,UAAM,gBAAgB;;;;;;4BAE1C,qBAAM,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAA;;4BAAxC,SAAwC,CAAC;;;;4BAEzC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAG,CAAC,CAAC;4BAC7C,MAAM,KAAG,CAAC;;;;iBAEX,CAAC,CACF,CAAC;QACH,CAAC,CAAC;QA9DD,IAAI,CAAC,cAAc,GAAG,IAAI,mBAAmB,EAAE,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,0CAAa,GAAb;QACC,OAAO,eAAe,CAAC;IACxB,CAAC;IA2BD,sBAAI,8CAAc;aAAlB;YACC,OAAO,IAAI,CAAC,cAAc,CAAC;QAC5B,CAAC;;;OAAA;IAED,sBAAI,oCAAI;aAAR;;YACC,aAAO,IAAI,CAAC,gBAAgB,mCAAK,EAAuB,CAAC;QAC1D,CAAC;;;OAAA;IAqBF,yBAAC;AAAD,CAAC,AArED,IAqEC;AAED,IAAM,aAAa,GAAG,IAAI,kBAAkB,EAAE,CAAC;AAE/C,eAAe,aAAa,CAAC;AAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC"}

package/lib-esm/PushNotification/NotEnabledError.d.ts

@@ -0,0 +1,3 @@
+export default class NotEnabledError extends Error {
+    constructor();
+}

package/lib-esm/PushNotification/NotEnabledError.js

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __extends } from "tslib";
+var NotEnabledError = /** @class */ (function (_super) {
+    __extends(NotEnabledError, _super);
+    function NotEnabledError() {
+        var _this = _super.call(this, 'Function is unavailable as Push has not been enabled. Please call `Push.enable` before calling this function.') || this;
+        _this.name = 'NotEnabledError';
+        return _this;
+    }
+    return NotEnabledError;
+}(Error));
+export default NotEnabledError;
+//# sourceMappingURL=NotEnabledError.js.map

package/lib-esm/PushNotification/NotEnabledError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotEnabledError.js","sourceRoot":"","sources":["../../src/PushNotification/NotEnabledError.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC;IAA6C,mCAAK;IACjD;QAAA,YACC,kBACC,+GAA+G,CAC/G,SAED;QADA,KAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;;IAC/B,CAAC;IACF,sBAAC;AAAD,CAAC,AAPD,CAA6C,KAAK,GAOjD"}

package/lib-esm/PushNotification/Platform/index.d.ts

@@ -0,0 +1,2 @@
+import { Platform as PlatformInterface } from './types';
+export declare const Platform: PlatformInterface;

package/lib-esm/PushNotification/Platform/index.js

@@ -0,0 +1,24 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var userAgentIncludes = function (text) {
+    var _a;
+    return (_a = navigator === null || navigator === void 0 ? void 0 : navigator.userAgent) === null || _a === void 0 ? void 0 : _a.includes(text);
+};
+var getOS = function () {
+    if (userAgentIncludes('Android'))
+        return 'android';
+    if (userAgentIncludes('like Mac'))
+        return 'ios';
+    if (userAgentIncludes('Win'))
+        return 'windows';
+    if (userAgentIncludes('Mac'))
+        return 'macos';
+    if (userAgentIncludes('Linux'))
+        return 'linux';
+    if (userAgentIncludes('X11'))
+        return 'unix';
+    return 'unknown';
+};
+var OS = getOS();
+export var Platform = { OS: OS };
+//# sourceMappingURL=index.js.map

package/lib-esm/PushNotification/Platform/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/PushNotification/Platform/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAItC,IAAM,iBAAiB,GAAG,UAAC,IAAY;;IACtC,aAAO,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,SAAS,0CAAE,QAAQ,CAAC,IAAI,EAAE;AAC7C,CAAC,CAAC;AAEF,IAAM,KAAK,GAAG;IACb,IAAI,iBAAiB,CAAC,SAAS,CAAC;QAAE,OAAO,SAAS,CAAC;IACnD,IAAI,iBAAiB,CAAC,UAAU,CAAC;QAAE,OAAO,KAAK,CAAC;IAChD,IAAI,iBAAiB,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC/C,IAAI,iBAAiB,CAAC,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IAC7C,IAAI,iBAAiB,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC/C,IAAI,iBAAiB,CAAC,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IAC5C,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAEF,IAAM,EAAE,GAAG,KAAK,EAAE,CAAC;AAEnB,MAAM,CAAC,IAAM,QAAQ,GAAsB,EAAE,EAAE,IAAA,EAAE,CAAC"}

package/lib-esm/PushNotification/Platform/index.native.d.ts

@@ -0,0 +1,2 @@
+import { Platform as PlatformInterface } from './types';
+export declare const Platform: PlatformInterface;

package/lib-esm/PushNotification/Platform/index.native.js

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Platform as NativePlatform } from 'react-native';
+var OS = NativePlatform.OS;
+export var Platform = { OS: OS };
+//# sourceMappingURL=index.native.js.map

package/lib-esm/PushNotification/Platform/index.native.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.native.js","sourceRoot":"","sources":["../../../src/PushNotification/Platform/index.native.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,OAAO,EAAE,QAAQ,IAAI,cAAc,EAAE,MAAM,cAAc,CAAC;AAGlD,IAAA,sBAAE,CAAoB;AAE9B,MAAM,CAAC,IAAM,QAAQ,GAAsB,EAAE,EAAE,IAAA,EAAE,CAAC"}

package/lib-esm/PushNotification/Platform/types.d.ts

@@ -0,0 +1,5 @@
+export interface Platform {
+    OS: KnownOS | 'unknown';
+}
+declare type KnownOS = 'windows' | 'macos' | 'unix' | 'linux' | 'ios' | 'android' | 'web';
+export {};

package/lib-esm/PushNotification/Platform/types.js

@@ -0,0 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+//# sourceMappingURL=types.js.map

package/lib-esm/PushNotification/Platform/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/PushNotification/Platform/types.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC"}

package/lib-esm/PushNotification/PlatformNotSupportedError.d.ts

@@ -0,0 +1,3 @@
+export default class PlatformNotSupportedError extends Error {
+    constructor();
+}

package/lib-esm/PushNotification/PlatformNotSupportedError.js

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __extends } from "tslib";
+var PlatformNotSupportedError = /** @class */ (function (_super) {
+    __extends(PlatformNotSupportedError, _super);
+    function PlatformNotSupportedError() {
+        var _this = _super.call(this, 'Function not supported on current platform') || this;
+        _this.name = 'PlatformNotSupportedError';
+        return _this;
+    }
+    return PlatformNotSupportedError;
+}(Error));
+export default PlatformNotSupportedError;
+//# sourceMappingURL=PlatformNotSupportedError.js.map

package/lib-esm/PushNotification/PlatformNotSupportedError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformNotSupportedError.js","sourceRoot":"","sources":["../../src/PushNotification/PlatformNotSupportedError.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC;IAAuD,6CAAK;IAC3D;QAAA,YACC,kBAAM,4CAA4C,CAAC,SAEnD;QADA,KAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;;IACzC,CAAC;IACF,gCAAC;AAAD,CAAC,AALD,CAAuD,KAAK,GAK3D"}

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/index.d.ts

@@ -0,0 +1,15 @@
+import { AWSPinpointProviderCommon } from '../../../common';
+import { PushNotificationProvider, NotificationsSubCategory } from '../../types';
+export default class AWSPinpointProvider extends AWSPinpointProviderCommon implements PushNotificationProvider {
+    static subCategory: NotificationsSubCategory;
+    private configured;
+    constructor();
+    /**
+     * get the sub-category of the plugin
+     */
+    getSubCategory(): "PushNotification";
+    configure: (config?: {}) => Record<string, any>;
+    registerDevice: (address: string) => Promise<void>;
+    private getChannelType;
+    private recordMessageEvent;
+}

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/index.js

@@ -0,0 +1,113 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __assign, __awaiter, __extends, __generator } from "tslib";
+import { ChannelType } from '@aws-sdk/client-pinpoint';
+import { addEventListener, AWSPinpointProviderCommon } from '../../../common';
+import PlatformNotSupportedError from '../../PlatformNotSupportedError';
+import { Platform } from '../../Platform';
+import { AWSPinpointMessageEvent } from './types';
+import { dispatchPushNotificationEvent, getAnalyticsEvent, logger, } from './utils';
+var AWSPinpointProvider = /** @class */ (function (_super) {
+    __extends(AWSPinpointProvider, _super);
+    function AWSPinpointProvider() {
+        var _this = _super.call(this, logger) || this;
+        _this.configured = false;
+        _this.configure = function (config) {
+            if (config === void 0) { config = {}; }
+            _this.config = __assign(__assign({}, _super.prototype.configure.call(_this, config)), { endpointInfo: { channelType: _this.getChannelType() } });
+            // some configuration steps should not be re-run even if provider is re-configured for some reason
+            if (!_this.configured) {
+                // wire up default Pinpoint message event handling
+                addEventListener(0 /* BACKGROUND_MESSAGE_RECEIVED */, function (message) {
+                    return _this.recordMessageEvent(message, AWSPinpointMessageEvent.BACKGROUND_MESSAGE_RECEIVED);
+                });
+                addEventListener(1 /* FOREGROUND_MESSAGE_RECEIVED */, function (message) {
+                    return _this.recordMessageEvent(message, AWSPinpointMessageEvent.FOREGROUND_MESSAGE_RECEIVED);
+                });
+                var launchNotificationOpenedListener_1 = addEventListener(2 /* LAUNCH_NOTIFICATION_OPENED */, function (message) {
+                    _this.recordMessageEvent(message, AWSPinpointMessageEvent.NOTIFICATION_OPENED);
+                    // once we are done with it we can remove the listener
+                    launchNotificationOpenedListener_1 === null || launchNotificationOpenedListener_1 === void 0 ? void 0 : launchNotificationOpenedListener_1.remove();
+                });
+                addEventListener(3 /* NOTIFICATION_OPENED */, function (message) {
+                    _this.recordMessageEvent(message, AWSPinpointMessageEvent.NOTIFICATION_OPENED);
+                    // if we are in this state, we no longer need the listener as the app was launched via some other means
+                    launchNotificationOpenedListener_1 === null || launchNotificationOpenedListener_1 === void 0 ? void 0 : launchNotificationOpenedListener_1.remove();
+                });
+            }
+            _this.configured = true;
+            dispatchPushNotificationEvent('pinpointProvider_configured', null);
+            return _this.config;
+        };
+        _this.registerDevice = function (address) { return __awaiter(_this, void 0, void 0, function () {
+            var err_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!!this.initialized) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.init()];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2:
+                        _a.trys.push([2, 4, , 5]);
+                        this.config.endpointInfo = __assign(__assign({}, this.config.endpointInfo), { address: address });
+                        return [4 /*yield*/, this.updateEndpoint()];
+                    case 3:
+                        _a.sent();
+                        return [3 /*break*/, 5];
+                    case 4:
+                        err_1 = _a.sent();
+                        this.logger.error('Error registering device', err_1);
+                        throw err_1;
+                    case 5: return [2 /*return*/];
+                }
+            });
+        }); };
+        _this.getChannelType = function () {
+            switch (Platform.OS) {
+                case 'android': {
+                    // FCM was previously known as GCM and continues to be the channel type in Pinpoint
+                    return ChannelType.GCM;
+                }
+                case 'ios': {
+                    // If building in debug mode, use the APNs sandbox
+                    return global['__DEV__'] ? ChannelType.APNS_SANDBOX : ChannelType.APNS;
+                }
+                default: {
+                    throw new PlatformNotSupportedError();
+                }
+            }
+        };
+        _this.recordMessageEvent = function (message, event) { return __awaiter(_this, void 0, void 0, function () {
+            var analyticsEvent;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        analyticsEvent = getAnalyticsEvent(message, event);
+                        if (!analyticsEvent) {
+                            logger.debug('A notification missing event information was not recorded');
+                            return [2 /*return*/];
+                        }
+                        if (!!this.initialized) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.init()];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, this.recordAnalyticsEvent(analyticsEvent)];
+                }
+            });
+        }); };
+        return _this;
+    }
+    /**
+     * get the sub-category of the plugin
+     */
+    AWSPinpointProvider.prototype.getSubCategory = function () {
+        return AWSPinpointProvider.subCategory;
+    };
+    AWSPinpointProvider.subCategory = 'PushNotification';
+    return AWSPinpointProvider;
+}(AWSPinpointProviderCommon));
+export default AWSPinpointProvider;
+//# sourceMappingURL=index.js.map

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/PushNotification/Providers/AWSPinpointProvider/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;;AAEtC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC9E,OAAO,yBAAyB,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAO1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EACN,6BAA6B,EAC7B,iBAAiB,EACjB,MAAM,GACN,MAAM,SAAS,CAAC;AAEjB;IACS,uCAAyB;IAOjC;QAAA,YACC,kBAAM,MAAM,CAAC,SACb;QAJO,gBAAU,GAAG,KAAK,CAAC;QAa3B,eAAS,GAAG,UAAC,MAAW;YAAX,uBAAA,EAAA,WAAW;YACvB,KAAI,CAAC,MAAM,yBACP,iBAAM,SAAS,aAAC,MAAM,CAAC,KAC1B,YAAY,EAAE,EAAE,WAAW,EAAE,KAAI,CAAC,cAAc,EAAE,EAAE,GACpD,CAAC;YAEF,kGAAkG;YAClG,IAAI,CAAC,KAAI,CAAC,UAAU,EAAE;gBACrB,kDAAkD;gBAClD,gBAAgB,sCAEf,UAAA,OAAO;oBACN,OAAA,KAAI,CAAC,kBAAkB,CACtB,OAAO,EACP,uBAAuB,CAAC,2BAA2B,CACnD;gBAHD,CAGC,CACF,CAAC;gBACF,gBAAgB,sCAEf,UAAA,OAAO;oBACN,OAAA,KAAI,CAAC,kBAAkB,CACtB,OAAO,EACP,uBAAuB,CAAC,2BAA2B,CACnD;gBAHD,CAGC,CACF,CAAC;gBACF,IAAM,kCAAgC,GAAG,gBAAgB,qCAExD,UAAA,OAAO;oBACN,KAAI,CAAC,kBAAkB,CACtB,OAAO,EACP,uBAAuB,CAAC,mBAAmB,CAC3C,CAAC;oBACF,sDAAsD;oBACtD,kCAAgC,aAAhC,kCAAgC,uBAAhC,kCAAgC,CAAE,MAAM,GAAG;gBAC5C,CAAC,CACD,CAAC;gBACF,gBAAgB,8BAA4C,UAAA,OAAO;oBAClE,KAAI,CAAC,kBAAkB,CACtB,OAAO,EACP,uBAAuB,CAAC,mBAAmB,CAC3C,CAAC;oBACF,uGAAuG;oBACvG,kCAAgC,aAAhC,kCAAgC,uBAAhC,kCAAgC,CAAE,MAAM,GAAG;gBAC5C,CAAC,CAAC,CAAC;aACH;YAED,KAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,6BAA6B,CAAC,6BAA6B,EAAE,IAAI,CAAC,CAAC;YACnE,OAAO,KAAI,CAAC,MAAM,CAAC;QACpB,CAAC,CAAC;QAEF,oBAAc,GAAG,UAAO,OAAe;;;;;6BAClC,CAAC,IAAI,CAAC,WAAW,EAAjB,wBAAiB;wBACpB,qBAAM,IAAI,CAAC,IAAI,EAAE,EAAA;;wBAAjB,SAAiB,CAAC;;;;wBAGlB,IAAI,CAAC,MAAM,CAAC,YAAY,yBACpB,IAAI,CAAC,MAAM,CAAC,YAAY,KAC3B,OAAO,SAAA,GACP,CAAC;wBACF,qBAAM,IAAI,CAAC,cAAc,EAAE,EAAA;;wBAA3B,SAA2B,CAAC;;;;wBAE5B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAG,CAAC,CAAC;wBACnD,MAAM,KAAG,CAAC;;;;aAEX,CAAC;QAEM,oBAAc,GAAG;YACxB,QAAQ,QAAQ,CAAC,EAAE,EAAE;gBACpB,KAAK,SAAS,CAAC,CAAC;oBACf,mFAAmF;oBACnF,OAAO,WAAW,CAAC,GAAG,CAAC;iBACvB;gBACD,KAAK,KAAK,CAAC,CAAC;oBACX,kDAAkD;oBAClD,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;iBACvE;gBACD,OAAO,CAAC,CAAC;oBACR,MAAM,IAAI,yBAAyB,EAAE,CAAC;iBACtC;aACD;QACF,CAAC,CAAC;QAEM,wBAAkB,GAAG,UAC5B,OAAgC,EAChC,KAA8B;;;;;wBAExB,cAAc,GAAG,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;wBACzD,IAAI,CAAC,cAAc,EAAE;4BACpB,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;4BAC1E,sBAAO;yBACP;6BACG,CAAC,IAAI,CAAC,WAAW,EAAjB,wBAAiB;wBACpB,qBAAM,IAAI,CAAC,IAAI,EAAE,EAAA;;wBAAjB,SAAiB,CAAC;;4BAEnB,sBAAO,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,EAAC;;;aACjD,CAAC;;IAzGF,CAAC;IAED;;OAEG;IACH,4CAAc,GAAd;QACC,OAAO,mBAAmB,CAAC,WAAW,CAAC;IACxC,CAAC;IAbM,+BAAW,GAA6B,kBAAkB,CAAC;IAgHnE,0BAAC;CAAA,AApHD,CACS,yBAAyB,GAmHjC;eApHoB,mBAAmB"}

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/types.d.ts

@@ -0,0 +1,9 @@
+export declare enum AWSPinpointMessageEventSource {
+    CAMPAIGN = "_campaign",
+    JOURNEY = "_journey"
+}
+export declare enum AWSPinpointMessageEvent {
+    NOTIFICATION_OPENED = "opened_notification",
+    BACKGROUND_MESSAGE_RECEIVED = "received_background",
+    FOREGROUND_MESSAGE_RECEIVED = "received_foreground"
+}

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/types.js

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export var AWSPinpointMessageEventSource;
+(function (AWSPinpointMessageEventSource) {
+    AWSPinpointMessageEventSource["CAMPAIGN"] = "_campaign";
+    AWSPinpointMessageEventSource["JOURNEY"] = "_journey";
+})(AWSPinpointMessageEventSource || (AWSPinpointMessageEventSource = {}));
+export var AWSPinpointMessageEvent;
+(function (AWSPinpointMessageEvent) {
+    AWSPinpointMessageEvent["NOTIFICATION_OPENED"] = "opened_notification";
+    AWSPinpointMessageEvent["BACKGROUND_MESSAGE_RECEIVED"] = "received_background";
+    AWSPinpointMessageEvent["FOREGROUND_MESSAGE_RECEIVED"] = "received_foreground";
+})(AWSPinpointMessageEvent || (AWSPinpointMessageEvent = {}));
+//# sourceMappingURL=types.js.map

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/PushNotification/Providers/AWSPinpointProvider/types.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,MAAM,CAAN,IAAY,6BAGX;AAHD,WAAY,6BAA6B;IACxC,uDAAsB,CAAA;IACtB,qDAAoB,CAAA;AACrB,CAAC,EAHW,6BAA6B,KAA7B,6BAA6B,QAGxC;AAED,MAAM,CAAN,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IAClC,sEAA2C,CAAA;IAC3C,8EAAmD,CAAA;IACnD,8EAAmD,CAAA;AACpD,CAAC,EAJW,uBAAuB,KAAvB,uBAAuB,QAIlC"}

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/utils.d.ts

@@ -0,0 +1,7 @@
+import { Event as AWSPinpointAnalyticsEvent } from '@aws-sdk/client-pinpoint';
+import { ConsoleLogger } from '@aws-amplify/core';
+import { PushNotificationMessage } from '../../types';
+import { AWSPinpointMessageEvent } from './types';
+export declare const logger: ConsoleLogger;
+export declare const dispatchPushNotificationEvent: (event: string, data: any, message?: string) => void;
+export declare const getAnalyticsEvent: ({ data }: PushNotificationMessage, event: AWSPinpointMessageEvent) => AWSPinpointAnalyticsEvent;

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/utils.js

@@ -0,0 +1,56 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { ConsoleLogger, Hub } from '@aws-amplify/core';
+import { AMPLIFY_SYMBOL } from '../../../common';
+import { AWSPinpointMessageEventSource, } from './types';
+var ANDROID_CAMPAIGN_ACTIVITY_ID_KEY = 'pinpoint.campaign.campaign_activity_id';
+var ANDROID_CAMPAIGN_ID_KEY = 'pinpoint.campaign.campaign_id';
+var ANDROID_CAMPAIGN_TREATMENT_ID_KEY = 'pinpoint.campaign.treatment_id';
+export var logger = new ConsoleLogger('PushNotification.AWSPinpointProvider');
+export var dispatchPushNotificationEvent = function (event, data, message) {
+    Hub.dispatch('pushNotification', { event: event, data: data, message: message }, 'PushNotification', AMPLIFY_SYMBOL);
+};
+export var getAnalyticsEvent = function (_a, event) {
+    var data = _a.data;
+    if (!data) {
+        return null;
+    }
+    var eventAttributes = getAnalyticsEventAttributes(data);
+    if (!eventAttributes) {
+        return null;
+    }
+    var source = eventAttributes.source, attributes = eventAttributes.attributes;
+    return {
+        Attributes: attributes,
+        EventType: source + "." + event,
+        Timestamp: new Date().toISOString(),
+    };
+};
+var getAnalyticsEventAttributes = function (data) {
+    if (data.hasOwnProperty(ANDROID_CAMPAIGN_ID_KEY)) {
+        return {
+            source: AWSPinpointMessageEventSource.CAMPAIGN,
+            attributes: {
+                campaign_activity_id: data[ANDROID_CAMPAIGN_ACTIVITY_ID_KEY],
+                campaign_id: data[ANDROID_CAMPAIGN_ID_KEY],
+                treatment_id: data[ANDROID_CAMPAIGN_TREATMENT_ID_KEY],
+            },
+        };
+    }
+    var pinpoint = typeof data.pinpoint === 'string'
+        ? JSON.parse(data.pinpoint)
+        : data.pinpoint;
+    if (pinpoint === null || pinpoint === void 0 ? void 0 : pinpoint.campaign) {
+        return {
+            source: AWSPinpointMessageEventSource.CAMPAIGN,
+            attributes: pinpoint.campaign,
+        };
+    }
+    if (pinpoint === null || pinpoint === void 0 ? void 0 : pinpoint.journey) {
+        return {
+            source: AWSPinpointMessageEventSource.JOURNEY,
+            attributes: pinpoint.journey,
+        };
+    }
+};
+//# sourceMappingURL=utils.js.map

package/lib-esm/PushNotification/Providers/AWSPinpointProvider/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/PushNotification/Providers/AWSPinpointProvider/utils.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAGtC,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EACN,6BAA6B,GAE7B,MAAM,SAAS,CAAC;AAEjB,IAAM,gCAAgC,GACrC,wCAAwC,CAAC;AAC1C,IAAM,uBAAuB,GAAG,+BAA+B,CAAC;AAChE,IAAM,iCAAiC,GAAG,gCAAgC,CAAC;AAE3E,MAAM,CAAC,IAAM,MAAM,GAAG,IAAI,aAAa,CAAC,sCAAsC,CAAC,CAAC;AAEhF,MAAM,CAAC,IAAM,6BAA6B,GAAG,UAC5C,KAAa,EACb,IAAS,EACT,OAAgB;IAEhB,GAAG,CAAC,QAAQ,CACX,kBAAkB,EAClB,EAAE,KAAK,OAAA,EAAE,IAAI,MAAA,EAAE,OAAO,SAAA,EAAE,EACxB,kBAAkB,EAClB,cAAc,CACd,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,iBAAiB,GAAG,UAChC,EAAiC,EACjC,KAA8B;QAD5B,cAAI;IAGN,IAAI,CAAC,IAAI,EAAE;QACV,OAAO,IAAI,CAAC;KACZ;IACD,IAAM,eAAe,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAC1D,IAAI,CAAC,eAAe,EAAE;QACrB,OAAO,IAAI,CAAC;KACZ;IACO,IAAA,+BAAM,EAAE,uCAAU,CAAqB;IAC/C,OAAO;QACN,UAAU,EAAE,UAAU;QACtB,SAAS,EAAK,MAAM,SAAI,KAAO;QAC/B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACnC,CAAC;AACH,CAAC,CAAC;AAEF,IAAM,2BAA2B,GAAG,UAAC,IAAqC;IACzE,IAAI,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC,EAAE;QACjD,OAAO;YACN,MAAM,EAAE,6BAA6B,CAAC,QAAQ;YAC9C,UAAU,EAAE;gBACX,oBAAoB,EAAE,IAAI,CAAC,gCAAgC,CAAC;gBAC5D,WAAW,EAAE,IAAI,CAAC,uBAAuB,CAAC;gBAC1C,YAAY,EAAE,IAAI,CAAC,iCAAiC,CAAC;aACrD;SACD,CAAC;KACF;IACD,IAAM,QAAQ,GACb,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ;QAChC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC3B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAClB,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,EAAE;QACvB,OAAO;YACN,MAAM,EAAE,6BAA6B,CAAC,QAAQ;YAC9C,UAAU,EAAE,QAAQ,CAAC,QAAQ;SAC7B,CAAC;KACF;IACD,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAE;QACtB,OAAO;YACN,MAAM,EAAE,6BAA6B,CAAC,OAAO;YAC7C,UAAU,EAAE,QAAQ,CAAC,OAAO;SAC5B,CAAC;KACF;AACF,CAAC,CAAC"}

package/lib-esm/PushNotification/Providers/index.d.ts

@@ -0,0 +1 @@
+export { default as AWSPinpointProvider } from './AWSPinpointProvider';

package/lib-esm/PushNotification/Providers/index.js

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export { default as AWSPinpointProvider } from './AWSPinpointProvider';
+//# sourceMappingURL=index.js.map

package/lib-esm/PushNotification/Providers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/PushNotification/Providers/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,uBAAuB,CAAC"}

package/lib-esm/PushNotification/PushNotification.d.ts

@@ -0,0 +1,39 @@
+import { NotificationsSubCategory, OnPushNotificationMessageHandler, OnTokenReceivedHandler, PushNotificationConfig, PushNotificationInterface, PushNotificationMessage, PushNotificationPermissions, PushNotificationPermissionStatus, PushNotificationProvider } from './types';
+export default class PushNotification implements PushNotificationInterface {
+    /**
+     * Configure PushNotification
+     * @param {Object} config - PushNotification configuration object
+     */
+    configure: (_?: PushNotificationConfig) => PushNotificationConfig;
+    /**
+     * Get the name of this module
+     * @returns {string} name of this module
+     */
+    getModuleName(): NotificationsSubCategory;
+    /**
+     * Get a plugin from added plugins
+     * @param {string} providerName - the name of the plugin to get
+     */
+    getPluggable: (_: string) => never;
+    /**
+     * Add plugin into PushNotification
+     * @param {PushNotificationProvider} pluggable - an instance of the plugin
+     */
+    addPluggable: (_: PushNotificationProvider) => void;
+    /**
+     * Remove a plugin from added plugins
+     * @param {string} providerName - the name of the plugin to remove
+     */
+    removePluggable: () => void;
+    enable: () => void;
+    identifyUser: () => Promise<void[]>;
+    getLaunchNotification: () => Promise<PushNotificationMessage>;
+    getBadgeCount: () => Promise<number>;
+    setBadgeCount: (_: number) => void;
+    getPermissionStatus: () => Promise<PushNotificationPermissionStatus>;
+    requestPermissions: (_?: PushNotificationPermissions) => Promise<boolean>;
+    onNotificationReceivedInBackground: (_: OnPushNotificationMessageHandler) => any;
+    onNotificationReceivedInForeground: (_: OnPushNotificationMessageHandler) => any;
+    onTokenReceived: (_: OnTokenReceivedHandler) => any;
+    onNotificationOpened: (_: OnPushNotificationMessageHandler) => any;
+}