Modules

node_modules/@firebase/component/dist/src/component.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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 { InstantiationMode, InstanceFactory, ComponentType, Dictionary, Name } from './types';
+/**
+ * Component for service name T, e.g. `auth`, `auth-internal`
+ */
+export declare class Component<T extends Name = Name> {
+    readonly name: T;
+    readonly instanceFactory: InstanceFactory<T>;
+    readonly type: ComponentType;
+    multipleInstances: boolean;
+    /**
+     * Properties to be added to the service namespace
+     */
+    serviceProps: Dictionary;
+    instantiationMode: InstantiationMode;
+    /**
+     *
+     * @param name The public service name, e.g. app, auth, firestore, database
+     * @param instanceFactory Service factory responsible for creating the public interface
+     * @param type whether the service provided by the component is public or private
+     */
+    constructor(name: T, instanceFactory: InstanceFactory<T>, type: ComponentType);
+    setInstantiationMode(mode: InstantiationMode): this;
+    setMultipleInstances(multipleInstances: boolean): this;
+    setServiceProps(props: Dictionary): this;
+}

node_modules/@firebase/component/dist/src/component_container.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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 './provider';
+import { Component } from './component';
+import { Name } from './types';
+/**
+ * ComponentContainer that provides Providers for service name T, e.g. `auth`, `auth-internal`
+ */
+export declare class ComponentContainer {
+    private readonly name;
+    private readonly providers;
+    constructor(name: string);
+    /**
+     *
+     * @param component Component being added
+     * @param overwrite When a component with the same name has already been registered,
+     * if overwrite is true: overwrite the existing component with the new component and create a new
+     * provider with the new component. It can be useful in tests where you want to use different mocks
+     * for different tests.
+     * if overwrite is false: throw an exception
+     */
+    addComponent<T extends Name>(component: Component<T>): void;
+    addOrOverwriteComponent<T extends Name>(component: Component<T>): void;
+    /**
+     * getProvider provides a type safe interface where it can only be called with a field name
+     * present in NameServiceMapping interface.
+     *
+     * Firebase SDKs providing services should extend NameServiceMapping interface to register
+     * themselves.
+     */
+    getProvider<T extends Name>(name: T): Provider<T>;
+    getProviders(): Array<Provider<Name>>;
+}

node_modules/@firebase/component/dist/src/component_container.test.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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 '../test/setup';
+declare module './types' {
+    interface NameServiceMapping {
+        rocket: {};
+        ship: {};
+        fireball: {};
+    }
+}

node_modules/@firebase/component/dist/src/constants.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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_ENTRY_NAME = "[DEFAULT]";

node_modules/@firebase/component/dist/src/provider.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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 { ComponentContainer } from './component_container';
+import { Name, NameServiceMapping } from './types';
+import { Component } from './component';
+/**
+ * Provider for instance for service name T, e.g. 'auth', 'auth-internal'
+ * NameServiceMapping[T] is an alias for the type of the instance
+ */
+export declare class Provider<T extends Name> {
+    private readonly name;
+    private readonly container;
+    private component;
+    private readonly instances;
+    private readonly instancesDeferred;
+    constructor(name: T, container: ComponentContainer);
+    /**
+     * @param identifier A provider can provide mulitple instances of a service
+     * if this.component.multipleInstances is true.
+     */
+    get(identifier?: string): Promise<NameServiceMapping[T]>;
+    /**
+     *
+     * @param options.identifier A provider can provide mulitple instances of a service
+     * if this.component.multipleInstances is true.
+     * @param options.optional If optional is false or not provided, the method throws an error when
+     * the service is not immediately available.
+     * If optional is true, the method returns null if the service is not immediately available.
+     */
+    getImmediate(options: {
+        identifier?: string;
+        optional: true;
+    }): NameServiceMapping[T] | null;
+    getImmediate(options?: {
+        identifier?: string;
+        optional?: false;
+    }): NameServiceMapping[T];
+    getComponent(): Component<T> | null;
+    setComponent(component: Component<T>): void;
+    clearInstance(identifier?: string): void;
+    delete(): Promise<void>;
+    isComponentSet(): boolean;
+    private getOrInitializeService;
+    private normalizeInstanceIdentifier;
+}

node_modules/@firebase/component/dist/src/provider.test.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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 '../test/setup';
+declare module './types' {
+    interface NameServiceMapping {
+        test: {};
+        badtest: {};
+    }
+}

node_modules/@firebase/component/dist/src/types.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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 { ComponentContainer } from './component_container';
+export declare const enum InstantiationMode {
+    LAZY = "LAZY",
+    EAGER = "EAGER"
+}
+/**
+ * PUBLIC: A public component provides a set of public APIs to customers. A service namespace will be patched
+ * onto `firebase` namespace. Assume the component name is `test`, customers will be able
+ * to get the service by calling `firebase.test()` or `app.test()` where `app` is a `FirebaseApp` instance.
+ *
+ * PRIVATE: A private component provides a set of private APIs that are used internally by other
+ * Firebase SDKs. No serivce namespace is created in `firebase` namespace and customers have no way to get them.
+ */
+export declare const enum ComponentType {
+    PUBLIC = "PUBLIC",
+    PRIVATE = "PRIVATE",
+    VERSION = "VERSION"
+}
+/**
+ * Factory to create an instance of type T, given a ComponentContainer.
+ * ComponentContainer is the IOC container that provides {@link Provider}
+ * for dependencies.
+ *
+ * NOTE: The container only provides {@link Provider} rather than the actual instances of dependencies.
+ * It is useful for lazily loaded dependencies and optional dependencies.
+ */
+export declare type InstanceFactory<T extends Name> = (container: ComponentContainer, instanceIdentifier?: string) => NameServiceMapping[T];
+export interface Dictionary {
+    [key: string]: unknown;
+}
+/**
+ * This interface will be extended by Firebase SDKs to provide service name and service type mapping.
+ * It is used as a generic constraint to ensure type safety.
+ */
+export interface NameServiceMapping {
+}
+export declare type Name = keyof NameServiceMapping;
+export declare type Service = NameServiceMapping[Name];