@firebase/util 1.10.1 → 1.10.2

package/dist/src/jwt.d.ts

@@ -1,73 +1,73 @@
-/**
- * @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 {};
+/**
+ * @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/src/obj.d.ts

@@ -1,30 +1,30 @@
-/**
- * @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;
+/**
+ * @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/src/promise.d.ts

@@ -1,21 +1,21 @@
-/**
- * @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>;
+/**
+ * @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/src/query.d.ts

@@ -1,33 +1,33 @@
-/**
- * @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;
+/**
+ * @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/src/sha1.d.ts

@@ -1,84 +1,84 @@
-/**
- * @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[];
-}
+/**
+ * @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/src/subscribe.d.ts

@@ -1,49 +1,49 @@
-/**
- * @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 type NextFn<T> = (value: T) => void;
-export declare type ErrorFn = (error: Error) => void;
-export declare type CompleteFn = () => void;
-export interface Observer<T> {
-    next: NextFn<T>;
-    error: ErrorFn;
-    complete: CompleteFn;
-}
-export declare type PartialObserver<T> = Partial<Observer<T>>;
-export declare 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 declare 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;
+/**
+ * @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/src/utf8.d.ts

@@ -1,27 +1,27 @@
-/**
- * @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;
+/**
+ * @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;