@dereekb/dbx-firebase 12.4.4 → 12.5.0

package/lib/modules/storagefile/store/storagefile.document.store.directive.d.ts

@@ -0,0 +1,9 @@
+import { DbxFirebaseDocumentStoreDirective } from '../../../model/modules/store';
+import { StorageFileDocumentStore } from './storagefile.document.store';
+import { StorageFile, StorageFileDocument } from '@dereekb/firebase';
+import * as i0 from "@angular/core";
+export declare class DbxFirebaseStorageFileDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective<StorageFile, StorageFileDocument, StorageFileDocumentStore> {
+    constructor(store: StorageFileDocumentStore);
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseStorageFileDocumentStoreDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseStorageFileDocumentStoreDirective, "[dbxFirebaseStorageFileDocument]", never, {}, {}, never, never, true, never>;
+}

package/lib/modules/storagefile/store/storagefile.upload.store.d.ts

@@ -0,0 +1,166 @@
+import { OnDestroy } from '@angular/core';
+import { FileAcceptFilterTypeString } from '@dereekb/dbx-web';
+import { FirebaseStorageAccessorFile, StoragePathInput } from '@dereekb/firebase';
+import { ArrayOrValue, Maybe, PercentDecimal } from '@dereekb/util';
+import { ComponentStore } from '@ngrx/component-store';
+import { StorageFileUploadFilesEvent, StorageFileUploadFilesFinalResult } from '../container';
+import * as i0 from "@angular/core";
+/**
+ * The stage of the upload process.
+ *
+ * - configuration: The initial stage where the upload store is being configured.
+ * - files: The stage where the files are to be selected.
+ * - uploading: The stage where the files are being uploaded.
+ * - success: The stage where the files have been successfully uploaded.
+ * - error: The stage where the upload has failed.
+ */
+export type DbxFirebaseStorageFileUploadStoreUploadStage = 'configuration' | 'files' | 'uploading' | 'success' | 'error';
+/**
+ * The accepted file types for the upload.
+ *
+ * If unset, then all file types are accepted.
+ */
+export type DbxFirebaseStorageFileUploadStoreAllowedTypes = FileAcceptFilterTypeString[];
+/**
+ * The progress of a file being uploaded.
+ *
+ * File progresses are automatically created for all files when one file's progress is
+ */
+export interface DbxFirebaseStorageFileUploadStoreFileProgress<T = unknown> {
+    /**
+     * The file being uploaded.
+     */
+    readonly file: File;
+    /**
+     * The accessor file for the file, if available.
+     */
+    readonly fileRef?: Maybe<FirebaseStorageAccessorFile>;
+    /**
+     * The upload reference info for the file, if available.
+     */
+    readonly uploadRef?: Maybe<T>;
+    /**
+     * The number of bytes that have been transferred for this file.
+     */
+    readonly bytesTransferred?: Maybe<number>;
+    /**
+     * The total number of bytes to be uploaded.
+     */
+    readonly totalBytes?: Maybe<number>;
+    /**
+     * The progress of the upload.
+     *
+     * If unset, then the file has not started uploading.
+     */
+    readonly progress?: Maybe<PercentDecimal>;
+    /**
+     * If true, the upload has failed for this file.
+     */
+    readonly failed?: boolean;
+    /**
+     * The error that occurred during the upload for this file.
+     */
+    readonly error?: unknown;
+}
+export interface DbxFirebaseStorageFileUploadStoreState {
+    /**
+     * The default accepted file types for the upload.
+     *
+     * This may be set by the component.
+     */
+    readonly componentFileTypesAccepted?: Maybe<DbxFirebaseStorageFileUploadStoreAllowedTypes>;
+    /**
+     * If true, the component allows multiple files to be selected.
+     *
+     * Defaults to undefined.
+     */
+    readonly isComponentMultiUploadAllowed?: Maybe<boolean>;
+    /**
+     * The accepted file types for the upload.
+     *
+     * Is used to filter the files that can be selected for upload.
+     *
+     * Overrides the componentFileTypesAccepted value if set.
+     */
+    readonly fileTypesAccepted?: Maybe<DbxFirebaseStorageFileUploadStoreAllowedTypes>;
+    /**
+     * If true, allow selecting multiple files for upload.
+     *
+     * If isComponentMultiUploadAllowed is false, then this value is ignored.
+     */
+    readonly isMultiUploadAllowed?: Maybe<boolean>;
+    /**
+     * Path to upload the file(s) to.
+     *
+     * Must be set before uploading.
+     */
+    readonly uploadPath?: Maybe<StoragePathInput>;
+    /**
+     * The current file(s) to upload.
+     */
+    readonly files?: Maybe<File[]>;
+    /**
+     * The progress of the upload for each file.
+     *
+     * Only set while one or more files are being uploaded.
+     */
+    readonly latestProgressEvent?: Maybe<StorageFileUploadFilesEvent>;
+    /**
+     * If true, the upload handler is working.
+     */
+    readonly isUploadHandlerWorking?: Maybe<boolean>;
+    /**
+     * The final upload result for the files.
+     *
+     * Only set after the upload has completed.
+     */
+    readonly uploadResult?: Maybe<StorageFileUploadFilesFinalResult>;
+}
+/**
+ * Store used for selecting a specific NotificationItem from a list of notification items.
+ */
+export declare class DbxFirebaseStorageFileUploadStore extends ComponentStore<DbxFirebaseStorageFileUploadStoreState> implements OnDestroy {
+    constructor();
+    readonly componentFileTypesAccepted$: import("rxjs").Observable<Maybe<DbxFirebaseStorageFileUploadStoreAllowedTypes>>;
+    readonly isComponentMultiUploadAllowed$: import("rxjs").Observable<Maybe<boolean>>;
+    readonly fileTypesAllowed$: import("rxjs").Observable<DbxFirebaseStorageFileUploadStoreAllowedTypes>;
+    readonly fileTypesAcceptString$: import("rxjs").Observable<string>;
+    readonly isMultiUploadAllowed$: import("rxjs").Observable<Maybe<boolean>>;
+    readonly uploadPath$: import("rxjs").Observable<Maybe<StoragePathInput>>;
+    readonly currentFiles$: import("rxjs").Observable<Maybe<File[]>>;
+    readonly files$: import("rxjs").Observable<File[]>;
+    readonly isUploadHandlerWorking$: import("rxjs").Observable<Maybe<boolean>>;
+    readonly latestProgressEvent$: import("rxjs").Observable<Maybe<StorageFileUploadFilesEvent>>;
+    readonly currentUploadResult$: import("rxjs").Observable<Maybe<StorageFileUploadFilesFinalResult>>;
+    readonly uploadResult$: import("rxjs").Observable<StorageFileUploadFilesFinalResult>;
+    readonly setComponentFileTypesAccepted: (() => void) | ((observableOrValue: Maybe<DbxFirebaseStorageFileUploadStoreAllowedTypes> | import("rxjs").Observable<Maybe<DbxFirebaseStorageFileUploadStoreAllowedTypes>>) => import("rxjs").Subscription);
+    readonly setIsComponentMultiUploadAllowed: (() => void) | ((observableOrValue: Maybe<boolean> | import("rxjs").Observable<Maybe<boolean>>) => import("rxjs").Subscription);
+    readonly setUploadPath: (() => void) | ((observableOrValue: Maybe<StoragePathInput> | import("rxjs").Observable<Maybe<StoragePathInput>>) => import("rxjs").Subscription);
+    readonly setFileTypesAccepted: (() => void) | ((observableOrValue: Maybe<ArrayOrValue<string>> | import("rxjs").Observable<Maybe<ArrayOrValue<string>>>) => import("rxjs").Subscription);
+    /**
+     * Sets the file list to upload.
+     *
+     * If the upload handler is working, the file list cannot be changed.
+     */
+    readonly setFiles: (() => void) | ((observableOrValue: Maybe<File[]> | import("rxjs").Observable<Maybe<File[]>>) => import("rxjs").Subscription);
+    readonly setIsMultiUploadAllowed: (() => void) | ((observableOrValue: Maybe<boolean> | import("rxjs").Observable<Maybe<boolean>>) => import("rxjs").Subscription);
+    /**
+     * Flags the upload handler to begin working.
+     *
+     * Once the upload handler is flagged, it cannot be unset until the upload handler has finished.
+     */
+    readonly setIsUploadHandlerWorking: (observableOrValue: boolean | import("rxjs").Observable<boolean>) => import("rxjs").Subscription;
+    /**
+     * Sets the latest progress event.
+     */
+    readonly setLatestProgressEvent: (() => void) | ((observableOrValue: Maybe<StorageFileUploadFilesEvent> | import("rxjs").Observable<Maybe<StorageFileUploadFilesEvent>>) => import("rxjs").Subscription);
+    /**
+     * Updates the upload progress for one or more files.
+     */
+    /**
+     * Sets the upload result.
+     */
+    readonly setUploadResult: (() => void) | ((observableOrValue: Maybe<StorageFileUploadFilesFinalResult> | import("rxjs").Observable<Maybe<StorageFileUploadFilesFinalResult>>) => import("rxjs").Subscription);
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseStorageFileUploadStore, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirebaseStorageFileUploadStore>;
+}

package/lib/storage/firebase.storage.module.d.ts

@@ -3,7 +3,7 @@ import { ProvideDbxFirebaseStorageConfig } from './firebase.storage.providers';
 import * as i0 from "@angular/core";
 export type DbxFirebaseStorageModuleConfig = ProvideDbxFirebaseStorageConfig;
 /**
- * @deprecated use providedDbxFirebaseStorageContext() instead.
+ * @deprecated use providedDbxFirebaseStorage() instead.
  */
 export declare class DbxFirebaseStorageModule {
     static forRoot(config?: DbxFirebaseStorageModuleConfig): ModuleWithProviders<DbxFirebaseStorageModule>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "12.4.4",
+  "version": "12.5.0",
   "peerDependencies": {
     "@angular/core": "^18.0.0",
     "@dereekb/dbx-analytics": "*",