@dereekb/firebase 12.6.20 → 12.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "12.6.20",
+  "version": "12.7.0",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/model/storagefile/storagefile.api.d.ts

@@ -226,6 +226,16 @@ export interface SyncAllFlaggedStorageFilesWithGroupsResult {
      */
     readonly storageFilesGroupsUpdated: number;
 }
+export declare class UpdateStorageFileGroupParams extends TargetModelParams {
+    /**
+     * Entries to update, if selected.
+     */
+    entries?: Maybe<UpdateStorageFileGroupEntryParams[]>;
+}
+export declare class UpdateStorageFileGroupEntryParams {
+    s: StorageFileId;
+    n?: Maybe<string>;
+}
 export declare class RegenerateStorageFileGroupContentParams extends TargetModelParams {
     /**
      * If true, will force syncing even if the StorageFile is not flagged for a resync.
@@ -290,6 +300,7 @@ export type StorageFileModelCrudFunctionsConfig = {
     };
     storageFileGroup: {
         update: {
+            _: UpdateStorageFileGroupParams;
             regenerateContent: [RegenerateStorageFileGroupContentParams, RegenerateStorageFileGroupContentResult];
         };
     };
@@ -316,6 +327,7 @@ export declare abstract class StorageFileFunctions implements ModelFirebaseFunct
     };
     abstract storageFileGroup: {
         updateStorageFileGroup: {
+            update: ModelFirebaseCrudFunction<UpdateStorageFileGroupParams>;
             regenerateContent: ModelFirebaseCrudFunction<RegenerateStorageFileGroupContentParams, RegenerateStorageFileGroupContentResult>;
         };
     };

package/src/lib/model/storagefile/storagefile.create.d.ts

@@ -32,6 +32,12 @@ export interface CreateStorageFileDocumentPairInput<M extends StorageFileMetadat
      * File to use when creating the StorageFile.
      */
     readonly file?: FirebaseStorageAccessorFile;
+    /**
+     * The display name of the StorageFile.
+     *
+     * Corresponds with the "n" value in the StorageFile template.
+     */
+    readonly displayName?: Maybe<string>;
     /**
      * The user that the file is associated with.
      *

package/src/lib/model/storagefile/storagefile.d.ts

@@ -1,7 +1,7 @@
 import { type NeedsSyncBoolean, type Maybe } from '@dereekb/util';
 import { type GrantedReadRole, type GrantedUpdateRole } from '@dereekb/model';
 import { AbstractFirestoreDocument, type CollectionReference, type FirestoreCollection, type FirestoreContext, type FirebaseAuthUserId, type FirebaseAuthOwnershipKey, type StoragePath, type StorageSignedDownloadUrl, type StorageDownloadUrl, type SavedToFirestoreIfTrue, type OneWayFlatFirestoreModelKey, type FirestoreCollectionModelKey } from '../../common';
-import { type StorageFilePurposeSubgroup, type StorageFileGroupId, type StorageFileGroupRelatedStorageFilePurpose, type StorageFileId, type StorageFileMetadata, type StorageFilePurpose } from './storagefile.id';
+import { type StorageFilePurposeSubgroup, type StorageFileGroupId, type StorageFileGroupRelatedStorageFilePurpose, type StorageFileId, type StorageFileMetadata, type StorageFilePurpose, type StorageFileDisplayName } from './storagefile.id';
 import { type NotificationKey } from '../notification';
 export declare abstract class StorageFileFirestoreCollections {
     abstract readonly storageFileCollection: StorageFileFirestoreCollection;
@@ -200,6 +200,13 @@ export interface StorageFile<M extends StorageFileMetadata = StorageFileMetadata
      * Created at date.
      */
     cat: Date;
+    /**
+     * Arbitrary display name for the file.
+     *
+     * This name is used in StorageFileGroup composite file generations, instead
+     * of the file's normal path file name, if available.
+     */
+    n?: Maybe<StorageFileDisplayName>;
     /**
      * Type of creation.
      */
@@ -309,6 +316,11 @@ export interface StorageFileGroupEmbeddedFile {
      * StorageFile id
      */
     s: StorageFileId;
+    /**
+     * Overrides the display name for this file within the group when generating
+     * a composite file (zip, etc.).
+     */
+    n?: Maybe<StorageFileDisplayName>;
     /**
      * The time number it was added to the group.
      */

package/src/lib/model/storagefile/storagefile.id.d.ts

@@ -1,3 +1,4 @@
+import { type SlashPathUntypedFile } from '@dereekb/util';
 import { type FlatFirestoreModelKey, inferKeyFromTwoWayFlatFirestoreModelKey, twoWayFlatFirestoreModelKey, type FirestoreModelId, type FirestoreModelKey } from '../../common';
 export type StorageFileId = FirestoreModelId;
 export type StorageFileKey = FirestoreModelKey;
@@ -20,6 +21,14 @@ export type StorageFilePurpose = string;
  * Example use case: Documents with the same StorageFilePurpose/processing, but should only have a single StorageFile per subgroup.
  */
 export type StorageFilePurposeSubgroup = string;
+/**
+ * Arbitrary untyped name that is attached with a StorageFile.
+ *
+ * This is an alternate name for the file that can be used for display purposes. It
+ * is used within StorageFileGroup's zip file as the primary name. The display name
+ * is merged with the StorageFile's file path extension to create the file name.
+ */
+export type StorageFileDisplayName = SlashPathUntypedFile;
 /**
  * A default constant to use as a default StorageFilePurposeSubgroup value for StorageFiles that have a purpose that defines subgroups.
  */

package/test/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [12.7.0](https://github.com/dereekb/dbx-components/compare/v12.6.21-dev...v12.7.0) (2026-02-20)
+
+
+
+## [12.6.21](https://github.com/dereekb/dbx-components/compare/v12.6.20-dev...v12.6.21) (2026-02-18)
+
+
+
 ## [12.6.20](https://github.com/dereekb/dbx-components/compare/v12.6.19-dev...v12.6.20) (2026-02-15)
 
 

package/test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "12.6.20",
+  "version": "12.7.0",
   "type": "commonjs",
   "peerDependencies": {
     "@dereekb/util": "*",