@dereekb/dbx-firebase 12.5.8 → 12.5.10

package/lib/modules/storagefile/container/index.d.ts

@@ -1,3 +1,4 @@
+export * from './storagefile.download.button.component';
 export * from './storagefile.upload.action.handler.directive';
 export * from './storagefile.upload.error';
 export * from './storagefile.upload.handler';

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

@@ -0,0 +1,87 @@
+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 { ClickableAnchor } from '@dereekb/dbx-core';
+import { WorkUsingObservable } from '@dereekb/rxjs';
+import { Observable } from 'rxjs';
+import { DbxFirebaseStorageFileDownloadUrlPair } from '../service/storagefile.download.storage.service';
+import { MatDialog } from '@angular/material/dialog';
+import * as i0 from "@angular/core";
+/**
+ * Configuration for the DbxFirebaseStorageFileDownloadButton.
+ */
+export interface DbxFirebaseStorageFileDownloadButtonConfig {
+    readonly buttonStyle?: Maybe<DbxButtonStyle>;
+    readonly previewButtonStyle?: Maybe<DbxButtonStyle>;
+    /**
+     * Whether or not to pre-load the download url from the source.
+     */
+    readonly preload?: Maybe<boolean>;
+    /**
+     * Whether or not to show a preview button.
+     */
+    readonly showPreviewButton?: Maybe<boolean>;
+    readonly icon?: Maybe<string>;
+    readonly text?: Maybe<string>;
+    readonly downloadReadyIcon?: Maybe<string>;
+    readonly downloadReadyText?: Maybe<string>;
+    readonly previewIcon?: Maybe<string>;
+    readonly previewText?: Maybe<string>;
+}
+export declare class DbxFirebaseStorageFileDownloadButton {
+    readonly dbxFirebaseStorageFileDownloadService: DbxFirebaseStorageFileDownloadService;
+    readonly matDialog: MatDialog;
+    /**
+     * The StorageFileKey to set up the download button for.
+     */
+    readonly storageFileKey: import("@angular/core").InputSignal<Maybe<string>>;
+    /**
+     * The download URL to use for the download button.
+     */
+    readonly storageFileDownloadUrl: import("@angular/core").InputSignal<Maybe<string>>;
+    /**
+     * The MIME type to use the embed component.
+     */
+    readonly embedMimeType: import("@angular/core").InputSignal<Maybe<string>>;
+    /**
+     * Whether or not to show a preview button.
+     *
+     * Defaults to true.
+     */
+    readonly showPreviewButton: import("@angular/core").InputSignal<Maybe<boolean>>;
+    /**
+     * Output event emitted when the download URL changes.
+     */
+    readonly downloadUrlChange: import("@angular/core").OutputEmitterRef<Maybe<string>>;
+    readonly config: import("@angular/core").InputSignal<Maybe<DbxFirebaseStorageFileDownloadButtonConfig>>;
+    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 hasDownloadUrlSignal: import("@angular/core").Signal<boolean>;
+    readonly buttonStyleSignal: import("@angular/core").Signal<DbxButtonStyle>;
+    readonly previewButtonStyleSignal: import("@angular/core").Signal<DbxButtonStyle>;
+    readonly iconSignal: import("@angular/core").Signal<Maybe<string>>;
+    readonly textSignal: import("@angular/core").Signal<Maybe<string>>;
+    readonly previewIconSignal: import("@angular/core").Signal<Maybe<string>>;
+    readonly previewTextSignal: import("@angular/core").Signal<Maybe<string>>;
+    readonly anchorSignal: import("@angular/core").Signal<Maybe<ClickableAnchor>>;
+    readonly storageFileDownloadUrlEffect: import("@angular/core").EffectRef;
+    readonly showPreviewButtonSignal: import("@angular/core").Signal<boolean>;
+    readonly handleOpenPreviewDialog: DbxActionDialogFunction;
+    readonly cachedUrlForStorageFileKey$: Observable<Maybe<DbxFirebaseStorageFileDownloadUrlPair>>;
+    readonly cachedUrlForStorageFileKeySignal: import("@angular/core").Signal<Maybe<DbxFirebaseStorageFileDownloadUrlPair>>;
+    readonly cachedUrlEffect: import("@angular/core").EffectRef;
+    readonly downloadUrlExpiresAt$: Observable<Maybe<Date>>;
+    readonly downloadUrlHasExpired$: Observable<boolean>;
+    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 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>;
+}

package/lib/modules/storagefile/index.d.ts

@@ -1,3 +1,5 @@
 export * from './container';
 export * from './store';
+export * from './service';
 export * from './storagefile.upload.module';
+export * from './storagefile.providers';

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

@@ -0,0 +1,2 @@
+export * from './storagefile.download.service';
+export * from './storagefile.download.storage.service';

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

@@ -0,0 +1,48 @@
+import { StorageFileFunctions, DownloadStorageFileParams, StorageFileKey, StorageFileId } from '@dereekb/firebase';
+import { Maybe, Milliseconds, Seconds } from '@dereekb/util';
+import { DbxFirebaseStorageFileDownloadStorage, DbxFirebaseStorageFileDownloadUrlPair } from './storagefile.download.storage.service';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Service used for retrieving download links for StorageFiles.
+ */
+export declare class DbxFirebaseStorageFileDownloadService {
+    /**
+     * Expiration duration for cached download URLs.
+     */
+    protected _expiresAfterTime: Milliseconds;
+    /**
+     * When reading cached values, this buffer is added to the expiration time to prevent the URL from expiring while it is being used.
+     */
+    protected _expiresAfterTimeBuffer: Seconds;
+    readonly storageFileFunctions: StorageFileFunctions;
+    readonly storageFileDownloadStorage: DbxFirebaseStorageFileDownloadStorage;
+    getExpiresAfterTime(): number;
+    setExpiresAfterTime(expiresAfter: number): void;
+    /**
+     * Returns an observable that returns the cached download URL pair for the StorageFile, and emits null once it expires.
+     *
+     * @param storageFileIdOrKey
+     * @returns
+     */
+    getCachedDownloadPairForStorageFile(storageFileIdOrKey: StorageFileId | StorageFileKey): Observable<Maybe<DbxFirebaseStorageFileDownloadUrlPair>>;
+    /**
+     * Retrieves the download URL for the StorageFile using the default parameters.
+     *
+     * These URLs are cached locally to prevent extra/redundant calls to the server.
+     *
+     * @param storageFileIdOrKey
+     * @returns
+     */
+    downloadPairForStorageFile(storageFileIdOrKey: StorageFileId | StorageFileKey): Observable<DbxFirebaseStorageFileDownloadUrlPair>;
+    /**
+     * Creates a new download URL for the StorageFile.
+     *
+     * @param storageFileIdOrKey
+     * @param inputParams
+     * @returns
+     */
+    createDownloadPairForStorageFile(storageFileIdOrKey: StorageFileId | StorageFileKey, inputParams?: Omit<DownloadStorageFileParams, 'key'>): Promise<DbxFirebaseStorageFileDownloadUrlPair>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseStorageFileDownloadService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirebaseStorageFileDownloadService>;
+}

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

@@ -0,0 +1,52 @@
+import { InjectionToken } from '@angular/core';
+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 * as i0 from "@angular/core";
+export interface DbxFirebaseStorageFileDownloadUrlPair {
+    readonly id: StorageFileId;
+    readonly downloadUrl: StorageFileSignedDownloadUrl;
+    /**
+     * Expiration in seconds since epoch.
+     */
+    readonly expiresAt: UnixTimeNumber;
+}
+export type DbxFirebaseStorageFileDownloadUrlPairString = `${UnixTimeNumber}_${StorageFileSignedDownloadUrl}`;
+export type DbxFirebaseStorageFileDownloadUrlPairsRecord = Record<StorageFileId, DbxFirebaseStorageFileDownloadUrlPairString>;
+export interface DbxFirebaseStorageFileDownloadUserCache {
+    readonly uid: FirebaseAuthUserId;
+    readonly pairs: DbxFirebaseStorageFileDownloadUrlPairsRecord;
+}
+/**
+ * Token that corresponds to a StorageAccessor<DbxFirebaseStorageFileDownloadUserCache> that is used by DbxModelViewTrackerStorage.
+ */
+export declare const DBX_FIREBASE_STORAGEFILE_DOWNLOAD_STORAGE_ACCESSOR_TOKEN: InjectionToken<unknown>;
+/**
+ * Used for managing DbxModelViewTrackerEvent storage.
+ */
+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>;
+    /**
+     * Returns the cached download URL pair for the given key.
+     *
+     * The pair may be expired.
+     *
+     * @param key
+     * @returns
+     */
+    getDownloadUrlPair(input: FirestoreModelIdInput): Observable<DbxFirebaseStorageFileDownloadUrlPair | undefined>;
+    getAllDownloadUrlPairsRecord(uid: FirebaseAuthUserId): Observable<DbxFirebaseStorageFileDownloadUrlPairsRecord>;
+    getCurrentUserDownloadCache(): Observable<DbxFirebaseStorageFileDownloadUserCache>;
+    getUserDownloadCache(uid: FirebaseAuthUserId): Observable<DbxFirebaseStorageFileDownloadUserCache>;
+    clearCurrentUserDownloadCache(): Observable<void>;
+    clearUserDownloadCache(uid: FirebaseAuthUserId): Observable<void>;
+    private _getUserDownloadCacheForStorageKey;
+    getStorageKeyForUid(uid: FirebaseAuthUserId): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseStorageFileDownloadStorage, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirebaseStorageFileDownloadStorage>;
+}

package/lib/modules/storagefile/storagefile.providers.d.ts

@@ -0,0 +1,13 @@
+import { type EnvironmentProviders } from '@angular/core';
+import { SimpleStorageAccessorFactory, type StorageAccessor } from '@dereekb/dbx-core';
+import { type DbxFirebaseStorageFileDownloadUserCache } from './service/storagefile.download.storage.service';
+/**
+ * Factory function for creating a StorageAccessor for the model view tracker.
+ */
+export declare function defaultDbxFirebaseStorageFileDownloadStorageAccessorFactory(storageAccessorFactory: SimpleStorageAccessorFactory): StorageAccessor<DbxFirebaseStorageFileDownloadUserCache>;
+/**
+ * Creates EnvironmentProviders for providing DbxModelTrackerService, DbxModelObjectStateService and sets up the NgRx store for DbxModelTrackerEffects.
+ *
+ * @returns EnvironmentProviders
+ */
+export declare function provideDbxFirebaseStorageFileService(): EnvironmentProviders;

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

@@ -10,7 +10,7 @@ import * as i4 from "./container/storagefile.upload.sync.directive";
 import * as i5 from "./container/storagefile.upload.initialize.document.directive";
 import * as i6 from "./store/storagefile.collection.store.directive";
 import * as i7 from "./store/storagefile.document.store.directive";
-export declare const importsAndExports: (typeof DbxActionModule | typeof DbxFirebaseStorageFileCollectionStoreDirective | typeof DbxFirebaseStorageFileDocumentStoreDirective | typeof DbxFirebaseStorageFileUploadActionHandlerDirective | typeof DbxFirebaseStorageFileUploadInitializeDocumentDirective | typeof DbxFirebaseStorageFileUploadStoreDirective | typeof DbxFirebaseStorageFileUploadSyncDirective | typeof DbxFileUploadComponent | typeof DbxLoadingComponent | typeof DbxActionLoadingContextDirective | typeof DbxActionSnackbarErrorDirective | typeof DbxFileUploadActionSyncDirective)[];
+export declare const importsAndExports: (typeof DbxActionModule | typeof DbxActionSnackbarErrorDirective | typeof DbxFirebaseStorageFileCollectionStoreDirective | typeof DbxFirebaseStorageFileDocumentStoreDirective | typeof DbxFirebaseStorageFileUploadActionHandlerDirective | typeof DbxFirebaseStorageFileUploadInitializeDocumentDirective | typeof DbxFirebaseStorageFileUploadStoreDirective | typeof DbxFirebaseStorageFileUploadSyncDirective | typeof DbxFileUploadComponent | typeof DbxLoadingComponent | typeof DbxActionLoadingContextDirective | typeof DbxFileUploadActionSyncDirective)[];
 /**
  * Convenience module for importing various modules/components that are relevant to the storage file upload feature.
  *

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

@@ -10,6 +10,7 @@ export declare class StorageFileDocumentStore extends AbstractDbxFirebaseDocumen
     readonly updateStorageFile: import("../../../model/modules/store").DbxFirebaseDocumentStoreFunction<import("@dereekb/firebase").UpdateStorageFileParams, void>;
     readonly processStorageFile: import("../../../model/modules/store").DbxFirebaseDocumentStoreFunction<import("@dereekb/firebase").ProcessStorageFileParams, import("@dereekb/firebase").ProcessStorageFileResult>;
     readonly deleteStorageFile: import("../../../model/modules/store").DbxFirebaseDocumentStoreFunction<import("@dereekb/firebase").DeleteStorageFileParams, void>;
+    readonly downloadStorageFile: import("../../../model/modules/store").DbxFirebaseDocumentStoreFunction<import("@dereekb/firebase").DownloadStorageFileParams, import("@dereekb/firebase").DownloadStorageFileResult>;
     static ɵfac: i0.ɵɵFactoryDeclaration<StorageFileDocumentStore, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<StorageFileDocumentStore>;
 }

package/lib/providers.d.ts

@@ -42,6 +42,10 @@ export interface ProvideDbxFirebaseConfig<T, M extends FirebaseFunctionsMap = Fi
      * If true, provideDbxFirebaseAnalyticsUserEventsListenerService() will be provided/called.
      */
     readonly provideAnalyticsUserEventsListener?: Maybe<boolean>;
+    /**
+     * If true, provideDbxFirebaseStorageFileService() will be provided/called.
+     */
+    readonly provideStorageFileService?: Maybe<boolean>;
 }
 /**
  * All-in-one provider for providing the main configurations for DbxFirebase.

package/package.json

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