@aws-amplify/notifications 2.0.1-unstable.cfbde4c.0 → 2.0.2-unstable.ff4e8d7.0

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInForeground.d.ts

@@ -1,27 +0,0 @@
-import { OnNotificationReceivedInForeground } from '../types';
-/**
- * Registers a listener that will be triggered when a notification is received while app is in a foreground state.
- *
- * @param {OnNotificationReceivedInForegroundInput} input - A callback handler to be invoked with the received
- * {@link PushNotificationMessage}.
- * @returns {OnNotificationReceivedInForegroundOutput} - An object with a remove function to remove the listener.
- * @example
- * ```ts
- * // Register a listener
- * onNotificationReceivedInForeground(message => {
- *   doSomething(message);
- * });
- * ```
- * @example
- * ```ts
- * // Register multiple listeners
- * onNotificationReceivedInForeground(message => {
- *   doSomething(message);
- * });
- *
- * onNotificationReceivedInForeground(message => {
- *   doSomethingElse(message);
- * });
- * ```
- */
-export declare const onNotificationReceivedInForeground: OnNotificationReceivedInForeground;

package/lib/pushNotifications/providers/pinpoint/apis/onNotificationReceivedInForeground.native.d.ts

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

package/lib/pushNotifications/providers/pinpoint/apis/onTokenReceived.d.ts

@@ -1,28 +0,0 @@
-import { OnTokenReceived } from '../types';
-/**
- * Registers a listener that will be triggered when a token is received. A token will be received:
- *   1. On every app launch, including the first install
- *   2. When a token changes (this may happen if the service invalidates the token for any reason)
- *
- * @param {OnTokenReceivedInput} input - A callback handler to be invoked with the token.
- * @returns {OnTokenReceivedOutput} - An object with a remove function to remove the listener.
- * @example
- * ```ts
- * // Register a listener
- * onTokenReceived(message => {
- *   doSomething(message);
- * });
- * ```
- * @example
- * ```ts
- * // Register multiple listeners
- * onTokenReceived(message => {
- *   doSomething(message);
- * });
- *
- * onTokenReceived(message => {
- *   doSomethingElse(message);
- * });
- * ```
- */
-export declare const onTokenReceived: OnTokenReceived;

package/lib/pushNotifications/providers/pinpoint/apis/onTokenReceived.native.d.ts

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

package/lib/pushNotifications/providers/pinpoint/apis/requestPermissions.d.ts

@@ -1,32 +0,0 @@
-import { RequestPermissions } from '../types';
-/**
- * Requests notification permissions from your user. By default, Amplify requests all supported permissions but you can
- * choose not to request specific permissions. The resulting promise will resolve to true if requested permissions are
- * granted (or have previously been granted) or false otherwise. Not all specific permissions are supported by platforms
- * your React Native app can run on but will be safely ignored even on those platforms. Currently supported permissions:
- *
- *   * `alert`: When set to true, requests the ability to display notifications to the user.
- *
- *   * `sound`: When set to true, requests the ability to play a sound in response to notifications.
- *
- *   * `badge`: When set to true, requests the ability to update the app's badge.
- *
- * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
- * only React Native is supported by this API.
- * @returns A promise that resolves to true if requested permissions are granted or have already previously been
- * granted or false otherwise.
- * @example
- * ```ts
- * // Request all permissions by default
- * const arePermissionsGranted = await requestPermissions();
- *
- * @example
- * ```ts
- * // Prevent requesting specific permissions
- * const arePermissionsGranted = await requestPermissions({
- *   sound: false,
- *   badge: false
- * });
- * ```
- */
-export declare const requestPermissions: RequestPermissions;

package/lib/pushNotifications/providers/pinpoint/apis/requestPermissions.native.d.ts

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

package/lib/pushNotifications/providers/pinpoint/apis/setBadgeCount.d.ts

@@ -1,14 +0,0 @@
-import { SetBadgeCount } from '../types';
-/**
- * Sets the current badge count (the number on the top right corner of your app's icon). Setting the badge count
- * to 0 (zero) will remove the badge from your app's icon. This function is safe to call (but will be ignored) even
- * when your React Native app is running on platforms where badges are not supported.
- *
- * @throws platform: {@link PlatformNotSupportedError} - Thrown if called against an unsupported platform. Currently,
- * only React Native is supported by this API.
- * @example
- * ```ts
- * setBadgeCount(42);
- * ```
- */
-export declare const setBadgeCount: SetBadgeCount;

package/lib/pushNotifications/providers/pinpoint/apis/setBadgeCount.native.d.ts

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

package/lib/pushNotifications/providers/pinpoint/index.d.ts

@@ -1,3 +0,0 @@
-export { getBadgeCount, getLaunchNotification, getPermissionStatus, identifyUser, initializePushNotifications, onNotificationOpened, onNotificationReceivedInBackground, onNotificationReceivedInForeground, onTokenReceived, requestPermissions, setBadgeCount, } from './apis';
-export { IdentifyUserInput, OnNotificationOpenedInput, OnNotificationReceivedInBackgroundInput, OnNotificationReceivedInForegroundInput, OnTokenReceivedInput, RequestPermissionsInput, SetBadgeCountInput, } from './types/inputs';
-export { GetBadgeCountOutput, GetLaunchNotificationOutput, GetPermissionStatusOutput, OnNotificationOpenedOutput, OnNotificationReceivedInBackgroundOutput, OnNotificationReceivedInForegroundOutput, OnTokenReceivedOutput, } from './types/outputs';

package/lib/pushNotifications/providers/pinpoint/types/analytics.d.ts

@@ -1,6 +0,0 @@
-export type PinpointMessageEvent = 'opened_notification' | 'received_background' | 'received_foreground';
-export type PinpointMessageEventSource = '_campaign' | '_journey';
-export type AnalyticsEventAttributes = {
-    source: PinpointMessageEventSource;
-    attributes: Record<string, string>;
-};

package/lib/pushNotifications/providers/pinpoint/types/apis.d.ts

@@ -1,13 +0,0 @@
-import { IdentifyUserInput, OnNotificationOpenedInput, OnNotificationReceivedInBackgroundInput, OnNotificationReceivedInForegroundInput, OnTokenReceivedInput, RequestPermissionsInput, SetBadgeCountInput } from './inputs';
-import { GetBadgeCountOutput, GetLaunchNotificationOutput, GetPermissionStatusOutput, OnNotificationOpenedOutput, OnNotificationReceivedInBackgroundOutput, OnNotificationReceivedInForegroundOutput, OnTokenReceivedOutput, RequestPermissionsOutput } from './outputs';
-export type GetBadgeCount = () => Promise<void | GetBadgeCountOutput>;
-export type GetLaunchNotification = () => Promise<GetLaunchNotificationOutput>;
-export type GetPermissionStatus = () => Promise<GetPermissionStatusOutput>;
-export type IdentifyUser = (input: IdentifyUserInput) => Promise<void>;
-export type InitializePushNotifications = () => void;
-export type RequestPermissions = (input?: RequestPermissionsInput) => Promise<RequestPermissionsOutput>;
-export type SetBadgeCount = (input: SetBadgeCountInput) => void;
-export type OnNotificationOpened = (input: OnNotificationOpenedInput) => OnNotificationOpenedOutput;
-export type OnNotificationReceivedInBackground = (input: OnNotificationReceivedInBackgroundInput) => OnNotificationReceivedInBackgroundOutput;
-export type OnNotificationReceivedInForeground = (input: OnNotificationReceivedInForegroundInput) => OnNotificationReceivedInForegroundOutput;
-export type OnTokenReceived = (input: OnTokenReceivedInput) => OnTokenReceivedOutput;

package/lib/pushNotifications/providers/pinpoint/types/index.d.ts

@@ -1,6 +0,0 @@
-export { AnalyticsEventAttributes, PinpointMessageEvent, PinpointMessageEventSource, } from './analytics';
-export { GetBadgeCount, GetLaunchNotification, GetPermissionStatus, IdentifyUser, InitializePushNotifications, OnNotificationOpened, OnNotificationReceivedInBackground, OnNotificationReceivedInForeground, OnTokenReceived, RequestPermissions, SetBadgeCount, } from './apis';
-export { IdentifyUserInput, OnNotificationOpenedInput, OnNotificationReceivedInBackgroundInput, OnNotificationReceivedInForegroundInput, OnTokenReceivedInput, RequestPermissionsInput, SetBadgeCountInput, } from './inputs';
-export { GetLaunchNotificationOutput, GetPermissionStatusOutput, OnNotificationOpenedOutput, OnNotificationReceivedInBackgroundOutput, OnNotificationReceivedInForegroundOutput, OnTokenReceivedOutput, } from './outputs';
-export { IdentifyUserOptions } from './options';
-export { ChannelType } from './pushNotifications';

package/lib/pushNotifications/providers/pinpoint/types/inputs.d.ts

@@ -1,9 +0,0 @@
-import { IdentifyUserOptions } from './options';
-import { PushNotificationIdentifyUserInput, PushNotificationRequestPermissionsInput, PushNotificationSetBadgeCountInput, PushNotificationOnNotificationOpenedInput, PushNotificationOnNotificationReceivedInBackgroundInput, PushNotificationOnNotificationReceivedInForegroundInput, PushNotificationOnTokenReceivedInput } from '../../../types';
-export type IdentifyUserInput = PushNotificationIdentifyUserInput<IdentifyUserOptions>;
-export type RequestPermissionsInput = PushNotificationRequestPermissionsInput;
-export type SetBadgeCountInput = PushNotificationSetBadgeCountInput;
-export type OnNotificationOpenedInput = PushNotificationOnNotificationOpenedInput;
-export type OnNotificationReceivedInBackgroundInput = PushNotificationOnNotificationReceivedInBackgroundInput;
-export type OnNotificationReceivedInForegroundInput = PushNotificationOnNotificationReceivedInForegroundInput;
-export type OnTokenReceivedInput = PushNotificationOnTokenReceivedInput;

package/lib/pushNotifications/providers/pinpoint/types/options.d.ts

@@ -1,5 +0,0 @@
-import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
-/**
- * Options specific to Pinpoint identityUser.
- */
-export type IdentifyUserOptions = PinpointServiceOptions;

package/lib/pushNotifications/providers/pinpoint/types/outputs.d.ts

@@ -1,9 +0,0 @@
-import { PushNotificationGetBadgeCountOutput, PushNotificationGetLaunchNotificationOutput, PushNotificationGetPermissionStatusOutput, PushNotificationOnNotificationOpenedOutput, PushNotificationOnNotificationReceivedInBackgroundOutput, PushNotificationOnNotificationReceivedInForegroundOutput, PushNotificationOnTokenReceivedOutput, PushNotificationRequestPermissionsOutput } from '../../../types';
-export type GetBadgeCountOutput = PushNotificationGetBadgeCountOutput;
-export type GetLaunchNotificationOutput = PushNotificationGetLaunchNotificationOutput;
-export type GetPermissionStatusOutput = PushNotificationGetPermissionStatusOutput;
-export type RequestPermissionsOutput = PushNotificationRequestPermissionsOutput;
-export type OnNotificationOpenedOutput = PushNotificationOnNotificationOpenedOutput;
-export type OnNotificationReceivedInBackgroundOutput = PushNotificationOnNotificationReceivedInBackgroundOutput;
-export type OnNotificationReceivedInForegroundOutput = PushNotificationOnNotificationReceivedInForegroundOutput;
-export type OnTokenReceivedOutput = PushNotificationOnTokenReceivedOutput;

package/lib/pushNotifications/providers/pinpoint/types/pushNotifications.d.ts

@@ -1,2 +0,0 @@
-import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
-export type ChannelType = Parameters<typeof updateEndpoint>[0]['channelType'];

package/lib/pushNotifications/providers/pinpoint/utils/createMessageEventRecorder.d.ts

@@ -1,6 +0,0 @@
-import { PinpointMessageEvent } from '../types';
-import { OnPushNotificationMessageHandler } from '../../../types';
-/**
- * @internal
- */
-export declare const createMessageEventRecorder: (event: PinpointMessageEvent, callback?: Function) => OnPushNotificationMessageHandler;

package/lib/pushNotifications/providers/pinpoint/utils/getAnalyticsEvent.d.ts

@@ -1,7 +0,0 @@
-import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
-import { PinpointMessageEvent } from '../types';
-import { PushNotificationMessage } from '../../../types';
-/**
- * @internal
- */
-export declare const getAnalyticsEvent: ({ data }: PushNotificationMessage, event: PinpointMessageEvent) => PinpointAnalyticsEvent | null;

package/lib/pushNotifications/providers/pinpoint/utils/getChannelType.d.ts

@@ -1,5 +0,0 @@
-import { ChannelType } from '../types';
-/**
- * @internal
- */
-export declare const getChannelType: () => ChannelType;

package/lib/pushNotifications/providers/pinpoint/utils/index.d.ts

@@ -1,4 +0,0 @@
-export { createMessageEventRecorder } from './createMessageEventRecorder';
-export { getAnalyticsEvent } from './getAnalyticsEvent';
-export { getChannelType } from './getChannelType';
-export { resolveConfig } from './resolveConfig';

package/lib/pushNotifications/providers/pinpoint/utils/resolveConfig.d.ts

@@ -1,7 +0,0 @@
-/**
- * @internal
- */
-export declare const resolveConfig: () => {
-    appId: string;
-    region: string;
-};

package/lib/pushNotifications/types/errors.d.ts

@@ -1,3 +0,0 @@
-export declare enum PushNotificationErrorCode {
-    NotInitialized = "NotInitialized"
-}

package/lib/pushNotifications/types/index.d.ts

@@ -1,6 +0,0 @@
-export * from './errors';
-export * from './inputs';
-export * from './module';
-export * from './options';
-export * from './outputs';
-export * from './pushNotifications';

package/lib/pushNotifications/types/index.js

@@ -1,24 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./errors"), exports);
-__exportStar(require("./inputs"), exports);
-__exportStar(require("./module"), exports);
-__exportStar(require("./options"), exports);
-__exportStar(require("./outputs"), exports);
-__exportStar(require("./pushNotifications"), exports);

package/lib/pushNotifications/types/inputs.d.ts

@@ -1,24 +0,0 @@
-import { UserProfile } from '@aws-amplify/core';
-import { PushNotificationServiceOptions } from './options';
-import { PushNotificationPermissions } from './module';
-import { OnPushNotificationMessageHandler, OnTokenReceivedHandler } from './pushNotifications';
-export type PushNotificationIdentifyUserInput<ServiceOptions extends PushNotificationServiceOptions = PushNotificationServiceOptions> = {
-    /**
-     * A User ID associated to the current device.
-     */
-    userId: string;
-    /**
-     * Additional information about the user and their device.
-     */
-    userProfile: UserProfile;
-    /**
-     * Options to be passed to the API.
-     */
-    options?: ServiceOptions;
-};
-export type PushNotificationRequestPermissionsInput = PushNotificationPermissions;
-export type PushNotificationSetBadgeCountInput = number;
-export type PushNotificationOnNotificationOpenedInput = OnPushNotificationMessageHandler;
-export type PushNotificationOnNotificationReceivedInBackgroundInput = OnPushNotificationMessageHandler;
-export type PushNotificationOnNotificationReceivedInForegroundInput = OnPushNotificationMessageHandler;
-export type PushNotificationOnTokenReceivedInput = OnTokenReceivedHandler;

package/lib/pushNotifications/types/module.d.ts

@@ -1,31 +0,0 @@
-/**
- * Types here are duplicated from `rtn-push-notifications` as it is not possible to share a source of truth
- * with a package that may conditionally not exist for developers not using push notifications. Modifications
- * made to these types should be reflected in the native module package and vice-versa!
- */
-interface ApnsPlatformOptions {
-    subtitle?: string;
-}
-interface FcmPlatformOptions {
-    channelId: string;
-    messageId: string;
-    senderId: string;
-    sendTime: Date;
-}
-export interface PushNotificationMessage {
-    title?: string;
-    body?: string;
-    imageUrl?: string;
-    deeplinkUrl?: string;
-    goToUrl?: string;
-    fcmOptions?: FcmPlatformOptions;
-    apnsOptions?: ApnsPlatformOptions;
-    data?: Record<string, unknown>;
-}
-export type PushNotificationPermissionStatus = 'denied' | 'granted' | 'shouldRequest' | 'shouldExplainThenRequest';
-export interface PushNotificationPermissions extends Partial<Record<string, boolean>> {
-    alert?: boolean;
-    badge?: boolean;
-    sound?: boolean;
-}
-export {};

package/lib/pushNotifications/types/options.d.ts

@@ -1,4 +0,0 @@
-/**
- * Base type for service options.
- */
-export type PushNotificationServiceOptions = Record<string, unknown>;

package/lib/pushNotifications/types/outputs.d.ts

@@ -1,10 +0,0 @@
-import { EventListenerRemover } from '../../eventListeners';
-import { PushNotificationMessage, PushNotificationPermissionStatus } from '../types';
-export type PushNotificationGetBadgeCountOutput = number | null;
-export type PushNotificationGetLaunchNotificationOutput = PushNotificationMessage | null;
-export type PushNotificationGetPermissionStatusOutput = PushNotificationPermissionStatus;
-export type PushNotificationRequestPermissionsOutput = boolean;
-export type PushNotificationOnNotificationOpenedOutput = EventListenerRemover;
-export type PushNotificationOnNotificationReceivedInBackgroundOutput = EventListenerRemover;
-export type PushNotificationOnNotificationReceivedInForegroundOutput = EventListenerRemover;
-export type PushNotificationOnTokenReceivedOutput = EventListenerRemover;

package/lib/pushNotifications/types/pushNotifications.d.ts

@@ -1,4 +0,0 @@
-import { PushNotificationMessage } from './module';
-export type OnTokenReceivedHandler = (token: string) => void;
-export type OnPushNotificationMessageHandler = (message: PushNotificationMessage) => void;
-export type PushNotificationEvent = 'backgroundMessageReceived' | 'foregroundMessageReceived' | 'launchNotificationOpened' | 'notificationOpened' | 'tokenReceived';

package/lib/pushNotifications/utils/getPushNotificationUserAgentString.d.ts

@@ -1,2 +0,0 @@
-import { PushNotificationAction } from '@aws-amplify/core/internals/utils';
-export declare const getPushNotificationUserAgentString: (action: PushNotificationAction) => string;

package/lib/pushNotifications/utils/index.d.ts

@@ -1,4 +0,0 @@
-export { getPushNotificationUserAgentString } from './getPushNotificationUserAgentString';
-export { initialize, isInitialized } from './initializationManager';
-export { resolveCredentials } from './resolveCredentials';
-export { getToken, setToken } from './tokenManager';

package/lib/pushNotifications/utils/initializationManager.d.ts

@@ -1,12 +0,0 @@
-/**
- * Sets initialization status to true.
- *
- * @internal
- */
-export declare const initialize: () => Promise<void>;
-/**
- * Returns the initialization status of push notifications.
- *
- * @internal
- */
-export declare const isInitialized: () => boolean;

package/lib/pushNotifications/utils/resolveCredentials.d.ts

@@ -1,7 +0,0 @@
-/**
- * @internal
- */
-export declare const resolveCredentials: () => Promise<{
-    credentials: import("@aws-amplify/core/lib-esm/libraryUtils").AWSCredentials;
-    identityId: string | undefined;
-}>;

package/lib/pushNotifications/utils/tokenManager.d.ts

@@ -1,12 +0,0 @@
-/**
- * Sets token.
- *
- * @internal
- */
-export declare const setToken: (newToken: string) => void;
-/**
- * Returns the current token.
- *
- * @internal
- */
-export declare const getToken: () => string;