@dereekb/firebase 13.11.14 → 13.11.16

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

@@ -68,9 +68,9 @@ export type StorageFileGroupCreatedStorageFileKey<P extends StorageFileGroupRela
 /**
  * Creates a StorageFileGroupCreatedStorageFileKey from the input StorageFileGroupId and purpose.
  *
- * @param purpose - the purpose identifying the type of file within the group
- * @param storageFileGroupId - the ID of the parent StorageFileGroup
- * @returns a deterministic FirestoreCollectionModelKey for the storage file
+ * @param purpose - The purpose identifying the type of file within the group.
+ * @param storageFileGroupId - The ID of the parent StorageFileGroup.
+ * @returns A deterministic FirestoreCollectionModelKey for the storage file.
  */
 export declare function storageFileGroupCreatedStorageFileKey<P extends StorageFileGroupRelatedStorageFilePurpose>(purpose: P, storageFileGroupId: StorageFileGroupId): StorageFileGroupCreatedStorageFileKey<P>;
 /**
@@ -80,8 +80,9 @@ export type StorageFileGroupCreateStorageFileKeyFactory<P extends StorageFileGro
 /**
  * Creates a factory function for generating StorageFileGroupCreatedStorageFileKey values using the input purpose.
  *
- * @param purpose The purpose of the StorageFileGroupCreatedStorageFileKey.
+ * @param purpose - The purpose of the StorageFileGroupCreatedStorageFileKey.
  * @returns A factory function that takes a StorageFileGroupId and returns a StorageFileGroupCreatedStorageFileKey.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function storageFileGroupCreateStorageFileKeyFactory<P extends StorageFileGroupRelatedStorageFilePurpose>(purpose: P): StorageFileGroupCreateStorageFileKeyFactory<P>;
@@ -214,8 +215,8 @@ export declare enum StorageFileProcessingState {
  * (INIT_OR_NONE, FAILED, or SUCCESS). Files that are already QUEUED/PROCESSING, ARCHIVED,
  * or DO_NOT_PROCESS are not eligible.
  *
- * @param storageFile - the file's processing state (`ps`) and purpose (`p`) fields
- * @returns true if the file can be queued for processing
+ * @param storageFile - The file's processing state (`ps`) and purpose (`p`) fields.
+ * @returns True if the file can be queued for processing.
  *
  * @example
  * ```ts
@@ -423,13 +424,13 @@ export declare const storageFileConverter: import("../..").SnapshotConverterFunc
 /**
  * Returns the raw Firestore CollectionReference for the StorageFile collection.
  *
+ * @param context - The Firestore context to use.
+ * @returns The CollectionReference for StorageFile documents.
+ *
  * @example
  * ```ts
  * const colRef = storageFileCollectionReference(firestoreContext);
  * ```
- *
- * @param context - the Firestore context to use
- * @returns the CollectionReference for StorageFile documents
  */
 export declare function storageFileCollectionReference(context: FirestoreContext): CollectionReference<StorageFile>;
 /**
@@ -439,14 +440,14 @@ export type StorageFileFirestoreCollection = FirestoreCollection<StorageFile, St
 /**
  * Creates a fully configured {@link StorageFileFirestoreCollection} with snapshot conversion and document factory.
  *
+ * @param firestoreContext - The Firestore context to use.
+ * @returns A configured StorageFileFirestoreCollection.
+ *
  * @example
  * ```ts
  * const collection = storageFileFirestoreCollection(firestoreContext);
  * const doc = collection.documentAccessor().newDocument();
  * ```
- *
- * @param firestoreContext - the Firestore context to use
- * @returns a configured StorageFileFirestoreCollection
  */
 export declare function storageFileFirestoreCollection(firestoreContext: FirestoreContext): StorageFileFirestoreCollection;
 /**
@@ -581,13 +582,13 @@ export declare const storageFileGroupConverter: import("../..").SnapshotConverte
 /**
  * Returns the raw Firestore CollectionReference for the StorageFileGroup collection.
  *
+ * @param context - The Firestore context to use.
+ * @returns The CollectionReference for StorageFileGroup documents.
+ *
  * @example
  * ```ts
  * const colRef = storageFileGroupCollectionReference(firestoreContext);
  * ```
- *
- * @param context - the Firestore context to use
- * @returns the CollectionReference for StorageFileGroup documents
  */
 export declare function storageFileGroupCollectionReference(context: FirestoreContext): CollectionReference<StorageFileGroup>;
 /**
@@ -597,13 +598,13 @@ export type StorageFileGroupFirestoreCollection = FirestoreCollection<StorageFil
 /**
  * Creates a fully configured {@link StorageFileGroupFirestoreCollection} with snapshot conversion and document factory.
  *
+ * @param firestoreContext - The Firestore context to use.
+ * @returns A configured StorageFileGroupFirestoreCollection.
+ *
  * @example
  * ```ts
  * const collection = storageFileGroupFirestoreCollection(firestoreContext);
  * const doc = collection.documentAccessor().loadDocumentForId(groupId);
  * ```
- *
- * @param firestoreContext - the Firestore context to use
- * @returns a configured StorageFileGroupFirestoreCollection
  */
 export declare function storageFileGroupFirestoreCollection(firestoreContext: FirestoreContext): StorageFileGroupFirestoreCollection;

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

@@ -60,7 +60,7 @@ export interface StoredFileReader {
  *
  * Should only be used server-side, as `copy` may not be available on the client.
  *
- * @returns a factory function that wraps FirebaseStorageAccessorFile instances into StoredFileReader accessors
+ * @returns A factory function that wraps FirebaseStorageAccessorFile instances into StoredFileReader accessors.
  *
  * @example
  * ```ts
@@ -68,6 +68,7 @@ export interface StoredFileReader {
  * const reader = factory(storageAccessorFile);
  * const bytes = await reader.loadFileBytes();
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function storedFileReaderFactory(): StoredFileReaderFactory;

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

@@ -9,9 +9,9 @@ export declare const STORAGE_FILE_GROUP_ROOT_FOLDER_PATH: SlashPathFolder;
 /**
  * Builds the storage folder path for a specific StorageFileGroup, optionally with sub-paths.
  *
- * @param storageFileGroupId - the group's document ID
- * @param subPath - optional sub-paths to append
- * @returns the folder path as a SlashPathFolder string
+ * @param storageFileGroupId - The group's document ID.
+ * @param subPath - Optional sub-paths to append.
+ * @returns The folder path as a SlashPathFolder string.
  *
  * @example
  * ```ts
@@ -30,8 +30,8 @@ export declare const STORAGE_FILE_GROUP_ZIP_FILE_PATH: SlashPathFile;
 /**
  * Returns the full storage path for a StorageFileGroup's zip file.
  *
- * @param storageFileGroupId - the group's document ID
- * @returns the full SlashPath to the group's zip archive
+ * @param storageFileGroupId - The group's document ID.
+ * @returns The full SlashPath to the group's zip archive.
  *
  * @example
  * ```ts

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

@@ -33,8 +33,8 @@ export type GrantStorageFileRolesForUserAuthFunction = (input: GrantStorageFileR
  *
  * Use this within a permission service to define role-based access for StorageFile operations.
  *
- * @param config - the permission output, auth context, and target document
- * @returns a function that accepts role configuration and returns a GrantRolesOtherwiseFunction
+ * @param config - Permission output, auth context, and target document for the grant.
+ * @returns Builder that takes role configuration and yields a GrantRolesOtherwiseFunction.
  *
  * @example
  * ```ts
@@ -44,6 +44,7 @@ export type GrantStorageFileRolesForUserAuthFunction = (input: GrantStorageFileR
  *   rolesForStorageFileOwnershipKey: (key) => ({ read: true })
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function grantStorageFileRolesForUserAuthFunction<T extends FirebaseModelContext>(config: GrantStorageFileRolesForUserAuthFunctionConfig<T>): GrantStorageFileRolesForUserAuthFunction;

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

@@ -7,13 +7,13 @@ import { type FirebaseAuthUserId } from '../../common/auth/auth';
  *
  * Used by the server action service to find files awaiting processing task creation.
  *
+ * @returns Firestore query constraints for StorageFiles queued for processing.
+ *
  * @example
  * ```ts
  * const constraints = storageFilesQueuedForProcessingQuery();
  * const results = await collection.query(constraints);
  * ```
- *
- * @returns Firestore query constraints for StorageFiles queued for processing
  */
 export declare function storageFilesQueuedForProcessingQuery(): FirestoreQueryConstraint[];
 /**
@@ -21,8 +21,8 @@ export declare function storageFilesQueuedForProcessingQuery(): FirestoreQueryCo
  *
  * Used by the cleanup service to find files ready for permanent deletion.
  *
- * @param now - reference time for comparison; defaults to current time
- * @returns Firestore query constraints for StorageFiles whose scheduled delete date has passed
+ * @param now - Reference time for comparison; defaults to current time.
+ * @returns Firestore query constraints for StorageFiles whose scheduled delete date has passed.
  *
  * @example
  * ```ts
@@ -45,11 +45,11 @@ export interface StorageFilePurposeAndUserQueryInput {
  * Returns query constraints for StorageFiles matching a specific purpose and user,
  * with optional subgroup filtering.
  *
- * @example
- * @param input - the user, purpose, and optional subgroup to filter by
- * @returns Firestore query constraints for the given purpose and user
+ * @param input - The user, purpose, and optional subgroup to filter by.
+ * @returns Firestore query constraints for the given purpose and user.
  *
  * @example
+ * @example
  * ```ts
  * const constraints = storageFilePurposeAndUserQuery({
  *   user: 'user123',
@@ -63,10 +63,10 @@ export declare function storageFilePurposeAndUserQuery(input: StorageFilePurpose
  *
  * Used by the sync service to find files whose group memberships need to be propagated.
  *
- * @example
- * @returns Firestore query constraints for StorageFiles flagged for group synchronization
+ * @returns Firestore query constraints for StorageFiles flagged for group synchronization.
  *
  * @example
+ * @example
  * ```ts
  * const constraints = storageFileFlaggedForSyncWithGroupsQuery();
  * ```
@@ -77,10 +77,10 @@ export declare function storageFileFlaggedForSyncWithGroupsQuery(): FirestoreQue
  *
  * Used by the initialization service to find newly-created groups that haven't been synced yet.
  *
- * @example
- * @returns Firestore query constraints for StorageFileGroups needing initialization
+ * @returns Firestore query constraints for StorageFileGroups needing initialization.
  *
  * @example
+ * @example
  * ```ts
  * const constraints = storageFileGroupsFlaggedForNeedsInitializationQuery();
  * ```
@@ -89,10 +89,10 @@ export declare function storageFileGroupsFlaggedForNeedsInitializationQuery(): F
 /**
  * Returns query constraints for StorageFileGroups flagged for content regeneration (`re == true`).
  *
- * @example
- * @returns Firestore query constraints for StorageFileGroups flagged for content regeneration
+ * @returns Firestore query constraints for StorageFileGroups flagged for content regeneration.
  *
  * @example
+ * @example
  * ```ts
  * const constraints = storageFileGroupsFlaggedForContentRegenerationQuery();
  * ```
@@ -103,10 +103,10 @@ export declare function storageFileGroupsFlaggedForContentRegenerationQuery(): F
  *
  * Invalid groups are typically cleaned up (deleted along with their associated files).
  *
- * @example
- * @returns Firestore query constraints for StorageFileGroups flagged as invalid
+ * @returns Firestore query constraints for StorageFileGroups flagged as invalid.
  *
  * @example
+ * @example
  * ```ts
  * const constraints = storageFileGroupsFlaggedInvalidQuery();
  * ```

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

@@ -68,8 +68,8 @@ export interface StorageFileProcessingNotificationTaskInput<M extends StorageFil
  *
  * The created task is unique per StorageFile (only one processing task at a time).
  *
- * @param input - the target StorageFileDocument and optional subtask data
- * @returns a CreateNotificationTaskTemplate for the StorageFile processing task
+ * @param input - The target StorageFileDocument and optional subtask data.
+ * @returns A CreateNotificationTaskTemplate for the StorageFile processing task.
  *
  * @example
  * ```ts

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

@@ -1,11 +1,11 @@
-import { type AUTH_ROLE_CLAIMS_DEFAULT_CLAIM_VALUE, type AuthRoleClaimsFactoryConfigEntrySimpleOptions } from '@dereekb/util';
+import { type DEFAULT_AUTH_ROLE_CLAIMS_CLAIM_VALUE, type AuthRoleClaimsFactoryConfigEntrySimpleOptions } from '@dereekb/util';
 /**
  * Claim value type used to restrict file uploads for a user.
  *
  * When set to true in the user's custom claims, the `uploads` role is revoked
  * (inverse claim pattern).
  */
-export type StorageFileUploadUserRestriction = typeof AUTH_ROLE_CLAIMS_DEFAULT_CLAIM_VALUE;
+export type StorageFileUploadUserRestriction = typeof DEFAULT_AUTH_ROLE_CLAIMS_CLAIM_VALUE;
 /**
  * Custom claims shape for controlling a user's file upload permission.
  *
@@ -36,8 +36,8 @@ export declare const STORAGE_FILE_UPLOAD_USER_ROLE = "uploads";
  * @example
  * ```ts
  * const claimsConfig = {
- *   fr: storageFileUploadUserSimpleClaimsConfiguration
+ *   fr: STORAGE_FILE_UPLOAD_USER_SIMPLE_CLAIMS_CONFIGURATION
  * };
  * ```
  */
-export declare const storageFileUploadUserSimpleClaimsConfiguration: AuthRoleClaimsFactoryConfigEntrySimpleOptions<StorageFileUploadUserRestriction>;
+export declare const STORAGE_FILE_UPLOAD_USER_SIMPLE_CLAIMS_CONFIGURATION: AuthRoleClaimsFactoryConfigEntrySimpleOptions<StorageFileUploadUserRestriction>;

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

@@ -27,8 +27,8 @@ export type UserUploadsFolderSlashPathFactory = FactoryWithRequiredInput<SlashPa
 /**
  * Creates a {@link UserUploadsFolderSlashPathFactory} that generates per-user upload folder paths.
  *
- * @param inputBasePath - optional custom base path; defaults to {@link ALL_USER_UPLOADS_FOLDER_PATH}
- * @returns a factory function that generates per-user upload folder slash paths
+ * @param inputBasePath - Optional custom base path; defaults to {@link ALL_USER_UPLOADS_FOLDER_PATH}
+ * @returns A factory function that generates per-user upload folder slash paths.
  *
  * @example
  * ```ts
@@ -36,6 +36,7 @@ export type UserUploadsFolderSlashPathFactory = FactoryWithRequiredInput<SlashPa
  * const path = factory('user123');
  * // path === '/uploads/u/user123'
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function userUploadsFolderSlashPathFactory(inputBasePath?: Maybe<string>): UserUploadsFolderSlashPathFactory;
@@ -53,10 +54,10 @@ export interface UserUploadsFolderStoragePathFactoryConfig {
 /**
  * Creates a {@link UserUploadsFolderStoragePathFactory} that includes the storage bucket ID.
  *
- * @param root0 - the configuration object
- * @param root0.bucketId - the storage bucket ID to include in each generated path
- * @param root0.basePath - optional custom base path; defaults to {@link ALL_USER_UPLOADS_FOLDER_PATH}
- * @returns a factory function that generates per-user StoragePath values including the bucket ID
+ * @param root0 - The configuration object.
+ * @param root0.bucketId - The storage bucket ID to include in each generated path.
+ * @param root0.basePath - Optional custom base path; defaults to {@link ALL_USER_UPLOADS_FOLDER_PATH}
+ * @returns A factory function that generates per-user StoragePath values including the bucket ID.
  *
  * @example
  * ```ts
@@ -64,6 +65,7 @@ export interface UserUploadsFolderStoragePathFactoryConfig {
  * const storagePath = factory('user123');
  * // storagePath === { pathString: '/uploads/u/user123', bucketId: 'my-bucket' }
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function userUploadsFolderStoragePathFactory({ bucketId, basePath: inputBasePath }: UserUploadsFolderStoragePathFactoryConfig): UserUploadsFolderStoragePathFactory;

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

@@ -136,8 +136,8 @@ export interface DetermineByFileNameConfig {
  * at {@link EXACT_UPLOADED_FILE_TYPE_DETERMINATION_LEVEL}. Otherwise, prefix matching is used
  * (e.g., `image` matches `image.png`, `image-test.jpg`) at {@link HIGH_UPLOADED_FILE_TYPE_DETERMINATION_LEVEL}.
  *
- * @param config - file type, match string, and optional determination levels
- * @returns an UploadedFileTypeDeterminer that classifies by file name
+ * @param config - File type, match string, and optional determination levels.
+ * @returns An UploadedFileTypeDeterminer that classifies by file name.
  *
  * @example
  * ```ts
@@ -164,8 +164,8 @@ export interface DetermineByFolderNameConfig {
  * Matches at {@link EXACT_UPLOADED_FILE_TYPE_DETERMINATION_LEVEL} when the folder path
  * exactly equals the configured match string.
  *
- * @param config - file type and folder name to match
- * @returns an UploadedFileTypeDeterminer that classifies by folder name
+ * @param config - File type and folder name to match.
+ * @returns An UploadedFileTypeDeterminer that classifies by folder name.
  *
  * @example
  * ```ts
@@ -207,8 +207,8 @@ export interface DetermineByFilePathConfig {
  * Uses {@link slashPathPathMatcher} for path pattern matching. Most flexible of the
  * built-in determiners.
  *
- * @param config - file type, path match config, optional bucket/file filters
- * @returns an UploadedFileTypeDeterminer that classifies by storage path
+ * @param config - File type, path match config, optional bucket/file filters.
+ * @returns An UploadedFileTypeDeterminer that classifies by storage path.
  *
  * @example
  * ```ts
@@ -265,8 +265,8 @@ export type DetermineUserByFolderDeterminerWrapperFunction = (determiner: Upload
  * Extracts the user ID from a path like `{rootFolder}/{userFolderPrefix}/{userId}/{file}`.
  * If `requireUser` is true, the determination fails when no user can be detected.
  *
- * @param config - root folder, user prefix, and matching options
- * @returns a wrapper function that adds user detection to any UploadedFileTypeDeterminer
+ * @param config - Root folder, user prefix, and matching options.
+ * @returns A wrapper function that adds user detection to any UploadedFileTypeDeterminer.
  *
  * @example
  * ```ts
@@ -276,20 +276,22 @@ export type DetermineUserByFolderDeterminerWrapperFunction = (determiner: Upload
  * });
  * const withUser = addUser(myDeterminer);
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function determineUserByFolderWrapperFunction(config: DetermineUserByFolderWrapperFunctionConfig): DetermineUserByFolderDeterminerWrapperFunction;
 /**
  * Convenience wrapper pre-configured for the standard uploads folder structure (`uploads/u/{userId}/...`).
  *
- * @param config - optional matching options (rootFolder and userFolderPrefix are pre-configured)
- * @returns a wrapper function that adds user detection for the standard uploads folder structure
+ * @param config - Optional matching options (rootFolder and userFolderPrefix are pre-configured)
+ * @returns A wrapper function that adds user detection for the standard uploads folder structure.
  *
  * @example
  * ```ts
  * const addUser = determineUserByUserUploadsFolderWrapperFunction();
  * const withUser = addUser(myDeterminer);
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function determineUserByUserUploadsFolderWrapperFunction(config?: Omit<DetermineUserByFolderWrapperFunctionConfig, 'rootFolder' | 'userFolderPrefix'>): DetermineUserByFolderDeterminerWrapperFunction;
@@ -305,7 +307,7 @@ export interface DetermineUserByFolderFunctionConfig extends DetermineUserByFold
 /**
  * Convenience function for using determineUserByFolderWrapperFunction directly on a pre-set determiner.
  *
- * @param config Configuration.
+ * @param config - Configuration.
  * @returns The wrapped UploadedFileTypeDeterminer.
  */
 export declare function determineUserByFolder(config: DetermineUserByFolderFunctionConfig): UploadedFileTypeDeterminer;
@@ -327,9 +329,9 @@ export interface LimitUploadFileTypeDeterminerConfig {
  *
  * Useful for scoping a broad determiner to a subset of types in a specific context.
  *
- * @param determiner - the determiner to filter
- * @param types - allowed file type identifier(s)
- * @returns an UploadedFileTypeDeterminer that only returns results for the specified file types
+ * @param determiner - The determiner to filter.
+ * @param types - Allowed file type identifier(s)
+ * @returns An UploadedFileTypeDeterminer that only returns results for the specified file types.
  *
  * @example
  * ```ts
@@ -364,8 +366,8 @@ export interface CombineUploadFileTypeDeterminerConfig {
  * If only one determiner is provided, it is returned unwrapped. The search can be
  * short-circuited via `completeSearchOnFirstMatch` or `completeSearchAtLevel`.
  *
- * @param config - determiners to combine and optional early-exit settings
- * @returns a combined UploadedFileTypeDeterminer that returns the highest-confidence match
+ * @param config - Determiners to combine and optional early-exit settings.
+ * @returns A combined UploadedFileTypeDeterminer that returns the highest-confidence match.
  *
  * @example
  * ```ts

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

@@ -26,10 +26,10 @@ export interface StorageFileGroupDocumentReferencePair {
  * If a document is provided directly, it is returned as-is. Otherwise, the related model key
  * is converted to a group ID via {@link storageFileGroupIdForModel} and loaded from the accessor.
  *
- * @param input - reference pair containing either a document or a related model key
- * @param accessor - document accessor used to load the group document by ID
- * @returns the resolved StorageFileGroupDocument
- * @throws {Error} When neither storageFileGroupDocument nor storageFileGroupRelatedModelKey is provided
+ * @param input - Reference pair containing either a document or a related model key.
+ * @param accessor - Document accessor used to load the group document by ID.
+ * @returns The resolved StorageFileGroupDocument.
+ * @throws {Error} When neither storageFileGroupDocument nor storageFileGroupRelatedModelKey is provided.
  *
  * @example
  * ```ts
@@ -65,8 +65,8 @@ export interface CalculateStorageFileGroupEmbeddedFileUpdateInput {
  * with existing ones by StorageFile ID. Automatically flags regeneration when files are removed
  * or when new files haven't been added to the zip yet.
  *
- * @param input - current group state, files to insert/remove, and regeneration options
- * @returns updated `f` (embedded files) and `re` (regeneration flag)
+ * @param input - Current group state, files to insert/remove, and regeneration options.
+ * @returns Updated `f` (embedded files) and `re` (regeneration flag)
  *
  * @example
  * ```ts
@@ -108,8 +108,8 @@ export interface CalculateStorageFileGroupRegenerationResult {
  * - The zip has never been generated (`zat` is unset) and files exist
  * - Any embedded file has never been included in the zip (`zat` is unset on the entry)
  *
- * @param input - group state and optional force flag
- * @returns the regeneration result indicating whether the zip or other derived files need to be regenerated
+ * @param input - Group state and optional force flag.
+ * @returns The regeneration result indicating whether the zip or other derived files need to be regenerated.
  *
  * @example
  * ```ts

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

@@ -95,13 +95,13 @@ export declare const systemStateConverter: import("../..").SnapshotConverterFunc
 /**
  * Returns the raw Firestore CollectionReference for the SystemState collection.
  *
+ * @param context - The Firestore context to use.
+ * @returns The CollectionReference for SystemState documents.
+ *
  * @example
  * ```ts
  * const colRef = systemStateCollectionReference(firestoreContext);
  * ```
- *
- * @param context - the Firestore context to use
- * @returns the CollectionReference for SystemState documents
  */
 export declare function systemStateCollectionReference(context: FirestoreContext): CollectionReference<SystemState>;
 export type SystemStateFirestoreCollection<T extends SystemStateStoredData = SystemStateStoredData> = FirestoreCollection<SystemState<T>, SystemStateDocument<T>>;
@@ -128,9 +128,9 @@ export type SystemStateStoredDataConverterMap = {
  * converter based on the document ID (which is the {@link SystemStateTypeIdentifier}).
  * Documents with no matching converter use the default pass-through converter.
  *
- * @param firestoreContext - the Firestore context
- * @param converters - map of type identifiers to their data field converters
- * @returns a configured SystemStateFirestoreCollection with per-type data converters
+ * @param firestoreContext - The Firestore context.
+ * @param converters - Map of type identifiers to their data field converters.
+ * @returns A configured SystemStateFirestoreCollection with per-type data converters.
  *
  * @example
  * ```ts