@dereekb/firebase 12.5.10 → 12.6.0

package/index.cjs.js

@@ -3235,8 +3235,8 @@ function firestoreDate(config = {}) {
   return firestoreField({
     default: config.default ?? (() => new Date()),
     defaultBeforeSave: config.defaultBeforeSave ?? (config.saveDefaultAsNow ? date.formatToISO8601DateString : null),
-    fromData: input => date.toJsDate(input),
-    toData: input => date.toISODateString(input)
+    fromData: date.toJsDate,
+    toData: date.toISODateString
   });
 }
 /**
@@ -3257,12 +3257,78 @@ function optionalFirestoreDate(config) {
   return optionalFirestoreField({
     ...config,
     dontStoreValueIf,
-    transformFromData: input => {
-      return date.toJsDate(input);
-    },
-    transformToData: input => {
-      return date.toISODateString(input);
-    }
+    transformFromData: date.toJsDate,
+    transformToData: date.toISODateString
+  });
+}
+/**
+ * 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
+ */
+function firestoreDateNumber(config) {
+  const {
+    fromDate,
+    toDate
+  } = config;
+  return firestoreField({
+    default: config.default ?? (() => new Date()),
+    defaultBeforeSave: config.defaultBeforeSave ?? (config.saveDefaultAsNow ? fromDate(new Date()) : null),
+    fromData: toDate,
+    toData: fromDate
+  });
+}
+/**
+ * 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
+ */
+function optionalFirestoreDateNumber(config) {
+  const {
+    fromDate,
+    toDate,
+    dontStoreValueIf: inputDontStoreValueIf
+  } = config;
+  let dontStoreValueIf = inputDontStoreValueIf;
+  if (dontStoreValueIf != null && util.isDate(dontStoreValueIf)) {
+    const comparisonDate = dontStoreValueIf;
+    dontStoreValueIf = x => date.isSameDate(x, comparisonDate);
+  }
+  return optionalFirestoreField({
+    ...config,
+    dontStoreValueIf,
+    transformFromData: toDate,
+    transformToData: fromDate
+  });
+}
+/**
+ * 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
+ */
+function firestoreUnixDateTimeSecondsNumber(config) {
+  return firestoreDateNumber({
+    ...config,
+    fromDate: util.unixDateTimeSecondsNumberFromDate,
+    toDate: util.dateFromDateOrTimeSecondsNumber
+  });
+}
+/**
+ * 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
+ */
+function optionalFirestoreUnixDateTimeSecondsNumber(config) {
+  return optionalFirestoreDateNumber({
+    ...config,
+    fromDate: util.unixDateTimeSecondsNumberFromDate,
+    toDate: util.dateFromDateOrTimeSecondsNumber
   });
 }
 /**
@@ -6111,6 +6177,12 @@ function firestoreModelKeyPart(identity, id) {
  * @returns
  */
 const firestoreModelKey = firestoreModelKeyPart;
+/**
+ * Creates a FirestoreModelKeyFactory for the input root identity.
+ */
+function firestoreModelKeyFactory(identity) {
+  return id => firestoreModelKey(identity, id);
+}
 /**
  * Creates an array of FirestoreCollectionModelKey values from the input ids.
  *
@@ -8923,6 +8995,9 @@ const notificationSummaryConverter = snapshotConverterFunctions({
     rat: optionalFirestoreDate(),
     s: optionalFirestoreBoolean({
       dontStoreIf: false
+    }),
+    fi: optionalFirestoreBoolean({
+      dontStoreIf: false
     })
   }
 });
@@ -10154,6 +10229,7 @@ function notificationUserHasExclusionQuery(exclusionId) {
 function notificationSummariesFlaggedForNeedsInitializationQuery() {
   return [where('s', '==', true)];
 }
+// TODO: Also grab summaries that are flagged as invalid and use to delete/cleanup as needed.
 // MARK: NotificationBox
 /**
  * Query for notificationBoxes that are flagged for initialization.
@@ -10279,10 +10355,21 @@ const DEFAULT_NOTIFICATION_TASK_SUBTASK_CLEANUP_RETRY_ATTEMPTS = 4;
 const DEFAULT_NOTIFICATION_TASK_SUBTASK_CLEANUP_RETRY_DELAY = util.MS_IN_HOUR;
 /**
  * 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.
  */
 function completeSubtaskProcessingAndScheduleCleanupTaskResult() {
   return notificationTaskPartiallyComplete(['processing']);
 }
+/**
+ * Similar to notificationTaskComplete, but is customized for a subtask with the intent of running the cleanup checkpoint.
+ */
+function notificationSubtaskComplete(options) {
+  return {
+    ...notificationTaskComplete(options?.updateMetadata),
+    canRunNextCheckpoint: options?.canRunNextCheckpoint
+  };
+}
 
 var $ = _export;
 var iterate = iterate$2;
@@ -10582,6 +10669,22 @@ const STORAGE_FILE_NOT_FLAGGED_FOR_DELETION_ERROR_CODE = 'STORAGE_FILE_NOT_FLAGG
  * Thrown if the target StorageFileDocument is flagged for deletion, but has not reached the time to be deleted yet.
  */
 const STORAGE_FILE_CANNOT_BE_DELETED_YET_ERROR_CODE = 'STORAGE_FILE_CANNOT_BE_DELETED_YET';
+/**
+ * Thrown if the target InitializedStorageFileModel has already been initialized.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+const STORAGE_FILE_GROUP_CREATE_INPUT_ERROR_CODE = 'STORAGE_FILE_GROUP_CREATE_INPUT_ERROR';
 
 /**
  * Used for directly create a new StorageFile.
@@ -10637,16 +10740,21 @@ class ProcessStorageFileParams extends TargetModelParams {
      */
     this.checkRetryProcessing = void 0;
     /**
-     * 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.
      */
     this.forceRestartProcessing = void 0;
+    /**
+     * If set, will start the processing again if the StorageFile is in a successful processing state.
+     */
+    this.processAgainIfSuccessful = void 0;
   }
 }
 __decorate([classTransformer.Expose(), classValidator.IsBoolean(), classValidator.IsOptional(), __metadata("design:type", Object)], ProcessStorageFileParams.prototype, "runImmediately", void 0);
 __decorate([classTransformer.Expose(), classValidator.IsBoolean(), classValidator.IsOptional(), __metadata("design:type", Object)], ProcessStorageFileParams.prototype, "checkRetryProcessing", void 0);
 __decorate([classTransformer.Expose(), classValidator.IsBoolean(), classValidator.IsOptional(), __metadata("design:type", Object)], ProcessStorageFileParams.prototype, "forceRestartProcessing", void 0);
+__decorate([classTransformer.Expose(), classValidator.IsBoolean(), classValidator.IsOptional(), __metadata("design:type", Object)], ProcessStorageFileParams.prototype, "processAgainIfSuccessful", void 0);
 /**
  * Processes all StorageFiles that are queued for processing.
  */
@@ -10709,16 +10817,98 @@ __decorate([classTransformer.Expose(), classValidator.Min(0), classValidator.IsN
 __decorate([classTransformer.Expose(), classValidator.IsOptional(), classValidator.IsString(), __metadata("design:type", Object)], DownloadStorageFileParams.prototype, "responseDisposition", void 0);
 __decorate([classTransformer.Expose(), classValidator.IsOptional(), classValidator.IsString(), classValidator.IsMimeType(), __metadata("design:type", Object)], DownloadStorageFileParams.prototype, "responseContentType", void 0);
 __decorate([classTransformer.Expose(), classValidator.IsBoolean(), classValidator.IsOptional(), __metadata("design:type", Object)], DownloadStorageFileParams.prototype, "asAdmin", void 0);
+/**
+ * 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.
+ */
+class CreateStorageFileGroupParams {
+  constructor() {
+    /**
+     * ModelKey to use for creating the StorageFileGroup.
+     */
+    this.model = void 0;
+    /**
+     * StorageFileId to use for creating the StorageFileGroup.
+     */
+    this.storageFileId = void 0;
+  }
+}
+__decorate([classTransformer.Expose(), classValidator.IsOptional(), classValidator.IsNotEmpty(), IsFirestoreModelKey(), __metadata("design:type", Object)], CreateStorageFileGroupParams.prototype, "model", void 0);
+__decorate([classTransformer.Expose(), classValidator.IsNotEmpty(), IsFirestoreModelId(), __metadata("design:type", Object)], CreateStorageFileGroupParams.prototype, "storageFileId", void 0);
+class SyncStorageFileWithGroupsParams extends TargetModelParams {
+  constructor(...args) {
+    super(...args);
+    /**
+     * If true, will force syncing even if the StorageFile is not flagged for a resync.
+     */
+    this.force = void 0;
+  }
+}
+__decorate([classTransformer.Expose(), classValidator.IsBoolean(), classValidator.IsOptional(), __metadata("design:type", Boolean)], SyncStorageFileWithGroupsParams.prototype, "force", void 0);
+class SyncAllFlaggedStorageFilesWithGroupsParams {}
+class RegenerateStorageFileGroupContentParams extends TargetModelParams {
+  constructor(...args) {
+    super(...args);
+    /**
+     * If true, will force syncing even if the StorageFile is not flagged for a resync.
+     */
+    this.force = void 0;
+  }
+}
+__decorate([classTransformer.Expose(), classValidator.IsBoolean(), classValidator.IsOptional(), __metadata("design:type", Boolean)], RegenerateStorageFileGroupContentParams.prototype, "force", void 0);
+class RegenerateAllFlaggedStorageFileGroupsContentParams {}
+/**
+ * Used for initializing an uninitialized model like NotificationBox or NotificationSummary.
+ */
+class InitializeStorageFileModelParams extends TargetModelParams {
+  constructor(...args) {
+    super(...args);
+    /**
+     * Whether or not to throw an error if the notification has already been sent or is being sent.
+     */
+    this.throwErrorIfAlreadyInitialized = void 0;
+  }
+}
+__decorate([classTransformer.Expose(), classValidator.IsBoolean(), classValidator.IsOptional(), __metadata("design:type", Boolean)], InitializeStorageFileModelParams.prototype, "throwErrorIfAlreadyInitialized", void 0);
+class InitializeAllApplicableStorageFileGroupsParams {}
 const storageFileFunctionTypeConfigMap = {};
 const storageFileModelCrudFunctionsConfig = {
-  storageFile: ['create:_,fromUpload,allFromUpload', 'update:_,process', 'delete:_', 'read:download']
+  storageFile: ['create:_,fromUpload,allFromUpload', 'update:_,process,syncWithGroups', 'delete:_', 'read:download'],
+  storageFileGroup: ['update:regenerateContent']
 };
 class StorageFileFunctions {}
 const storageFileFunctionMap = callModelFirebaseFunctionMapFactory(storageFileFunctionTypeConfigMap, storageFileModelCrudFunctionsConfig);
 
+/**
+ * Creates a StorgaeFileGroupId from the input FirestoreModelKey.
+ *
+ * @param modelKey
+ * @returns
+ */
+const storageFileGroupIdForModel = twoWayFlatFirestoreModelKey;
+const inferStorageFileGroupRelatedModelKey = inferKeyFromTwoWayFlatFirestoreModelKey;
+
 class StorageFileFirestoreCollections {}
 // MARK: StorageFile
 const storageFileIdentity = firestoreModelIdentity('storageFile', 'sf');
+/**
+ * Creates a StorageFileGroupCreatedStorageFileKey from the input StorageFileGroupId and purpose.
+ */
+function storageFileGroupCreatedStorageFileKey(purpose, storageFileGroupId) {
+  return firestoreModelKey(storageFileIdentity, `${purpose}_${storageFileGroupId}`);
+}
+/**
+ * Creates a factory function for generating StorageFileGroupCreatedStorageFileKey values using the input purpose.
+ *
+ * @param purpose The purpose of the StorageFileGroupCreatedStorageFileKey.
+ * @returns A factory function that takes a StorageFileGroupId and returns a StorageFileGroupCreatedStorageFileKey.
+ */
+function storageFileGroupCreateStorageFileKeyFactory(purpose) {
+  return storageFileGroupId => storageFileGroupCreatedStorageFileKey(purpose, storageFileGroupId);
+}
 /**
  * This key is used in the CustomStorageMetadata of a Firebase Storage file that is associated with a StorageFile to link the file to the StorageFile.
  */
@@ -10740,6 +10930,13 @@ exports.StorageFileCreationType = void 0;
    * The StorageFile was initialized from an uploaded file.
    */
   StorageFileCreationType[StorageFileCreationType["INIT_FROM_UPLOAD"] = 2] = "INIT_FROM_UPLOAD";
+  /**
+   * This StorageFile was created by/for a StorageFileGroup.
+   *
+   * When creating a StorageFile via createStorageFileDocumentPairFactory(), this flag changes the behavior to use a parent
+   * StorageFileGroup to derive the created StorageFile's identifier.
+   */
+  StorageFileCreationType[StorageFileCreationType["FOR_STORAGE_FILE_GROUP"] = 3] = "FOR_STORAGE_FILE_GROUP";
 })(exports.StorageFileCreationType || (exports.StorageFileCreationType = {}));
 /**
  * The current file state.
@@ -10859,7 +11056,11 @@ const storageFileConverter = snapshotConverterFunctions({
     o: optionalFirestoreString(),
     p: optionalFirestoreString(),
     d: firestorePassThroughField(),
-    sdat: optionalFirestoreDate()
+    sdat: optionalFirestoreDate(),
+    g: firestoreUniqueStringArray(),
+    gs: optionalFirestoreBoolean({
+      dontStoreIf: false
+    })
   }
 });
 function storageFileCollectionReference(context) {
@@ -10874,6 +11075,65 @@ function storageFileFirestoreCollection(firestoreContext) {
     firestoreContext
   });
 }
+// MARK: StorageFileGroup
+const storageFileGroupIdentity = firestoreModelIdentity('storageFileGroup', 'sfg');
+const storageFileGroupEmbeddedFile = firestoreSubObject({
+  objectField: {
+    fields: {
+      s: firestoreModelIdString,
+      sat: firestoreUnixDateTimeSecondsNumber({
+        saveDefaultAsNow: true
+      }),
+      zat: optionalFirestoreUnixDateTimeSecondsNumber()
+    }
+  }
+});
+class StorageFileGroupDocument extends AbstractFirestoreDocument {
+  get modelIdentity() {
+    return storageFileGroupIdentity;
+  }
+  get storageFileGroupRelatedModelKey() {
+    return inferStorageFileGroupRelatedModelKey(this.id);
+  }
+}
+const storageFileGroupConverter = snapshotConverterFunctions({
+  fields: {
+    f: firestoreObjectArray({
+      objectField: storageFileGroupEmbeddedFile
+    }),
+    cat: firestoreDate(),
+    o: optionalFirestoreString(),
+    z: optionalFirestoreBoolean({
+      dontStoreIf: false
+    }),
+    zsf: optionalFirestoreString(),
+    zat: optionalFirestoreDate(),
+    s: optionalFirestoreBoolean({
+      dontStoreIf: false
+    }),
+    fi: optionalFirestoreBoolean({
+      dontStoreIf: false
+    }),
+    re: optionalFirestoreBoolean({
+      dontStoreIf: false
+    }),
+    c: optionalFirestoreBoolean({
+      dontStoreIf: false
+    })
+  }
+});
+function storageFileGroupCollectionReference(context) {
+  return context.collection(storageFileGroupIdentity.collectionName);
+}
+function storageFileGroupFirestoreCollection(firestoreContext) {
+  return firestoreContext.firestoreCollection({
+    modelIdentity: storageFileGroupIdentity,
+    converter: storageFileGroupConverter,
+    collection: storageFileGroupCollectionReference(firestoreContext),
+    makeDocument: (accessor, documentAccessor) => new StorageFileGroupDocument(accessor, documentAccessor),
+    firestoreContext
+  });
+}
 
 /**
  * Creates a CreateStorageFileDocumentPairFactory.
@@ -10899,7 +11159,10 @@ function createStorageFileDocumentPairFactory(config = {}) {
       user,
       purpose,
       metadata,
-      shouldBeProcessed
+      shouldBeProcessed,
+      parentStorageFileGroup,
+      storageFileGroupIds,
+      flagForStorageFileGroupsSync
     } = input;
     const now = inputNow ?? new Date();
     let accessor = inputAccessor;
@@ -10916,17 +11179,33 @@ function createStorageFileDocumentPairFactory(config = {}) {
     if (!storagePath) {
       throw new Error('createStorageFileDocumentPair() failed as neither a file, storagePathRef, or storagePath was provided.');
     }
-    const storageFileDocument = accessor.newDocument();
+    let storageFileDocument;
+    const p = purpose ?? inputTemplate?.p;
+    const ct = inputTemplate?.ct ?? defaultCreationType;
+    if (ct === exports.StorageFileCreationType.FOR_STORAGE_FILE_GROUP) {
+      if (!parentStorageFileGroup || !p) {
+        throw new Error('createStorageFileDocumentPair() failed as either the "parentStorageFileGroup" or "purpose" value was not provided with StorageFileCreationType.FOR_STORAGE_FILE_GROUP creation type.');
+      }
+      const storageFileGroupId = firestoreModelId(parentStorageFileGroup);
+      const storageFileKey = storageFileGroupCreatedStorageFileKey(p, storageFileGroupId);
+      storageFileDocument = accessor.loadDocumentForKey(storageFileKey);
+    } else {
+      storageFileDocument = accessor.newDocument();
+    }
+    const g = storageFileGroupIds ?? [];
+    const gs = g.length > 0 && flagForStorageFileGroupsSync !== false;
     const template = {
       ...inputTemplate,
+      g,
+      gs,
       cat: now,
       u: user ?? inputTemplate?.u,
       uby: uploadedBy ?? inputTemplate?.uby,
-      p: purpose ?? inputTemplate?.p,
+      p,
       d: metadata ?? inputTemplate?.d,
       fs: inputTemplate?.fs ?? exports.StorageFileState.OK,
       ps: shouldBeProcessed ?? defaultShouldBeProcessed ? exports.StorageFileProcessingState.QUEUED_FOR_PROCESSING : exports.StorageFileProcessingState.DO_NOT_PROCESS,
-      ct: inputTemplate?.ct ?? defaultCreationType,
+      ct,
       bucketId: storagePath.bucketId,
       pathString: storagePath.pathString
     };
@@ -10947,6 +11226,30 @@ async function createStorageFileDocumentPair(input) {
   return createStorageFileDocumentPairFactory()(input);
 }
 
+/**
+ * All StorageFileGroup generated files are stored under this root folder.
+ */
+const STORAGE_FILE_GROUP_ROOT_FOLDER_PATH = '/sfg/';
+function storageFileGroupFolderPath(storageFileGroupId, ...subPath) {
+  return util.mergeSlashPaths([STORAGE_FILE_GROUP_ROOT_FOLDER_PATH, storageFileGroupId, '/', ...subPath]);
+}
+const STORAGE_FILE_GROUP_ZIP_FILE_PATH = 'z.zip';
+function storageFileGroupZipFileStoragePath(storageFileGroupId) {
+  return storageFileGroupFolderPath(storageFileGroupId, STORAGE_FILE_GROUP_ZIP_FILE_PATH);
+}
+
+// MARK: StorageFileGroup Zip StorageFile
+/**
+ * StorageFilePurpose for a StorageFileGroup's generated zip file.
+ */
+const STORAGE_FILE_GROUP_ZIP_STORAGE_FILE_PURPOSE = 'sfg_zip';
+/**
+ * Creates a StorageFileGroupZipStorageFileKey from the input StorageFileGroupId.
+ */
+const storageFileGroupZipStorageFileKey = storageFileGroupCreateStorageFileKeyFactory(STORAGE_FILE_GROUP_ZIP_STORAGE_FILE_PURPOSE);
+const STORAGE_FILE_GROUP_ZIP_STORAGE_FILE_PURPOSE_CREATE_ZIP_SUBTASK = 'create_zip';
+const STORAGE_FILE_GROUP_ZIP_INFO_JSON_FILE_NAME = 'info.json';
+
 // MARK: StorageFile
 /**
  * Returns a query constraint for StorageFiles that are queued for processing.
@@ -10963,6 +11266,37 @@ function storageFilesQueuedForDeleteQuery(now) {
 function storageFilePurposeAndUserQuery(input) {
   return [where('p', '==', input.purpose), where('u', '==', input.user)];
 }
+function storageFileFlaggedForSyncWithGroupsQuery() {
+  return [where('gs', '==', true)];
+}
+// MARK: StorageFileGroup
+/**
+ * Query for storageFileGroups that are flagged for initialization.
+ *
+ * @param now
+ * @returns
+ */
+function storageFileGroupsFlaggedForNeedsInitializationQuery() {
+  return [where('s', '==', true)];
+}
+/**
+ * Query for storageFileGroups that are flagged for content regeneration.
+ *
+ * @param now
+ * @returns
+ */
+function storageFileGroupsFlaggedForContentRegenerationQuery() {
+  return [where('re', '==', true)];
+}
+/**
+ * Query for storageFileGroups that are flagged as invalid.
+ *
+ * @param now
+ * @returns
+ */
+function storageFileGroupsFlaggedInvalidQuery() {
+  return [where('fi', '==', true)];
+}
 
 // MARK: Storage File Processing Notification
 const STORAGE_FILE_PROCESSING_NOTIFICATION_TASK_TYPE = 'SFP';
@@ -11366,6 +11700,98 @@ function combineUploadFileTypeDeterminers(config) {
   return result;
 }
 
+function loadStorageFileGroupDocumentForReferencePair(input, accessor) {
+  const {
+    storageFileGroupDocument: inputStorageFileGroupDocument,
+    storageFileGroupRelatedModelKey: inputStorageFileGroupRelatedModelKey
+  } = input;
+  let storageFileGroupDocument;
+  if (inputStorageFileGroupDocument != null) {
+    storageFileGroupDocument = inputStorageFileGroupDocument;
+  } else if (inputStorageFileGroupRelatedModelKey) {
+    const storageFileGroupId = storageFileGroupIdForModel(inputStorageFileGroupRelatedModelKey);
+    storageFileGroupDocument = accessor.loadDocumentForId(storageFileGroupId);
+  } else {
+    throw new Error('StorageFileGroupDocument or StorageFileGroupRelatedModelKey is required');
+  }
+  return storageFileGroupDocument;
+}
+function calculateStorageFileGroupEmbeddedFileUpdate(input) {
+  const {
+    storageFileGroup,
+    insert,
+    remove,
+    allowRecalculateRegenerateFlag
+  } = input;
+  const {
+    f: currentF,
+    re: currentRe,
+    z: currentZ,
+    zat: currentZat
+  } = storageFileGroup;
+  const removeSet = new Set(remove);
+  const mergeFunction = util.mergeObjectsFunction(util.KeyValueTypleValueFilter.UNDEFINED);
+  const fWithRemovedTargetsRemoved = currentF.filter(x => !removeSet.has(x.s));
+  const oneOrMoreItemsWereRemoved = fWithRemovedTargetsRemoved.length < currentF.length;
+  const f = util.ModelRelationUtility.insertCollection(fWithRemovedTargetsRemoved, insert ?? [], {
+    readKey: x => x.s,
+    readType: () => 'x',
+    merge: (a, b) => mergeFunction([a, b])
+  });
+  let re = currentRe || oneOrMoreItemsWereRemoved; // flag removed if any items were removed
+  // recalculate re if it is false or the retain flag is false
+  if (!re || allowRecalculateRegenerateFlag) {
+    const {
+      flagRegenerate
+    } = calculateStorageFileGroupRegeneration({
+      storageFileGroup: {
+        f,
+        z: currentZ,
+        zat: currentZat
+      }
+    });
+    re = flagRegenerate;
+  }
+  return {
+    f,
+    re
+  };
+}
+/**
+ * Calculates the regeneration flags for a StorageFileGroup.
+ *
+ * @param input CalculateStorageFileGroupRegenerationInput
+ * @returns CalculateStorageFileGroupRegenerationResult
+ */
+function calculateStorageFileGroupRegeneration(input) {
+  const {
+    storageFileGroup,
+    force
+  } = input;
+  const {
+    f,
+    z,
+    zat
+  } = storageFileGroup;
+  let regenerateZip = undefined;
+  // check regeneration of zip file should be flagged
+  if (z) {
+    if (force) {
+      regenerateZip = true;
+    } else if (zat) {
+      // check that each of the entries have a zat value. If not set, then they've never been added to the archive
+      regenerateZip = f.some(x => !x.zat);
+    } else {
+      regenerateZip = f.length > 0; // if never generated, and there are files, regenerate it
+    }
+  }
+  const re = regenerateZip ?? false;
+  return {
+    flagRegenerate: re,
+    regenerateZip
+  };
+}
+
 // MARK: Collection
 class SystemStateFirestoreCollections {}
 // MARK: Mock Item
@@ -11427,6 +11853,7 @@ exports.ContextGrantedModelRolesReaderInstance = ContextGrantedModelRolesReaderI
 exports.CreateNotificationBoxParams = CreateNotificationBoxParams;
 exports.CreateNotificationSummaryParams = CreateNotificationSummaryParams;
 exports.CreateNotificationUserParams = CreateNotificationUserParams;
+exports.CreateStorageFileGroupParams = CreateStorageFileGroupParams;
 exports.CreateStorageFileParams = CreateStorageFileParams;
 exports.DBX_FIREBASE_SERVER_NO_AUTH_ERROR_CODE = DBX_FIREBASE_SERVER_NO_AUTH_ERROR_CODE;
 exports.DBX_FIREBASE_SERVER_NO_UID_ERROR_CODE = DBX_FIREBASE_SERVER_NO_UID_ERROR_CODE;
@@ -11493,9 +11920,11 @@ exports.InferredTargetModelIdParams = InferredTargetModelIdParams;
 exports.InferredTargetModelParams = InferredTargetModelParams;
 exports.InitializeAllApplicableNotificationBoxesParams = InitializeAllApplicableNotificationBoxesParams;
 exports.InitializeAllApplicableNotificationSummariesParams = InitializeAllApplicableNotificationSummariesParams;
+exports.InitializeAllApplicableStorageFileGroupsParams = InitializeAllApplicableStorageFileGroupsParams;
 exports.InitializeAllStorageFilesFromUploadsParams = InitializeAllStorageFilesFromUploadsParams;
 exports.InitializeNotificationModelParams = InitializeNotificationModelParams;
 exports.InitializeStorageFileFromUploadParams = InitializeStorageFileFromUploadParams;
+exports.InitializeStorageFileModelParams = InitializeStorageFileModelParams;
 exports.IsFirestoreModelId = IsFirestoreModelId;
 exports.IsFirestoreModelIdOrKey = IsFirestoreModelIdOrKey;
 exports.IsFirestoreModelKey = IsFirestoreModelKey;
@@ -11538,13 +11967,24 @@ exports.NotificationWeekDocument = NotificationWeekDocument;
 exports.ProcessAllQueuedStorageFilesParams = ProcessAllQueuedStorageFilesParams;
 exports.ProcessStorageFileParams = ProcessStorageFileParams;
 exports.RUN_DEV_FUNCTION_APP_FUNCTION_KEY = RUN_DEV_FUNCTION_APP_FUNCTION_KEY;
+exports.RegenerateAllFlaggedStorageFileGroupsContentParams = RegenerateAllFlaggedStorageFileGroupsContentParams;
+exports.RegenerateStorageFileGroupContentParams = RegenerateStorageFileGroupContentParams;
 exports.ResyncAllNotificationUserParams = ResyncAllNotificationUserParams;
 exports.ResyncNotificationUserParams = ResyncNotificationUserParams;
 exports.SCHEDULED_FUNCTION_DEV_FUNCTION_SPECIFIER = SCHEDULED_FUNCTION_DEV_FUNCTION_SPECIFIER;
 exports.STORAGEFILE_RELATED_FILE_METADATA_KEY = STORAGEFILE_RELATED_FILE_METADATA_KEY;
 exports.STORAGE_FILE_ALREADY_PROCESSED_ERROR_CODE = STORAGE_FILE_ALREADY_PROCESSED_ERROR_CODE;
 exports.STORAGE_FILE_CANNOT_BE_DELETED_YET_ERROR_CODE = STORAGE_FILE_CANNOT_BE_DELETED_YET_ERROR_CODE;
+exports.STORAGE_FILE_GROUP_CREATE_INPUT_ERROR_CODE = STORAGE_FILE_GROUP_CREATE_INPUT_ERROR_CODE;
+exports.STORAGE_FILE_GROUP_QUEUED_FOR_INITIALIZATION_ERROR_CODE = STORAGE_FILE_GROUP_QUEUED_FOR_INITIALIZATION_ERROR_CODE;
+exports.STORAGE_FILE_GROUP_ROOT_FOLDER_PATH = STORAGE_FILE_GROUP_ROOT_FOLDER_PATH;
+exports.STORAGE_FILE_GROUP_ZIP_FILE_PATH = STORAGE_FILE_GROUP_ZIP_FILE_PATH;
+exports.STORAGE_FILE_GROUP_ZIP_INFO_JSON_FILE_NAME = STORAGE_FILE_GROUP_ZIP_INFO_JSON_FILE_NAME;
+exports.STORAGE_FILE_GROUP_ZIP_STORAGE_FILE_PURPOSE = STORAGE_FILE_GROUP_ZIP_STORAGE_FILE_PURPOSE;
+exports.STORAGE_FILE_GROUP_ZIP_STORAGE_FILE_PURPOSE_CREATE_ZIP_SUBTASK = STORAGE_FILE_GROUP_ZIP_STORAGE_FILE_PURPOSE_CREATE_ZIP_SUBTASK;
+exports.STORAGE_FILE_MODEL_ALREADY_INITIALIZED_ERROR_CODE = STORAGE_FILE_MODEL_ALREADY_INITIALIZED_ERROR_CODE;
 exports.STORAGE_FILE_NOT_FLAGGED_FOR_DELETION_ERROR_CODE = STORAGE_FILE_NOT_FLAGGED_FOR_DELETION_ERROR_CODE;
+exports.STORAGE_FILE_NOT_FLAGGED_FOR_GROUPS_SYNC_ERROR_CODE = STORAGE_FILE_NOT_FLAGGED_FOR_GROUPS_SYNC_ERROR_CODE;
 exports.STORAGE_FILE_PROCESSING_NOTIFICATION_TASK_CHECKPOINT_CLEANUP = STORAGE_FILE_PROCESSING_NOTIFICATION_TASK_CHECKPOINT_CLEANUP;
 exports.STORAGE_FILE_PROCESSING_NOTIFICATION_TASK_CHECKPOINT_PROCESSING = STORAGE_FILE_PROCESSING_NOTIFICATION_TASK_CHECKPOINT_PROCESSING;
 exports.STORAGE_FILE_PROCESSING_NOTIFICATION_TASK_TYPE = STORAGE_FILE_PROCESSING_NOTIFICATION_TASK_TYPE;
@@ -11560,7 +12000,10 @@ exports.SendQueuedNotificationsParams = SendQueuedNotificationsParams;
 exports.StorageFileDocument = StorageFileDocument;
 exports.StorageFileFirestoreCollections = StorageFileFirestoreCollections;
 exports.StorageFileFunctions = StorageFileFunctions;
+exports.StorageFileGroupDocument = StorageFileGroupDocument;
 exports.StorageFileUploadStreamUnsupportedError = StorageFileUploadStreamUnsupportedError;
+exports.SyncAllFlaggedStorageFilesWithGroupsParams = SyncAllFlaggedStorageFilesWithGroupsParams;
+exports.SyncStorageFileWithGroupsParams = SyncStorageFileWithGroupsParams;
 exports.SystemStateDocument = SystemStateDocument;
 exports.SystemStateFirestoreCollections = SystemStateFirestoreCollections;
 exports.TargetModelIdParams = TargetModelIdParams;
@@ -11599,6 +12042,8 @@ exports.assignWebsiteFileLinkFunction = assignWebsiteFileLinkFunction;
 exports.assignWebsiteLinkFunction = assignWebsiteLinkFunction;
 exports.buildFirebaseCollectionTypeModelTypeMap = buildFirebaseCollectionTypeModelTypeMap;
 exports.calculateNsForNotificationUserNotificationBoxRecipientConfigs = calculateNsForNotificationUserNotificationBoxRecipientConfigs;
+exports.calculateStorageFileGroupEmbeddedFileUpdate = calculateStorageFileGroupEmbeddedFileUpdate;
+exports.calculateStorageFileGroupRegeneration = calculateStorageFileGroupRegeneration;
 exports.callModelFirebaseFunctionMapFactory = callModelFirebaseFunctionMapFactory;
 exports.canQueueStorageFileForProcessing = canQueueStorageFileForProcessing;
 exports.childFirestoreModelKey = childFirestoreModelKey;
@@ -11691,6 +12136,7 @@ exports.firestoreDateCellRangeArray = firestoreDateCellRangeArray;
 exports.firestoreDateCellRangeAssignFn = firestoreDateCellRangeAssignFn;
 exports.firestoreDateCellSchedule = firestoreDateCellSchedule;
 exports.firestoreDateCellScheduleAssignFn = firestoreDateCellScheduleAssignFn;
+exports.firestoreDateNumber = firestoreDateNumber;
 exports.firestoreDencoderArray = firestoreDencoderArray;
 exports.firestoreDencoderMap = firestoreDencoderMap;
 exports.firestoreDencoderStringArray = firestoreDencoderStringArray;
@@ -11735,6 +12181,7 @@ exports.firestoreModelKeyCollectionTypeArray = firestoreModelKeyCollectionTypeAr
 exports.firestoreModelKeyCollectionTypeArrayName = firestoreModelKeyCollectionTypeArrayName;
 exports.firestoreModelKeyCollectionTypePair = firestoreModelKeyCollectionTypePair;
 exports.firestoreModelKeyEncodedGrantedRoleMap = firestoreModelKeyEncodedGrantedRoleMap;
+exports.firestoreModelKeyFactory = firestoreModelKeyFactory;
 exports.firestoreModelKeyFromDocument = firestoreModelKeyFromDocument;
 exports.firestoreModelKeyGrantedRoleArrayMap = firestoreModelKeyGrantedRoleArrayMap;
 exports.firestoreModelKeyGrantedRoleMap = firestoreModelKeyGrantedRoleMap;
@@ -11775,6 +12222,7 @@ exports.firestoreUniqueNumberArray = firestoreUniqueNumberArray;
 exports.firestoreUniqueStringArray = firestoreUniqueStringArray;
 exports.firestoreUnitedStatesAddress = firestoreUnitedStatesAddress;
 exports.firestoreUnitedStatesAddressAssignFn = firestoreUnitedStatesAddressAssignFn;
+exports.firestoreUnixDateTimeSecondsNumber = firestoreUnixDateTimeSecondsNumber;
 exports.firestoreUpdateWithNoDataError = firestoreUpdateWithNoDataError;
 exports.firestoreWebsiteFileLink = firestoreWebsiteFileLink;
 exports.firestoreWebsiteFileLinkAssignFn = firestoreWebsiteFileLinkAssignFn;
@@ -11809,6 +12257,7 @@ exports.inContextFirebaseModelsServiceFactory = inContextFirebaseModelsServiceFa
 exports.incrementUpdateWithAccessorFunction = incrementUpdateWithAccessorFunction;
 exports.inferKeyFromTwoWayFlatFirestoreModelKey = inferKeyFromTwoWayFlatFirestoreModelKey;
 exports.inferNotificationBoxRelatedModelKey = inferNotificationBoxRelatedModelKey;
+exports.inferStorageFileGroupRelatedModelKey = inferStorageFileGroupRelatedModelKey;
 exports.interceptAccessorFactoryFunction = interceptAccessorFactoryFunction;
 exports.isAdminInFirebaseModelContext = isAdminInFirebaseModelContext;
 exports.isClientFirebaseError = isClientFirebaseError;
@@ -11846,6 +12295,7 @@ exports.loadDocumentsForKeysFromValues = loadDocumentsForKeysFromValues;
 exports.loadDocumentsForSnapshots = loadDocumentsForSnapshots;
 exports.loadDocumentsForValues = loadDocumentsForValues;
 exports.loadNotificationBoxDocumentForReferencePair = loadNotificationBoxDocumentForReferencePair;
+exports.loadStorageFileGroupDocumentForReferencePair = loadStorageFileGroupDocumentForReferencePair;
 exports.makeDocuments = makeDocuments;
 exports.makeFirestoreCollection = makeFirestoreCollection;
 exports.makeFirestoreCollectionGroup = makeFirestoreCollectionGroup;
@@ -11889,6 +12339,7 @@ exports.notificationIdentity = notificationIdentity;
 exports.notificationMessageFunction = notificationMessageFunction;
 exports.notificationSendExclusionCanSendFunction = notificationSendExclusionCanSendFunction;
 exports.notificationSendFlagsImplyIsComplete = notificationSendFlagsImplyIsComplete;
+exports.notificationSubtaskComplete = notificationSubtaskComplete;
 exports.notificationSummariesFlaggedForNeedsInitializationQuery = notificationSummariesFlaggedForNeedsInitializationQuery;
 exports.notificationSummaryCollectionReference = notificationSummaryCollectionReference;
 exports.notificationSummaryConverter = notificationSummaryConverter;
@@ -11931,12 +12382,14 @@ exports.onCallUpdateModelParams = onCallUpdateModelParams;
 exports.optionalFirestoreArray = optionalFirestoreArray;
 exports.optionalFirestoreBoolean = optionalFirestoreBoolean;
 exports.optionalFirestoreDate = optionalFirestoreDate;
+exports.optionalFirestoreDateNumber = optionalFirestoreDateNumber;
 exports.optionalFirestoreEnum = optionalFirestoreEnum;
 exports.optionalFirestoreField = optionalFirestoreField;
 exports.optionalFirestoreNumber = optionalFirestoreNumber;
 exports.optionalFirestoreString = optionalFirestoreString;
 exports.optionalFirestoreUID = optionalFirestoreUID;
 exports.optionalFirestoreUnitedStatesAddress = optionalFirestoreUnitedStatesAddress;
+exports.optionalFirestoreUnixDateTimeSecondsNumber = optionalFirestoreUnixDateTimeSecondsNumber;
 exports.orderBy = orderBy;
 exports.orderByDocumentId = orderByDocumentId;
 exports.readFirestoreModelKey = readFirestoreModelKey;
@@ -11958,8 +12411,23 @@ exports.startAtValue = startAtValue;
 exports.storageFileCollectionReference = storageFileCollectionReference;
 exports.storageFileConverter = storageFileConverter;
 exports.storageFileFirestoreCollection = storageFileFirestoreCollection;
+exports.storageFileFlaggedForSyncWithGroupsQuery = storageFileFlaggedForSyncWithGroupsQuery;
 exports.storageFileFunctionMap = storageFileFunctionMap;
 exports.storageFileFunctionTypeConfigMap = storageFileFunctionTypeConfigMap;
+exports.storageFileGroupCollectionReference = storageFileGroupCollectionReference;
+exports.storageFileGroupConverter = storageFileGroupConverter;
+exports.storageFileGroupCreateStorageFileKeyFactory = storageFileGroupCreateStorageFileKeyFactory;
+exports.storageFileGroupCreatedStorageFileKey = storageFileGroupCreatedStorageFileKey;
+exports.storageFileGroupEmbeddedFile = storageFileGroupEmbeddedFile;
+exports.storageFileGroupFirestoreCollection = storageFileGroupFirestoreCollection;
+exports.storageFileGroupFolderPath = storageFileGroupFolderPath;
+exports.storageFileGroupIdForModel = storageFileGroupIdForModel;
+exports.storageFileGroupIdentity = storageFileGroupIdentity;
+exports.storageFileGroupZipFileStoragePath = storageFileGroupZipFileStoragePath;
+exports.storageFileGroupZipStorageFileKey = storageFileGroupZipStorageFileKey;
+exports.storageFileGroupsFlaggedForContentRegenerationQuery = storageFileGroupsFlaggedForContentRegenerationQuery;
+exports.storageFileGroupsFlaggedForNeedsInitializationQuery = storageFileGroupsFlaggedForNeedsInitializationQuery;
+exports.storageFileGroupsFlaggedInvalidQuery = storageFileGroupsFlaggedInvalidQuery;
 exports.storageFileIdentity = storageFileIdentity;
 exports.storageFileModelCrudFunctionsConfig = storageFileModelCrudFunctionsConfig;
 exports.storageFileProcessingNotificationTaskTemplate = storageFileProcessingNotificationTaskTemplate;