@dereekb/firebase 8.9.0 → 8.11.0

package/src/lib/common/model/function.js

@@ -9,15 +9,19 @@ const util_1 = require("@dereekb/util");
  * @param data
  * @returns
  */
-function onCallTypedModelParams(modelTypeInput, data) {
+function onCallTypedModelParams(modelTypeInput, data, specifier) {
     const modelType = typeof modelTypeInput === 'string' ? modelTypeInput : modelTypeInput.modelType;
     if (!modelType) {
         throw new Error('modelType is required.');
     }
-    return {
+    const result = {
         modelType,
         data
     };
+    if (specifier != null) {
+        result.specifier = specifier;
+    }
+    return result;
 }
 exports.onCallTypedModelParams = onCallTypedModelParams;
 /**

package/src/lib/common/model/function.js.map

@@ -1 +1 @@
-{"version":3,"file":"function.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/model/function.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AAQtD;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAI,cAA0D,EAAE,IAAO;IAC3G,MAAM,SAAS,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC;IAEjG,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;KAC3C;IAED,OAAO;QACL,SAAS;QACT,IAAI;KACL,CAAC;AACJ,CAAC;AAXD,wDAWC;AAED;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAI3D;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAG3D;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAY3D,SAAgB,+BAA+B,CAAC,MAAmD;IACjG,OAAO,uBAAuB,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AACjF,CAAC;AAFD,0EAEC;AAED,SAAgB,uBAAuB,CAAC,SAA0C;IAChF,OAAO;QACL,SAAS,EAAE,IAAA,cAAO,EAAC,SAAS,CAAC;KAC9B,CAAC;AACJ,CAAC;AAJD,0DAIC"}
+{"version":3,"file":"function.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/model/function.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AAStD;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAI,cAA0D,EAAE,IAAO,EAAE,SAAkB;IAC/H,MAAM,SAAS,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC;IAEjG,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;KAC3C;IAED,MAAM,MAAM,GAA8B;QACxC,SAAS;QACT,IAAI;KACL,CAAC;IAEF,IAAI,SAAS,IAAI,IAAI,EAAE;QACrB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;KAC9B;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAjBD,wDAiBC;AAED;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAI3D;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAG3D;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAY3D,SAAgB,+BAA+B,CAAC,MAAmD;IACjG,OAAO,uBAAuB,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AACjF,CAAC;AAFD,0EAEC;AAED,SAAgB,uBAAuB,CAAC,SAA0C;IAChF,OAAO;QACL,SAAS,EAAE,IAAA,cAAO,EAAC,SAAS,CAAC;KAC9B,CAAC;AACJ,CAAC;AAJD,0DAIC"}

package/src/lib/common/storage/accessor/index.d.ts

@@ -0,0 +1 @@
+export * from './path.model';

package/src/lib/common/storage/accessor/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./path.model"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/common/storage/accessor/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/storage/accessor/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B"}

package/src/lib/common/storage/accessor/path.model.d.ts

@@ -0,0 +1,26 @@
+import { SlashPath, SlashPathFolder, FactoryWithRequiredInput } from '@dereekb/util';
+import { ReadFirestoreModelKeyInput } from '../../firestore/collection/collection';
+export declare const BASE_MODEL_STORAGE_FILE_PATH: SlashPathFolder;
+/**
+ * Shared and configured slashPathFactory configuration for the model storage file path.
+ */
+export declare const MODEL_STORAGE_FILE_SLASH_PATH_FACTORY: import("@dereekb/util").SlashPathFactory;
+export interface ModelStorageSlashPathFactoryConfig {
+    /**
+     * Additional base path to provide.
+     *
+     * This value is merged with the BASE_MODEL_STORAGE_FILE_PATH (/model/) base path configured for all ModelStorageSlashPathFactory values
+     */
+    basePath?: string;
+}
+/**
+ * Factory for SlashPath values using input ReadFirestoreModelKeyInput values.
+ */
+export declare type ModelStorageSlashPathFactory<T extends object = object> = FactoryWithRequiredInput<SlashPath, ReadFirestoreModelKeyInput<T>>;
+/**
+ * Creates a ModelStorageSlashPathFactory.
+ *
+ * @param config
+ * @returns
+ */
+export declare function modelStorageSlashPathFactory<T extends object = object>(config?: ModelStorageSlashPathFactoryConfig): ModelStorageSlashPathFactory<T>;

package/src/lib/common/storage/accessor/path.model.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.modelStorageSlashPathFactory = exports.MODEL_STORAGE_FILE_SLASH_PATH_FACTORY = exports.BASE_MODEL_STORAGE_FILE_PATH = void 0;
+const util_1 = require("@dereekb/util");
+const collection_1 = require("../../firestore/collection/collection");
+exports.BASE_MODEL_STORAGE_FILE_PATH = '/model/';
+/**
+ * Shared and configured slashPathFactory configuration for the model storage file path.
+ */
+exports.MODEL_STORAGE_FILE_SLASH_PATH_FACTORY = (0, util_1.slashPathFactory)({ startType: 'absolute', basePath: exports.BASE_MODEL_STORAGE_FILE_PATH });
+/**
+ * Creates a ModelStorageSlashPathFactory.
+ *
+ * @param config
+ * @returns
+ */
+function modelStorageSlashPathFactory(config) {
+    const { basePath = '' } = config !== null && config !== void 0 ? config : {};
+    return (input) => {
+        const key = (0, collection_1.readFirestoreModelKey)(input, true);
+        return (0, exports.MODEL_STORAGE_FILE_SLASH_PATH_FACTORY)([basePath, key]);
+    };
+}
+exports.modelStorageSlashPathFactory = modelStorageSlashPathFactory;
+//# sourceMappingURL=path.model.js.map

package/src/lib/common/storage/accessor/path.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.model.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/storage/accessor/path.model.ts"],"names":[],"mappings":";;;AAAA,wCAAuG;AACvG,sEAA0G;AAE7F,QAAA,4BAA4B,GAAoB,SAAS,CAAC;AAEvE;;GAEG;AACU,QAAA,qCAAqC,GAAG,IAAA,uBAAgB,EAAC,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,oCAA4B,EAAE,CAAC,CAAC;AAgBzI;;;;;GAKG;AACH,SAAgB,4BAA4B,CAA4B,MAA2C;IACjH,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;IACvC,OAAO,CAAC,KAAiC,EAAE,EAAE;QAC3C,MAAM,GAAG,GAAG,IAAA,kCAAqB,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,IAAA,6CAAqC,EAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC;AACJ,CAAC;AAND,oEAMC"}

package/src/lib/common/storage/context.d.ts

@@ -0,0 +1,35 @@
+import { FirebaseStorageAccessor } from './driver/accessor';
+import { FirebaseStorageDrivers } from './driver/driver';
+import { StorageBucketId } from './storage';
+import { FirebaseStorage } from './types';
+/**
+ * A @dereekb/firebase FirebaseStorageContext. Wraps the main FirebaseStorage context and the drivers, as well as utility/convenience functions.
+ */
+export interface FirebaseStorageContext<F extends FirebaseStorage = FirebaseStorage> extends FirebaseStorageAccessor {
+    readonly storage: F;
+    readonly drivers: FirebaseStorageDrivers;
+}
+/**
+ * Factory function for generating a FirebaseStorageContext given the input FirebaseStorage.
+ */
+export declare type FirebaseStorageContextFactory<F extends FirebaseStorage = FirebaseStorage> = (firebaseStorage: F, config?: FirebaseStorageContextFactoryConfig) => FirebaseStorageContext;
+/**
+ * firebaseStorageContextFactory() configuration
+ */
+export interface FirebaseStorageContextFactoryConfig {
+    /**
+     * The default bucket
+     */
+    defaultBucketId?: StorageBucketId;
+    /**
+     * Whether or not to force using the default bucket id.
+     */
+    forceBucket?: boolean;
+}
+/**
+ * Creates a new FirebaseStorageContextFactory given the input FirebaseStorageDrivers.
+ *
+ * @param drivers
+ * @returns
+ */
+export declare function firebaseStorageContextFactory<F extends FirebaseStorage = FirebaseStorage>(drivers: FirebaseStorageDrivers): FirebaseStorageContextFactory<F>;

package/src/lib/common/storage/context.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firebaseStorageContextFactory = void 0;
+const storage_1 = require("./storage");
+/**
+ * Creates a new FirebaseStorageContextFactory given the input FirebaseStorageDrivers.
+ *
+ * @param drivers
+ * @returns
+ */
+function firebaseStorageContextFactory(drivers) {
+    return (firebaseStorage, config) => {
+        var _a, _b;
+        const { defaultBucketId: inputDefaultBucketId, forceBucket = false } = config !== null && config !== void 0 ? config : {};
+        const defaultBucketId = inputDefaultBucketId || ((_b = (_a = drivers.storageAccessorDriver).defaultBucket) === null || _b === void 0 ? void 0 : _b.call(_a, firebaseStorage)) || '';
+        if (!defaultBucketId) {
+            throw new Error('Could not resolve a default bucket id for the firebaseStorageContextFactory(). Supply a defaultBucketId.');
+        }
+        const storagePathBuilder = (0, storage_1.storagePathFactory)({
+            bucketId: defaultBucketId,
+            replaceBucket: forceBucket
+        });
+        const context = {
+            storage: firebaseStorage,
+            drivers,
+            defaultBucket: () => defaultBucketId,
+            file: (path) => drivers.storageAccessorDriver.file(firebaseStorage, storagePathBuilder(path)),
+            folder: (path) => drivers.storageAccessorDriver.folder(firebaseStorage, storagePathBuilder(path))
+        };
+        return context;
+    };
+}
+exports.firebaseStorageContextFactory = firebaseStorageContextFactory;
+//# sourceMappingURL=context.js.map

package/src/lib/common/storage/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/storage/context.ts"],"names":[],"mappings":";;;AAEA,uCAAsG;AA8BtG;;;;;GAKG;AACH,SAAgB,6BAA6B,CAA8C,OAA+B;IACxH,OAAO,CAAC,eAAkB,EAAE,MAA4C,EAAE,EAAE;;QAC1E,MAAM,EAAE,eAAe,EAAE,oBAAoB,EAAE,WAAW,GAAG,KAAK,EAAE,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACpF,MAAM,eAAe,GAAoB,oBAAoB,KAAI,MAAA,MAAA,OAAO,CAAC,qBAAqB,EAAC,aAAa,mDAAG,eAAe,CAAC,CAAA,IAAI,EAAE,CAAC;QAEtI,IAAI,CAAC,eAAe,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,0GAA0G,CAAC,CAAC;SAC7H;QAED,MAAM,kBAAkB,GAAuB,IAAA,4BAAkB,EAAC;YAChE,QAAQ,EAAE,eAAe;YACzB,aAAa,EAAE,WAAW;SAC3B,CAAC,CAAC;QAEH,MAAM,OAAO,GAA8B;YACzC,OAAO,EAAE,eAAe;YACxB,OAAO;YACP,aAAa,EAAE,GAAG,EAAE,CAAC,eAAe;YACpC,IAAI,EAAE,CAAC,IAAsB,EAAE,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC/G,MAAM,EAAE,CAAC,IAAsB,EAAE,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;SACpH,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC;AAxBD,sEAwBC"}

package/src/lib/common/storage/driver/accessor.d.ts

@@ -0,0 +1,170 @@
+/// <reference types="node" />
+import { StorageBucketId, StoragePathInput, StoragePath, StoragePathRef } from '../storage';
+import { FirebaseStorage, StorageClientUploadBytesInput, StorageDeleteFileOptions, StorageDownloadUrl, StorageMetadata, StorageUploadInput, StorageUploadOptions, StorageUploadResult, StorageUploadTask } from '../types';
+import { Maybe } from '@dereekb/util';
+/**
+ * Used for accessing files and folders in the storage.
+ */
+export interface FirebaseStorageAccessor {
+    defaultBucket: () => StorageBucketId;
+    file(path: StoragePathInput): FirebaseStorageAccessorFile;
+    folder(path: StoragePathInput): FirebaseStorageAccessorFolder;
+}
+/**
+ * Generic interface for accessing data from a file at the given path.
+ */
+export interface FirebaseStorageAccessorFile<R = unknown> extends StoragePathRef {
+    /**
+     * Returns the underlying reference type.
+     */
+    readonly reference: R;
+    /**
+     * Returns true if the file exists.
+     */
+    exists(): Promise<boolean>;
+    /**
+     *
+     */
+    getDownloadUrl(): Promise<StorageDownloadUrl>;
+    /**
+     * Returns the metadata from the input objects.
+     */
+    getMetadata(): Promise<StorageMetadata>;
+    /**
+     * Downloads the data as an ArrayBuffer.
+     */
+    getBytes(maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
+    /**
+     * Downloads the data as a Blob.
+     *
+     * Available only in the browser.
+     */
+    getBlob?(maxDownloadSizeBytes?: number): Promise<Blob>;
+    /**
+     * Returns a ReadableStream of the bytes.
+     *
+     * Available only in NodeJS.
+     */
+    getStream?(maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
+    /**
+     * Uploads data to the file's path.
+     */
+    upload(data: StorageUploadInput, options?: StorageUploadOptions): Promise<StorageUploadResult>;
+    /**
+     * Uploads data to the file's path using a resumable.
+     *
+     * Optional implementation.
+     */
+    uploadResumable?(data: StorageClientUploadBytesInput, options?: StorageUploadOptions): StorageUploadTask;
+    /**
+     * Returns a WritableStream that can be written to.
+     *
+     * Optional implementation.
+     */
+    uploadStream?(options?: StorageUploadOptions): NodeJS.WritableStream;
+    /**
+     * Deletes the file.
+     *
+     * Throws an error if the file does not exist.
+     */
+    delete(options?: StorageDeleteFileOptions): Promise<void>;
+}
+export interface StorageListFilesOptions {
+    /**
+     * If set, limits the total number of `prefixes` and `items` to return.
+     * The default and maximum maxResults is 1000.
+     */
+    maxResults?: number;
+    /**
+     * The `nextPageToken` from a previous call to `list()`. If provided,
+     * listing is resumed from the previous position.
+     */
+    pageToken?: string;
+}
+export interface StorageListItemResult extends StoragePathRef {
+    /**
+     * Raw result
+     */
+    readonly raw?: unknown;
+    /**
+     * Name of the item
+     */
+    readonly name: string;
+}
+export interface StorageListFolderResult extends StorageListItemResult {
+    /**
+     * Gets this item as a FirebaseStorageAccessorFolder
+     */
+    folder(): FirebaseStorageAccessorFolder;
+}
+export interface StorageListFileResult extends StorageListItemResult {
+    /**
+     * Gets this item as a FirebaseStorageAccessorFile
+     */
+    file(): FirebaseStorageAccessorFile;
+}
+export interface StorageListFilesResult<R = unknown> {
+    /**
+     * The raw result.
+     */
+    raw: R;
+    /**
+     * Options used to retrieve the result.
+     */
+    options: StorageListFilesOptions | undefined;
+    /**
+     * Whether or not there are more results available.
+     */
+    hasNext: boolean;
+    /**
+     * Returns true if any files or folders exist in the results.
+     */
+    hasItems(): boolean;
+    /**
+     * Returns all the prefixes/folders in the result.
+     */
+    folders(): StorageListFolderResult[];
+    /**
+     * Returns all the files in the result.
+     */
+    files(): StorageListFileResult[];
+    /**
+     * Returns the next set of results, if available.
+     */
+    next(): Promise<StorageListFilesResult>;
+}
+/**
+ * Generic interface for accessing "folder" information at the given path.
+ */
+export interface FirebaseStorageAccessorFolder<R = unknown> extends StoragePathRef {
+    readonly reference: R;
+    /**
+     * Returns true if the folder exists.
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Performs a search for items
+     * @param options
+     */
+    list(options?: StorageListFilesOptions): Promise<StorageListFilesResult>;
+}
+export declare type FirebaseStorageAccessorDriverDefaultBucketFunction = (storage: FirebaseStorage) => Maybe<StorageBucketId>;
+export declare type FirebaseStorageAccessorDriverFileFunction<R = unknown> = (storage: FirebaseStorage, path: StoragePath) => FirebaseStorageAccessorFile<R>;
+export declare type FirebaseStorageAccessorDriverFolderFunction<R = unknown> = (storage: FirebaseStorage, path: StoragePath) => FirebaseStorageAccessorFolder<R>;
+/**
+ * A driver to use for storage functionality.
+ */
+export interface FirebaseStorageAccessorDriver {
+    /**
+     * Returns the default bucketId for the input storage.
+     */
+    readonly defaultBucket?: FirebaseStorageAccessorDriverDefaultBucketFunction;
+    readonly file: FirebaseStorageAccessorDriverFileFunction;
+    readonly folder: FirebaseStorageAccessorDriverFolderFunction;
+}
+/**
+ * Ref to a StorageAccessorDriver.
+ */
+export interface FirebaseStorageAccessorDriverRef {
+    readonly storageAccessorDriver: FirebaseStorageAccessorDriver;
+}

package/src/lib/common/storage/driver/accessor.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=accessor.js.map

package/src/lib/common/storage/driver/accessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/storage/driver/accessor.ts"],"names":[],"mappings":""}

package/src/lib/common/storage/driver/driver.d.ts

@@ -0,0 +1,10 @@
+import { FirebaseStorageAccessorDriverRef } from './accessor';
+export declare type FirebaseStorageDriverIdentifier = string;
+export declare type FirebaseStorageDriverType = 'production' | 'testing';
+/**
+ * Implements all FirebaseStorage related driver reference interfaces.
+ */
+export interface FirebaseStorageDrivers extends FirebaseStorageAccessorDriverRef {
+    storageDriverIdentifier?: FirebaseStorageDriverIdentifier;
+    storageDriverType: FirebaseStorageDriverType;
+}

package/src/lib/common/storage/driver/driver.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=driver.js.map

package/src/lib/common/storage/driver/driver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/storage/driver/driver.ts"],"names":[],"mappings":""}

package/src/lib/common/storage/driver/error.d.ts

@@ -0,0 +1,3 @@
+import { StorageDataStringType, StorageUploadOptions } from '../types';
+export declare function assertStorageUploadOptionsStringFormat(options?: StorageUploadOptions): StorageDataStringType;
+export declare function noStringFormatInStorageUploadOptionsError(): Error;

package/src/lib/common/storage/driver/error.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noStringFormatInStorageUploadOptionsError = exports.assertStorageUploadOptionsStringFormat = void 0;
+function assertStorageUploadOptionsStringFormat(options) {
+    const stringFormat = options === null || options === void 0 ? void 0 : options.stringFormat;
+    if (!stringFormat) {
+        throw noStringFormatInStorageUploadOptionsError();
+    }
+    return stringFormat;
+}
+exports.assertStorageUploadOptionsStringFormat = assertStorageUploadOptionsStringFormat;
+function noStringFormatInStorageUploadOptionsError() {
+    return new Error('stringFormat was missing a value in the StorageUploadOptions.');
+}
+exports.noStringFormatInStorageUploadOptionsError = noStringFormatInStorageUploadOptionsError;
+//# sourceMappingURL=error.js.map

package/src/lib/common/storage/driver/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/storage/driver/error.ts"],"names":[],"mappings":";;;AAEA,SAAgB,sCAAsC,CAAC,OAA8B;IACnF,MAAM,YAAY,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,CAAC;IAE3C,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,yCAAyC,EAAE,CAAC;KACnD;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AARD,wFAQC;AAED,SAAgB,yCAAyC;IACvD,OAAO,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;AACpF,CAAC;AAFD,8FAEC"}

package/src/lib/common/storage/driver/index.d.ts

@@ -0,0 +1,4 @@
+export * from './accessor';
+export * from './driver';
+export * from './error';
+export * from './list';

package/src/lib/common/storage/driver/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./accessor"), exports);
+tslib_1.__exportStar(require("./driver"), exports);
+tslib_1.__exportStar(require("./error"), exports);
+tslib_1.__exportStar(require("./list"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/common/storage/driver/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/storage/driver/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,mDAAyB;AACzB,kDAAwB;AACxB,iDAAuB"}

package/src/lib/common/storage/driver/list.d.ts

@@ -0,0 +1,13 @@
+import { FirebaseStorageAccessorFile, FirebaseStorageAccessorFolder, StorageListFilesOptions, StorageListFilesResult, StorageListItemResult } from './accessor';
+export interface StorageListFilesResultFactoryDelegate<S, R> {
+    hasItems(result: R): boolean;
+    hasNext(result: R): boolean;
+    next(storage: S, folder: FirebaseStorageAccessorFolder, result: R): Promise<StorageListFilesResult>;
+    file(storage: S, fileResult: StorageListItemResult): FirebaseStorageAccessorFile;
+    folder(storage: S, folderResult: StorageListItemResult): FirebaseStorageAccessorFolder;
+    filesFromResult(result: R, folder: FirebaseStorageAccessorFolder): StorageListItemResult[];
+    foldersFromResult(result: R, folder: FirebaseStorageAccessorFolder): StorageListItemResult[];
+}
+export declare type StorageListFilesResultFactory<S, R> = (storage: S, folder: FirebaseStorageAccessorFolder, options: StorageListFilesOptions | undefined, result: R) => StorageListFilesResult;
+export declare function storageListFilesResultFactory<S, R>(delegate: StorageListFilesResultFactoryDelegate<S, R>): StorageListFilesResultFactory<S, R>;
+export declare function storageListFilesResultHasNoNextError(): Error;

package/src/lib/common/storage/driver/list.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.storageListFilesResultHasNoNextError = exports.storageListFilesResultFactory = void 0;
+const util_1 = require("@dereekb/util");
+function storageListFilesResultFactory(delegate) {
+    return (storage, folder, options, result) => {
+        function fileResult(item) {
+            item.file = () => delegate.file(storage, item);
+            return item;
+        }
+        function folderResult(item) {
+            item.folder = () => delegate.folder(storage, item);
+            return item;
+        }
+        const hasNext = delegate.hasNext(result);
+        const next = (0, util_1.cachedGetter)(() => {
+            if (!hasNext) {
+                throw storageListFilesResultHasNoNextError();
+            }
+            return delegate.next(storage, folder, result);
+        });
+        const files = (0, util_1.cachedGetter)(() => delegate.filesFromResult(result, folder).map(fileResult));
+        const folders = (0, util_1.cachedGetter)(() => delegate.foldersFromResult(result, folder).map(folderResult));
+        const filesResult = {
+            raw: result,
+            options,
+            hasNext,
+            hasItems: () => delegate.hasItems(result),
+            next,
+            files,
+            folders
+        };
+        return filesResult;
+    };
+}
+exports.storageListFilesResultFactory = storageListFilesResultFactory;
+function storageListFilesResultHasNoNextError() {
+    return new Error('hasNext is false, there are no more results available.');
+}
+exports.storageListFilesResultHasNoNextError = storageListFilesResultHasNoNextError;
+//# sourceMappingURL=list.js.map

package/src/lib/common/storage/driver/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/storage/driver/list.ts"],"names":[],"mappings":";;;AAAA,wCAA6C;AAe7C,SAAgB,6BAA6B,CAAO,QAAqD;IACvG,OAAO,CAAC,OAAU,EAAE,MAAqC,EAAE,OAA4C,EAAE,MAAS,EAAE,EAAE;QACpH,SAAS,UAAU,CAAC,IAA2B;YAC5C,IAA8B,CAAC,IAAI,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC1E,OAAO,IAA6B,CAAC;QACvC,CAAC;QAED,SAAS,YAAY,CAAC,IAA2B;YAC9C,IAAgC,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAChF,OAAO,IAA+B,CAAC;QACzC,CAAC;QAED,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEzC,MAAM,IAAI,GAA0C,IAAA,mBAAY,EAAC,GAAG,EAAE;YACpE,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,oCAAoC,EAAE,CAAC;aAC9C;YAED,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QACH,MAAM,KAAK,GAAkC,IAAA,mBAAY,EAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QAC1H,MAAM,OAAO,GAAoC,IAAA,mBAAY,EAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;QAElI,MAAM,WAAW,GAA2B;YAC1C,GAAG,EAAE,MAAM;YACX,OAAO;YACP,OAAO;YACP,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;YACzC,IAAI;YACJ,KAAK;YACL,OAAO;SACR,CAAC;QAEF,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC;AApCD,sEAoCC;AAED,SAAgB,oCAAoC;IAClD,OAAO,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;AAC7E,CAAC;AAFD,oFAEC"}

package/src/lib/common/storage/index.d.ts

@@ -0,0 +1,5 @@
+export * from './accessor';
+export * from './driver';
+export * from './context';
+export * from './storage';
+export * from './types';

package/src/lib/common/storage/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./accessor"), exports);
+tslib_1.__exportStar(require("./driver"), exports);
+tslib_1.__exportStar(require("./context"), exports);
+tslib_1.__exportStar(require("./storage"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/common/storage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/storage/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,mDAAyB;AACzB,oDAA0B;AAC1B,oDAA0B;AAC1B,kDAAwB"}

package/src/lib/common/storage/storage.d.ts

@@ -0,0 +1,65 @@
+import { SlashPath, FactoryWithRequiredInput } from '@dereekb/util';
+/**
+ * Storage bucket identifier.
+ *
+ * Should contain no slashes, just the bucket's identifier.
+ */
+export declare type StorageBucketId = string;
+/**
+ * A reference to a StorageBucketId
+ */
+export interface StorageBucketIdRef {
+    bucketId: StorageBucketId;
+}
+/**
+ * A filepath to a file or folder.
+ */
+export declare type StorageSlashPath = SlashPath;
+/**
+ * A reference to a StorageSlashPath
+ */
+export interface StorageSlashPathRef {
+    pathString: StorageSlashPath;
+}
+/**
+ * A bucket and path pair.
+ *
+ * If the bucket is not defined, it implies the default app bucket.
+ */
+export interface StoragePath extends StorageBucketIdRef, StorageSlashPathRef {
+}
+/**
+ * Storage-Path related input.
+ */
+export declare type StoragePathInput = StorageSlashPath | StoragePath | StorageSlashPathRef;
+/**
+ * Converts the input to a StoragePath
+ */
+export declare type StoragePathFactory = FactoryWithRequiredInput<StoragePath, StoragePathInput>;
+export interface StoragePathFactoryConfig extends StorageBucketIdRef {
+    /**
+     * Whether or not to replace the bucketId on input that has it.
+     *
+     * False by default.
+     */
+    replaceBucket?: boolean;
+}
+/**
+ * Creates a StoragePathFactory.
+ *
+ * @param config
+ * @returns
+ */
+export declare function storagePathFactory(config: StoragePathFactoryConfig): StoragePathFactory;
+/**
+ * A reference to a StoragePath
+ */
+export interface StoragePathRef {
+    storagePath: StoragePath;
+}
+export declare type GoogleCloudStorageBucketPrefix<S extends StorageBucketId = StorageBucketId> = `gs://${S}`;
+export declare type GoogleCloudStorageDefaultBucketFilePath<P extends StorageSlashPath = StorageSlashPath> = P;
+export declare type GoogleCloudStorageBucketAndFilePath<P extends StorageSlashPath = StorageSlashPath, S extends StorageBucketId = StorageBucketId> = `${GoogleCloudStorageBucketPrefix<S>}/${P}`;
+export declare type GoogleCloudStorageFilePath<P extends StorageSlashPath = StorageSlashPath> = GoogleCloudStorageDefaultBucketFilePath<P> | GoogleCloudStorageBucketAndFilePath<P>;
+export declare function firebaseStorageFilePathFromStorageFilePath(path: StoragePath): GoogleCloudStorageFilePath;
+export declare function firebaseStorageBucketFolderPath(storage: StorageBucketId | StorageBucketIdRef): GoogleCloudStorageBucketPrefix;

package/src/lib/common/storage/storage.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firebaseStorageBucketFolderPath = exports.firebaseStorageFilePathFromStorageFilePath = exports.storagePathFactory = void 0;
+const util_1 = require("@dereekb/util");
+/**
+ * Creates a StoragePathFactory.
+ *
+ * @param config
+ * @returns
+ */
+function storagePathFactory(config) {
+    const { replaceBucket = false, bucketId } = config;
+    return (input) => {
+        const { pathString, bucketId: inputBucketId } = typeof input === 'string' ? { pathString: input, bucketId: undefined } : input;
+        if (replaceBucket) {
+            return {
+                pathString,
+                bucketId
+            };
+        }
+        else {
+            return {
+                pathString,
+                bucketId: inputBucketId || bucketId
+            };
+        }
+    };
+}
+exports.storagePathFactory = storagePathFactory;
+function firebaseStorageFilePathFromStorageFilePath(path) {
+    const { bucketId, pathString } = path;
+    const relativePathString = (0, util_1.toRelativeSlashPathStartType)(pathString);
+    let storagePath;
+    if (bucketId) {
+        const prefix = firebaseStorageBucketFolderPath(bucketId);
+        storagePath = `${prefix}/${relativePathString}`;
+    }
+    else {
+        storagePath = relativePathString;
+    }
+    return storagePath;
+}
+exports.firebaseStorageFilePathFromStorageFilePath = firebaseStorageFilePathFromStorageFilePath;
+function firebaseStorageBucketFolderPath(storage) {
+    let storageId;
+    if (typeof storage === 'string') {
+        storageId = storage;
+    }
+    else {
+        storageId = storage.bucketId;
+    }
+    return `gs://${storageId}`;
+}
+exports.firebaseStorageBucketFolderPath = firebaseStorageBucketFolderPath;
+//# sourceMappingURL=storage.js.map

package/src/lib/common/storage/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/storage/storage.ts"],"names":[],"mappings":";;;AAAA,wCAAkG;AAsDlG;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,MAAgC;IACjE,MAAM,EAAE,aAAa,GAAG,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IACnD,OAAO,CAAC,KAAuB,EAAE,EAAE;QACjC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC,CAAE,KAAqB,CAAC;QAEhJ,IAAI,aAAa,EAAE;YACjB,OAAO;gBACL,UAAU;gBACV,QAAQ;aACT,CAAC;SACH;aAAM;YACL,OAAO;gBACL,UAAU;gBACV,QAAQ,EAAE,aAAa,IAAI,QAAQ;aACpC,CAAC;SACH;IACH,CAAC,CAAC;AACJ,CAAC;AAjBD,gDAiBC;AAeD,SAAgB,0CAA0C,CAAC,IAAiB;IAC1E,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACtC,MAAM,kBAAkB,GAAG,IAAA,mCAA4B,EAAC,UAAU,CAAC,CAAC;IACpE,IAAI,WAAuC,CAAC;IAE5C,IAAI,QAAQ,EAAE;QACZ,MAAM,MAAM,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAC;QACzD,WAAW,GAAG,GAAG,MAAM,IAAI,kBAAkB,EAAE,CAAC;KACjD;SAAM;QACL,WAAW,GAAG,kBAAkB,CAAC;KAClC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAbD,gGAaC;AAED,SAAgB,+BAA+B,CAAC,OAA6C;IAC3F,IAAI,SAAiB,CAAC;IAEtB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,SAAS,GAAG,OAAO,CAAC;KACrB;SAAM;QACL,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;KAC9B;IAED,OAAO,QAAQ,SAAS,EAAE,CAAC;AAC7B,CAAC;AAVD,0EAUC"}