@dereekb/firebase 13.11.2 → 13.11.3

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

@@ -123,6 +123,10 @@ export type FirestoreModelFieldMapFunctionsConfig<V, D> = ModelFieldMapFunctions
  * @param config - Configuration for the Firestore field
  * @returns A configured mapping between model and Firestore data
  *
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldTags base, custom, transform, default, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-field
  * @example
  * ```ts
  * // Custom field that stores a Set<string> as a comma-separated string
@@ -132,6 +136,7 @@ export type FirestoreModelFieldMapFunctionsConfig<V, D> = ModelFieldMapFunctions
  *   toData: (set) => [...set].join(',')
  * });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreField<V, D = unknown>(config: FirestoreFieldConfig<V, D>): FirestoreModelFieldMapFunctionsConfig<V, D>;
 /**
@@ -139,6 +144,16 @@ export declare function firestoreField<V, D = unknown>(config: FirestoreFieldCon
  *
  * Defaults to `null` when the field is missing. Used internally by {@link firestorePassThroughField}
  * and as a fallback for {@link optionalFirestoreField} when no config is provided.
+ *
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldTags passthrough, identity, raw, untransformed, builtin
+ * @example
+ * ```ts
+ * fields: {
+ *   raw: FIRESTORE_PASSTHROUGH_FIELD
+ * }
+ * ```
  */
 export declare const FIRESTORE_PASSTHROUGH_FIELD: FirestoreModelFieldMapFunctionsConfig<unknown, unknown>;
 /**
@@ -149,6 +164,16 @@ export declare const FIRESTORE_PASSTHROUGH_FIELD: FirestoreModelFieldMapFunction
  *
  * @template T - Type for both the model field and Firestore field
  * @returns A field mapping configuration that passes values through unchanged
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldTags passthrough, identity, raw, untransformed, factory
+ * @example
+ * ```ts
+ * fields: {
+ *   payload: firestorePassThroughField<MyType>()
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestorePassThroughField<T>(): ModelFieldMapFunctionsConfig<T, T>;
 /**
@@ -267,6 +292,12 @@ export interface OptionalFirestoreFieldConfigWithOneTypeTransform<T> extends Opt
  *   transformToData: toISODateString
  * });
  * ```
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags base, optional, dontstore, transform, factory
+ * @dbxModelSnapshotFieldRelated firestore-field
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreField<V, D>(config?: OptionalFirestoreFieldConfigWithTwoTypeTransform<V, D>): FirestoreModelFieldMapFunctionsConfig<Maybe<V>, Maybe<D>>;
 /**
@@ -347,6 +378,11 @@ export declare const DEFAULT_FIRESTORE_STRING_FIELD_VALUE = "";
  * // String field with lowercase transformation
  * const emailField = firestoreString({ transform: 'lowercase' });
  * ```
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldTags string, text, transform, lowercase, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-string
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreString<S extends string = string>(config?: FirestoreStringConfig<S>): FirestoreModelFieldMapFunctionsConfig<S, S>;
 /**
@@ -361,6 +397,18 @@ export type OptionalFirestoreString<S extends string = string> = OptionalOneType
  * @template S - String type for the field (defaults to string)
  * @param config - Configuration for the optional string field
  * @returns A field mapping configuration for optional string values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags string, text, optional, transform, factory
+ * @dbxModelSnapshotFieldRelated firestore-string
+ * @example
+ * ```ts
+ * fields: {
+ *   nickname: optionalFirestoreString()
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreString<S extends string = string>(config?: OptionalFirestoreString<S>): FirestoreModelFieldMapFunctionsConfig<Maybe<S>, Maybe<S>>;
 /**
@@ -375,6 +423,17 @@ export type FirestoreEnumConfig<S extends string | number> = MapConfiguredFirest
  * @template S - Enum type (string or number)
  * @param config - Configuration for the enum field
  * @returns A field mapping configuration for enum values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldTags enum, string, number, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-enum
+ * @example
+ * ```ts
+ * fields: {
+ *   status: firestoreEnum<UserStatus>({ default: UserStatus.Pending })
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreEnum<S extends string | number>(config: FirestoreEnumConfig<S>): FirestoreModelFieldMapFunctionsConfig<S, S>;
 /**
@@ -389,26 +448,69 @@ export type OptionalFirestoreEnumConfig<S extends string | number> = OptionalOne
  * @template S - Enum type (string or number)
  * @param config - Configuration for the optional enum field
  * @returns A field mapping configuration for optional enum values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags enum, optional, string, number, factory
+ * @dbxModelSnapshotFieldRelated firestore-enum
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreEnum<S extends string | number>(config?: OptionalFirestoreEnumConfig<S>): FirestoreModelFieldMapFunctionsConfig<Maybe<S>, Maybe<S>>;
 /**
  * Creates a field mapping configuration for Firestore UID fields.
  *
  * @returns A field mapping configuration for Firebase Auth user IDs
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory model-key
+ * @dbxModelSnapshotFieldTags uid, user, owner, account, auth, string, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-uid
+ * @example
+ * ```ts
+ * fields: {
+ *   uid: firestoreUID()
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreUID(): FirestoreModelFieldMapFunctionsConfig<string, string>;
 /**
  * Creates a field mapping configuration for optional Firestore UID fields.
  *
  * @returns A field mapping configuration for optional Firebase Auth user IDs
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory model-key
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags uid, user, owner, account, auth, optional, string, factory
+ * @dbxModelSnapshotFieldRelated firestore-uid
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreUID(): FirestoreModelFieldMapFunctionsConfig<Maybe<string>, Maybe<string>>;
 /**
  * Pre-built field mapping for Firestore model key strings. Defaults to empty string.
+ *
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory model-key
+ * @dbxModelSnapshotFieldTags model, key, string, reference, ref, pointer, builtin
+ * @example
+ * ```ts
+ * fields: {
+ *   m: firestoreModelKeyString
+ * }
+ * ```
  */
 export declare const firestoreModelKeyString: FirestoreModelFieldMapFunctionsConfig<string, string>;
 /**
  * Pre-built field mapping for Firestore model ID strings. Defaults to empty string.
+ *
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory model-key
+ * @dbxModelSnapshotFieldTags model, id, string, reference, pointer, builtin
+ * @example
+ * ```ts
+ * fields: {
+ *   id: firestoreModelIdString
+ * }
+ * ```
  */
 export declare const firestoreModelIdString: FirestoreModelFieldMapFunctionsConfig<string, string>;
 /**
@@ -441,6 +543,11 @@ export type FirestoreDateFieldConfig = DefaultMapConfiguredFirestoreFieldConfig<
  * // Date field with a fixed default
  * const startDateField = firestoreDate({ default: new Date('2020-01-01') });
  * ```
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory date
+ * @dbxModelSnapshotFieldTags date, time, iso, timestamp, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-date, firestore-date-number
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDate(config?: FirestoreDateFieldConfig): FirestoreModelFieldMapFunctionsConfig<Date, string>;
 /**
@@ -457,6 +564,18 @@ export type OptionalFirestoreDateFieldConfig = OptionalFirestoreFieldConfig<Date
  *
  * @param config - Configuration for the optional date field
  * @returns A field mapping configuration for optional Date values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory date
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags date, time, iso, optional, factory
+ * @dbxModelSnapshotFieldRelated firestore-date
+ * @example
+ * ```ts
+ * fields: {
+ *   deletedAt: optionalFirestoreDate()
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreDate(config?: OptionalFirestoreDateFieldConfig): FirestoreModelFieldMapFunctionsConfig<Maybe<Date>, Maybe<string>>;
 /**
@@ -484,6 +603,11 @@ export type FirestoreDateNumberFieldConfig = DefaultMapConfiguredFirestoreFieldC
  *
  * @param config - Configuration including custom Date-to-number conversion functions
  * @returns A field mapping configuration for Date values stored as numbers
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory date
+ * @dbxModelSnapshotFieldTags date, number, timestamp, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-date-number, firestore-unix-date-time-seconds-number
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDateNumber(config: FirestoreDateNumberFieldConfig): FirestoreModelFieldMapFunctionsConfig<Date, number>;
 /**
@@ -498,6 +622,12 @@ export type OptionalFirestoreDateNumberFieldConfig = OptionalFirestoreFieldConfi
  *
  * @param config - Configuration for the optional date field
  * @returns A field mapping configuration for optional Date values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory date
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags date, number, timestamp, optional, factory
+ * @dbxModelSnapshotFieldRelated firestore-date-number
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreDateNumber(config: OptionalFirestoreDateNumberFieldConfig): FirestoreModelFieldMapFunctionsConfig<Maybe<Date>, Maybe<number>>;
 export type FirestoreUnixDateTimeSecondsNumberFieldConfig = Omit<FirestoreDateNumberFieldConfig, 'fromDate' | 'toDate'>;
@@ -506,6 +636,7 @@ export type FirestoreUnixDateTimeSecondsNumberFieldConfig = Omit<FirestoreDateNu
  *
  * @param config - Configuration for the date field
  * @returns A field mapping configuration for Date values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreUnixDateTimeSecondsNumber(config: FirestoreUnixDateTimeSecondsNumberFieldConfig): FirestoreModelFieldMapFunctionsConfig<Date, number>;
 export type OptionalFirestoreUnixDateTimeSecondsNumberFieldConfig = Omit<OptionalFirestoreDateNumberFieldConfig, 'fromDate' | 'toDate'>;
@@ -514,6 +645,7 @@ export type OptionalFirestoreUnixDateTimeSecondsNumberFieldConfig = Omit<Optiona
  *
  * @param config - Configuration for the optional date field
  * @returns A field mapping configuration for optional Date values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreUnixDateTimeSecondsNumber(config?: OptionalFirestoreUnixDateTimeSecondsNumberFieldConfig): FirestoreModelFieldMapFunctionsConfig<Maybe<Date>, Maybe<number>>;
 /**
@@ -525,6 +657,17 @@ export type FirestoreBooleanFieldConfig = MapConfiguredFirestoreFieldConfigWithD
  *
  * @param config - Configuration for the boolean field
  * @returns A field mapping configuration for boolean values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldTags boolean, flag, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-boolean
+ * @example
+ * ```ts
+ * fields: {
+ *   active: firestoreBoolean({ default: true })
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreBoolean(config: FirestoreBooleanFieldConfig): FirestoreModelFieldMapFunctionsConfig<boolean, boolean>;
 /**
@@ -536,6 +679,18 @@ export type OptionalFirestoreBooleanFieldConfig = OptionalOneTypeFirestoreFieldC
  *
  * @param config - Configuration for the optional boolean field
  * @returns A field mapping configuration for optional boolean values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags boolean, flag, optional, dontstore, factory
+ * @dbxModelSnapshotFieldRelated firestore-boolean
+ * @example
+ * ```ts
+ * fields: {
+ *   ns: optionalFirestoreBoolean()
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreBoolean(config?: OptionalFirestoreBooleanFieldConfig): FirestoreModelFieldMapFunctionsConfig<Maybe<boolean>, Maybe<boolean>>;
 /**
@@ -559,6 +714,17 @@ export interface FirestoreNumberConfig<N extends number = number> extends MapCon
  * @template N - Number type for the field (defaults to number)
  * @param config - Configuration for the number field
  * @returns A field mapping configuration for number values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldTags number, integer, transform, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-number
+ * @example
+ * ```ts
+ * fields: {
+ *   count: firestoreNumber({ default: 0 })
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreNumber<N extends number = number>(config: FirestoreNumberConfig<N>): FirestoreModelFieldMapFunctionsConfig<N, N>;
 /**
@@ -573,6 +739,12 @@ export type OptionalFirestoreNumberFieldConfig<N extends number = number> = Opti
  * @template N - Number type for the field (defaults to number)
  * @param config - Configuration for the optional number field
  * @returns A field mapping configuration for optional number values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory primitive
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags number, integer, optional, transform, factory
+ * @dbxModelSnapshotFieldRelated firestore-number
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreNumber<N extends number = number>(config?: OptionalFirestoreNumberFieldConfig<N>): FirestoreModelFieldMapFunctionsConfig<Maybe<N>, Maybe<N>>;
 /**
@@ -598,6 +770,11 @@ export type FirestoreArrayFieldConfig<T> = DefaultMapConfiguredFirestoreFieldCon
  *   sortWith: (a, b) => a.localeCompare(b)
  * });
  * ```
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory array
+ * @dbxModelSnapshotFieldTags array, list, sort, factory
+ * @dbxModelSnapshotFieldRelated optional-firestore-array, firestore-unique-array
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreArray<T>(config: FirestoreArrayFieldConfig<T>): FirestoreModelFieldMapFunctionsConfig<T[], T[]>;
 /**
@@ -629,6 +806,18 @@ export type OptionalFirestoreArrayFieldConfig<T> = Omit<OptionalFirestoreFieldCo
  * @template T - Type of elements in the array
  * @param config - Configuration for the optional array field
  * @returns A field mapping configuration for optional array values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory array
+ * @dbxModelSnapshotFieldOptional true
+ * @dbxModelSnapshotFieldTags array, list, optional, unique, dontstore, factory
+ * @dbxModelSnapshotFieldRelated firestore-array
+ * @example
+ * ```ts
+ * fields: {
+ *   tags: optionalFirestoreArray<string>({ filterUnique: true, dontStoreIfEmpty: true })
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreArray<T>(config?: OptionalFirestoreArrayFieldConfig<T>): FirestoreModelFieldMapFunctionsConfig<Maybe<T[]>, Maybe<T[]>>;
 /**
@@ -650,6 +839,7 @@ export type FirestoreUniqueArrayFieldConfig<T, K extends PrimativeKey = T extend
  * @template K - Key type for filtering uniqueness
  * @param config - Configuration for the unique array field
  * @returns A field mapping configuration for unique array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreUniqueArray<T, K extends PrimativeKey = T extends PrimativeKey ? T : PrimativeKey>(config: FirestoreUniqueArrayFieldConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<T[], T[]>;
 /**
@@ -671,6 +861,7 @@ export type FirestoreUniqueKeyedArrayFieldConfig<T, K extends PrimativeKey = Pri
  * @template K - Type of the key used for uniqueness
  * @param config - Configuration for the keyed unique array field
  * @returns A field mapping configuration for keyed unique array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreUniqueKeyedArray<T, K extends PrimativeKey = PrimativeKey>(config: FirestoreUniqueKeyedArrayFieldConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<T[], T[]>;
 /**
@@ -685,6 +876,10 @@ export type FirestoreEnumArrayFieldConfig<S extends string | number> = Omit<Fire
  * @template S - Enum type (string or number)
  * @param config - Configuration for the enum array field
  * @returns A field mapping configuration for enum array values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory array
+ * @dbxModelSnapshotFieldTags array, enum, unique, flags, tags, factory
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreEnumArray<S extends string | number>(config?: FirestoreEnumArrayFieldConfig<S>): FirestoreModelFieldMapFunctionsConfig<S[], S[]>;
 /**
@@ -699,15 +894,30 @@ export type FirestoreUniqueStringArrayFieldConfig<S extends string = string> = O
  * @template S - String type (defaults to string)
  * @param config - Configuration for the unique string array field
  * @returns A field mapping configuration for unique string array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreUniqueStringArray<S extends string = string>(config?: FirestoreUniqueStringArrayFieldConfig<S>): FirestoreModelFieldMapFunctionsConfig<S[], S[]>;
 /**
  * Pre-built field mapping for arrays of unique Firestore model key strings.
+ *
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory model-key
+ * @dbxModelSnapshotFieldTags model, key, array, unique, reference, ref, pointer, builtin
+ * @example
+ * ```ts
+ * fields: {
+ *   b: firestoreModelKeyArrayField
+ * }
+ * ```
  */
 export declare const firestoreModelKeyArrayField: FirestoreModelFieldMapFunctionsConfig<string[], string[]>;
 /**
  * Pre-built field mapping for arrays of unique Firestore model ID strings.
  * Alias for {@link firestoreModelKeyArrayField}.
+ *
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory model-key
+ * @dbxModelSnapshotFieldTags model, id, array, unique, reference, pointer, builtin
  */
 export declare const firestoreModelIdArrayField: FirestoreModelFieldMapFunctionsConfig<string[], string[]>;
 /**
@@ -722,6 +932,7 @@ export type FirestoreUniqueNumberArrayFieldConfig<S extends number = number> = O
  * @template S - Number type (defaults to number)
  * @param config - Configuration for the unique number array field
  * @returns A field mapping configuration for unique number array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreUniqueNumberArray<S extends number = number>(config?: FirestoreUniqueNumberArrayFieldConfig<S>): FirestoreModelFieldMapFunctionsConfig<S[], S[]>;
 /**
@@ -755,6 +966,7 @@ export type FirestoreEncodedArrayFieldConfig<T, E extends string | number> = Def
  * @template E - Type of encoded elements in Firestore (string or number)
  * @param config - Configuration for the encoded array field
  * @returns A field mapping configuration for encoded array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreEncodedArray<T, E extends string | number>(config: FirestoreEncodedArrayFieldConfig<T, E>): FirestoreModelFieldMapFunctionsConfig<T[], E[]>;
 /**
@@ -779,6 +991,7 @@ export type FirestoreDencoderArrayFieldConfig<D extends PrimativeKey, E extends
  * @template E - Type of encoded elements in Firestore
  * @param config - Configuration for the decoder array field
  * @returns A field mapping configuration for encoded primative key array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDencoderArray<D extends PrimativeKey, E extends PrimativeKey>(config: FirestoreDencoderArrayFieldConfig<D, E>): FirestoreModelFieldMapFunctionsConfig<D[], E[]>;
 /**
@@ -804,6 +1017,7 @@ export type FirestoreDencoderStringArrayFieldConfig<D extends PrimativeKey, E ex
  * @template S - String type for storage in Firestore
  * @param config - Configuration for the string decoder array field
  * @returns A field mapping configuration for string-encoded primative key array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDencoderStringArray<D extends PrimativeKey, E extends PrimativeKey, S extends string = string>(config: FirestoreDencoderStringArrayFieldConfig<D, E, S>): FirestoreModelFieldMapFunctionsConfig<D[], S>;
 /**
@@ -846,6 +1060,10 @@ export type FirestoreMapFieldConfig<T, K extends string = string> = DefaultMapCo
  *   mapFilter: KeyValueTypleValueFilter.EMPTY
  * });
  * ```
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory map
+ * @dbxModelSnapshotFieldTags map, record, dictionary, dict, factory
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreMap<T, K extends string = string>(config?: FirestoreMapFieldConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<T, K>, FirestoreMapFieldType<T, K>>;
 /**
@@ -854,6 +1072,7 @@ export declare function firestoreMap<T, K extends string = string>(config?: Fire
  * Filters out models with no/null roles by default.
  *
  * @returns A field mapping configuration for a map of granted roles keyed by FirestoreModelKey
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyGrantedRoleMap<R extends GrantedRole>(): FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<R, string>, FirestoreMapFieldType<R, string>>;
 /**
@@ -893,6 +1112,7 @@ export type FirestoreEncodedObjectMapFieldConfig<T, E, S extends string = string
  * @template S - Key type (string, defaults to string)
  * @param config - Configuration including encoder/decoder functions
  * @returns A field mapping configuration for encoded map values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreEncodedObjectMap<T, E, S extends string = string>(config: FirestoreEncodedObjectMapFieldConfig<T, E, S>): FirestoreModelFieldMapFunctionsConfig<FirestoreEncodedObjectMapFieldValueType<T, S>, FirestoreMapFieldType<E, S>>;
 export type FirestoreDencoderMapFieldValueType<D extends PrimativeKey, S extends string = string> = FirestoreEncodedObjectMapFieldValueType<D[], S>;
@@ -913,6 +1133,7 @@ export type FirestoreDencoderMapFieldConfig<D extends PrimativeKey, E extends Pr
  * @template S - Key type for the map (string, defaults to string)
  * @param config - Configuration including the dencoder function
  * @returns A field mapping configuration for dencoder-mapped values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDencoderMap<D extends PrimativeKey, E extends PrimativeKey, S extends string = string>(config: FirestoreDencoderMapFieldConfig<D, E, S>): FirestoreModelFieldMapFunctionsConfig<FirestoreEncodedObjectMapFieldValueType<D[], S>, FirestoreMapFieldType<E, S>>;
 /**
@@ -922,6 +1143,7 @@ export declare function firestoreDencoderMap<D extends PrimativeKey, E extends P
  *
  * @param dencoder - The dencoder function used to encode and decode the role values
  * @returns A field mapping configuration for an encoded granted role map keyed by FirestoreModelKey
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyEncodedGrantedRoleMap<D extends GrantedRole, E extends string>(dencoder: PrimativeKeyStringDencoderFunction<D, E>): FirestoreModelFieldMapFunctionsConfig<FirestoreEncodedObjectMapFieldValueType<D[], string>, FirestoreMapFieldType<E, string>>;
 /**
@@ -938,6 +1160,10 @@ export type FirestoreArrayMapFieldConfig<T, K extends string = string> = Firesto
  * @template K - Key type for the map (string)
  * @param config - Configuration for the array map field
  * @returns A field mapping configuration for map values with array entries
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory map
+ * @dbxModelSnapshotFieldTags map, array, lookup, multi-value, factory
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreArrayMap<T, K extends string = string>(config?: FirestoreArrayMapFieldConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<T[], K>, FirestoreMapFieldType<T[], K>>;
 /**
@@ -946,6 +1172,7 @@ export declare function firestoreArrayMap<T, K extends string = string>(config?:
  * Filters empty roles/arrays by default.
  *
  * @returns A field mapping configuration for a map of granted role arrays keyed by FirestoreModelKey
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyGrantedRoleArrayMap<R extends GrantedRole>(): FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<R[], string>, FirestoreMapFieldType<R[], string>>;
 /**
@@ -987,6 +1214,7 @@ export type FirestoreObjectArrayFieldConfigFirestoreFieldInput<T extends object,
  *
  * @param config - The FirestoreModelFieldMapFunctionsConfig to convert
  * @returns A ModelMapFunctionsRef wrapping the derived map functions
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreFieldConfigToModelMapFunctionsRef<T extends object, O extends object = FirestoreModelData<T>>(config: FirestoreModelFieldMapFunctionsConfig<T, O>): ModelMapFunctionsRef<T, O>;
 /**
@@ -1011,6 +1239,11 @@ export declare function firestoreFieldConfigToModelMapFunctionsRef<T extends obj
  *   sortWith: sortAscendingIndexNumberRefFunction()
  * });
  * ```
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory object
+ * @dbxModelSnapshotFieldTags array, object, embedded, nested, structured, factory
+ * @dbxModelSnapshotFieldRelated firestore-sub-object
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreObjectArray<T extends object, O extends object = FirestoreModelData<T>>(config: FirestoreObjectArrayFieldConfig<T, O>): FirestoreModelFieldMapFunctionsConfig<T[], O[]>;
 /**
@@ -1052,6 +1285,11 @@ export type FirestoreSubObjectFieldMapFunctionsConfig<T extends object, O extend
  *   }
  * });
  * ```
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory object
+ * @dbxModelSnapshotFieldTags object, nested, embedded, structured, factory
+ * @dbxModelSnapshotFieldRelated firestore-object-array
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreSubObject<T extends object, O extends object = FirestoreModelData<T>>(config: FirestoreSubObjectFieldConfig<T, O>): FirestoreSubObjectFieldMapFunctionsConfig<T, O>;
 export interface FirestoreLatLngStringConfig extends DefaultMapConfiguredFirestoreFieldConfig<LatLngString, LatLngString> {
@@ -1069,6 +1307,16 @@ export interface FirestoreLatLngStringConfig extends DefaultMapConfiguredFiresto
  *
  * @param config - Optional precision and default value configuration
  * @returns A field mapping configuration for LatLngString values
+ * @dbxModelSnapshotField
+ * @dbxModelSnapshotFieldCategory geo
+ * @dbxModelSnapshotFieldTags geo, latlng, location, coordinates, coords, geolocation, factory
+ * @example
+ * ```ts
+ * fields: {
+ *   loc: firestoreLatLngString()
+ * }
+ * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreLatLngString(config?: FirestoreLatLngStringConfig): FirestoreModelFieldMapFunctionsConfig<`${number},${number}`, `${number},${number}`>;
 export type FirestoreTimezoneStringConfig = DefaultMapConfiguredFirestoreFieldConfig<TimezoneString, TimezoneString>;
@@ -1079,6 +1327,7 @@ export type FirestoreTimezoneStringConfig = DefaultMapConfiguredFirestoreFieldCo
  *
  * @param config - Optional configuration for the timezone string field, including default value and pre-save default.
  * @returns A configured Firestore field that stores a TimezoneString value.
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreTimezoneString(config?: FirestoreTimezoneStringConfig): FirestoreModelFieldMapFunctionsConfig<string, string>;
 export declare const DEFAULT_WEBSITE_LINK: WebsiteLink;
@@ -1088,12 +1337,14 @@ export declare const firestoreWebsiteLinkAssignFn: MapFunction<WebsiteLink, Webs
  * Creates a field mapping configuration for Firestore website link fields.
  *
  * @returns A field mapping configuration for website link values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreWebsiteLink(): FirestoreModelFieldMapFunctionsConfig<WebsiteLink, WebsiteLink>;
 /**
  * Creates a field mapping configuration for Firestore arrays of WebsiteLink values.
  *
  * @returns A field mapping configuration for WebsiteLink array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreWebsiteLinkArray(): FirestoreModelFieldMapFunctionsConfig<WebsiteLink[], WebsiteLink[]>;
 export declare const DEFAULT_FIRESTORE_WEBSITE_FILE_LINK_VALUE: WebsiteFileLink;
@@ -1103,18 +1354,21 @@ export declare const firestoreWebsiteFileLinkAssignFn: MapFunction<WebsiteFileLi
  * Creates a field mapping configuration for Firestore website file link fields.
  *
  * @returns A field mapping configuration for website file link values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreWebsiteFileLink(): FirestoreModelFieldMapFunctionsConfig<WebsiteFileLink, WebsiteFileLink>;
 /**
  * Stores the array of WebsiteFileLink values as an array of objects.
  *
  * @returns A field mapping configuration for WebsiteFileLink array values stored as objects
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreWebsiteFileLinkObjectArray(): FirestoreModelFieldMapFunctionsConfig<WebsiteFileLink[], WebsiteFileLink[]>;
 /**
  * Stores the array of WebsiteFileLink values as an array of EncodedWebsiteFileLink values.
  *
  * @returns A field mapping configuration for WebsiteFileLink array values stored in encoded form
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreWebsiteFileLinkEncodedArray(): FirestoreModelFieldMapFunctionsConfig<WebsiteFileLink[], string[]>;
 export declare const DEFAULT_DATE_CELL_RANGE_VALUE: DateCellRange;
@@ -1124,6 +1378,7 @@ export declare const firestoreDateCellRangeAssignFn: MapFunction<DateCellRange,
  * Creates a field mapping configuration for Firestore date cell range fields.
  *
  * @returns A field mapping configuration for date cell range values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDateCellRange(): FirestoreModelFieldMapFunctionsConfig<DateCellRange, DateCellRange>;
 /**
@@ -1131,6 +1386,7 @@ export declare function firestoreDateCellRange(): FirestoreModelFieldMapFunction
  *
  * @param sort - Whether to sort the array by index number; defaults to true
  * @returns A field mapping configuration for DateCellRange array values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDateCellRangeArray(sort?: boolean): FirestoreModelFieldMapFunctionsConfig<DateCellRange[], DateCellRange[]>;
 export declare const DEFAULT_FIRESTORE_DATE_CELL_SCHEDULE_VALUE: DateCellSchedule;
@@ -1140,6 +1396,7 @@ export declare const firestoreDateCellScheduleAssignFn: MapFunction<DateCellSche
  * Creates a field mapping configuration for Firestore date cell schedule fields.
  *
  * @returns A field mapping configuration for date cell schedule values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDateCellSchedule(): FirestoreModelFieldMapFunctionsConfig<DateCellSchedule, DateCellSchedule>;
 export declare const DEFAULT_FIRESTORE_UNITED_STATES_ADDRESS_VALUE: UnitedStatesAddress;
@@ -1158,12 +1415,14 @@ export declare const firestoreUnitedStatesAddressAssignFn: MapFunction<UnitedSta
  * Creates a field mapping configuration for Firestore United States address fields.
  *
  * @returns A field mapping configuration for United States address values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreUnitedStatesAddress(): FirestoreModelFieldMapFunctionsConfig<UnitedStatesAddress, UnitedStatesAddress>;
 /**
  * Creates a field mapping configuration for optional Firestore United States address fields.
  *
  * @returns A field mapping configuration for optional United States address values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreUnitedStatesAddress(): FirestoreModelFieldMapFunctionsConfig<Maybe<UnitedStatesAddress>, Maybe<UnitedStatesAddress>>;
 export declare const MIN_FIRESTORE_MAP_ZOOM_LEVEL_VALUE: ZoomLevel;
@@ -1191,6 +1450,7 @@ export interface FirestoreBitwiseSetConfig<D extends number = number> extends De
  * @template D - Type of number elements in the set (defaults to number)
  * @param config - Configuration for the bitwise set field
  * @returns A field mapping configuration for bitwise-encoded set values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreBitwiseSet<D extends number = number>(config: FirestoreBitwiseSetConfig<D>): FirestoreModelFieldMapFunctionsConfig<Set<D>, number>;
 /**
@@ -1212,6 +1472,7 @@ export interface FirestoreBitwiseSetMapConfig<D extends number = number, K exten
  * @template K - Type of keys in the object (string)
  * @param config - Configuration for the bitwise set map field
  * @returns A field mapping configuration for object maps with bitwise-encoded set values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreBitwiseSetMap<D extends number = number, K extends string = string>(config: FirestoreBitwiseSetMapConfig<D, K>): FirestoreModelFieldMapFunctionsConfig<FirestoreEncodedObjectMapFieldValueType<Set<D>, K>, FirestoreMapFieldType<number, K>>;
 /**
@@ -1233,5 +1494,6 @@ export interface FirestoreBitwiseObjectMapConfig<T extends object, K extends str
  * @template K - Type of keys in the object (string)
  * @param config - Configuration for the bitwise object map field
  * @returns A field mapping configuration for object maps with bitwise-encoded object values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreBitwiseObjectMap<T extends object, K extends string = string>(config: FirestoreBitwiseObjectMapConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<FirestoreEncodedObjectMapFieldValueType<T, K>, FirestoreMapFieldType<number, K>>;

package/src/lib/common/firestore/util/id.batch.d.ts

@@ -73,5 +73,6 @@ export type FirestoreIdBatchVerifierFactory<T, I extends PrimativeKey> = Factory
  * const verifier = factory(myCollection);
  * // verifier can now check batches of IDs for uniqueness
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreIdBatchVerifierFactory<T, I extends PrimativeKey>(config: FirestoreIdBatchVerifierFactoryConfig<T, I>): FirestoreIdBatchVerifierFactory<T, I>;

package/src/lib/common/model/function.d.ts

@@ -50,6 +50,7 @@ export type OnCallTypeModelParamsFunction = <T>(modelTypeInput: FirestoreModelTy
  * const params = createParams('notification', { title: 'Hello' });
  * // params === { call: 'create', modelType: 'notification', data: { title: 'Hello' } }
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function onCallTypedModelParamsFunction(call?: Maybe<OnCallFunctionType>): OnCallTypeModelParamsFunction;
 /**