@depup/firebase__messaging 0.12.24-depup.0

package/dist/src/testing/fakes/firebase-dependencies.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types';
+import { FirebaseInternalDependencies } from '../../interfaces/internal-dependencies';
+import { FirebaseOptions } from '@firebase/app';
+import { Provider } from '@firebase/component';
+import { _FirebaseInstallationsInternal } from '@firebase/installations';
+export declare function getFakeFirebaseDependencies(options?: FirebaseOptions): FirebaseInternalDependencies;
+export declare function getFakeApp(options?: FirebaseOptions): any;
+export declare function getFakeInstallations(): _FirebaseInstallationsInternal;
+export declare function getFakeAnalyticsProvider(): Provider<FirebaseAnalyticsInternalName>;

package/dist/src/testing/fakes/logging-object.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+import { LogEvent, LogResponse } from '../../interfaces/logging-types';
+export declare function getFakeLogEvent(): LogEvent;
+export declare function getSuccessResponse(): LogResponse;
+export declare function getFailedResponse(): LogResponse;

package/dist/src/testing/fakes/messaging-service.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MessagingService } from '../../messaging-service';
+export declare function getFakeMessagingService(): MessagingService;

package/dist/src/testing/fakes/service-worker.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ExtendableEvent } from '../../util/sw-types';
+export declare function mockServiceWorker(): void;
+export declare function restoreServiceWorker(): void;
+export declare class FakeServiceWorkerRegistration implements ServiceWorkerRegistration {
+    active: null;
+    installing: null;
+    waiting: null;
+    onupdatefound: null;
+    pushManager: FakePushManager;
+    scope: string;
+    navigationPreload: NavigationPreloadManager;
+    updateViaCache: ServiceWorkerUpdateViaCache;
+    getNotifications(): Promise<never[]>;
+    showNotification(): Promise<void>;
+    update(): Promise<void>;
+    unregister(): Promise<boolean>;
+    addEventListener(): void;
+    removeEventListener(): void;
+    dispatchEvent(): boolean;
+}
+declare class FakePushManager implements PushManager {
+    private subscription;
+    permissionState(): Promise<"granted">;
+    getSubscription(): Promise<FakePushSubscription | null>;
+    subscribe(): Promise<FakePushSubscription>;
+}
+export declare class FakePushSubscription implements PushSubscription {
+    endpoint: string;
+    expirationTime: number;
+    auth: string;
+    p256: string;
+    getKey(name: PushEncryptionKeyName): Uint8Array;
+    unsubscribe(): Promise<boolean>;
+    toJSON: () => PushSubscriptionJSON;
+    options: PushSubscriptionOptions;
+}
+/**
+ * Most of the fields in here are unused / deprecated. They are only added here to match the TS
+ * Event interface.
+ */
+export declare class FakeEvent implements ExtendableEvent {
+    type: string;
+    NONE: 0;
+    AT_TARGET: 2;
+    BUBBLING_PHASE: 3;
+    CAPTURING_PHASE: 1;
+    bubbles: boolean;
+    cancelable: boolean;
+    composed: boolean;
+    timeStamp: number;
+    isTrusted: boolean;
+    eventPhase: 0;
+    target: null;
+    currentTarget: null;
+    srcElement: null;
+    cancelBubble: boolean;
+    defaultPrevented: boolean;
+    returnValue: boolean;
+    preventDefault(): void;
+    stopPropagation(): void;
+    stopImmediatePropagation(): void;
+    initEvent(): void;
+    waitUntil(): void;
+    composedPath(): never[];
+    constructor(type: string, options?: EventInit);
+}
+export {};

package/dist/src/testing/fakes/token-details.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { TokenDetails } from '../../interfaces/token-details';
+export declare function getFakeTokenDetails(): TokenDetails;

package/dist/src/testing/setup.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/src/testing/sinon-types.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SinonSpy, SinonStub } from 'sinon';
+export type Stub<T extends (...args: any) => any> = SinonStub<Parameters<T>, ReturnType<T>>;
+export type Spy<T extends (...args: any) => any> = SinonSpy<Parameters<T>, ReturnType<T>>;

package/dist/src/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "0.1.2"
+    }
+  ]
+}

package/dist/src/util/constants.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare const DEFAULT_SW_PATH = "/firebase-messaging-sw.js";
+export declare const DEFAULT_SW_SCOPE = "/firebase-cloud-messaging-push-scope";
+export declare const DEFAULT_VAPID_KEY = "BDOU99-h67HcA6JeFXHbSNMu7e2yNNu3RzoMj8TM4W88jITfq7ZmPvIM1Iv-4_l2LxQcYwhqby2xGpWwzjfAnG4";
+export declare const ENDPOINT = "https://fcmregistrations.googleapis.com/v1";
+/** Key of FCM Payload in Notification's data field. */
+export declare const FCM_MSG = "FCM_MSG";
+export declare const CONSOLE_CAMPAIGN_ID = "google.c.a.c_id";
+export declare const CONSOLE_CAMPAIGN_NAME = "google.c.a.c_l";
+export declare const CONSOLE_CAMPAIGN_TIME = "google.c.a.ts";
+/** Set to '1' if Analytics is enabled for the campaign */
+export declare const CONSOLE_CAMPAIGN_ANALYTICS_ENABLED = "google.c.a.e";
+export declare const TAG = "FirebaseMessaging: ";
+export declare const MAX_NUMBER_OF_EVENTS_PER_LOG_REQUEST = 1000;
+export declare const MAX_RETRIES = 3;
+export declare const LOG_INTERVAL_IN_MS = 86400000;
+export declare const DEFAULT_BACKOFF_TIME_MS = 5000;
+export declare const DEFAULT_REGISTRATION_TIMEOUT = 10000;
+export declare const FCM_LOG_SOURCE = 1249;
+export declare const SDK_PLATFORM_WEB = 3;
+export declare const EVENT_MESSAGE_DELIVERED = 1;
+export declare enum MessageType {
+    DATA_MESSAGE = 1,
+    DISPLAY_NOTIFICATION = 3
+}

package/dist/src/util/errors.d.ts

@@ -0,0 +1,57 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ErrorFactory, ErrorMap } from '@firebase/util';
+export declare const enum ErrorCode {
+    MISSING_APP_CONFIG_VALUES = "missing-app-config-values",
+    AVAILABLE_IN_WINDOW = "only-available-in-window",
+    AVAILABLE_IN_SW = "only-available-in-sw",
+    PERMISSION_DEFAULT = "permission-default",
+    PERMISSION_BLOCKED = "permission-blocked",
+    UNSUPPORTED_BROWSER = "unsupported-browser",
+    INDEXED_DB_UNSUPPORTED = "indexed-db-unsupported",
+    FAILED_DEFAULT_REGISTRATION = "failed-service-worker-registration",
+    TOKEN_SUBSCRIBE_FAILED = "token-subscribe-failed",
+    TOKEN_SUBSCRIBE_NO_TOKEN = "token-subscribe-no-token",
+    TOKEN_UNSUBSCRIBE_FAILED = "token-unsubscribe-failed",
+    TOKEN_UPDATE_FAILED = "token-update-failed",
+    TOKEN_UPDATE_NO_TOKEN = "token-update-no-token",
+    INVALID_BG_HANDLER = "invalid-bg-handler",
+    USE_SW_AFTER_GET_TOKEN = "use-sw-after-get-token",
+    INVALID_SW_REGISTRATION = "invalid-sw-registration",
+    USE_VAPID_KEY_AFTER_GET_TOKEN = "use-vapid-key-after-get-token",
+    INVALID_VAPID_KEY = "invalid-vapid-key"
+}
+export declare const ERROR_MAP: ErrorMap<ErrorCode>;
+interface ErrorParams {
+    [ErrorCode.MISSING_APP_CONFIG_VALUES]: {
+        valueName: string;
+    };
+    [ErrorCode.FAILED_DEFAULT_REGISTRATION]: {
+        browserErrorMessage: string;
+    };
+    [ErrorCode.TOKEN_SUBSCRIBE_FAILED]: {
+        errorInfo: string;
+    };
+    [ErrorCode.TOKEN_UNSUBSCRIBE_FAILED]: {
+        errorInfo: string;
+    };
+    [ErrorCode.TOKEN_UPDATE_FAILED]: {
+        errorInfo: string;
+    };
+}
+export declare const ERROR_FACTORY: ErrorFactory<ErrorCode, ErrorParams>;
+export {};

package/dist/src/util/sw-types.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Subset of Web Worker types from lib.webworker.d.ts
+ * https://github.com/Microsoft/TypeScript/blob/master/lib/lib.webworker.d.ts
+ *
+ * Since it's not possible to have both "dom" and "webworker" libs in a single project, we have to
+ * manually declare the web worker types we need.
+ */
+export interface ServiceWorkerGlobalScope {
+    readonly location: WorkerLocation;
+    readonly clients: Clients;
+    readonly registration: ServiceWorkerRegistration;
+    addEventListener<K extends keyof ServiceWorkerGlobalScopeEventMap>(type: K, listener: (this: ServiceWorkerGlobalScope, ev: ServiceWorkerGlobalScopeEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+}
+export interface ServiceWorkerGlobalScopeEventMap {
+    notificationclick: NotificationEvent;
+    push: PushEvent;
+    pushsubscriptionchange: PushSubscriptionChangeEvent;
+}
+export interface Client {
+    readonly id: string;
+    readonly type: ClientTypes;
+    readonly url: string;
+    postMessage(message: any, transfer?: Transferable[]): void;
+}
+export interface ClientQueryOptions {
+    includeReserved?: boolean;
+    includeUncontrolled?: boolean;
+    type?: ClientTypes;
+}
+export interface WindowClient extends Client {
+    readonly focused: boolean;
+    readonly visibilityState: DocumentVisibilityState;
+    focus(): Promise<WindowClient>;
+    navigate(url: string): Promise<WindowClient>;
+}
+export interface Clients {
+    claim(): Promise<void>;
+    get(id: string): Promise<any>;
+    matchAll(options?: ClientQueryOptions): Promise<Client[]>;
+    openWindow(url: string): Promise<WindowClient | null>;
+}
+export interface ExtendableEvent extends Event {
+    waitUntil(f: Promise<any>): void;
+}
+export interface NotificationEvent extends ExtendableEvent {
+    readonly action: string;
+    readonly notification: Notification;
+}
+interface PushMessageData {
+    arrayBuffer(): ArrayBuffer;
+    blob(): Blob;
+    json(): any;
+    text(): string;
+}
+export interface PushEvent extends ExtendableEvent {
+    readonly data: PushMessageData | null;
+}
+export interface PushSubscriptionChangeEvent extends ExtendableEvent {
+    readonly newSubscription: PushSubscription | null;
+    readonly oldSubscription: PushSubscription | null;
+}
+interface WorkerLocation {
+    readonly hash: string;
+    readonly host: string;
+    readonly hostname: string;
+    readonly href: string;
+    readonly origin: string;
+    readonly pathname: string;
+    readonly port: string;
+    readonly protocol: string;
+    readonly search: string;
+    toString(): string;
+}
+export {};

package/dist/sw/index-public.d.ts

@@ -0,0 +1,166 @@
+import { FirebaseApp } from '@firebase/app';
+
+import { NextFn , Observer , Unsubscribe } from '@firebase/util';
+
+/**
+ * Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery. By
+ * default, message delivery metrics are not exported to BigQuery. Use this method to enable or
+ * disable the export at runtime.
+ *
+ * @param messaging - The `FirebaseMessaging` instance.
+ * @param enable - Whether Firebase Cloud Messaging should export message delivery metrics to
+ * BigQuery.
+ *
+ * @public
+ */
+export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
+/**
+ * Options for features provided by the FCM SDK for Web. See {@link
+ * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
+ * WebpushFcmOptions}.
+ *
+ * @public
+ */
+export declare interface FcmOptions {
+    /**
+     * The link to open when the user clicks on the notification.
+     */
+    link?: string;
+    /**
+     * The label associated with the message's analytics data.
+     */
+    analyticsLabel?: string;
+}
+/* Excluded from this release type: _FirebaseMessagingName */
+/**
+ * Retrieves a Firebase Cloud Messaging instance.
+ *
+ * @returns The Firebase Cloud Messaging instance associated with the provided firebase app.
+ *
+ * @public
+ */
+export declare function getMessaging(app?: FirebaseApp): Messaging;
+/**
+ * Options for {@link getToken}.
+ *
+ * @public
+ */
+export declare interface GetTokenOptions {
+    /**
+     * The public server key provided to push services. The key is used to
+     * authenticate push subscribers to receive push messages only from sending servers that hold
+     * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
+     * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
+     * to generate and import a VAPID key for your project with
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
+     * See
+     * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
+     * for details on web push services.
+     */
+    vapidKey?: string;
+    /**
+     * The service worker registration for receiving push
+     * messaging. If the registration is not provided explicitly, you need to have a
+     * `firebase-messaging-sw.js` at your root location. See
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
+     * for more details.
+     */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+}
+/**
+ * Checks whether all required APIs exist within SW Context
+ * @returns a Promise that resolves to a boolean.
+ *
+ * @public
+ */
+export declare function isSupported(): Promise<boolean>;
+/**
+ * Message payload that contains the notification payload that is represented with
+ * {@link NotificationPayload} and the data payload that contains an arbitrary
+ * number of key-value pairs sent by developers through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
+ *
+ * @public
+ */
+export declare interface MessagePayload {
+    /**
+     * {@inheritdoc NotificationPayload}
+     */
+    notification?: NotificationPayload;
+    /**
+     * Arbitrary key/value payload.
+     */
+    data?: {
+        [key: string]: string;
+    };
+    /**
+     * {@inheritdoc FcmOptions}
+     */
+    fcmOptions?: FcmOptions;
+    /**
+     * The sender of this message.
+     */
+    from: string;
+    /**
+     * The collapse key of the message. See
+     * {@link https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages | Non-collapsible and collapsible messages}
+     */
+    collapseKey: string;
+    /**
+     * The message ID of a message.
+     */
+    messageId: string;
+}
+/**
+ * Public interface of the Firebase Cloud Messaging SDK.
+ *
+ * @public
+ */
+export declare interface Messaging {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this `Messaging` instance is associated with.
+     */
+    app: FirebaseApp;
+}
+export { NextFn };
+/**
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
+ *
+ * @public
+ */
+export declare interface NotificationPayload {
+    /**
+     * The notification's title.
+     */
+    title?: string;
+    /**
+     * The notification's body text.
+     */
+    body?: string;
+    /**
+     * The URL of an image that is downloaded on the device and displayed in the notification.
+     */
+    image?: string;
+    /**
+     * The URL to use for the notification's icon. If you don't send this key in the request,
+     * FCM displays the launcher icon specified in your app manifest.
+     */
+    icon?: string;
+}
+export { Observer };
+/**
+ * Called when a message is received while the app is in the background. An app is considered to be
+ * in the background if no active window is displayed.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @param nextOrObserver - This function, or observer object with `next` defined, is called when a
+ * message is received and the app is currently in the background.
+ *
+ * @returns To stop listening for messages execute this returned function
+ *
+ * @public
+ */
+export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+export { Unsubscribe };
+export {};