@dereekb/firebase 13.11.14 → 13.11.16

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

@@ -97,8 +97,8 @@ export type NotificationSummaryIdForUidFunction = FactoryWithRequiredInput<Notif
  * Creates a {@link NotificationSummaryIdForUidFunction} that generates summary IDs
  * by combining the given user model identity with the provided UID.
  *
- * @param userModelIdentity - the root identity for user models (e.g., `profileIdentity`)
- * @returns a function that generates a {@link NotificationSummaryId} for a given user UID
+ * @param userModelIdentity - Root identity for the user model (e.g., `profileIdentity`).
+ * @returns Function that maps a user UID to its {@link NotificationSummaryId}.
  *
  * @example
  * ```ts
@@ -128,14 +128,14 @@ export type NotificationLoggedEventDayKey = FirestoreModelKey;
  * Returns the {@link NotificationLoggedEventDayId} (an ISO 8601 day string in UTC)
  * for the given date. Used as the document ID when archiving logged-event notifications.
  *
+ * @param date - Instant whose UTC calendar day is captured.
+ * @returns UTC ISO day string for that instant.
+ *
  * @example
  * ```ts
  * notificationLoggedEventDayId(new Date('2026-05-08T17:30:00Z'));
  * // '2026-05-08'
  * ```
- *
- * @param date - the date to derive the day ID from
- * @returns the UTC ISO day string for that date
  */
 export declare function notificationLoggedEventDayId(date: Date): NotificationLoggedEventDayId;
 /**
@@ -209,8 +209,8 @@ export interface NotificationTaskKeyRef {
 /**
  * Creates a NotificationTaskUniqueId from the input model id and task type.
  *
- * @param input - model id input
- * @param taskType - task type
- * @returns the unique notification task id combining the model id and task type
+ * @param input - Model id input.
+ * @param taskType - Task type.
+ * @returns The unique notification task id combining the model id and task type.
  */
 export declare function notificationTaskUniqueId(input: FirestoreModelIdInput, taskType: NotificationTaskType): NotificationTaskUniqueId;

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

@@ -97,9 +97,9 @@ export interface UnreadNotificationItemsResult<D extends NotificationItemMetadat
  * Items are considered read if their `v` flag is true OR if they were created before the `considerReadIfCreatedBefore` date.
  * This is used with {@link NotificationSummary.rat} to mark all older items as read.
  *
- * @param items - notification items to classify
- * @param considerReadIfCreatedBefore - optional cutoff date; items created at or before this date are treated as read
- * @returns an object containing both the read and unread item arrays along with the input cutoff date
+ * @param items - Notification items to classify.
+ * @param considerReadIfCreatedBefore - Optional cutoff date; items created at or before this date are treated as read.
+ * @returns An object containing both the read and unread item arrays along with the input cutoff date.
  *
  * @example
  * ```ts

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

@@ -76,7 +76,7 @@ export interface NotificationLoggedEventLoader {
  *
  * Cache lifetime is the loader instance — create one per request/transaction; do not retain.
  *
- * @param config - notification collections, the parent {@link NotificationBoxDocument}, optional transaction.
- * @returns the cached loader.
+ * @param config - Notification collections, the parent {@link NotificationBoxDocument}, optional transaction.
+ * @returns The cached loader.
  */
 export declare function notificationLoggedEventLoader(config: NotificationLoggedEventLoaderConfig): NotificationLoggedEventLoader;

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

@@ -266,9 +266,9 @@ export type NotificationMessageFunction = NotificationMessageFunctionWithoutExtr
  * Creates a {@link NotificationMessageFunction} by attaching optional {@link NotificationMessageFunctionExtras}
  * (global recipients, lifecycle callbacks) to a base message generation function.
  *
- * @param fn - base function that generates message content per recipient
- * @param extras - optional delivery customization (global recipients, send callbacks)
- * @returns a {@link NotificationMessageFunction} with the extras attached
+ * @param fn - Base function that generates message content per recipient.
+ * @param extras - Optional delivery customization (global recipients, send callbacks)
+ * @returns A {@link NotificationMessageFunction} with the extras attached.
  *
  * @example
  * ```ts
@@ -280,6 +280,7 @@ export type NotificationMessageFunction = NotificationMessageFunctionWithoutExtr
  *   { globalRecipients: [adminRecipient] }
  * );
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationMessageFunction(fn: NotificationMessageFunctionWithoutExtras, extras?: NotificationMessageFunctionExtras): NotificationMessageFunction;
@@ -288,7 +289,7 @@ export declare function notificationMessageFunction(fn: NotificationMessageFunct
  *
  * Useful as a placeholder factory for template types that should not produce deliverable content.
  *
- * @returns a factory that produces no-content message functions
+ * @returns A factory that produces no-content message functions.
  *
  * @example
  * ```ts
@@ -297,6 +298,7 @@ export declare function notificationMessageFunction(fn: NotificationMessageFunct
  * const msg = await msgFn(inputContext);
  * // msg.flag === NotificationMessageFlag.NO_CONTENT
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function noContentNotificationMessageFunctionFactory<D extends NotificationItemMetadata = {}>(): NotificationMessageFunctionFactory<D>;

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

@@ -12,26 +12,26 @@ import { type ArrayOrValue } from '@dereekb/util';
  *
  * Used by the server to discover users whose configs need to be synced to their NotificationBox recipients.
  *
- * @returns array of Firestore query constraints filtering for users needing sync
+ * @returns Array of Firestore query constraints filtering for users needing sync.
  */
 export declare function notificationUsersFlaggedForNeedsSyncQuery(): FirestoreQueryConstraint[];
 /**
  * Query constraints for finding {@link NotificationUser} documents that have any of the given exclusion IDs in their `x` array.
  *
- * @param exclusionId - one or more box IDs or collection name prefixes to match against
- * @returns array of Firestore query constraints filtering for users with matching exclusions
+ * @param exclusionId - One or more box IDs or collection name prefixes to match against.
+ * @returns Array of Firestore query constraints filtering for users with matching exclusions.
  */
 export declare function notificationUserHasExclusionQuery(exclusionId: ArrayOrValue<NotificationBoxSendExclusion>): FirestoreQueryConstraint[];
 /**
  * Query constraints for finding {@link NotificationSummary} documents that need server-side initialization (`s == true`).
  *
- * @returns array of Firestore query constraints filtering for summaries needing initialization
+ * @returns Array of Firestore query constraints filtering for summaries needing initialization.
  */
 export declare function notificationSummariesFlaggedForNeedsInitializationQuery(): FirestoreQueryConstraint[];
 /**
  * Query constraints for finding {@link NotificationBox} documents that need server-side initialization (`s == true`).
  *
- * @returns array of Firestore query constraints filtering for boxes needing initialization
+ * @returns Array of Firestore query constraints filtering for boxes needing initialization.
  */
 export declare function notificationBoxesFlaggedForNeedsInitializationQuery(): FirestoreQueryConstraint[];
 /**
@@ -39,7 +39,7 @@ export declare function notificationBoxesFlaggedForNeedsInitializationQuery(): F
  *
  * Used by the server to clean up boxes that could not be initialized.
  *
- * @returns array of Firestore query constraints filtering for boxes flagged as invalid
+ * @returns Array of Firestore query constraints filtering for boxes flagged as invalid.
  */
 export declare function notificationBoxesFlaggedInvalidQuery(): FirestoreQueryConstraint[];
 /**
@@ -48,15 +48,15 @@ export declare function notificationBoxesFlaggedInvalidQuery(): FirestoreQueryCo
  *
  * This is the primary query used by the send queue processor.
  *
- * @param now - reference time for the `sat` comparison (defaults to current time)
- * @returns array of Firestore query constraints filtering for notifications past their scheduled send time
+ * @param now - Reference time for the `sat` comparison (defaults to current time)
+ * @returns Array of Firestore query constraints filtering for notifications past their scheduled send time.
  */
 export declare function notificationsPastSendAtTimeQuery(now?: Date): FirestoreQueryConstraint[];
 /**
  * Query constraints for finding {@link Notification} documents marked as done (`d == true`)
  * and ready to be archived to {@link NotificationWeek} and then deleted.
  *
- * @returns array of Firestore query constraints filtering for completed notifications ready to archive
+ * @returns Array of Firestore query constraints filtering for completed notifications ready to archive.
  */
 export declare function notificationsReadyForCleanupQuery(): FirestoreQueryConstraint[];
 /**
@@ -71,8 +71,8 @@ export declare function notificationsReadyForCleanupQuery(): FirestoreQueryConst
  * `FieldPath.documentId()` with a bare day string (it requires a full path). The `d` field stores
  * the same ISO 8601 day string as the document ID and supports a plain inequality.
  *
- * @param retentionDays - number of days of history to retain; days strictly older than `now - retentionDays` match
- * @param now - reference time for the cutoff (defaults to current time)
- * @returns array of Firestore query constraints filtering by the day string
+ * @param retentionDays - Number of days of history to retain; days strictly older than `now - retentionDays` match.
+ * @param now - Reference time for the cutoff (defaults to current time)
+ * @returns Array of Firestore query constraints filtering by the day string.
  */
 export declare function notificationLoggedEventDaysOlderThanQuery(retentionDays: number, now?: Date): FirestoreQueryConstraint[];

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

@@ -35,9 +35,9 @@ export interface NotificationSendMessagesResult<K> {
  *
  * Used when combining results from multiple send batches within the same channel.
  *
- * @param a - first result to merge
- * @param b - second result to merge
- * @returns a new result with all recipient lists concatenated from both inputs
+ * @param a - First result to merge.
+ * @param b - Second result to merge.
+ * @returns A new result with all recipient lists concatenated from both inputs.
  *
  * @example
  * ```ts

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

@@ -78,7 +78,7 @@ export interface NotificationTask<D extends NotificationItemMetadata = {}> {
  * Use this when the handler needs more time but doesn't want to increment the failure counter.
  * The task will be re-queued without counting as an error attempt.
  *
- * @returns an empty checkpoint array signaling in-progress without failure
+ * @returns An empty checkpoint array signaling in-progress without failure.
  *
  * @example
  * ```ts
@@ -92,9 +92,9 @@ export declare function delayCompletion<S extends NotificationTaskCheckpointStri
  *
  * Use when the task needs to wait (e.g., for an external API to complete) but hasn't failed.
  *
- * @param delayUntil - absolute date or relative milliseconds from the task's run start time
- * @param updateMetadata - optional metadata updates to merge into the notification item
- * @returns a task result that re-queues the task after the specified delay without marking it failed
+ * @param delayUntil - Absolute date or relative milliseconds from the task's run start time.
+ * @param updateMetadata - Optional metadata updates to merge into the notification item.
+ * @returns A task result that re-queues the task after the specified delay without marking it failed.
  *
  * @example
  * ```ts
@@ -109,9 +109,9 @@ export declare function notificationTaskDelayRetry<D extends NotificationItemMet
  * The completed checkpoint strings are added to the notification's `tpr` set. The task is re-queued
  * for the next checkpoint.
  *
- * @param completedParts - checkpoint string(s) that were just completed
- * @param updateMetadata - optional metadata updates to merge into the notification item
- * @returns a task result marking the given checkpoints complete while keeping the task running
+ * @param completedParts - Checkpoint string(s) that were just completed.
+ * @param updateMetadata - Optional metadata updates to merge into the notification item.
+ * @returns A task result marking the given checkpoints complete while keeping the task running.
  *
  * @example
  * ```ts
@@ -123,8 +123,8 @@ export declare function notificationTaskPartiallyComplete<D extends Notification
 /**
  * Returns a result indicating the task completed successfully. The notification document will be deleted.
  *
- * @param updateMetadata - optional final metadata update (applied before deletion if subtasks need it)
- * @returns a task result signaling successful completion; the notification document will be deleted
+ * @param updateMetadata - Optional final metadata update (applied before deletion if subtasks need it)
+ * @returns A task result signaling successful completion; the notification document will be deleted.
  *
  * @example
  * ```ts
@@ -138,9 +138,9 @@ export declare function notificationTaskComplete<D extends NotificationItemMetad
  *
  * After exceeding the maximum retry attempts, the task will be permanently deleted.
  *
- * @param updateMetadata - optional metadata updates
- * @param removeFromCompletedCheckpoints - checkpoint(s) to remove from the completed set (e.g., to retry a checkpoint)
- * @returns a task result signaling failure; the error attempt counter is incremented
+ * @param updateMetadata - Optional metadata updates.
+ * @param removeFromCompletedCheckpoints - Checkpoint(s) to remove from the completed set (e.g., to retry a checkpoint)
+ * @returns A task result signaling failure; the error attempt counter is incremented.
  *
  * @example
  * ```ts
@@ -155,9 +155,9 @@ export declare function notificationTaskFailed<D extends NotificationItemMetadat
  * By default, only sets `canRunNextCheckpoint` if it isn't already defined.
  * Use `force: true` to override an existing value.
  *
- * @param result - the task result to wrap
- * @param force - when true, overrides any existing `canRunNextCheckpoint` value
- * @returns a copy of the result with `canRunNextCheckpoint` set to true
+ * @param result - The task result to wrap.
+ * @param force - When true, overrides any existing `canRunNextCheckpoint` value.
+ * @returns A copy of the result with `canRunNextCheckpoint` set to true.
  */
 export declare function notificationTaskCanRunNextCheckpoint<D extends NotificationItemMetadata = {}, S extends NotificationTaskCheckpointString = NotificationTaskCheckpointString>(result: NotificationTaskServiceHandleNotificationTaskResult<D, S>, force?: Maybe<boolean>): NotificationTaskServiceHandleNotificationTaskResult<D, S>;
 /**

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

@@ -76,7 +76,7 @@ export type NotificationTaskSubtaskCheckpoint = typeof NOTIFICATION_TASK_SUBTASK
  *
  * Prefer using {@link notificationSubtaskComplete} in subtask handlers instead of calling this directly.
  *
- * @returns a partially-complete task result with the processing checkpoint marked done
+ * @returns A partially-complete task result with the processing checkpoint marked done.
  */
 export declare function completeSubtaskProcessingAndScheduleCleanupTaskResult<D extends NotificationTaskSubtaskData>(): NotificationTaskServiceHandleNotificationTaskResult<D, NotificationTaskSubtaskCheckpoint>;
 /**
@@ -85,8 +85,8 @@ export declare function completeSubtaskProcessingAndScheduleCleanupTaskResult<D
  * Unlike {@link notificationTaskComplete}, this signals that the cleanup checkpoint should still run.
  * Use `canRunNextCheckpoint: true` in options to run cleanup immediately in the same execution.
  *
- * @param options - optional metadata updates and flag to run cleanup immediately in the same execution
- * @returns a task result marking the subtask as complete while allowing cleanup to proceed
+ * @param options - Optional metadata updates and flag to run cleanup immediately in the same execution.
+ * @returns A task result marking the subtask as complete while allowing cleanup to proceed.
  *
  * @example
  * ```ts

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

@@ -29,8 +29,8 @@ export interface EffectiveNotificationBoxRecipientConfigInput {
  * Filters template configs to only include types applicable to the notification box's model.
  * Used during the server-side sync process to update box recipient entries from user configs.
  *
- * @param input - the merged config inputs including uid, global config, box config, and optional existing recipient
- * @returns the computed effective box recipient with merged config, contact info, and flags
+ * @param input - The merged config inputs including uid, global config, box config, and optional existing recipient.
+ * @returns The computed effective box recipient with merged config, contact info, and flags.
  */
 export declare function effectiveNotificationBoxRecipientConfig(input: EffectiveNotificationBoxRecipientConfigInput): NotificationBoxRecipient;
 /**
@@ -51,8 +51,8 @@ export interface UpdateNotificationUserNotificationSendExclusionsResult {
  *
  * Exclusions not matching any associated notification box are automatically filtered out.
  *
- * @param input - the user, exclusions to add, and exclusions to remove
- * @returns the updated exclusion list and the partial user update to apply
+ * @param input - The user, exclusions to add, and exclusions to remove.
+ * @returns The updated exclusion list and the partial user update to apply.
  */
 export declare function updateNotificationUserNotificationSendExclusions(input: UpdateNotificationUserNotificationSendExclusionsInput): UpdateNotificationUserNotificationSendExclusionsResult;
 /**
@@ -69,15 +69,15 @@ export type ApplyExclusionsToNotificationUserNotificationBoxRecipientConfigsResu
  * Applies the current exclusion list to per-box configs, setting/clearing the `x` flag and marking
  * changed configs as needing sync (`ns = true`).
  *
- * @param params - the exclusion list, per-box configs, and optional flag to recalculate the global ns flag
- * @returns the updated per-box configs and the recalculated needs-sync flag
+ * @param params - The exclusion list, per-box configs, and optional flag to recalculate the global ns flag.
+ * @returns The updated per-box configs and the recalculated needs-sync flag.
  */
 export declare function applyExclusionsToNotificationUserNotificationBoxRecipientConfigs(params: ApplyExclusionsToNotificationUserNotificationBoxRecipientConfigsParams): ApplyExclusionsToNotificationUserNotificationBoxRecipientConfigsResult;
 /**
  * Returns true if any of the per-box configs need syncing (`ns == true`).
  *
- * @param configs - array of per-box recipient configs to check
- * @returns true if at least one config has its needs-sync flag set
+ * @param configs - Array of per-box recipient configs to check.
+ * @returns True if at least one config has its needs-sync flag set.
  */
 export declare function calculateNsForNotificationUserNotificationBoxRecipientConfigs(configs: NotificationUserNotificationBoxRecipientConfig[]): boolean;
 /**
@@ -91,24 +91,24 @@ export type NotificationSendExclusionCanSendFunction = ((notification: Notificat
  * Creates a {@link NotificationSendExclusionCanSendFunction} from the given exclusion list.
  * Returns true for IDs that don't match any exclusion prefix.
  *
- * @param exclusions - the list of box IDs or prefixes that should be excluded from delivery
- * @returns a predicate function that returns true if the given notification/box ID is not excluded
+ * @param exclusions - The list of box IDs or prefixes that should be excluded from delivery.
+ * @returns A predicate function that returns true if the given notification/box ID is not excluded.
  */
 export declare const notificationSendExclusionCanSendFunction: (exclusions: NotificationBoxSendExclusionList) => NotificationSendExclusionCanSendFunction;
 /**
  * Returns true if all channels on the notification have reached a terminal state
  * (NONE, NO_TRY, SENT, or SKIPPED). Used to determine if the notification can be marked done.
  *
- * @param input - the per-channel send flags to evaluate
- * @returns true if all channels are in a terminal send state
+ * @param input - The per-channel send flags to evaluate.
+ * @returns True if all channels are in a terminal send state.
  */
 export declare function notificationSendFlagsImplyIsComplete(input: NotificationSendFlags): boolean;
 /**
  * Returns true if the given send state is terminal — no further send attempts will be made.
  * Terminal states: NONE, NO_TRY, SENT, SKIPPED.
  *
- * @param input - the send state to evaluate
- * @returns true if the state is terminal and no further delivery will be attempted
+ * @param input - The send state to evaluate.
+ * @returns True if the state is terminal and no further delivery will be attempted.
  */
 export declare function isCompleteNotificationSendState(input: NotificationSendState): boolean;
 /**
@@ -122,8 +122,8 @@ export interface AllowedNotificationRecipients {
 /**
  * Resolves which recipient groups (global, box, explicit) are allowed based on the {@link NotificationRecipientSendFlag}.
  *
- * @param flag - the recipient send flag controlling which groups are included
- * @returns an object indicating which recipient groups are permitted for this notification
+ * @param flag - The recipient send flag controlling which groups are included.
+ * @returns An object indicating which recipient groups are permitted for this notification.
  */
 export declare function allowedNotificationRecipients(flag?: Maybe<NotificationRecipientSendFlag>): AllowedNotificationRecipients;
 /**
@@ -132,8 +132,8 @@ export declare function allowedNotificationRecipients(flag?: Maybe<NotificationR
  * Logged-event notifications bypass the normal send pipeline entirely and are archived to the
  * day-keyed {@link NotificationLoggedEventDay} collection during cleanup.
  *
- * @param notification - the notification to check
- * @returns true if the notification has the LOGGED_EVENT send type
+ * @param notification - The notification to check.
+ * @returns True if the notification has the LOGGED_EVENT send type.
  */
 export declare function isLoggedEventNotification(notification: Pick<Notification, 'st'>): boolean;
 /**
@@ -143,25 +143,25 @@ export declare function isLoggedEventNotification(notification: Pick<Notificatio
  * to only explicit or only global recipients are not saved to the weekly archive). Logged-event
  * notifications are archived to {@link NotificationLoggedEventDay} instead and never to the weekly archive.
  *
- * @param notification - the notification to check
- * @returns true if the notification should be saved to the weekly archive after delivery
+ * @param notification - The notification to check.
+ * @returns True if the notification should be saved to the weekly archive after delivery.
  */
 export declare function shouldSaveNotificationToNotificationWeek(notification: Notification): boolean;
 /**
  * Merges a partial update into a {@link NotificationUserNotificationBoxRecipientConfig},
  * preserving user-controlled fields (`nb`, `rm`, `ns`, `lk`, `bk`) and respecting OPT_OUT state.
  *
- * @param a - base user box recipient config to merge into
- * @param b - partial update to apply on top of the base
- * @returns the merged config with protected fields retained from `a`
+ * @param a - Base user box recipient config to merge into.
+ * @param b - Partial update to apply on top of the base.
+ * @returns The merged config with protected fields retained from `a`
  */
 export declare function mergeNotificationUserNotificationBoxRecipientConfigs(a: NotificationUserNotificationBoxRecipientConfig, b: Partial<NotificationUserNotificationBoxRecipientConfig>): NotificationUserNotificationBoxRecipientConfig;
 /**
  * Merges a partial update into a {@link NotificationBoxRecipient}, deeply merging the `c` (config record) field.
  *
- * @param a - base recipient to merge into
- * @param b - partial recipient update to apply on top of the base
- * @returns the merged recipient with deeply merged template config records
+ * @param a - Base recipient to merge into.
+ * @param b - Partial recipient update to apply on top of the base.
+ * @returns The merged recipient with deeply merged template config records.
  */
 export declare function mergeNotificationBoxRecipients<T extends NotificationBoxRecipient>(a: T, b: Partial<T>): T;
 /**
@@ -182,9 +182,9 @@ export interface NotificationBoxDocumentReferencePair {
 /**
  * Resolves a {@link NotificationBoxDocument} from a reference pair, loading by model key if no document is provided directly.
  *
- * @param input - reference pair containing either a direct document or a model key to load from
- * @param accessor - Firestore document accessor used to load the document by ID when needed
- * @returns the resolved NotificationBoxDocument
+ * @param input - Reference pair containing either a direct document or a model key to load from.
+ * @param accessor - Firestore document accessor used to load the document by ID when needed.
+ * @returns The resolved NotificationBoxDocument.
  * @throws {Error} When neither a document nor a model key is provided.
  */
 export declare function loadNotificationBoxDocumentForReferencePair(input: NotificationBoxDocumentReferencePair, accessor: FirestoreDocumentAccessor<NotificationBox, NotificationBoxDocument>): NotificationBoxDocument;

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

@@ -101,7 +101,7 @@ export { targetModelParamsType as deleteOidcTokenParamsType } from '../../common
  * Custom (non-CRUD) function type map for OIDC.
  */
 export type OidcModelFunctionTypeMap = {};
-export declare const oidcFunctionTypeConfigMap: FirebaseFunctionTypeConfigMap<OidcModelFunctionTypeMap>;
+export declare const OIDC_FUNCTION_TYPE_CONFIG_MAP: FirebaseFunctionTypeConfigMap<OidcModelFunctionTypeMap>;
 /**
  * CRUD function configuration map for the OIDC client model.
  *
@@ -122,7 +122,7 @@ export type OidcModelCrudFunctionsConfig = {
         };
     };
 };
-export declare const oidcModelCrudFunctionsConfig: ModelFirebaseCrudFunctionConfigMap<OidcModelCrudFunctionsConfig, OidcModelTypes>;
+export declare const OIDC_MODEL_CRUD_FUNCTIONS_CONFIG: ModelFirebaseCrudFunctionConfigMap<OidcModelCrudFunctionsConfig, OidcModelTypes>;
 /**
  * Abstract class defining all callable OIDC cloud functions.
  *

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

@@ -1,4 +1,4 @@
-import { type JsonSerializableObject, type Maybe } from '@dereekb/util';
+import { type JsonSerializableObject, type SuggestedString, type Maybe } from '@dereekb/util';
 import { AbstractFirestoreDocument, type CollectionReference, type FirestoreCollection, type FirestoreContext, type FirebaseAuthOwnershipKey, type FirebaseAuthUserId } from '../../common';
 import { type GrantedDeleteRole, type GrantedReadRole, type GrantedUpdateRole } from '@dereekb/model';
 /**
@@ -29,7 +29,7 @@ export declare const oidcEntryIdentity: import("../..").RootFirestoreModelIdenti
  *
  * Used as the discriminator in the {@link OidcEntry.type} field.
  */
-export type OidcEntryType = 'Session' | 'AccessToken' | 'AuthorizationCode' | 'RefreshToken' | 'DeviceCode' | 'ClientCredentials' | 'Client' | 'InitialAccessToken' | 'RegistrationAccessToken' | 'Interaction' | 'ReplayDetection' | 'PushedAuthorizationRequest' | 'Grant' | 'BackchannelAuthenticationRequest' | (string & {});
+export type OidcEntryType = SuggestedString<'Session' | 'AccessToken' | 'AuthorizationCode' | 'RefreshToken' | 'DeviceCode' | 'ClientCredentials' | 'Client' | 'InitialAccessToken' | 'RegistrationAccessToken' | 'Interaction' | 'ReplayDetection' | 'PushedAuthorizationRequest' | 'Grant' | 'BackchannelAuthenticationRequest'>;
 /**
  * Type value for Client adapter entries.
  */
@@ -146,14 +146,14 @@ export interface OidcEntryFirestoreCollectionConfig {
 /**
  * Returns the Firestore {@link CollectionReference} for {@link OidcEntry} documents.
  *
- * @param context - the Firestore context to use
- * @returns the CollectionReference for OidcEntry documents
+ * @param context - The Firestore context to use.
+ * @returns The CollectionReference for OidcEntry documents.
  */
 export declare function oidcEntryCollectionReference(context: FirestoreContext): CollectionReference<OidcEntry>;
 /**
  * Creates an {@link OidcEntryFirestoreCollection} from the given configuration.
  *
- * @param config - the Firestore context and collection configuration
- * @returns a configured OidcEntryFirestoreCollection
+ * @param config - The Firestore context and collection configuration.
+ * @returns A configured OidcEntryFirestoreCollection.
  */
 export declare function oidcEntryFirestoreCollection(config: OidcEntryFirestoreCollectionConfig): OidcEntryFirestoreCollection;

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

@@ -3,47 +3,47 @@ import { type OidcEntryType } from './oidcmodel';
 /**
  * Query for OidcEntry documents with a specific type.
  *
- * @param type - the OIDC entry type to filter by
- * @returns Firestore query constraints for the given type
+ * @param type - The OIDC entry type to filter by.
+ * @returns Firestore query constraints for the given type.
  */
 export declare function oidcEntriesWithTypeQuery(type: OidcEntryType): FirestoreQueryConstraint[];
 /**
  * Query for OidcEntry documents with a specific type and userCode.
  *
- * @param type - the OIDC entry type to filter by
- * @param userCode - the user code to match
- * @returns Firestore query constraints for the given type and userCode
+ * @param type - The OIDC entry type to filter by.
+ * @param userCode - The user code to match.
+ * @returns Firestore query constraints for the given type and userCode.
  */
 export declare function oidcEntriesByUserCodeQuery(type: OidcEntryType, userCode: string): FirestoreQueryConstraint[];
 /**
  * Query for OidcEntry documents with a specific type and uid.
  *
- * @param type - the OIDC entry type to filter by
- * @param uid - the Firebase user ID to match
- * @returns Firestore query constraints for the given type and uid
+ * @param type - The OIDC entry type to filter by.
+ * @param uid - The Firebase user ID to match.
+ * @returns Firestore query constraints for the given type and uid.
  */
 export declare function oidcEntriesByUidQuery(type: OidcEntryType, uid: FirebaseAuthUserId): FirestoreQueryConstraint[];
 /**
  * Query for OidcEntry documents with a specific type and grantId.
  *
- * @param type - the OIDC entry type to filter by
- * @param grantId - the grant ID to match
- * @returns Firestore query constraints for the given type and grantId
+ * @param type - The OIDC entry type to filter by.
+ * @param grantId - The grant ID to match.
+ * @returns Firestore query constraints for the given type and grantId.
  */
 export declare function oidcEntriesByGrantIdQuery(type: OidcEntryType, grantId: string): FirestoreQueryConstraint[];
 /**
  * Query for OidcEntry documents with a specific type and clientId.
  *
- * @param type - the OIDC entry type to filter by
- * @param clientId - the OAuth client ID to match
- * @returns Firestore query constraints for the given type and clientId
+ * @param type - The OIDC entry type to filter by.
+ * @param clientId - The OAuth client ID to match.
+ * @returns Firestore query constraints for the given type and clientId.
  */
 export declare function oidcEntriesByClientIdQuery(type: OidcEntryType, clientId: string): FirestoreQueryConstraint[];
 /**
  * Query for OidcEntry Client documents owned by a specific user.
  *
- * @param ownershipKey - the ownership key identifying the owner
- * @returns Firestore query constraints for Client entries matching the ownership key
+ * @param ownershipKey - The ownership key identifying the owner.
+ * @returns Firestore query constraints for Client entries matching the ownership key.
  */
 export declare function oidcClientEntriesByOwnerQuery(ownershipKey: FirebaseAuthOwnershipKey): FirestoreQueryConstraint[];
 /**
@@ -52,7 +52,7 @@ export declare function oidcClientEntriesByOwnerQuery(ownershipKey: FirebaseAuth
  * Used by the "apps with access to my account" UI to list every outstanding
  * grant the signed-in user has authorized.
  *
- * @param uid - the Firebase user id the grants were issued to
- * @returns Firestore query constraints for Grant entries matching the uid
+ * @param uid - The Firebase user id the grants were issued to.
+ * @returns Firestore query constraints for Grant entries matching the uid.
  */
 export declare function oidcGrantEntriesByUidQuery(uid: FirebaseAuthUserId): FirestoreQueryConstraint[];

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

@@ -258,7 +258,7 @@ export interface InitializeAllApplicableStorageFileGroupsResult {
  * Custom (non-CRUD) function type map for StorageFile. Currently empty — all operations use CRUD functions.
  */
 export type StorageFileFunctionTypeMap = {};
-export declare const storageFileFunctionTypeConfigMap: FirebaseFunctionTypeConfigMap<StorageFileFunctionTypeMap>;
+export declare const STORAGE_FILE_FUNCTION_TYPE_CONFIG_MAP: FirebaseFunctionTypeConfigMap<StorageFileFunctionTypeMap>;
 /**
  * CRUD function configuration map for the StorageFile model family.
  *
@@ -295,7 +295,7 @@ export type StorageFileModelCrudFunctionsConfig = {
         };
     };
 };
-export declare const storageFileModelCrudFunctionsConfig: ModelFirebaseCrudFunctionConfigMap<StorageFileModelCrudFunctionsConfig, StorageFileTypes>;
+export declare const STORAGE_FILE_MODEL_CRUD_FUNCTIONS_CONFIG: ModelFirebaseCrudFunctionConfigMap<StorageFileModelCrudFunctionsConfig, StorageFileTypes>;
 /**
  * Abstract class defining all callable StorageFile cloud functions.
  *

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

@@ -170,11 +170,11 @@ export type CreateStorageFileDocumentPairFactory = <M extends StorageFileMetadat
  * {@link StorageFileCreationType.FOR_STORAGE_FILE_GROUP}), storage path resolution, and
  * initial state setup.
  *
- * @param config - optional defaults for creation type, subgroup, and processing state
- * @returns a factory function that creates StorageFile document pairs
- * @throws {Error} When neither accessor nor context is provided
- * @throws {Error} When no storage path can be resolved from the input
- * @throws {Error} When FOR_STORAGE_FILE_GROUP is used without parentStorageFileGroup or purpose
+ * @param config - Optional defaults for creation type, subgroup, and processing state.
+ * @returns A factory function that creates StorageFile document pairs.
+ * @throws {Error} When neither accessor nor context is provided.
+ * @throws {Error} When no storage path can be resolved from the input.
+ * @throws {Error} When FOR_STORAGE_FILE_GROUP is used without parentStorageFileGroup or purpose.
  *
  * @example
  * ```ts
@@ -188,6 +188,7 @@ export type CreateStorageFileDocumentPairFactory = <M extends StorageFileMetadat
  *   context: collections
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function createStorageFileDocumentPairFactory(config?: CreateStorageFileDocumentPairFactoryConfig): CreateStorageFileDocumentPairFactory;
@@ -196,7 +197,7 @@ export declare function createStorageFileDocumentPairFactory(config?: CreateStor
  *
  * Calls createStorageFileDocumentPairFactory() with no arguments, then passes the input to the factory and returns the result.
  *
- * @param input - the creation input specifying the storage path, purpose, and context
- * @returns a promise resolving to the created StorageFileDocument and StorageFile data
+ * @param input - Creation input specifying the storage path, purpose, and context.
+ * @returns Resolves with the created StorageFileDocument and StorageFile data.
  */
 export declare function createStorageFileDocumentPair<M extends StorageFileMetadata = StorageFileMetadata>(input: CreateStorageFileDocumentPairInput<M>): Promise<CreateStorageFileDocumentPairResult<M>>;