@firebase/rules-unit-testing 4.0.1-canary.4e6a5c670 → 4.0.1-canary.59ae45e48

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

@@ -1,87 +0,0 @@
-/**
- * @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.
- */
-/**
- * @fileoverview Standardized Firebase Error.
- *
- * Usage:
- *
- *   // TypeScript string literals for type-safe codes
- *   type Err =
- *     'unknown' |
- *     'object-not-found'
- *     ;
- *
- *   // Closure enum for type-safe error codes
- *   // at-enum {string}
- *   var Err = {
- *     UNKNOWN: 'unknown',
- *     OBJECT_NOT_FOUND: 'object-not-found',
- *   }
- *
- *   let errors: Map<Err, string> = {
- *     'generic-error': "Unknown error",
- *     'file-not-found': "Could not find file: {$file}",
- *   };
- *
- *   // Type-safe function - must pass a valid error code as param.
- *   let error = new ErrorFactory<Err>('service', 'Service', errors);
- *
- *   ...
- *   throw error.create(Err.GENERIC);
- *   ...
- *   throw error.create(Err.FILE_NOT_FOUND, {'file': fileName});
- *   ...
- *   // Service: Could not file file: foo.txt (service/file-not-found).
- *
- *   catch (e) {
- *     assert(e.message === "Could not find file: foo.txt.");
- *     if ((e as FirebaseError)?.code === 'service/file-not-found') {
- *       console.log("Could not read file: " + e['file']);
- *     }
- *   }
- */
-export type ErrorMap<ErrorCode extends string> = {
-    readonly [K in ErrorCode]: string;
-};
-export interface StringLike {
-    toString(): string;
-}
-export interface ErrorData {
-    [key: string]: unknown;
-}
-export declare class FirebaseError extends Error {
-    /** The error code for this error. */
-    readonly code: string;
-    /** Custom data for this error. */
-    customData?: Record<string, unknown> | undefined;
-    /** The custom name for all FirebaseErrors. */
-    readonly name: string;
-    constructor(
-    /** The error code for this error. */
-    code: string, message: string, 
-    /** Custom data for this error. */
-    customData?: Record<string, unknown> | undefined);
-}
-export declare class ErrorFactory<ErrorCode extends string, ErrorParams extends {
-    readonly [K in ErrorCode]?: ErrorData;
-} = {}> {
-    private readonly service;
-    private readonly serviceName;
-    private readonly errors;
-    constructor(service: string, serviceName: string, errors: ErrorMap<ErrorCode>);
-    create<K extends ErrorCode>(code: K, ...data: K extends keyof ErrorParams ? [ErrorParams[K]] : []): FirebaseError;
-}

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

@@ -1,37 +0,0 @@
-/**
- * @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.
- */
-/**
- * The maximum milliseconds to increase to.
- *
- * <p>Visible for testing
- */
-export declare const MAX_VALUE_MILLIS: number;
-/**
- * The percentage of backoff time to randomize by.
- * See
- * http://go/safe-client-behavior#step-1-determine-the-appropriate-retry-interval-to-handle-spike-traffic
- * for context.
- *
- * <p>Visible for testing
- */
-export declare const RANDOM_FACTOR = 0.5;
-/**
- * Based on the backoff method from
- * https://github.com/google/closure-library/blob/master/closure/goog/math/exponentialbackoff.js.
- * Extracted here so we don't need to pass metadata and a stateful ExponentialBackoff object around.
- */
-export declare function calculateBackoffMillis(backoffCount: number, intervalMillis?: number, backoffFactor?: number): number;

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

@@ -1,20 +0,0 @@
-/**
- * @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.
- */
-/**
- * Provide English ordinal letters after a number
- */
-export declare function ordinal(i: number): string;

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

@@ -1,22 +0,0 @@
-/**
- * @license
- * Copyright 2022 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.
- */
-/**
- * Polyfill for `globalThis` object.
- * @returns the `globalThis` object for the given environment.
- * @public
- */
-export declare function getGlobal(): typeof globalThis;

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

@@ -1,29 +0,0 @@
-/**
- * @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.
- */
-/**
- * Evaluates a JSON string into a javascript object.
- *
- * @param {string} str A string containing JSON.
- * @return {*} The javascript object representing the specified JSON.
- */
-export declare function jsonEval(str: string): unknown;
-/**
- * Returns JSON representing a javascript object.
- * @param {*} data JavaScript object to be stringified.
- * @return {string} The JSON contents of the object.
- */
-export declare function stringify(data: unknown): string;

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

@@ -1,73 +0,0 @@
-/**
- * @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.
- */
-interface Claims {
-    [key: string]: {};
-}
-interface DecodedToken {
-    header: object;
-    claims: Claims;
-    data: object;
-    signature: string;
-}
-/**
- * Decodes a Firebase auth. token into constituent parts.
- *
- * Notes:
- * - May return with invalid / incomplete claims if there's no native base64 decoding support.
- * - Doesn't check if the token is actually valid.
- */
-export declare const decode: (token: string) => DecodedToken;
-interface DecodedToken {
-    header: object;
-    claims: Claims;
-    data: object;
-    signature: string;
-}
-/**
- * Decodes a Firebase auth. token and checks the validity of its time-based claims. Will return true if the
- * token is within the time window authorized by the 'nbf' (not-before) and 'iat' (issued-at) claims.
- *
- * Notes:
- * - May return a false negative if there's no native base64 decoding support.
- * - Doesn't check if the token is actually valid.
- */
-export declare const isValidTimestamp: (token: string) => boolean;
-/**
- * Decodes a Firebase auth. token and returns its issued at time if valid, null otherwise.
- *
- * Notes:
- * - May return null if there's no native base64 decoding support.
- * - Doesn't check if the token is actually valid.
- */
-export declare const issuedAtTime: (token: string) => number | null;
-/**
- * Decodes a Firebase auth. token and checks the validity of its format. Expects a valid issued-at time.
- *
- * Notes:
- * - May return a false negative if there's no native base64 decoding support.
- * - Doesn't check if the token is actually valid.
- */
-export declare const isValidFormat: (token: string) => boolean;
-/**
- * Attempts to peer into an auth token and determine if it's an admin auth token by looking at the claims portion.
- *
- * Notes:
- * - May return a false negative if there's no native base64 decoding support.
- * - Doesn't check if the token is actually valid.
- */
-export declare const isAdmin: (token: string) => boolean;
-export {};

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

@@ -1,30 +0,0 @@
-/**
- * @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.
- */
-export declare function contains<T extends object>(obj: T, key: string): boolean;
-export declare function safeGet<T extends object, K extends keyof T>(obj: T, key: K): T[K] | undefined;
-export declare function isEmpty(obj: object): obj is {};
-export declare function map<K extends string, V, U>(obj: {
-    [key in K]: V;
-}, fn: (value: V, key: K, obj: {
-    [key in K]: V;
-}) => U, contextObj?: unknown): {
-    [key in K]: U;
-};
-/**
- * Deep equal two objects. Support Arrays and Objects.
- */
-export declare function deepEqual(a: object, b: object): boolean;

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

@@ -1,21 +0,0 @@
-/**
- * @license
- * Copyright 2022 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.
- */
-/**
- * Rejects if the given promise doesn't resolve in timeInMS milliseconds.
- * @internal
- */
-export declare function promiseWithTimeout<T>(promise: Promise<T>, timeInMS?: number): Promise<T>;

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

@@ -1,33 +0,0 @@
-/**
- * @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.
- */
-/**
- * Returns a querystring-formatted string (e.g. &arg=val&arg2=val2) from a
- * params object (e.g. {arg: 'val', arg2: 'val2'})
- * Note: You must prepend it with ? when adding it to a URL.
- */
-export declare function querystring(querystringParams: {
-    [key: string]: string | number;
-}): string;
-/**
- * Decodes a querystring (e.g. ?arg=val&arg2=val2) into a params object
- * (e.g. {arg: 'val', arg2: 'val2'})
- */
-export declare function querystringDecode(querystring: string): Record<string, string>;
-/**
- * Extract the query string part of a URL, including the leading question mark (if present).
- */
-export declare function extractQuerystring(url: string): string;

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

@@ -1,84 +0,0 @@
-/**
- * @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.
- */
-/**
- * @fileoverview SHA-1 cryptographic hash.
- * Variable names follow the notation in FIPS PUB 180-3:
- * http://csrc.nist.gov/publications/fips/fips180-3/fips180-3_final.pdf.
- *
- * Usage:
- *   var sha1 = new sha1();
- *   sha1.update(bytes);
- *   var hash = sha1.digest();
- *
- * Performance:
- *   Chrome 23:   ~400 Mbit/s
- *   Firefox 16:  ~250 Mbit/s
- *
- */
-/**
- * SHA-1 cryptographic hash constructor.
- *
- * The properties declared here are discussed in the above algorithm document.
- * @constructor
- * @final
- * @struct
- */
-export declare class Sha1 {
-    /**
-     * Holds the previous values of accumulated variables a-e in the compress_
-     * function.
-     * @private
-     */
-    private chain_;
-    /**
-     * A buffer holding the partially computed hash result.
-     * @private
-     */
-    private buf_;
-    /**
-     * An array of 80 bytes, each a part of the message to be hashed.  Referred to
-     * as the message schedule in the docs.
-     * @private
-     */
-    private W_;
-    /**
-     * Contains data needed to pad messages less than 64 bytes.
-     * @private
-     */
-    private pad_;
-    /**
-     * @private {number}
-     */
-    private inbuf_;
-    /**
-     * @private {number}
-     */
-    private total_;
-    blockSize: number;
-    constructor();
-    reset(): void;
-    /**
-     * Internal compress helper function.
-     * @param buf Block to compress.
-     * @param offset Offset of the block in the buffer.
-     * @private
-     */
-    compress_(buf: number[] | Uint8Array | string, offset?: number): void;
-    update(bytes?: number[] | Uint8Array | string, length?: number): void;
-    /** @override */
-    digest(): number[];
-}

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

@@ -1,49 +0,0 @@
-/**
- * @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.
- */
-export type NextFn<T> = (value: T) => void;
-export type ErrorFn = (error: Error) => void;
-export type CompleteFn = () => void;
-export interface Observer<T> {
-    next: NextFn<T>;
-    error: ErrorFn;
-    complete: CompleteFn;
-}
-export type PartialObserver<T> = Partial<Observer<T>>;
-export type Unsubscribe = () => void;
-/**
- * The Subscribe interface has two forms - passing the inline function
- * callbacks, or a object interface with callback properties.
- */
-export interface Subscribe<T> {
-    (next?: NextFn<T>, error?: ErrorFn, complete?: CompleteFn): Unsubscribe;
-    (observer: PartialObserver<T>): Unsubscribe;
-}
-export interface Observable<T> {
-    subscribe: Subscribe<T>;
-}
-export type Executor<T> = (observer: Observer<T>) => void;
-/**
- * Helper to make a Subscribe function (just like Promise helps make a
- * Thenable).
- *
- * @param executor Function which can make calls to a single Observer
- *     as a proxy.
- * @param onNoObservers Callback when count of Observers goes to zero.
- */
-export declare function createSubscribe<T>(executor: Executor<T>, onNoObservers?: Executor<T>): Subscribe<T>;
-/** Turn synchronous function into one called asynchronously. */
-export declare function async(fn: Function, onError?: ErrorFn): Function;

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

@@ -1,27 +0,0 @@
-/**
- * @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.
- */
-/**
- * @param {string} str
- * @return {Array}
- */
-export declare const stringToByteArray: (str: string) => number[];
-/**
- * Calculate length without actually converting; useful for doing cheaper validation.
- * @param {string} str
- * @return {number}
- */
-export declare const stringLength: (str: string) => number;

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

@@ -1,43 +0,0 @@
-/**
- * @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.
- */
-/**
- * Check to make sure the appropriate number of arguments are provided for a public function.
- * Throws an error if it fails.
- *
- * @param fnName The function name
- * @param minCount The minimum number of arguments to allow for the function call
- * @param maxCount The maximum number of argument to allow for the function call
- * @param argCount The actual number of arguments provided.
- */
-export declare const validateArgCount: (fnName: string, minCount: number, maxCount: number, argCount: number) => void;
-/**
- * Generates a string to prefix an error message about failed argument validation
- *
- * @param fnName The function name
- * @param argName The name of the argument
- * @return The prefix to add to the error thrown for validation.
- */
-export declare function errorPrefix(fnName: string, argName: string): string;
-/**
- * @param fnName
- * @param argumentNumber
- * @param namespace
- * @param optional
- */
-export declare function validateNamespace(fnName: string, namespace: string, optional: boolean): void;
-export declare function validateCallback(fnName: string, argumentName: string, callback: Function, optional: boolean): void;
-export declare function validateContextObject(fnName: string, argumentName: string, context: unknown, optional: boolean): void;

package/dist/firebase/compat/firestore/index.d.ts

@@ -1,17 +0,0 @@
-/**
- * @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 '@firebase/firestore-compat';

package/dist/util/index.d.ts

@@ -1,38 +0,0 @@
-/**
- * @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.
- */
-export * from './src/assert';
-export * from './src/crypt';
-export * from './src/constants';
-export * from './src/deepCopy';
-export * from './src/defaults';
-export * from './src/deferred';
-export * from './src/emulator';
-export * from './src/environment';
-export * from './src/errors';
-export * from './src/json';
-export * from './src/jwt';
-export * from './src/obj';
-export * from './src/promise';
-export * from './src/query';
-export * from './src/sha1';
-export * from './src/subscribe';
-export * from './src/validation';
-export * from './src/utf8';
-export * from './src/exponential_backoff';
-export * from './src/formatters';
-export * from './src/compat';
-export * from './src/global';

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

@@ -1,24 +0,0 @@
-/**
- * @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.
- */
-/**
- * Throws an error if the provided assertion is falsy
- */
-export declare const assert: (assertion: unknown, message: string) => void;
-/**
- * Returns an Error object suitable for throwing.
- */
-export declare const assertionError: (message: string) => Error;

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

@@ -1,20 +0,0 @@
-/**
- * @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.
- */
-export interface Compat<T> {
-    _delegate: T;
-}
-export declare function getModularInstance<ExpService>(service: Compat<ExpService> | ExpService): ExpService;