@depup/firebase__performance 0.7.10-depup.0

package/dist/src/resources/trace.d.ts

@@ -0,0 +1,121 @@
+/**
+ * @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 { PerformanceTrace } from '../public_types';
+import { PerformanceController } from '../controllers/perf';
+import { CoreVitalMetric, WebVitalMetrics } from './web_vitals';
+export declare class Trace implements PerformanceTrace {
+    readonly performanceController: PerformanceController;
+    readonly name: string;
+    readonly isAuto: boolean;
+    private state;
+    startTimeUs: number;
+    durationUs: number;
+    private customAttributes;
+    counters: {
+        [counterName: string]: number;
+    };
+    private api;
+    private randomId;
+    private traceStartMark;
+    private traceStopMark;
+    private traceMeasure;
+    /**
+     * @param performanceController The performance controller running.
+     * @param name The name of the trace.
+     * @param isAuto If the trace is auto-instrumented.
+     * @param traceMeasureName The name of the measure marker in user timing specification. This field
+     * is only set when the trace is built for logging when the user directly uses the user timing
+     * api (performance.mark and performance.measure).
+     */
+    constructor(performanceController: PerformanceController, name: string, isAuto?: boolean, traceMeasureName?: string);
+    /**
+     * Starts a trace. The measurement of the duration starts at this point.
+     */
+    start(): void;
+    /**
+     * Stops the trace. The measurement of the duration of the trace stops at this point and trace
+     * is logged.
+     */
+    stop(): void;
+    /**
+     * Records a trace with predetermined values. If this method is used a trace is created and logged
+     * directly. No need to use start and stop methods.
+     * @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;
+    /**
+     * Increments a custom metric by a certain number or 1 if number not specified. Will create a new
+     * custom metric if one with the given name does not exist. The value will be floored down to an
+     * integer.
+     * @param counter Name of the custom metric
+     * @param numAsInteger Increment by value
+     */
+    incrementMetric(counter: string, numAsInteger?: number): void;
+    /**
+     * Sets a custom metric to a specified value. Will create a new custom metric if one with the
+     * given name does not exist. The value will be floored down to an integer.
+     * @param counter Name of the custom metric
+     * @param numAsInteger Set custom metric to this value
+     */
+    putMetric(counter: string, numAsInteger: 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 counter
+     */
+    getMetric(counter: string): number;
+    /**
+     * Sets a custom attribute of a trace to a certain value.
+     * @param attr
+     * @param value
+     */
+    putAttribute(attr: string, value: string): void;
+    /**
+     * Retrieves the value a custom attribute of a trace is set to.
+     * @param attr
+     */
+    getAttribute(attr: string): string | undefined;
+    removeAttribute(attr: string): void;
+    getAttributes(): {
+        [key: string]: string;
+    };
+    private setStartTime;
+    private setDuration;
+    /**
+     * Calculates and assigns the duration and start time of the trace using the measure performance
+     * entry.
+     */
+    private calculateTraceMetrics;
+    /**
+     * @param navigationTimings A single element array which contains the navigationTIming object of
+     * the page load
+     * @param paintTimings A array which contains paintTiming object of the page load
+     * @param firstInputDelay First input delay in millisec
+     */
+    static createOobTrace(performanceController: PerformanceController, navigationTimings: PerformanceNavigationTiming[], paintTimings: PerformanceEntry[], webVitalMetrics: WebVitalMetrics, firstInputDelay?: number): void;
+    static addWebVitalMetric(trace: Trace, metricKey: string, attributeKey: string, metric?: CoreVitalMetric): void;
+    static createUserTimingTrace(performanceController: PerformanceController, measureName: string): void;
+}

package/dist/src/resources/web_vitals.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2024 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 interface CoreVitalMetric {
+    value: number;
+    elementAttribution?: string;
+}
+export interface WebVitalMetrics {
+    cls?: CoreVitalMetric;
+    inp?: CoreVitalMetric;
+    lcp?: CoreVitalMetric;
+}

package/dist/src/services/api_service.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @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 { CLSMetricWithAttribution, INPMetricWithAttribution, LCPMetricWithAttribution } from 'web-vitals/attribution';
+declare global {
+    interface Window {
+        PerformanceObserver: typeof PerformanceObserver;
+        perfMetrics?: {
+            onFirstInputDelay(fn: (fid: number) => void): void;
+        };
+    }
+}
+export type EntryType = 'mark' | 'measure' | 'paint' | 'resource' | 'frame' | 'navigation';
+/**
+ * This class holds a reference to various browser related objects injected by
+ * set methods.
+ */
+export declare class Api {
+    readonly window?: Window | undefined;
+    private readonly performance;
+    /** PerformanceObserver constructor function. */
+    private readonly PerformanceObserver;
+    private readonly windowLocation;
+    readonly onFirstInputDelay?: (fn: (fid: number) => void) => void;
+    readonly onLCP: (fn: (metric: LCPMetricWithAttribution) => void) => void;
+    readonly onINP: (fn: (metric: INPMetricWithAttribution) => void) => void;
+    readonly onCLS: (fn: (metric: CLSMetricWithAttribution) => void) => void;
+    readonly localStorage?: Storage;
+    readonly document: Document;
+    readonly navigator: Navigator;
+    constructor(window?: Window | undefined);
+    getUrl(): string;
+    mark(name: string): void;
+    measure(measureName: string, mark1: string, mark2: string): void;
+    getEntriesByType(type: EntryType): PerformanceEntry[];
+    getEntriesByName(name: string): PerformanceEntry[];
+    getTimeOrigin(): number;
+    requiredApisAvailable(): boolean;
+    setupObserver(entryType: EntryType, callback: (entry: PerformanceEntry) => void): void;
+    static getInstance(): Api;
+}
+export declare function setupApi(window: Window): void;

package/dist/src/services/iid_service.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 { _FirebaseInstallationsInternal } from '@firebase/installations';
+export declare function getIidPromise(installationsService: _FirebaseInstallationsInternal): Promise<string>;
+export declare function getIid(): string | undefined;
+export declare function getAuthTokenPromise(installationsService: _FirebaseInstallationsInternal): Promise<string>;
+export declare function getAuthenticationToken(): string | undefined;

package/dist/src/services/initialization_service.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @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 function getInitializationPromise(performanceController: PerformanceController): Promise<void>;
+export declare function isPerfInitialized(): boolean;

package/dist/src/services/oob_resources_service.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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 function setupOobResources(performanceController: PerformanceController): void;
+/**
+ * This service will only export the page load trace once. This function allows
+ * resetting it for unit tests
+ */
+export declare function resetForUnitTests(): void;

package/dist/src/services/perf_logger.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 { NetworkRequest } from '../resources/network_request';
+import { Trace } from '../resources/trace';
+export declare function logTrace(trace: Trace): void;
+export declare function flushLogs(): void;
+export declare function logNetworkRequest(networkRequest: NetworkRequest): void;

package/dist/src/services/remote_config_service.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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 function getConfig(performanceController: PerformanceController, iid: string): Promise<void>;

package/dist/src/services/settings_service.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @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 class SettingsService {
+    instrumentationEnabled: boolean;
+    dataCollectionEnabled: boolean;
+    loggingEnabled: boolean;
+    tracesSamplingRate: number;
+    networkRequestsSamplingRate: number;
+    logEndPointUrl: string;
+    flTransportEndpointUrl: string;
+    transportKey: string;
+    logSource: number;
+    logTraceAfterSampling: boolean;
+    logNetworkAfterSampling: boolean;
+    configTimeToLive: number;
+    logMaxFlushSize: number;
+    getFlTransportFullUrl(): string;
+    static getInstance(): SettingsService;
+}

package/dist/src/services/transport_service.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.
+ */
+export declare function setupTransportService(): void;
+/**
+ * Utilized by testing to clean up message queue and un-initialize transport service.
+ */
+export declare function resetTransportService(): void;
+/** Log handler for cc service to send the performance logs to the server. */
+export declare function transportHandler(serializer: (...args: any[]) => string): (...args: unknown[]) => void;
+/**
+ * Force flush the queued events. Useful at page unload time to ensure all events are uploaded.
+ * Flush will attempt to use sendBeacon to send events async and defaults back to fetch as soon as a
+ * sendBeacon fails. Firefox
+ */
+export declare function flushQueuedEvents(): void;

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/utils/app_utils.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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';
+export declare function getAppId(firebaseApp: FirebaseApp): string;
+export declare function getProjectId(firebaseApp: FirebaseApp): string;
+export declare function getApiKey(firebaseApp: FirebaseApp): string;

package/dist/src/utils/attributes_utils.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @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.
+ */
+declare const enum ServiceWorkerStatus {
+    UNKNOWN = 0,
+    UNSUPPORTED = 1,
+    CONTROLLED = 2,
+    UNCONTROLLED = 3
+}
+export declare enum VisibilityState {
+    UNKNOWN = 0,
+    VISIBLE = 1,
+    HIDDEN = 2
+}
+declare const enum EffectiveConnectionType {
+    UNKNOWN = 0,
+    CONNECTION_SLOW_2G = 1,
+    CONNECTION_2G = 2,
+    CONNECTION_3G = 3,
+    CONNECTION_4G = 4
+}
+export declare const MAX_ATTRIBUTE_VALUE_LENGTH = 100;
+export declare function getServiceWorkerStatus(): ServiceWorkerStatus;
+export declare function getVisibilityState(): VisibilityState;
+export declare function getEffectiveConnectionType(): EffectiveConnectionType;
+export declare function isValidCustomAttributeName(name: string): boolean;
+export declare function isValidCustomAttributeValue(value: string): boolean;
+export {};

package/dist/src/utils/console_logger.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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 { Logger } from '@firebase/logger';
+export declare const consoleLogger: Logger;

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

@@ -0,0 +1,60 @@
+/**
+ * @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 { ErrorFactory } from '@firebase/util';
+export declare const enum ErrorCode {
+    TRACE_STARTED_BEFORE = "trace started",
+    TRACE_STOPPED_BEFORE = "trace stopped",
+    NONPOSITIVE_TRACE_START_TIME = "nonpositive trace startTime",
+    NONPOSITIVE_TRACE_DURATION = "nonpositive trace duration",
+    NO_WINDOW = "no window",
+    NO_APP_ID = "no app id",
+    NO_PROJECT_ID = "no project id",
+    NO_API_KEY = "no api key",
+    INVALID_CC_LOG = "invalid cc log",
+    FB_NOT_DEFAULT = "FB not default",
+    RC_NOT_OK = "RC response not ok",
+    INVALID_ATTRIBUTE_NAME = "invalid attribute name",
+    INVALID_ATTRIBUTE_VALUE = "invalid attribute value",
+    INVALID_CUSTOM_METRIC_NAME = "invalid custom metric name",
+    INVALID_STRING_MERGER_PARAMETER = "invalid String merger input",
+    ALREADY_INITIALIZED = "already initialized"
+}
+interface ErrorParams {
+    [ErrorCode.TRACE_STARTED_BEFORE]: {
+        traceName: string;
+    };
+    [ErrorCode.TRACE_STOPPED_BEFORE]: {
+        traceName: string;
+    };
+    [ErrorCode.NONPOSITIVE_TRACE_START_TIME]: {
+        traceName: string;
+    };
+    [ErrorCode.NONPOSITIVE_TRACE_DURATION]: {
+        traceName: string;
+    };
+    [ErrorCode.INVALID_ATTRIBUTE_NAME]: {
+        attributeName: string;
+    };
+    [ErrorCode.INVALID_ATTRIBUTE_VALUE]: {
+        attributeValue: string;
+    };
+    [ErrorCode.INVALID_CUSTOM_METRIC_NAME]: {
+        customMetricName: string;
+    };
+}
+export declare const ERROR_FACTORY: ErrorFactory<ErrorCode, ErrorParams>;
+export {};

package/dist/src/utils/metric_utils.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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.
+ */
+/**
+ * Returns true if the metric is custom and does not start with reserved prefix, or if
+ * the metric is one of out of the box page load trace metrics.
+ */
+export declare function isValidMetricName(name: string, traceName?: string): boolean;
+/**
+ * Converts the provided value to an integer value to be used in case of a metric.
+ * @param providedValue Provided number value of the metric that needs to be converted to an integer.
+ *
+ * @returns Converted integer number to be set for the metric.
+ */
+export declare function convertMetricValueToInteger(providedValue: number): number;

package/dist/src/utils/string_merger.d.ts

@@ -0,0 +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.
+ */
+export declare function mergeStrings(part1: string, part2: string): string;

package/dist/test/setup.d.ts

@@ -0,0 +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.
+ */
+export {};