@dereekb/dbx-firebase 12.5.10 → 12.6.0

package/lib/development/development.widget.service.d.ts

@@ -5,7 +5,7 @@ import * as i0 from "@angular/core";
 /**
  * Default providers to inject.
  */
-export declare const DEFAULT_FIREBASE_DEVELOPMENT_WIDGET_PROVIDERS_TOKEN: InjectionToken<unknown>;
+export declare const DEFAULT_FIREBASE_DEVELOPMENT_WIDGET_PROVIDERS_TOKEN: InjectionToken<DbxFirebaseDevelopmentWidgetEntry[]>;
 /**
  * Service used for registering widgets used for development.
  *

package/lib/modules/storagefile/container/storagefile.download.button.component.d.ts

@@ -1,13 +1,41 @@
-import { DbxActionDialogFunction, DbxButtonStyle } from '@dereekb/dbx-web';
-import { StorageFileKey } from '@dereekb/firebase';
-import { DateOrUnixTimeNumber, Maybe } from '@dereekb/util';
-import { DbxFirebaseStorageFileDownloadService } from '../service/storagefile.download.service';
+import { DbxActionDialogFunction, DbxButtonStyle, DbxWebFilePreviewService } from '@dereekb/dbx-web';
+import { StorageFileDownloadUrl, StorageFileKey } from '@dereekb/firebase';
+import { ContentTypeMimeType, DateOrUnixDateTimeSecondsNumber, Maybe } from '@dereekb/util';
+import { DbxFirebaseStorageFileDownloadService, DbxFirebaseStorageFileDownloadServiceCustomSource } from '../service/storagefile.download.service';
 import { ClickableAnchor } from '@dereekb/dbx-core';
-import { WorkUsingObservable } from '@dereekb/rxjs';
+import { MaybeObservableOrValue, WorkUsingContext } from '@dereekb/rxjs';
 import { Observable } from 'rxjs';
 import { DbxFirebaseStorageFileDownloadUrlPair } from '../service/storagefile.download.storage.service';
-import { MatDialog } from '@angular/material/dialog';
+import { MatDialog, MatDialogRef } from '@angular/material/dialog';
 import * as i0 from "@angular/core";
+export interface DbxFirebaseStorageFileDownloadButtonSource {
+    /**
+     * A static StorageFileKey to use.
+     */
+    readonly storageFileKey?: MaybeObservableOrValue<StorageFileKey>;
+    /**
+     * The expected mime type of the StorageFile to use when previewing.
+     */
+    readonly storageFileEmbedMimeType?: MaybeObservableOrValue<ContentTypeMimeType | string>;
+    /**
+     * Custom source to use with the DbxFirebaseStorageFileDownloadService. A more simple alternative to using handleGetDownloadUrl().
+     */
+    readonly customSource?: Maybe<DbxFirebaseStorageFileDownloadServiceCustomSource>;
+    /**
+     * Optional custom work to use to get the download URL.
+     *
+     * If provided, customSource is ignored.
+     */
+    readonly handleGetDownloadUrl?: Maybe<WorkUsingContext<StorageFileKey, DbxFirebaseStorageFileDownloadUrlPair>>;
+    /**
+     * Optional custom success handler for the download URL.
+     */
+    readonly handleGetDownloadUrlSuccess?: (value: DbxFirebaseStorageFileDownloadUrlPair) => void;
+    /**
+     * Optional custom error handler for the download URL.
+     */
+    readonly handleGetDownloadUrlError?: (error: unknown) => void;
+}
 /**
  * Configuration for the DbxFirebaseStorageFileDownloadButton.
  */
@@ -16,10 +44,14 @@ export interface DbxFirebaseStorageFileDownloadButtonConfig {
     readonly previewButtonStyle?: Maybe<DbxButtonStyle>;
     /**
      * Whether or not to pre-load the download url from the source.
+     *
+     * Defaults to false.
      */
     readonly preload?: Maybe<boolean>;
     /**
      * Whether or not to show a preview button.
+     *
+     * Defaults to true.
      */
     readonly showPreviewButton?: Maybe<boolean>;
     readonly icon?: Maybe<string>;
@@ -28,10 +60,17 @@ export interface DbxFirebaseStorageFileDownloadButtonConfig {
     readonly downloadReadyText?: Maybe<string>;
     readonly previewIcon?: Maybe<string>;
     readonly previewText?: Maybe<string>;
+    /**
+     * Optional custom function to open a preview dialog. If not provided, the default preview dialog provided by the DbxWebFilePreviewService will be used.
+     *
+     * The function can return undefined, in which case the default preview dialog will be used.
+     */
+    readonly openCustomPreview?: Maybe<(downloadUrl: StorageFileDownloadUrl, embedMimeType?: Maybe<string>) => Maybe<MatDialogRef<any>>>;
 }
 export declare class DbxFirebaseStorageFileDownloadButton {
-    readonly dbxFirebaseStorageFileDownloadService: DbxFirebaseStorageFileDownloadService;
     readonly matDialog: MatDialog;
+    readonly dbxWebFilePreviewService: DbxWebFilePreviewService;
+    readonly dbxFirebaseStorageFileDownloadService: DbxFirebaseStorageFileDownloadService;
     /**
      * The StorageFileKey to set up the download button for.
      */
@@ -55,11 +94,17 @@ export declare class DbxFirebaseStorageFileDownloadButton {
      */
     readonly downloadUrlChange: import("@angular/core").OutputEmitterRef<Maybe<string>>;
     readonly config: import("@angular/core").InputSignal<Maybe<DbxFirebaseStorageFileDownloadButtonConfig>>;
+    readonly source: import("@angular/core").InputSignal<Maybe<DbxFirebaseStorageFileDownloadButtonSource>>;
+    readonly source$: Observable<Maybe<DbxFirebaseStorageFileDownloadButtonSource>>;
     readonly configSignal: import("@angular/core").Signal<DbxFirebaseStorageFileDownloadButtonConfig>;
     readonly preloadSignal: import("@angular/core").Signal<boolean>;
     readonly downloadUrlSignal: import("@angular/core").WritableSignal<Maybe<string>>;
-    readonly downloadUrlExpiresAtSignal: import("@angular/core").WritableSignal<Maybe<DateOrUnixTimeNumber>>;
-    readonly storageFileKey$: Observable<Maybe<string>>;
+    readonly downloadMimeTypeSignal: import("@angular/core").WritableSignal<Maybe<string>>;
+    readonly downloadUrlExpiresAtSignal: import("@angular/core").WritableSignal<Maybe<DateOrUnixDateTimeSecondsNumber>>;
+    readonly storageFileKeyFromInput$: Observable<Maybe<string>>;
+    readonly storageFileKeyFromSource$: Observable<Maybe<StorageFileKey>>;
+    readonly storageFileKey$: Observable<Maybe<StorageFileKey>>;
+    readonly storageFileKeySignal: import("@angular/core").Signal<Maybe<string>>;
     readonly hasDownloadUrlSignal: import("@angular/core").Signal<boolean>;
     readonly buttonStyleSignal: import("@angular/core").Signal<DbxButtonStyle>;
     readonly previewButtonStyleSignal: import("@angular/core").Signal<DbxButtonStyle>;
@@ -70,6 +115,7 @@ export declare class DbxFirebaseStorageFileDownloadButton {
     readonly anchorSignal: import("@angular/core").Signal<Maybe<ClickableAnchor>>;
     readonly storageFileDownloadUrlEffect: import("@angular/core").EffectRef;
     readonly showPreviewButtonSignal: import("@angular/core").Signal<boolean>;
+    readonly openCustomPreviewSignal: import("@angular/core").Signal<Maybe<(downloadUrl: StorageFileDownloadUrl, embedMimeType?: Maybe<string>) => Maybe<MatDialogRef<any>>>>;
     readonly handleOpenPreviewDialog: DbxActionDialogFunction;
     readonly cachedUrlForStorageFileKey$: Observable<Maybe<DbxFirebaseStorageFileDownloadUrlPair>>;
     readonly cachedUrlForStorageFileKeySignal: import("@angular/core").Signal<Maybe<DbxFirebaseStorageFileDownloadUrlPair>>;
@@ -79,9 +125,9 @@ export declare class DbxFirebaseStorageFileDownloadButton {
     readonly downloadUrlHasExpiredSignal: import("@angular/core").Signal<boolean | undefined>;
     readonly downloadUrlHasExpiredEffect: import("@angular/core").EffectRef;
     readonly downloadUrlChangeEffect: import("@angular/core").EffectRef;
-    readonly handleGetDownloadUrl: WorkUsingObservable<StorageFileKey, DbxFirebaseStorageFileDownloadUrlPair>;
+    readonly handleGetDownloadUrl: WorkUsingContext<StorageFileKey, DbxFirebaseStorageFileDownloadUrlPair>;
     readonly handleGetDownloadUrlSuccess: (value: DbxFirebaseStorageFileDownloadUrlPair) => void;
     readonly handleGetDownloadUrlError: (error: unknown) => void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseStorageFileDownloadButton, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseStorageFileDownloadButton, "dbx-firebase-storagefile-download-button", never, { "storageFileKey": { "alias": "storageFileKey"; "required": false; "isSignal": true; }; "storageFileDownloadUrl": { "alias": "storageFileDownloadUrl"; "required": false; "isSignal": true; }; "embedMimeType": { "alias": "embedMimeType"; "required": false; "isSignal": true; }; "showPreviewButton": { "alias": "showPreviewButton"; "required": false; "isSignal": true; }; "config": { "alias": "config"; "required": false; "isSignal": true; }; }, { "downloadUrlChange": "downloadUrlChange"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseStorageFileDownloadButton, "dbx-firebase-storagefile-download-button", never, { "storageFileKey": { "alias": "storageFileKey"; "required": false; "isSignal": true; }; "storageFileDownloadUrl": { "alias": "storageFileDownloadUrl"; "required": false; "isSignal": true; }; "embedMimeType": { "alias": "embedMimeType"; "required": false; "isSignal": true; }; "showPreviewButton": { "alias": "showPreviewButton"; "required": false; "isSignal": true; }; "config": { "alias": "config"; "required": false; "isSignal": true; }; "source": { "alias": "source"; "required": false; "isSignal": true; }; }, { "downloadUrlChange": "downloadUrlChange"; }, never, never, true, never>;
 }

package/lib/modules/storagefile/service/storagefile.download.service.d.ts

@@ -1,8 +1,23 @@
-import { StorageFileFunctions, DownloadStorageFileParams, StorageFileKey, StorageFileId } from '@dereekb/firebase';
+import { StorageFileFunctions, DownloadStorageFileParams, StorageFileKey, StorageFileId, DownloadStorageFileResult } from '@dereekb/firebase';
 import { Maybe, Milliseconds, Seconds } from '@dereekb/util';
 import { DbxFirebaseStorageFileDownloadStorage, DbxFirebaseStorageFileDownloadUrlPair } from './storagefile.download.storage.service';
 import { Observable } from 'rxjs';
+import { LoadingState } from '@dereekb/rxjs';
 import * as i0 from "@angular/core";
+export type DbxFirebaseStorageFileDownloadServiceCustomSourceDownloadFunction = (params: DownloadStorageFileParams, storageFileId: StorageFileId) => Promise<DownloadStorageFileResult>;
+/**
+ * Used as a custom source for downloading StorageFiles.
+ */
+export interface DbxFirebaseStorageFileDownloadServiceCustomSource {
+    /**
+     * Retrieves the download result for the StorageFile using the input parameters.
+     *
+     * @param storageFileId
+     * @returns
+     */
+    downloadStorageFileResult: DbxFirebaseStorageFileDownloadServiceCustomSourceDownloadFunction;
+}
+export declare function dbxFirebaseStorageFileDownloadServiceCustomSourceFromObs(obsForInput: (params: DownloadStorageFileParams, storageFileId: StorageFileId) => Observable<LoadingState<DownloadStorageFileResult>>): DbxFirebaseStorageFileDownloadServiceCustomSource;
 /**
  * Service used for retrieving download links for StorageFiles.
  */
@@ -35,6 +50,21 @@ export declare class DbxFirebaseStorageFileDownloadService {
      * @returns
      */
     downloadPairForStorageFile(storageFileIdOrKey: StorageFileId | StorageFileKey): Observable<DbxFirebaseStorageFileDownloadUrlPair>;
+    /**
+     * Retrieves the download URL for the StorageFile using the default parameters and pulled from the input source, if applicable.
+     *
+     * If no source is provided, uses the default internal source.
+     *
+     * These URLs are cached locally to prevent extra/redundant calls to the server.
+     *
+     * @param storageFileIdOrKey
+     * @returns
+     */
+    downloadPairForStorageFileUsingSource(storageFileIdOrKey: StorageFileId | StorageFileKey, source: Maybe<DbxFirebaseStorageFileDownloadServiceCustomSource>): Observable<DbxFirebaseStorageFileDownloadUrlPair>;
+    /**
+     * Adds the given download URL pair to the cache.
+     */
+    addPairForStorageFileToCache(downloadUrlPair: DbxFirebaseStorageFileDownloadUrlPair): void;
     /**
      * Creates a new download URL for the StorageFile.
      *
@@ -43,6 +73,7 @@ export declare class DbxFirebaseStorageFileDownloadService {
      * @returns
      */
     createDownloadPairForStorageFile(storageFileIdOrKey: StorageFileId | StorageFileKey, inputParams?: Omit<DownloadStorageFileParams, 'key'>): Promise<DbxFirebaseStorageFileDownloadUrlPair>;
+    private _createDownloadPairForStorageFileUsingSource;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseStorageFileDownloadService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirebaseStorageFileDownloadService>;
 }

package/lib/modules/storagefile/service/storagefile.download.storage.service.d.ts

@@ -3,17 +3,21 @@ import { StorageAccessor } from '@dereekb/dbx-core';
 import { Observable } from 'rxjs';
 import { FirebaseAuthUserId, FirestoreModelIdInput, StorageFileId, StorageFileSignedDownloadUrl } from '@dereekb/firebase';
 import { DbxFirebaseAuthService } from '../../../auth/service/firebase.auth.service';
-import { UnixTimeNumber } from '@dereekb/util';
+import { ContentTypeMimeType, Maybe, UnixDateTimeSecondsNumber } from '@dereekb/util';
 import * as i0 from "@angular/core";
 export interface DbxFirebaseStorageFileDownloadUrlPair {
     readonly id: StorageFileId;
     readonly downloadUrl: StorageFileSignedDownloadUrl;
+    /**
+     * Mime type, if available.
+     */
+    readonly mimeType?: Maybe<ContentTypeMimeType>;
     /**
      * Expiration in seconds since epoch.
      */
-    readonly expiresAt: UnixTimeNumber;
+    readonly expiresAt: UnixDateTimeSecondsNumber;
 }
-export type DbxFirebaseStorageFileDownloadUrlPairString = `${UnixTimeNumber}_${StorageFileSignedDownloadUrl}`;
+export type DbxFirebaseStorageFileDownloadUrlPairString = `${UnixDateTimeSecondsNumber}_${StorageFileSignedDownloadUrl}`;
 export type DbxFirebaseStorageFileDownloadUrlPairsRecord = Record<StorageFileId, DbxFirebaseStorageFileDownloadUrlPairString>;
 export interface DbxFirebaseStorageFileDownloadUserCache {
     readonly uid: FirebaseAuthUserId;
@@ -30,7 +34,7 @@ export declare class DbxFirebaseStorageFileDownloadStorage {
     static readonly DEFAULT_MAX_DOWNLOAD_URLS = 100;
     readonly authService: DbxFirebaseAuthService;
     readonly storageAccessor: StorageAccessor<DbxFirebaseStorageFileDownloadUserCache>;
-    addDownloadUrl({ id, downloadUrl, expiresAt }: DbxFirebaseStorageFileDownloadUrlPair): Observable<void>;
+    addDownloadUrl({ id, downloadUrl, expiresAt, mimeType }: DbxFirebaseStorageFileDownloadUrlPair): Observable<void>;
     /**
      * Returns the cached download URL pair for the given key.
      *

package/package.json

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