@firebase/installations 0.5.1 → 0.5.2-canary.2322b6023

package/dist/esm/src/interfaces/installation-entry.d.ts

@@ -0,0 +1,85 @@
+/**
+ * @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.
+ */
+/** Status of a server request. */
+export declare const enum RequestStatus {
+    NOT_STARTED = 0,
+    IN_PROGRESS = 1,
+    COMPLETED = 2
+}
+export interface NotStartedAuthToken {
+    readonly requestStatus: RequestStatus.NOT_STARTED;
+}
+export interface InProgressAuthToken {
+    readonly requestStatus: RequestStatus.IN_PROGRESS;
+    /**
+     * Unix timestamp when the current generateAuthRequest was initiated.
+     * Used for figuring out how long the request status has been IN_PROGRESS.
+     */
+    readonly requestTime: number;
+}
+export interface CompletedAuthToken {
+    readonly requestStatus: RequestStatus.COMPLETED;
+    /**
+     * Firebase Installations Authentication Token.
+     * Only exists if requestStatus is COMPLETED.
+     */
+    readonly token: string;
+    /**
+     * Unix timestamp when Authentication Token was created.
+     * Only exists if requestStatus is COMPLETED.
+     */
+    readonly creationTime: number;
+    /**
+     * Authentication Token time to live duration in milliseconds.
+     * Only exists if requestStatus is COMPLETED.
+     */
+    readonly expiresIn: number;
+}
+export declare type AuthToken = NotStartedAuthToken | InProgressAuthToken | CompletedAuthToken;
+export interface UnregisteredInstallationEntry {
+    /** Status of the Firebase Installation registration on the server. */
+    readonly registrationStatus: RequestStatus.NOT_STARTED;
+    /** Firebase Installation ID */
+    readonly fid: string;
+}
+export interface InProgressInstallationEntry {
+    /** Status of the Firebase Installation registration on the server. */
+    readonly registrationStatus: RequestStatus.IN_PROGRESS;
+    /**
+     * Unix timestamp that shows the time when the current createInstallation
+     * request was initiated.
+     * Used for figuring out how long the registration status has been PENDING.
+     */
+    readonly registrationTime: number;
+    /** Firebase Installation ID */
+    readonly fid: string;
+}
+export interface RegisteredInstallationEntry {
+    /** Status of the Firebase Installation registration on the server. */
+    readonly registrationStatus: RequestStatus.COMPLETED;
+    /** Firebase Installation ID */
+    readonly fid: string;
+    /**
+     * Refresh Token returned from the server.
+     * Used for authenticating generateAuthToken requests.
+     */
+    readonly refreshToken: string;
+    /** Firebase Installation Authentication Token. */
+    readonly authToken: AuthToken;
+}
+/** Firebase Installation ID and related data in the database. */
+export declare type InstallationEntry = UnregisteredInstallationEntry | InProgressInstallationEntry | RegisteredInstallationEntry;

package/dist/esm/src/interfaces/installation-impl.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @license
+ * Copyright 2020 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 { Provider } from '@firebase/component';
+import { _FirebaseService } from '@firebase/app';
+import { Installations } from '../interfaces/public-types';
+export interface FirebaseInstallationsImpl extends Installations, _FirebaseService {
+    readonly appConfig: AppConfig;
+    readonly platformLoggerProvider: Provider<'platform-logger'>;
+}
+export interface AppConfig {
+    readonly appName: string;
+    readonly projectId: string;
+    readonly apiKey: string;
+    readonly appId: string;
+}

package/dist/esm/src/interfaces/public-types.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2020 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 { FirebaseApp } from '@firebase/app';
+/**
+ * Public interface of the Firebase Installations SDK.
+ *
+ * @public
+ */
+export interface Installations {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this `Installations` instance is associated with.
+     */
+    app: FirebaseApp;
+}
+/**
+ * An interface for Firebase internal SDKs use only.
+ *
+ * @internal
+ */
+export interface _FirebaseInstallationsInternal {
+    /**
+     * Creates a Firebase Installation if there isn't one for the app and
+     * returns the Installation ID.
+     */
+    getId(): Promise<string>;
+    /**
+     * Returns an Authentication Token for the current Firebase Installation.
+     */
+    getToken(forceRefresh?: boolean): Promise<string>;
+}
+declare module '@firebase/component' {
+    interface NameServiceMapping {
+        'installations': Installations;
+        'installations-internal': _FirebaseInstallationsInternal;
+    }
+}

package/dist/esm/src/testing/compare-headers.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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.
+ */
+declare class HeadersWithEntries extends Headers {
+    entries?(): Iterable<[string, string]>;
+}
+export declare function compareHeaders(expectedHeaders: HeadersWithEntries, actualHeaders: HeadersWithEntries): void;
+export {};

package/dist/esm/src/testing/compare-headers.test.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.
+ */
+import '../testing/setup';

package/dist/esm/src/testing/fake-generators.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 { FirebaseApp } from '@firebase/app';
+import { FirebaseInstallationsImpl, AppConfig } from '../interfaces/installation-impl';
+export declare function getFakeApp(): FirebaseApp;
+export declare function getFakeAppConfig(customValues?: Partial<AppConfig>): AppConfig;
+export declare function getFakeInstallations(): FirebaseInstallationsImpl;

package/dist/esm/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/esm/src/util/constants.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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 PENDING_TIMEOUT_MS = 10000;
+export declare const PACKAGE_VERSION: string;
+export declare const INTERNAL_AUTH_VERSION = "FIS_v2";
+export declare const INSTALLATIONS_API_URL = "https://firebaseinstallations.googleapis.com/v1";
+export declare const TOKEN_EXPIRATION_BUFFER: number;
+export declare const SERVICE = "installations";
+export declare const SERVICE_NAME = "Installations";

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

@@ -0,0 +1,46 @@
+/**
+ * @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 { ErrorFactory, FirebaseError } from '@firebase/util';
+export declare const enum ErrorCode {
+    MISSING_APP_CONFIG_VALUES = "missing-app-config-values",
+    NOT_REGISTERED = "not-registered",
+    INSTALLATION_NOT_FOUND = "installation-not-found",
+    REQUEST_FAILED = "request-failed",
+    APP_OFFLINE = "app-offline",
+    DELETE_PENDING_REGISTRATION = "delete-pending-registration"
+}
+interface ErrorParams {
+    [ErrorCode.MISSING_APP_CONFIG_VALUES]: {
+        valueName: string;
+    };
+    [ErrorCode.REQUEST_FAILED]: {
+        requestName: string;
+        [index: string]: string | number;
+    } & ServerErrorData;
+}
+export declare const ERROR_FACTORY: ErrorFactory<ErrorCode, ErrorParams>;
+export interface ServerErrorData {
+    serverCode: number;
+    serverMessage: string;
+    serverStatus: string;
+}
+export declare type ServerError = FirebaseError & {
+    customData: ServerErrorData;
+};
+/** Returns true if error is a FirebaseError that is based on an error from the server. */
+export declare function isServerError(error: unknown): error is ServerError;
+export {};

package/dist/esm/src/util/get-key.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 { AppConfig } from '../interfaces/installation-impl';
+/** Returns a string key that can be used to identify the app. */
+export declare function getKey(appConfig: AppConfig): string;

package/dist/esm/src/util/sleep.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.
+ */
+/** Returns a promise that resolves after given time passes. */
+export declare function sleep(ms: number): Promise<void>;

package/dist/esm/src/util/sleep.test.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.
+ */
+import '../testing/setup';

package/dist/index.cjs.js

@@ -9,7 +9,7 @@ var util = require('@firebase/util');
 var idb = require('idb');
 
 var name = "@firebase/installations";
-var version = "0.5.1";
+var version = "0.5.2-canary.2322b6023";
 
 /**
  * @license
@@ -1397,7 +1397,9 @@ function registerInstallations() {
  * @packageDocumentation
  */
 registerInstallations();
-app.registerVersion(name, version);
+app.registerVersion(name, version);
+// BUILD_TARGET will be replaced by values like esm5, esm2017, cjs5, etc during the compilation
+app.registerVersion(name, version, 'cjs5');
 
 exports.deleteInstallations = deleteInstallations;
 exports.getId = getId;