@firebase/performance 0.6.10 → 0.6.11

package/dist/esm/src/controllers/perf.d.ts

@@ -1,39 +1,39 @@
-/**
- * @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';
-import { _FirebaseInstallationsInternal } from '@firebase/installations';
-import { PerformanceSettings, FirebasePerformance } from '../public_types';
-export declare class PerformanceController implements FirebasePerformance {
-    readonly app: FirebaseApp;
-    readonly installations: _FirebaseInstallationsInternal;
-    private initialized;
-    constructor(app: FirebaseApp, installations: _FirebaseInstallationsInternal);
-    /**
-     * This method *must* be called internally as part of creating a
-     * PerformanceController instance.
-     *
-     * Currently it's not possible to pass the settings object through the
-     * constructor using Components, so this method exists to be called with the
-     * desired settings, to ensure nothing is collected without the user's
-     * consent.
-     */
-    _init(settings?: PerformanceSettings): void;
-    set instrumentationEnabled(val: boolean);
-    get instrumentationEnabled(): boolean;
-    set dataCollectionEnabled(val: boolean);
-    get dataCollectionEnabled(): boolean;
-}
+/**
+ * @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';
+import { _FirebaseInstallationsInternal } from '@firebase/installations';
+import { PerformanceSettings, FirebasePerformance } from '../public_types';
+export declare class PerformanceController implements FirebasePerformance {
+    readonly app: FirebaseApp;
+    readonly installations: _FirebaseInstallationsInternal;
+    private initialized;
+    constructor(app: FirebaseApp, installations: _FirebaseInstallationsInternal);
+    /**
+     * This method *must* be called internally as part of creating a
+     * PerformanceController instance.
+     *
+     * Currently it's not possible to pass the settings object through the
+     * constructor using Components, so this method exists to be called with the
+     * desired settings, to ensure nothing is collected without the user's
+     * consent.
+     */
+    _init(settings?: PerformanceSettings): void;
+    set instrumentationEnabled(val: boolean);
+    get instrumentationEnabled(): boolean;
+    set dataCollectionEnabled(val: boolean);
+    get dataCollectionEnabled(): boolean;
+}

package/dist/esm/src/controllers/perf.test.d.ts

@@ -1,17 +1,17 @@
-/**
- * @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 '../../test/setup';
+/**
+ * @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 '../../test/setup';

package/dist/esm/src/index.d.ts

@@ -1,46 +1,46 @@
-/**
- * The Firebase Performance Monitoring Web SDK.
- * This SDK does not work in a Node.js environment.
- *
- * @packageDocumentation
- */
-/**
- * @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 { FirebasePerformance, PerformanceSettings, PerformanceTrace } from './public_types';
-import { FirebaseApp } from '@firebase/app';
-import '@firebase/installations';
-/**
- * Returns a {@link FirebasePerformance} instance for the given app.
- * @param app - The {@link @firebase/app#FirebaseApp} to use.
- * @public
- */
-export declare function getPerformance(app?: FirebaseApp): FirebasePerformance;
-/**
- * Returns a {@link FirebasePerformance} instance for the given app. Can only be called once.
- * @param app - The {@link @firebase/app#FirebaseApp} to use.
- * @param settings - Optional settings for the {@link FirebasePerformance} instance.
- * @public
- */
-export declare function initializePerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;
-/**
- * Returns a new `PerformanceTrace` instance.
- * @param performance - The {@link FirebasePerformance} instance to use.
- * @param name - The name of the trace.
- * @public
- */
-export declare function trace(performance: FirebasePerformance, name: string): PerformanceTrace;
-export { FirebasePerformance, PerformanceSettings, PerformanceTrace };
+/**
+ * The Firebase Performance Monitoring Web SDK.
+ * This SDK does not work in a Node.js environment.
+ *
+ * @packageDocumentation
+ */
+/**
+ * @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 { FirebasePerformance, PerformanceSettings, PerformanceTrace } from './public_types';
+import { FirebaseApp } from '@firebase/app';
+import '@firebase/installations';
+/**
+ * Returns a {@link FirebasePerformance} instance for the given app.
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
+ * @public
+ */
+export declare function getPerformance(app?: FirebaseApp): FirebasePerformance;
+/**
+ * Returns a {@link FirebasePerformance} instance for the given app. Can only be called once.
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
+ * @param settings - Optional settings for the {@link FirebasePerformance} instance.
+ * @public
+ */
+export declare function initializePerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;
+/**
+ * Returns a new `PerformanceTrace` instance.
+ * @param performance - The {@link FirebasePerformance} instance to use.
+ * @param name - The name of the trace.
+ * @public
+ */
+export declare function trace(performance: FirebasePerformance, name: string): PerformanceTrace;
+export { FirebasePerformance, PerformanceSettings, PerformanceTrace };

package/dist/esm/src/index.test.d.ts

@@ -1,17 +1,17 @@
-/**
- * @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 '../test/setup';
+/**
+ * @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 '../test/setup';

package/dist/esm/src/public_types.d.ts

@@ -1,136 +1,136 @@
-/**
- * @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';
-/**
- * Defines configuration options for the Performance Monitoring SDK.
- *
- * @public
- */
-export interface PerformanceSettings {
-    /** Whether to collect custom events. */
-    dataCollectionEnabled?: boolean;
-    /** Whether to collect out of the box events. */
-    instrumentationEnabled?: boolean;
-}
-/**
- * The Firebase Performance Monitoring service interface.
- *
- * @public
- */
-export interface FirebasePerformance {
-    /**
-     * The {@link @firebase/app#FirebaseApp} this `FirebasePerformance` instance is associated with.
-     */
-    app: FirebaseApp;
-    /**
-     * Controls the logging of automatic traces and HTTP/S network monitoring.
-     */
-    instrumentationEnabled: boolean;
-    /**
-     * Controls the logging of custom traces.
-     */
-    dataCollectionEnabled: boolean;
-}
-/**
- * The interface representing a `Trace`.
- *
- * @public
- */
-export interface PerformanceTrace {
-    /**
-     * Starts the timing for the trace instance.
-     */
-    start(): void;
-    /**
-     * Stops the timing of the trace instance and logs the data of the instance.
-     */
-    stop(): void;
-    /**
-     * Records a trace from given parameters. This provides a direct way to use trace without a need to
-     * start/stop. This is useful for use cases in which the trace cannot directly be used
-     * (e.g. if the duration was captured before the Performance SDK was loaded).
-     *
-     * @param startTime - trace start time since epoch in millisec.
-     * @param duration - The duration of the trace in millisec.
-     * @param options - An object which can optionally hold maps of custom metrics and
-     * custom attributes.
-     */
-    record(startTime: number, duration: number, options?: {
-        metrics?: {
-            [key: string]: number;
-        };
-        attributes?: {
-            [key: string]: string;
-        };
-    }): void;
-    /**
-     * Adds to the value of a custom metric. If a custom metric with the provided name does not
-     * exist, it creates one with that name and the value equal to the given number. The value will be floored down to an
-     * integer.
-     *
-     * @param metricName - The name of the custom metric.
-     * @param num - The number to be added to the value of the custom metric. If not provided, it
-     * uses a default value of one.
-     */
-    incrementMetric(metricName: string, num?: number): void;
-    /**
-     * Sets the value of the specified custom metric to the given number regardless of whether
-     * a metric with that name already exists on the trace instance or not. The value will be floored down to an
-     * integer.
-     *
-     * @param metricName - Name of the custom metric.
-     * @param num - Value to of the custom metric.
-     */
-    putMetric(metricName: string, num: number): void;
-    /**
-     * Returns the value of the custom metric by that name. If a custom metric with that name does
-     * not exist will return zero.
-     *
-     * @param metricName - Name of the custom metric.
-     */
-    getMetric(metricName: string): number;
-    /**
-     * Set a custom attribute of a trace to a certain value.
-     *
-     * @param attr - Name of the custom attribute.
-     * @param value - Value of the custom attribute.
-     */
-    putAttribute(attr: string, value: string): void;
-    /**
-     * Retrieves the value which a custom attribute is set to.
-     *
-     * @param attr - Name of the custom attribute.
-     */
-    getAttribute(attr: string): string | undefined;
-    /**
-     * Removes the specified custom attribute from a trace instance.
-     *
-     * @param attr - Name of the custom attribute.
-     */
-    removeAttribute(attr: string): void;
-    /**
-     * Returns a map of all custom attributes of a trace instance.
-     */
-    getAttributes(): {
-        [key: string]: string;
-    };
-}
-declare module '@firebase/component' {
-    interface NameServiceMapping {
-        'performance': FirebasePerformance;
-    }
-}
+/**
+ * @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';
+/**
+ * Defines configuration options for the Performance Monitoring SDK.
+ *
+ * @public
+ */
+export interface PerformanceSettings {
+    /** Whether to collect custom events. */
+    dataCollectionEnabled?: boolean;
+    /** Whether to collect out of the box events. */
+    instrumentationEnabled?: boolean;
+}
+/**
+ * The Firebase Performance Monitoring service interface.
+ *
+ * @public
+ */
+export interface FirebasePerformance {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this `FirebasePerformance` instance is associated with.
+     */
+    app: FirebaseApp;
+    /**
+     * Controls the logging of automatic traces and HTTP/S network monitoring.
+     */
+    instrumentationEnabled: boolean;
+    /**
+     * Controls the logging of custom traces.
+     */
+    dataCollectionEnabled: boolean;
+}
+/**
+ * The interface representing a `Trace`.
+ *
+ * @public
+ */
+export interface PerformanceTrace {
+    /**
+     * Starts the timing for the trace instance.
+     */
+    start(): void;
+    /**
+     * Stops the timing of the trace instance and logs the data of the instance.
+     */
+    stop(): void;
+    /**
+     * Records a trace from given parameters. This provides a direct way to use trace without a need to
+     * start/stop. This is useful for use cases in which the trace cannot directly be used
+     * (e.g. if the duration was captured before the Performance SDK was loaded).
+     *
+     * @param startTime - trace start time since epoch in millisec.
+     * @param duration - The duration of the trace in millisec.
+     * @param options - An object which can optionally hold maps of custom metrics and
+     * custom attributes.
+     */
+    record(startTime: number, duration: number, options?: {
+        metrics?: {
+            [key: string]: number;
+        };
+        attributes?: {
+            [key: string]: string;
+        };
+    }): void;
+    /**
+     * Adds to the value of a custom metric. If a custom metric with the provided name does not
+     * exist, it creates one with that name and the value equal to the given number. The value will be floored down to an
+     * integer.
+     *
+     * @param metricName - The name of the custom metric.
+     * @param num - The number to be added to the value of the custom metric. If not provided, it
+     * uses a default value of one.
+     */
+    incrementMetric(metricName: string, num?: number): void;
+    /**
+     * Sets the value of the specified custom metric to the given number regardless of whether
+     * a metric with that name already exists on the trace instance or not. The value will be floored down to an
+     * integer.
+     *
+     * @param metricName - Name of the custom metric.
+     * @param num - Value to of the custom metric.
+     */
+    putMetric(metricName: string, num: number): void;
+    /**
+     * Returns the value of the custom metric by that name. If a custom metric with that name does
+     * not exist will return zero.
+     *
+     * @param metricName - Name of the custom metric.
+     */
+    getMetric(metricName: string): number;
+    /**
+     * Set a custom attribute of a trace to a certain value.
+     *
+     * @param attr - Name of the custom attribute.
+     * @param value - Value of the custom attribute.
+     */
+    putAttribute(attr: string, value: string): void;
+    /**
+     * Retrieves the value which a custom attribute is set to.
+     *
+     * @param attr - Name of the custom attribute.
+     */
+    getAttribute(attr: string): string | undefined;
+    /**
+     * Removes the specified custom attribute from a trace instance.
+     *
+     * @param attr - Name of the custom attribute.
+     */
+    removeAttribute(attr: string): void;
+    /**
+     * Returns a map of all custom attributes of a trace instance.
+     */
+    getAttributes(): {
+        [key: string]: string;
+    };
+}
+declare module '@firebase/component' {
+    interface NameServiceMapping {
+        'performance': FirebasePerformance;
+    }
+}

package/dist/esm/src/resources/network_request.d.ts

@@ -1,43 +1,43 @@
-/**
- * @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 { PerformanceController } from '../controllers/perf';
-export declare const enum HttpMethod {
-    HTTP_METHOD_UNKNOWN = 0,
-    GET = 1,
-    PUT = 2,
-    POST = 3,
-    DELETE = 4,
-    HEAD = 5,
-    PATCH = 6,
-    OPTIONS = 7,
-    TRACE = 8,
-    CONNECT = 9
-}
-export interface NetworkRequest {
-    performanceController: PerformanceController;
-    url: string;
-    httpMethod?: HttpMethod;
-    requestPayloadBytes?: number;
-    responsePayloadBytes?: number;
-    httpResponseCode?: number;
-    responseContentType?: string;
-    startTimeUs?: number;
-    timeToRequestCompletedUs?: number;
-    timeToResponseInitiatedUs?: number;
-    timeToResponseCompletedUs?: number;
-}
-export declare function createNetworkRequestEntry(performanceController: PerformanceController, entry: PerformanceEntry): void;
+/**
+ * @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 { PerformanceController } from '../controllers/perf';
+export declare const enum HttpMethod {
+    HTTP_METHOD_UNKNOWN = 0,
+    GET = 1,
+    PUT = 2,
+    POST = 3,
+    DELETE = 4,
+    HEAD = 5,
+    PATCH = 6,
+    OPTIONS = 7,
+    TRACE = 8,
+    CONNECT = 9
+}
+export interface NetworkRequest {
+    performanceController: PerformanceController;
+    url: string;
+    httpMethod?: HttpMethod;
+    requestPayloadBytes?: number;
+    responsePayloadBytes?: number;
+    httpResponseCode?: number;
+    responseContentType?: string;
+    startTimeUs?: number;
+    timeToRequestCompletedUs?: number;
+    timeToResponseInitiatedUs?: number;
+    timeToResponseCompletedUs?: number;
+}
+export declare function createNetworkRequestEntry(performanceController: PerformanceController, entry: PerformanceEntry): void;

package/dist/esm/src/resources/network_request.test.d.ts

@@ -1,17 +1,17 @@
-/**
- * @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 '../../test/setup';
+/**
+ * @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 '../../test/setup';