@depup/firebase__storage 0.14.1-depup.0

package/dist/src/service.d.ts

@@ -0,0 +1,131 @@
+/**
+ * @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 { Location } from './implementation/location';
+import { Request } from './implementation/request';
+import { RequestInfo } from './implementation/requestinfo';
+import { Reference } from './reference';
+import { Provider } from '@firebase/component';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { FirebaseApp } from '@firebase/app';
+import { FirebaseStorage } from './public-types';
+import { EmulatorMockTokenOptions } from '@firebase/util';
+import { Connection, ConnectionType } from './implementation/connection';
+export declare function isUrl(path?: string): boolean;
+/**
+ * Returns a storage Reference for the given url.
+ * @param storage - `Storage` instance.
+ * @param url - URL. If empty, returns root reference.
+ * @public
+ */
+export declare function ref(storage: FirebaseStorageImpl, url?: string): Reference;
+/**
+ * Returns a storage Reference for the given path in the
+ * default bucket.
+ * @param storageOrRef - `Storage` service or storage `Reference`.
+ * @param pathOrUrlStorage - path. If empty, returns root reference (if Storage
+ * instance provided) or returns same reference (if Reference provided).
+ * @public
+ */
+export declare function ref(storageOrRef: FirebaseStorageImpl | Reference, path?: string): Reference;
+export declare function connectStorageEmulator(storage: FirebaseStorageImpl, host: string, port: number, options?: {
+    mockUserToken?: EmulatorMockTokenOptions | string;
+}): void;
+/**
+ * A service that provides Firebase Storage Reference instances.
+ * @param opt_url - gs:// url to a custom Storage Bucket
+ *
+ * @internal
+ */
+export declare class FirebaseStorageImpl implements FirebaseStorage {
+    /**
+     * FirebaseApp associated with this StorageService instance.
+     */
+    readonly app: FirebaseApp;
+    readonly _authProvider: Provider<FirebaseAuthInternalName>;
+    /**
+     * @internal
+     */
+    readonly _appCheckProvider: Provider<AppCheckInternalComponentName>;
+    /**
+     * @internal
+     */
+    readonly _url?: string | undefined;
+    readonly _firebaseVersion?: string | undefined;
+    _isUsingEmulator: boolean;
+    _bucket: Location | null;
+    /**
+     * This string can be in the formats:
+     * - host
+     * - host:port
+     */
+    private _host;
+    _protocol: string;
+    protected readonly _appId: string | null;
+    private readonly _requests;
+    private _deleted;
+    private _maxOperationRetryTime;
+    private _maxUploadRetryTime;
+    _overrideAuthToken?: string;
+    constructor(
+    /**
+     * FirebaseApp associated with this StorageService instance.
+     */
+    app: FirebaseApp, _authProvider: Provider<FirebaseAuthInternalName>, 
+    /**
+     * @internal
+     */
+    _appCheckProvider: Provider<AppCheckInternalComponentName>, 
+    /**
+     * @internal
+     */
+    _url?: string | undefined, _firebaseVersion?: string | undefined, _isUsingEmulator?: boolean);
+    /**
+     * The host string for this service, in the form of `host` or
+     * `host:port`.
+     */
+    get host(): string;
+    set host(host: string);
+    /**
+     * The maximum time to retry uploads in milliseconds.
+     */
+    get maxUploadRetryTime(): number;
+    set maxUploadRetryTime(time: number);
+    /**
+     * The maximum time to retry operations other than uploads or downloads in
+     * milliseconds.
+     */
+    get maxOperationRetryTime(): number;
+    set maxOperationRetryTime(time: number);
+    _getAuthToken(): Promise<string | null>;
+    _getAppCheckToken(): Promise<string | null>;
+    /**
+     * Stop running requests and prevent more from being created.
+     */
+    _delete(): Promise<void>;
+    /**
+     * Returns a new firebaseStorage.Reference object referencing this StorageService
+     * at the given Location.
+     */
+    _makeStorageReference(loc: Location): Reference;
+    /**
+     * @param requestInfo - HTTP RequestInfo object
+     * @param authToken - Firebase auth token
+     */
+    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null, retry?: boolean): Request<O>;
+    makeRequestWithTokens<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>): Promise<O>;
+}

package/dist/src/task.d.ts

@@ -0,0 +1,148 @@
+/**
+ * @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 Defines types for interacting with blob transfer tasks.
+ */
+import { FbsBlob } from './implementation/blob';
+import { StorageError } from './implementation/error';
+import { InternalTaskState, TaskEvent } from './implementation/taskenums';
+import { Metadata } from './metadata';
+import { Subscribe, Unsubscribe } from './implementation/observer';
+import { UploadTaskSnapshot, StorageObserver } from './public-types';
+import { Reference } from './reference';
+import { CompleteFn } from '@firebase/util';
+/**
+ * Represents a blob being uploaded. Can be used to pause/resume/cancel the
+ * upload and manage callbacks for various events.
+ * @internal
+ */
+export declare class UploadTask {
+    private _ref;
+    /**
+     * The data to be uploaded.
+     */
+    _blob: FbsBlob;
+    /**
+     * Metadata related to the upload.
+     */
+    _metadata: Metadata | null;
+    private _mappings;
+    /**
+     * Number of bytes transferred so far.
+     */
+    _transferred: number;
+    private _needToFetchStatus;
+    private _needToFetchMetadata;
+    private _observers;
+    private _resumable;
+    /**
+     * Upload state.
+     */
+    _state: InternalTaskState;
+    private _error?;
+    private _uploadUrl?;
+    private _request?;
+    private _chunkMultiplier;
+    private _errorHandler;
+    private _metadataErrorHandler;
+    private _resolve?;
+    private _reject?;
+    private pendingTimeout?;
+    private _promise;
+    private sleepTime;
+    private maxSleepTime;
+    isExponentialBackoffExpired(): boolean;
+    /**
+     * @param ref - The firebaseStorage.Reference object this task came
+     *     from, untyped to avoid cyclic dependencies.
+     * @param blob - The blob to upload.
+     */
+    constructor(ref: Reference, blob: FbsBlob, metadata?: Metadata | null);
+    private _makeProgressCallback;
+    private _shouldDoResumable;
+    private _start;
+    private _resolveToken;
+    private _createResumable;
+    private _fetchStatus;
+    private _continueUpload;
+    private _increaseMultiplier;
+    private _fetchMetadata;
+    private _oneShotUpload;
+    private _updateProgress;
+    private _transition;
+    private completeTransitions_;
+    /**
+     * A snapshot of the current task state.
+     */
+    get snapshot(): UploadTaskSnapshot;
+    /**
+     * Adds a callback for an event.
+     * @param type - The type of event to listen for.
+     * @param nextOrObserver -
+     *     The `next` function, which gets called for each item in
+     *     the event stream, or an observer object with some or all of these three
+     *     properties (`next`, `error`, `complete`).
+     * @param error - A function that gets called with a `StorageError`
+     *     if the event stream ends due to an error.
+     * @param completed - A function that gets called if the
+     *     event stream ends normally.
+     * @returns
+     *     If only the event argument is passed, returns a function you can use to
+     *     add callbacks (see the examples above). If more than just the event
+     *     argument is passed, returns a function you can call to unregister the
+     *     callbacks.
+     */
+    on(type: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, completed?: CompleteFn | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;
+    /**
+     * This object behaves like a Promise, and resolves with its snapshot data
+     * when the upload completes.
+     * @param onFulfilled - The fulfillment callback. Promise chaining works as normal.
+     * @param onRejected - The rejection callback.
+     */
+    then<U>(onFulfilled?: ((value: UploadTaskSnapshot) => U | Promise<U>) | null, onRejected?: ((error: StorageError) => U | Promise<U>) | null): Promise<U>;
+    /**
+     * Equivalent to calling `then(null, onRejected)`.
+     */
+    catch<T>(onRejected: (p1: StorageError) => T | Promise<T>): Promise<T>;
+    /**
+     * Adds the given observer.
+     */
+    private _addObserver;
+    /**
+     * Removes the given observer.
+     */
+    private _removeObserver;
+    private _notifyObservers;
+    private _finishPromise;
+    private _notifyObserver;
+    /**
+     * Resumes a paused task. Has no effect on a currently running or failed task.
+     * @returns True if the operation took effect, false if ignored.
+     */
+    resume(): boolean;
+    /**
+     * Pauses a currently running task. Has no effect on a paused or failed task.
+     * @returns True if the operation took effect, false if ignored.
+     */
+    pause(): boolean;
+    /**
+     * Cancels a currently running or paused task. Has no effect on a complete or
+     * failed task.
+     * @returns True if the operation took effect, false if ignored.
+     */
+    cancel(): boolean;
+}

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"
+    }
+  ]
+}