@firebase/storage 0.8.4-pr5646.4594d3fd6 → 0.8.5

package/dist/node-esm/src/api.d.ts

@@ -0,0 +1,184 @@
+/**
+ * @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 { StorageReference, FirebaseStorage, UploadResult, ListOptions, ListResult, UploadTask, SettableMetadata, UploadMetadata, FullMetadata } from './public-types';
+import { Reference } from './reference';
+import { EmulatorMockTokenOptions } from '@firebase/util';
+import { StringFormat } from './implementation/string';
+export { EmulatorMockTokenOptions } from '@firebase/util';
+/**
+ * Public types.
+ */
+export * from './public-types';
+export { Location as _Location } from './implementation/location';
+export { UploadTask as _UploadTask } from './task';
+export type { Reference as _Reference } from './reference';
+export type { FirebaseStorageImpl as _FirebaseStorageImpl } from './service';
+export { FbsBlob as _FbsBlob } from './implementation/blob';
+export { dataFromString as _dataFromString } from './implementation/string';
+export { invalidRootOperation as _invalidRootOperation, invalidArgument as _invalidArgument } from './implementation/error';
+export { TaskEvent as _TaskEvent, TaskState as _TaskState } from './implementation/taskenums';
+export { StringFormat };
+/**
+ * Uploads data to this object's location.
+ * The upload is not resumable.
+ * @public
+ * @param ref - {@link StorageReference} where data should be uploaded.
+ * @param data - The data to upload.
+ * @param metadata - Metadata for the data to upload.
+ * @returns A Promise containing an UploadResult
+ */
+export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
+/**
+ * Uploads a string to this object's location.
+ * The upload is not resumable.
+ * @public
+ * @param ref - {@link StorageReference} where string should be uploaded.
+ * @param value - The string to upload.
+ * @param format - The format of the string to upload.
+ * @param metadata - Metadata for the string to upload.
+ * @returns A Promise containing an UploadResult
+ */
+export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
+/**
+ * Uploads data to this object's location.
+ * The upload can be paused and resumed, and exposes progress updates.
+ * @public
+ * @param ref - {@link StorageReference} where data should be uploaded.
+ * @param data - The data to upload.
+ * @param metadata - Metadata for the data to upload.
+ * @returns An UploadTask
+ */
+export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
+/**
+ * A `Promise` that resolves with the metadata for this object. If this
+ * object doesn't exist or metadata cannot be retreived, the promise is
+ * rejected.
+ * @public
+ * @param ref - {@link StorageReference} to get metadata from.
+ */
+export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
+/**
+ * Updates the metadata for this object.
+ * @public
+ * @param ref - {@link StorageReference} to update metadata for.
+ * @param metadata - The new metadata for the object.
+ *     Only values that have been explicitly set will be changed. Explicitly
+ *     setting a value to null will remove the metadata.
+ * @returns A `Promise` that resolves with the new metadata for this object.
+ */
+export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
+/**
+ * List items (files) and prefixes (folders) under this storage reference.
+ *
+ * List API is only available for Firebase Rules Version 2.
+ *
+ * GCS is a key-blob store. Firebase Storage imposes the semantic of '/'
+ * delimited folder structure.
+ * Refer to GCS's List API if you want to learn more.
+ *
+ * To adhere to Firebase Rules's Semantics, Firebase Storage does not
+ * support objects whose paths end with "/" or contain two consecutive
+ * "/"s. Firebase Storage List API will filter these unsupported objects.
+ * list() may fail if there are too many unsupported objects in the bucket.
+ * @public
+ *
+ * @param ref - {@link StorageReference} to get list from.
+ * @param options - See {@link ListOptions} for details.
+ * @returns A `Promise` that resolves with the items and prefixes.
+ *      `prefixes` contains references to sub-folders and `items`
+ *      contains references to objects in this folder. `nextPageToken`
+ *      can be used to get the rest of the results.
+ */
+export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
+/**
+ * List all items (files) and prefixes (folders) under this storage reference.
+ *
+ * This is a helper method for calling list() repeatedly until there are
+ * no more results. The default pagination size is 1000.
+ *
+ * Note: The results may not be consistent if objects are changed while this
+ * operation is running.
+ *
+ * Warning: `listAll` may potentially consume too many resources if there are
+ * too many results.
+ * @public
+ * @param ref - {@link StorageReference} to get list from.
+ *
+ * @returns A `Promise` that resolves with all the items and prefixes under
+ *      the current storage reference. `prefixes` contains references to
+ *      sub-directories and `items` contains references to objects in this
+ *      folder. `nextPageToken` is never returned.
+ */
+export declare function listAll(ref: StorageReference): Promise<ListResult>;
+/**
+ * Returns the download URL for the given {@link StorageReference}.
+ * @public
+ * @param ref - {@link StorageReference} to get the download URL for.
+ * @returns A `Promise` that resolves with the download
+ *     URL for this object.
+ */
+export declare function getDownloadURL(ref: StorageReference): Promise<string>;
+/**
+ * Deletes the object at this location.
+ * @public
+ * @param ref - {@link StorageReference} for object to delete.
+ * @returns A `Promise` that resolves if the deletion succeeds.
+ */
+export declare function deleteObject(ref: StorageReference): Promise<void>;
+/**
+ * Returns a {@link StorageReference} for the given url.
+ * @param storage - {@link FirebaseStorage} instance.
+ * @param url - URL. If empty, returns root reference.
+ * @public
+ */
+export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
+/**
+ * Returns a {@link StorageReference} for the given path in the
+ * default bucket.
+ * @param storageOrRef - {@link FirebaseStorage} or {@link StorageReference}.
+ * @param pathOrUrlStorage - path. If empty, returns root reference (if {@link FirebaseStorage}
+ * instance provided) or returns same reference (if {@link StorageReference} provided).
+ * @public
+ */
+export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
+/**
+ * @internal
+ */
+export declare function _getChild(ref: StorageReference, childPath: string): Reference;
+/**
+ * Gets a {@link FirebaseStorage} instance for the given Firebase app.
+ * @public
+ * @param app - Firebase app to get {@link FirebaseStorage} instance for.
+ * @param bucketUrl - The gs:// url to your Firebase Storage Bucket.
+ * If not passed, uses the app's default Storage Bucket.
+ * @returns A {@link FirebaseStorage} instance.
+ */
+export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
+/**
+ * Modify this {@link FirebaseStorage} instance to communicate with the Cloud Storage emulator.
+ *
+ * @param storage - The {@link FirebaseStorage} instance
+ * @param host - The emulator host (ex: localhost)
+ * @param port - The emulator port (ex: 5001)
+ * @param options - Emulator options. `options.mockUserToken` is the mock auth
+ * token to use for unit testing Security Rules.
+ * @public
+ */
+export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
+    mockUserToken?: EmulatorMockTokenOptions | string;
+}): void;

package/dist/node-esm/src/api.node.d.ts

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

package/dist/node-esm/src/constants.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.
+ */
+/**
+ * Type constant for Firebase Storage.
+ */
+export declare const STORAGE_TYPE = "storage";

package/dist/node-esm/src/implementation/async.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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 function that invokes f with its arguments asynchronously as a
+ * microtask, i.e. as soon as possible after the current script returns back
+ * into browser code.
+ */
+export declare function async(f: Function): Function;

package/dist/node-esm/src/implementation/backoff.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @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 Provides a method for running a function with exponential
+ * backoff.
+ */
+declare type id = (p1: boolean) => void;
+export { id };
+/**
+ * @param f May be invoked
+ *     before the function returns.
+ * @param callback Get all the arguments passed to the function
+ *     passed to f, including the initial boolean.
+ */
+export declare function start(f: (p1: (success: boolean) => void, canceled: boolean) => void, callback: (...args: any[]) => unknown, timeout: number): id;
+/**
+ * Stops the retry loop from repeating.
+ * If the function is currently "in between" retries, it is invoked immediately
+ * with the second parameter as "true". Otherwise, it will be invoked once more
+ * after the current invocation finishes iff the current invocation would have
+ * triggered another retry.
+ */
+export declare function stop(id: id): void;

package/dist/node-esm/src/implementation/blob.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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 opt_elideCopy - If true, doesn't copy mutable input data
+ *     (e.g. Uint8Arrays). Pass true only if you know the objects will not be
+ *     modified after this blob's construction.
+ *
+ * @internal
+ */
+export declare class FbsBlob {
+    private data_;
+    private size_;
+    private type_;
+    constructor(data: Blob | Uint8Array | ArrayBuffer, elideCopy?: boolean);
+    size(): number;
+    type(): string;
+    slice(startByte: number, endByte: number): FbsBlob | null;
+    static getBlob(...args: Array<string | FbsBlob>): FbsBlob | null;
+    uploadData(): Blob | Uint8Array;
+}

package/dist/node-esm/src/implementation/connection.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @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.
+ */
+/** Network headers */
+export declare type Headers = Record<string, string>;
+/**
+ * A lightweight wrapper around XMLHttpRequest with a
+ * goog.net.XhrIo-like interface.
+ */
+export interface Connection {
+    /**
+     * This method should never reject. In case of encountering an error, set an error code internally which can be accessed
+     * by calling getErrorCode() by callers.
+     */
+    send(url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers): Promise<void>;
+    getErrorCode(): ErrorCode;
+    getStatus(): number;
+    getResponseText(): string;
+    /**
+     * Abort the request.
+     */
+    abort(): void;
+    getResponseHeader(header: string): string | null;
+    addUploadProgressListener(listener: (p1: ProgressEvent) => void): void;
+    removeUploadProgressListener(listener: (p1: ProgressEvent) => void): void;
+}
+/**
+ * Error codes for requests made by the the XhrIo wrapper.
+ */
+export declare enum ErrorCode {
+    NO_ERROR = 0,
+    NETWORK_ERROR = 1,
+    ABORT = 2
+}

package/dist/node-esm/src/implementation/constants.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @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 Constants used in the Firebase Storage library.
+ */
+/**
+ * Domain name for firebase storage.
+ */
+export declare const DEFAULT_HOST = "firebasestorage.googleapis.com";
+/**
+ * The key in Firebase config json for the storage bucket.
+ */
+export declare const CONFIG_STORAGE_BUCKET_KEY = "storageBucket";
+/**
+ * 2 minutes
+ *
+ * The timeout for all operations except upload.
+ */
+export declare const DEFAULT_MAX_OPERATION_RETRY_TIME: number;
+/**
+ * 10 minutes
+ *
+ * The timeout for upload.
+ */
+export declare const DEFAULT_MAX_UPLOAD_RETRY_TIME: number;
+/**
+ * This is the value of Number.MIN_SAFE_INTEGER, which is not well supported
+ * enough for us to use it directly.
+ */
+export declare const MIN_SAFE_INTEGER = -9007199254740991;

package/dist/node-esm/src/implementation/error.d.ts

@@ -0,0 +1,105 @@
+import { FirebaseError } from '@firebase/util';
+/**
+ * An error returned by the Firebase Storage SDK.
+ * @public
+ */
+export declare class StorageError extends FirebaseError {
+    private readonly _baseMessage;
+    /**
+     * Stores custom error data unque to StorageError.
+     */
+    customData: {
+        serverResponse: string | null;
+    };
+    /**
+     * @param code - A StorageErrorCode string to be prefixed with 'storage/' and
+     *  added to the end of the message.
+     * @param message  - Error message.
+     */
+    constructor(code: StorageErrorCode, message: string);
+    /**
+     * Compares a StorageErrorCode against this error's code, filtering out the prefix.
+     */
+    _codeEquals(code: StorageErrorCode): boolean;
+    /**
+     * Optional response message that was added by the server.
+     */
+    get serverResponse(): null | string;
+    set serverResponse(serverResponse: string | null);
+}
+export declare const errors: {};
+/**
+ * @public
+ * Error codes that can be attached to `StorageError`s.
+ */
+export declare const enum StorageErrorCode {
+    UNKNOWN = "unknown",
+    OBJECT_NOT_FOUND = "object-not-found",
+    BUCKET_NOT_FOUND = "bucket-not-found",
+    PROJECT_NOT_FOUND = "project-not-found",
+    QUOTA_EXCEEDED = "quota-exceeded",
+    UNAUTHENTICATED = "unauthenticated",
+    UNAUTHORIZED = "unauthorized",
+    UNAUTHORIZED_APP = "unauthorized-app",
+    RETRY_LIMIT_EXCEEDED = "retry-limit-exceeded",
+    INVALID_CHECKSUM = "invalid-checksum",
+    CANCELED = "canceled",
+    INVALID_EVENT_NAME = "invalid-event-name",
+    INVALID_URL = "invalid-url",
+    INVALID_DEFAULT_BUCKET = "invalid-default-bucket",
+    NO_DEFAULT_BUCKET = "no-default-bucket",
+    CANNOT_SLICE_BLOB = "cannot-slice-blob",
+    SERVER_FILE_WRONG_SIZE = "server-file-wrong-size",
+    NO_DOWNLOAD_URL = "no-download-url",
+    INVALID_ARGUMENT = "invalid-argument",
+    INVALID_ARGUMENT_COUNT = "invalid-argument-count",
+    APP_DELETED = "app-deleted",
+    INVALID_ROOT_OPERATION = "invalid-root-operation",
+    INVALID_FORMAT = "invalid-format",
+    INTERNAL_ERROR = "internal-error",
+    UNSUPPORTED_ENVIRONMENT = "unsupported-environment"
+}
+export declare function prependCode(code: StorageErrorCode): string;
+export declare function unknown(): StorageError;
+export declare function objectNotFound(path: string): StorageError;
+export declare function bucketNotFound(bucket: string): StorageError;
+export declare function projectNotFound(project: string): StorageError;
+export declare function quotaExceeded(bucket: string): StorageError;
+export declare function unauthenticated(): StorageError;
+export declare function unauthorizedApp(): StorageError;
+export declare function unauthorized(path: string): StorageError;
+export declare function retryLimitExceeded(): StorageError;
+export declare function invalidChecksum(path: string, checksum: string, calculated: string): StorageError;
+export declare function canceled(): StorageError;
+export declare function invalidEventName(name: string): StorageError;
+export declare function invalidUrl(url: string): StorageError;
+export declare function invalidDefaultBucket(bucket: string): StorageError;
+export declare function noDefaultBucket(): StorageError;
+export declare function cannotSliceBlob(): StorageError;
+export declare function serverFileWrongSize(): StorageError;
+export declare function noDownloadURL(): StorageError;
+/**
+ * @internal
+ */
+export declare function invalidArgument(message: string): StorageError;
+export declare function invalidArgumentCount(argMin: number, argMax: number, fnName: string, real: number): StorageError;
+export declare function appDeleted(): StorageError;
+/**
+ * @param name - The name of the operation that was invalid.
+ *
+ * @internal
+ */
+export declare function invalidRootOperation(name: string): StorageError;
+/**
+ * @param format - The format that was not valid.
+ * @param message - A message describing the format violation.
+ */
+export declare function invalidFormat(format: string, message: string): StorageError;
+/**
+ * @param message - A message describing the internal error.
+ */
+export declare function unsupportedEnvironment(message: string): StorageError;
+/**
+ * @param message - A message describing the internal error.
+ */
+export declare function internalError(message: string): StorageError;

package/dist/node-esm/src/implementation/failrequest.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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.
+ */
+import { StorageError } from './error';
+import { Request } from './request';
+/**
+ * A request whose promise always fails.
+ */
+export declare class FailRequest<T> implements Request<T> {
+    promise_: Promise<T>;
+    constructor(error: StorageError);
+    /** @inheritDoc */
+    getPromise(): Promise<T>;
+    /** @inheritDoc */
+    cancel(_appDelete?: boolean): void;
+}

package/dist/node-esm/src/implementation/fs.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Concatenates one or more values together and converts them to a Blob.
+ *
+ * @param args The values that will make up the resulting blob.
+ * @return The blob.
+ */
+export declare function getBlob(...args: Array<string | Blob | ArrayBuffer>): Blob;
+/**
+ * Slices the blob. The returned blob contains data from the start byte
+ * (inclusive) till the end byte (exclusive). Negative indices cannot be used.
+ *
+ * @param blob The blob to be sliced.
+ * @param start Index of the starting byte.
+ * @param end Index of the ending byte.
+ * @return The blob slice or null if not supported.
+ */
+export declare function sliceBlob(blob: Blob, start: number, end: number): Blob | null;

package/dist/node-esm/src/implementation/json.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the Object resulting from parsing the given JSON, or null if the
+ * given string does not represent a JSON object.
+ */
+export declare function jsonObjectOrNull(s: string): {
+    [name: string]: unknown;
+} | null;

package/dist/node-esm/src/implementation/list.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @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.
+ */
+import { ListResult } from '../list';
+import { FirebaseStorageImpl } from '../service';
+export declare function fromResponseString(service: FirebaseStorageImpl, bucket: string, resourceString: string): ListResult | null;

package/dist/node-esm/src/implementation/location.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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.
+ */
+/**
+ * Firebase Storage location data.
+ *
+ * @internal
+ */
+export declare class Location {
+    readonly bucket: string;
+    private path_;
+    constructor(bucket: string, path: string);
+    get path(): string;
+    get isRoot(): boolean;
+    fullServerUrl(): string;
+    bucketOnlyServerUrl(): string;
+    static makeFromBucketSpec(bucketString: string, host: string): Location;
+    static makeFromUrl(url: string, host: string): Location;
+}

package/dist/node-esm/src/implementation/metadata.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @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 Documentation for the metadata format
+ */
+import { Metadata } from '../metadata';
+import { FirebaseStorageImpl } from '../service';
+export declare function noXform_<T>(metadata: Metadata, value: T): T;
+declare class Mapping<T> {
+    server: string;
+    local: string;
+    writable: boolean;
+    xform: (p1: Metadata, p2?: T) => T | undefined;
+    constructor(server: string, local?: string | null, writable?: boolean, xform?: ((p1: Metadata, p2?: T) => T | undefined) | null);
+}
+declare type Mappings = Array<Mapping<string> | Mapping<number>>;
+export { Mappings };
+export declare function xformPath(fullPath: string | undefined): string | undefined;
+export declare function getMappings(): Mappings;
+export declare function addRef(metadata: Metadata, service: FirebaseStorageImpl): void;
+export declare function fromResource(service: FirebaseStorageImpl, resource: {
+    [name: string]: unknown;
+}, mappings: Mappings): Metadata;
+export declare function fromResourceString(service: FirebaseStorageImpl, resourceString: string, mappings: Mappings): Metadata | null;
+export declare function downloadUrlFromResourceString(metadata: Metadata, resourceString: string, host: string, protocol: string): string | null;
+export declare function toResourceString(metadata: Partial<Metadata>, mappings: Mappings): string;