@dereekb/firebase 12.5.10 → 12.6.1

package/package.json

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

package/src/lib/common/firestore/collection/collection.d.ts

@@ -362,6 +362,14 @@ export declare function firestoreModelKeyPart<N extends FirestoreCollectionNameR
  * @returns
  */
 export declare const firestoreModelKey: <I extends RootFirestoreModelIdentity, K extends FirestoreModelId = FirestoreModelId>(identity: I, id: K) => FirestoreCollectionModelKey<I, K>;
+/**
+ * Creates a FirestoreModelKey for root FirestoreModelIdentity values.
+ */
+export type FirestoreModelKeyFactory<I extends RootFirestoreModelIdentity, K extends FirestoreModelId = FirestoreModelId> = (id: K) => FirestoreCollectionModelKey<I, K>;
+/**
+ * Creates a FirestoreModelKeyFactory for the input root identity.
+ */
+export declare function firestoreModelKeyFactory<I extends RootFirestoreModelIdentity, K extends FirestoreModelId = FirestoreModelId>(identity: I): (id: K) => FirestoreCollectionModelKeyPart<I, K>;
 /**
  * Creates an array of FirestoreCollectionModelKey values from the input ids.
  *

package/src/lib/common/firestore/snapshot/snapshot.field.d.ts

@@ -348,6 +348,62 @@ export type OptionalFirestoreDateFieldConfig = OptionalFirestoreFieldConfig<Date
  * @returns A field mapping configuration for optional Date values
  */
 export declare function optionalFirestoreDate(config?: OptionalFirestoreDateFieldConfig): ModelFieldMapFunctionsConfig<Maybe<Date>, Maybe<string>>;
+/**
+ * Configuration for a Firestore date field that is stored as a number.
+ */
+export type FirestoreDateNumberFieldConfig = DefaultMapConfiguredFirestoreFieldConfig<Date, number> & {
+    /**
+     * Whether to save the default date as the current timestamp
+     */
+    readonly saveDefaultAsNow?: boolean;
+    /**
+     * Converts a Date object to a number.
+     */
+    readonly fromDate: (input: Date) => number;
+    /**
+     * Converts a number to a Date object.
+     */
+    readonly toDate: (input: number) => Date;
+};
+/**
+ * Creates a field mapping configuration for Firestore date fields.
+ *
+ * Handles conversion between JavaScript Date objects and ISO8601 strings stored in Firestore.
+ *
+ * @param config - Configuration for the date field
+ * @returns A field mapping configuration for Date values
+ */
+export declare function firestoreDateNumber(config: FirestoreDateNumberFieldConfig): FirestoreModelFieldMapFunctionsConfig<Date, number>;
+/**
+ * Configuration for an optional Firestore date field.
+ *
+ * @template Date - JavaScript Date object type
+ * @template ISO8601DateString - ISO8601 date string format in Firestore
+ */
+export type OptionalFirestoreDateNumberFieldConfig = OptionalFirestoreFieldConfig<Date, number> & Pick<FirestoreDateNumberFieldConfig, 'fromDate' | 'toDate'>;
+/**
+ * Creates a field mapping configuration for optional Firestore date field that is stored as a number.
+ *
+ * @param config - Configuration for the optional date field
+ * @returns A field mapping configuration for optional Date values
+ */
+export declare function optionalFirestoreDateNumber(config: OptionalFirestoreDateNumberFieldConfig): ModelFieldMapFunctionsConfig<Maybe<Date>, Maybe<number>>;
+export type FirestoreUnixDateTimeSecondsNumberFieldConfig = Omit<FirestoreDateNumberFieldConfig, 'fromDate' | 'toDate'>;
+/**
+ * Creates a field mapping configuration for Firestore Date fields that are stored as a UnixDateTimeSecondsNumber.
+ *
+ * @param config - Configuration for the date field
+ * @returns A field mapping configuration for Date values
+ */
+export declare function firestoreUnixDateTimeSecondsNumber(config: FirestoreUnixDateTimeSecondsNumberFieldConfig): FirestoreModelFieldMapFunctionsConfig<Date, number>;
+export type OptionalFirestoreUnixDateTimeSecondsNumberFieldConfig = Omit<OptionalFirestoreDateNumberFieldConfig, 'fromDate' | 'toDate'>;
+/**
+ * Creates a field mapping configuration for optional Firestore Date fields that are stored as a UnixDateTimeSecondsNumber.
+ *
+ * @param config - Configuration for the optional date field
+ * @returns A field mapping configuration for optional Date values
+ */
+export declare function optionalFirestoreUnixDateTimeSecondsNumber(config?: OptionalFirestoreUnixDateTimeSecondsNumberFieldConfig): ModelFieldMapFunctionsConfig<Maybe<Date>, Maybe<number>>;
 /**
  * Configuration for a Firestore boolean field.
  */

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

@@ -1,6 +1,7 @@
 import { type StorageBucketId, type StoragePathInput, type StoragePath, type StoragePathRef, type StorageSlashPath } from '../storage';
 import { type ConfigurableStorageMetadata, type StorageAccessControlObject, type StorageAclMetadata, type StorageMakePrivateOptions, type StorageMoveOptions, type StorageSignedDownloadUrl, type StorageSignedDownloadUrlConfig, type FirebaseStorage, type StorageClientUploadBytesInput, type StorageDeleteFileOptions, type StorageDownloadUrl, type StorageMetadata, type StorageUploadInput, type StorageUploadOptions, type StorageUploadResult, type StorageUploadTask } from '../types';
 import { type ArrayOrValue, type Maybe } from '@dereekb/util';
+import { type Readable } from 'stream';
 /**
  * Used for accessing files and folders in the storage.
  */
@@ -64,7 +65,7 @@ export interface FirebaseStorageAccessorFile<R = unknown> extends StoragePathRef
      *
      * Available only in NodeJS.
      */
-    getStream?(maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
+    getStream?(maxDownloadSizeBytes?: number): Readable;
     /**
      * Uploads data to the file's path.
      */

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

@@ -419,7 +419,7 @@ export declare class SendQueuedNotificationsParams {
      */
     readonly sendNotificationLoopsTaskExcessThreshold?: Maybe<number>;
 }
-export interface SendQueuedNotificationsResult extends Omit<SendNotificationResult, 'throttled' | 'isNotificationTask' | 'isUniqueNotificationTask' | 'uniqueNotificationTaskConflict' | 'isConfiguredTemplateType' | 'isKnownTemplateType' | 'notificationTemplateType' | 'notificationMarkedDone' | 'deletedNotification' | 'createdBox' | 'success' | 'exists' | 'boxExists' | 'notificationBoxNeedsInitialization' | 'tryRun' | 'loadMessageFunctionFailure' | 'buildMessageFailure'> {
+export interface SendQueuedNotificationsResult extends Omit<SendNotificationResult, 'throttled' | 'isNotificationTask' | 'isUniqueNotificationTask' | 'notificationTaskCompletionType' | 'uniqueNotificationTaskConflict' | 'isConfiguredTemplateType' | 'isKnownTemplateType' | 'notificationTemplateType' | 'notificationMarkedDone' | 'deletedNotification' | 'createdBox' | 'success' | 'exists' | 'boxExists' | 'notificationBoxNeedsInitialization' | 'tryRun' | 'loadMessageFunctionFailure' | 'buildMessageFailure'> {
     readonly excessLoopsDetected: boolean;
     readonly notificationLoopCount: number;
     readonly notificationBoxesCreated: number;

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

@@ -18,6 +18,8 @@ export declare abstract class NotificationFirestoreCollections {
 export type NotificationTypes = typeof notificationUserIdentity | typeof notificationSummaryIdentity | typeof notificationBoxIdentity | typeof notificationIdentity | typeof notificationWeekIdentity;
 /**
  * Notification-related model that is initialized asynchronously at a later time.
+ *
+ * Examples: NotificationSummary, NotificationBox
  */
 export interface InitializedNotificationModel {
     /**
@@ -111,7 +113,7 @@ export declare const NOTIFICATION_SUMMARY_EMBEDDED_NOTIFICATION_ITEM_MESSAGE_MAX
  *
  * Notification Items can be delivered here.
  */
-export interface NotificationSummary {
+export interface NotificationSummary extends InitializedNotificationModel {
     /**
      * Notification Summary creation date
      */
@@ -167,7 +169,7 @@ export declare const notificationBoxIdentity: import("../../common").RootFiresto
  *
  * Update to each recipient is propogated from NotificationUser values.
  */
-export interface NotificationBox {
+export interface NotificationBox extends InitializedNotificationModel {
     /**
      * Notification Box creation date
      */

package/src/lib/model/notification/notification.task.subtask.d.ts

@@ -52,5 +52,11 @@ export declare const DEFAULT_NOTIFICATION_TASK_SUBTASK_CLEANUP_RETRY_DELAY: numb
 export type NotificationTaskSubtaskCheckpoint = typeof NOTIFICATION_TASK_SUBTASK_CHECKPOINT_PROCESSING | typeof NOTIFICATION_TASK_SUBTASK_CHECKPOINT_CLEANUP;
 /**
  * Returned by a subtask to complete the processing step and schedule the cleanup step.
+ *
+ * This is used internally in subtask running. Do not use this directly. Use of notificationSubtaskComplete() is preferred.
  */
 export declare function completeSubtaskProcessingAndScheduleCleanupTaskResult<D extends NotificationTaskSubtaskData>(): NotificationTaskServiceHandleNotificationTaskResult<D, NotificationTaskSubtaskCheckpoint>;
+/**
+ * Similar to notificationTaskComplete, but is customized for a subtask with the intent of running the cleanup checkpoint.
+ */
+export declare function notificationSubtaskComplete<D extends NotificationTaskSubtaskData>(options?: Maybe<Pick<NotificationTaskServiceHandleNotificationTaskResult<D, NotificationTaskSubtaskCheckpoint>, 'updateMetadata' | 'canRunNextCheckpoint'>>): NotificationTaskServiceHandleNotificationTaskResult<D, NotificationTaskSubtaskCheckpoint>;

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

@@ -2,6 +2,8 @@ export * from './storagefile.action';
 export * from './storagefile.api.error';
 export * from './storagefile.api';
 export * from './storagefile.create';
+export * from './storagefile.group';
+export * from './storagefile.group.processing';
 export * from './storagefile.id';
 export * from './storagefile.query';
 export * from './storagefile.task';
@@ -11,3 +13,4 @@ export * from './storagefile.file';
 export * from './storagefile.upload';
 export * from './storagefile.upload.claims';
 export * from './storagefile.upload.determiner';
+export * from './storagefile.util';

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

@@ -1,8 +1,14 @@
 import { type AsyncFirebaseFunctionDeleteAction, type FirebaseFunctionDeleteAction, type AsyncFirebaseFunctionCreateAction, type AsyncFirebaseFunctionUpdateAction, type FirebaseFunctionCreateAction, type FirebaseFunctionUpdateAction } from '../../common';
-import { type StorageFileDocument } from './storagefile';
+import { type StorageFileGroupDocument, type StorageFileDocument } from './storagefile';
 export type StorageFileCreateAction<P extends object> = FirebaseFunctionCreateAction<P, StorageFileDocument>;
 export type AsyncStorageFileCreateAction<P extends object> = AsyncFirebaseFunctionCreateAction<P, StorageFileDocument>;
 export type StorageFileUpdateAction<P extends object> = FirebaseFunctionUpdateAction<P, StorageFileDocument>;
 export type AsyncStorageFileUpdateAction<P extends object> = AsyncFirebaseFunctionUpdateAction<P, StorageFileDocument>;
 export type StorageFileDeleteAction<P extends object> = FirebaseFunctionDeleteAction<P, StorageFileDocument>;
 export type AsyncStorageFileDeleteAction<P extends object> = AsyncFirebaseFunctionDeleteAction<P, StorageFileDocument>;
+export type StorageFileGroupCreateAction<P extends object> = FirebaseFunctionCreateAction<P, StorageFileGroupDocument>;
+export type AsyncStorageFileGroupCreateAction<P extends object> = AsyncFirebaseFunctionCreateAction<P, StorageFileGroupDocument>;
+export type StorageFileGroupUpdateAction<P extends object> = FirebaseFunctionUpdateAction<P, StorageFileGroupDocument>;
+export type AsyncStorageFileGroupUpdateAction<P extends object> = AsyncFirebaseFunctionUpdateAction<P, StorageFileGroupDocument>;
+export type StorageFileGroupDeleteAction<P extends object> = FirebaseFunctionDeleteAction<P, StorageFileGroupDocument>;
+export type AsyncStorageFileGroupDeleteAction<P extends object> = AsyncFirebaseFunctionDeleteAction<P, StorageFileGroupDocument>;

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

@@ -1,8 +1,10 @@
-import { TargetModelParams, OnCallCreateModelResult } from '../../common';
+import { TargetModelParams, OnCallCreateModelResult, FirestoreModelKey } from '../../common';
 import { type ModelFirebaseCrudFunction, type FirebaseFunctionTypeConfigMap, type ModelFirebaseCrudFunctionConfigMap, type ModelFirebaseFunctionMap, ModelFirebaseCreateFunction } from '../../client';
 import { StorageFileSignedDownloadUrl, StorageFileTypes } from './storagefile';
 import { type StorageBucketId, type StoragePath, type StorageSlashPath } from '../../common/storage';
-import { ContentDispositionString, ContentTypeMimeType, Maybe, Milliseconds } from '@dereekb/util';
+import { ContentDispositionString, ContentTypeMimeType, Maybe, Milliseconds, UnixDateTimeSecondsNumber } from '@dereekb/util';
+import { StorageFileId } from './storagefile.id';
+import { SendNotificationResult } from '../notification/notification.api';
 /**
  * Used for directly create a new StorageFile.
  */
@@ -52,13 +54,25 @@ export declare class ProcessStorageFileParams extends TargetModelParams {
      */
     checkRetryProcessing?: Maybe<boolean>;
     /**
-     * Used with retryProcessing.
+     * Used with checkRetryProcessing.
      *
-     * If set, will forcibly create a new processing task even if the existing processing task appears to be ok.
+     * If set, will forcibly create a new processing task even if the existing processing task appears to be ok, or if processing was already marked complete.
      */
     forceRestartProcessing?: Maybe<boolean>;
+    /**
+     * If set, will start the processing again if the StorageFile is in a successful processing state.
+     */
+    processAgainIfSuccessful?: Maybe<boolean>;
 }
 export interface ProcessStorageFileResult {
+    /**
+     * Whether or not the StorageFile was run immediately.
+     */
+    readonly runImmediately: boolean;
+    /**
+     * The expedite result, if runImmediately returned true.
+     */
+    readonly expediteResult: Maybe<SendNotificationResult>;
 }
 /**
  * Processes all StorageFiles that are queued for processing.
@@ -136,11 +150,116 @@ export declare class DownloadStorageFileParams extends TargetModelParams {
      */
     asAdmin?: Maybe<boolean>;
 }
+/**
+ * Result of downloading a StorageFile.
+ */
 export interface DownloadStorageFileResult {
     /**
      * The download URL.
      */
     readonly url: StorageFileSignedDownloadUrl;
+    /**
+     * The name of the StorageFile, if available.
+     */
+    readonly fileName?: Maybe<string>;
+    /**
+     * The mime type of the StorageFile, if available.
+     */
+    readonly mimeType?: Maybe<ContentTypeMimeType>;
+    /**
+     * Expiration time as a UnixDateTimeSecondsNumber value.
+     */
+    readonly expiresAt?: Maybe<UnixDateTimeSecondsNumber>;
+}
+/**
+ * Used for creating or initializing a new StorageFileGroup for a StorageFile.
+ *
+ * Mainly used for testing. Not exposed to the API.
+ *
+ * The preferred way is to create a StorageFileGroup through a StorageFile.
+ */
+export declare class CreateStorageFileGroupParams {
+    /**
+     * ModelKey to use for creating the StorageFileGroup.
+     */
+    model?: Maybe<FirestoreModelKey>;
+    /**
+     * StorageFileId to use for creating the StorageFileGroup.
+     */
+    storageFileId?: Maybe<StorageFileId>;
+}
+export declare class SyncStorageFileWithGroupsParams extends TargetModelParams {
+    /**
+     * If true, will force syncing even if the StorageFile is not flagged for a resync.
+     */
+    force?: boolean;
+}
+export interface SyncStorageFileWithGroupsResult {
+    /**
+     * The number of StorageFileGroups that were created.
+     */
+    readonly storageFilesGroupsCreated: number;
+    /**
+     * The number of StorageFileGroups that were updated.
+     */
+    readonly storageFilesGroupsUpdated: number;
+}
+export declare class SyncAllFlaggedStorageFilesWithGroupsParams {
+}
+export interface SyncAllFlaggedStorageFilesWithGroupsResult {
+    /**
+     * The total number of StorageFiles that were synced.
+     */
+    readonly storageFilesSynced: number;
+    /**
+     * The total number of StorageFileGroups that were created.
+     */
+    readonly storageFilesGroupsCreated: number;
+    /**
+     * The total number of StorageFileGroups that were updated.
+     */
+    readonly storageFilesGroupsUpdated: number;
+}
+export declare class RegenerateStorageFileGroupContentParams extends TargetModelParams {
+    /**
+     * If true, will force syncing even if the StorageFile is not flagged for a resync.
+     */
+    force?: boolean;
+}
+export interface RegenerateStorageFileGroupContentResult {
+    /**
+     * The total number of "content" StorageFiles that were flagged for processing again.
+     */
+    readonly contentStorageFilesFlaggedForProcessing: number;
+}
+export declare class RegenerateAllFlaggedStorageFileGroupsContentParams {
+}
+export interface RegenerateAllFlaggedStorageFileGroupsContentResult {
+    /**
+     * The number of StorageFileGroups that were updated.
+     */
+    readonly storageFileGroupsUpdated: number;
+    /**
+     * The number of "content" StorageFiles that were flagged for processing again.
+     */
+    readonly contentStorageFilesFlaggedForProcessing: number;
+}
+/**
+ * Used for initializing an uninitialized model like NotificationBox or NotificationSummary.
+ */
+export declare class InitializeStorageFileModelParams extends TargetModelParams {
+    /**
+     * Whether or not to throw an error if the notification has already been sent or is being sent.
+     */
+    throwErrorIfAlreadyInitialized?: boolean;
+}
+export declare class InitializeAllApplicableStorageFileGroupsParams {
+}
+export interface InitializeAllApplicableStorageFileGroupsResult {
+    readonly storageFileGroupsVisited: number;
+    readonly storageFileGroupsSucceeded: number;
+    readonly storageFileGroupsFailed: number;
+    readonly storageFileGroupsAlreadyInitialized: number;
 }
 export type StorageFileFunctionTypeMap = {};
 export declare const storageFileFunctionTypeConfigMap: FirebaseFunctionTypeConfigMap<StorageFileFunctionTypeMap>;
@@ -154,6 +273,7 @@ export type StorageFileModelCrudFunctionsConfig = {
         update: {
             _: UpdateStorageFileParams;
             process: [ProcessStorageFileParams, ProcessStorageFileResult];
+            syncWithGroups: [SyncStorageFileWithGroupsParams, SyncStorageFileWithGroupsResult];
         };
         read: {
             download: [DownloadStorageFileParams, DownloadStorageFileResult];
@@ -162,6 +282,11 @@ export type StorageFileModelCrudFunctionsConfig = {
             _: DeleteStorageFileParams;
         };
     };
+    storageFileGroup: {
+        update: {
+            regenerateContent: [RegenerateStorageFileGroupContentParams, RegenerateStorageFileGroupContentResult];
+        };
+    };
 };
 export declare const storageFileModelCrudFunctionsConfig: ModelFirebaseCrudFunctionConfigMap<StorageFileModelCrudFunctionsConfig, StorageFileTypes>;
 export declare abstract class StorageFileFunctions implements ModelFirebaseFunctionMap<StorageFileFunctionTypeMap, StorageFileModelCrudFunctionsConfig> {
@@ -174,6 +299,7 @@ export declare abstract class StorageFileFunctions implements ModelFirebaseFunct
         updateStorageFile: {
             update: ModelFirebaseCrudFunction<UpdateStorageFileParams>;
             process: ModelFirebaseCrudFunction<ProcessStorageFileParams, ProcessStorageFileResult>;
+            syncWithGroups: ModelFirebaseCrudFunction<SyncStorageFileWithGroupsParams, SyncStorageFileWithGroupsResult>;
         };
         readStorageFile: {
             download: ModelFirebaseCrudFunction<DownloadStorageFileParams, DownloadStorageFileResult>;
@@ -182,5 +308,10 @@ export declare abstract class StorageFileFunctions implements ModelFirebaseFunct
             delete: ModelFirebaseCrudFunction<DeleteStorageFileParams>;
         };
     };
+    abstract storageFileGroup: {
+        updateStorageFileGroup: {
+            regenerateContent: ModelFirebaseCrudFunction<RegenerateStorageFileGroupContentParams, RegenerateStorageFileGroupContentResult>;
+        };
+    };
 }
 export declare const storageFileFunctionMap: import("../../client").ModelFirebaseFunctionMapFactory<StorageFileFunctionTypeMap, StorageFileModelCrudFunctionsConfig>;

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

@@ -49,3 +49,19 @@ export declare const STORAGE_FILE_NOT_FLAGGED_FOR_DELETION_ERROR_CODE = "STORAGE
  * Thrown if the target StorageFileDocument is flagged for deletion, but has not reached the time to be deleted yet.
  */
 export declare const STORAGE_FILE_CANNOT_BE_DELETED_YET_ERROR_CODE = "STORAGE_FILE_CANNOT_BE_DELETED_YET";
+/**
+ * Thrown if the target InitializedStorageFileModel has already been initialized.
+ */
+export declare const STORAGE_FILE_MODEL_ALREADY_INITIALIZED_ERROR_CODE = "STORAGE_FILE_MODEL_ALREADY_INITIALIZED";
+/**
+ * Thrown if the target StorageFileDocument is attempted to be synced with groups, but is not flagged for groups sync.
+ */
+export declare const STORAGE_FILE_NOT_FLAGGED_FOR_GROUPS_SYNC_ERROR_CODE = "STORAGE_FILE_NOT_FLAGGED_FOR_GROUPS_SYNC";
+/**
+ * Thrown if the target StorageFileGroupDocument is queued for initialization and the current function is not yet allowed.
+ */
+export declare const STORAGE_FILE_GROUP_QUEUED_FOR_INITIALIZATION_ERROR_CODE = "STORAGE_FILE_GROUP_QUEUED_FOR_INITIALIZATION";
+/**
+ * Thrown if both the target model and storageFileId is not provided in CreateStorageFileGroupParams.
+ */
+export declare const STORAGE_FILE_GROUP_CREATE_INPUT_ERROR_CODE = "STORAGE_FILE_GROUP_CREATE_INPUT_ERROR";

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

@@ -1,11 +1,12 @@
 import { type Maybe } from '@dereekb/util';
-import { StorageFileCreationType, type StorageFile, type StorageFileDocument, type StorageFileFirestoreCollections } from './storagefile';
+import { StorageFileCreationType, type StorageFileGroup, type StorageFile, type StorageFileDocument, type StorageFileFirestoreCollections } from './storagefile';
 import { type Transaction } from '../../common/firestore/types';
 import { type FirestoreDocumentAccessor } from '../../common/firestore/accessor/document';
 import { type FirebaseStorageAccessorFile } from '../../common/storage/driver/accessor';
 import { type StoragePathRef, type StoragePath } from '../../common/storage/storage';
 import { type FirebaseAuthOwnershipKey, type FirebaseAuthUserId } from '../../common/auth/auth';
-import { type StorageFileMetadata, type StorageFilePurpose } from './storagefile.id';
+import { type StorageFileGroupId, type StorageFileGroupRelatedStorageFilePurpose, type StorageFileMetadata, type StorageFilePurpose } from './storagefile.id';
+import { type ReadFirestoreModelKeyInput } from '../../common';
 export interface CreateStorageFileDocumentPairInput<M extends StorageFileMetadata = StorageFileMetadata> {
     /**
      * Optional "now" value that is assigned to the "cat" value, created at time.
@@ -43,6 +44,20 @@ export interface CreateStorageFileDocumentPairInput<M extends StorageFileMetadat
      * Corresponds with the "uby" value in the StorageFile template.
      */
     readonly uploadedBy?: Maybe<FirebaseAuthUserId>;
+    /**
+     * The group ids of the file.
+     *
+     * Corresponds with the "g" value in the StorageFile template.
+     */
+    readonly storageFileGroupIds?: Maybe<StorageFileGroupId[]>;
+    /**
+     * If true, will flag the file for group sync.
+     *
+     * Defaults to true if one or more values in "storageFileGroupIds" are provided.
+     *
+     * Ignored if the "storageFileGroupIds" value is empty.
+     */
+    readonly flagForStorageFileGroupsSync?: boolean;
     /**
      * The ownership key of the file.
      *
@@ -54,7 +69,13 @@ export interface CreateStorageFileDocumentPairInput<M extends StorageFileMetadat
      *
      * Corresponds with the "p" value in the StorageFile template.
      */
-    readonly purpose?: Maybe<StorageFilePurpose>;
+    readonly purpose?: Maybe<StorageFilePurpose | StorageFileGroupRelatedStorageFilePurpose>;
+    /**
+     * The StorageFileGroup that the file is associated with.
+     *
+     * This is ONLY used if the creation type is StorageFileCreationType.FOR_STORAGE_FILE_GROUP.
+     */
+    readonly parentStorageFileGroup?: Maybe<ReadFirestoreModelKeyInput<StorageFileGroup>>;
     /**
      * The metadata of the file.
      *