@dereekb/firebase 4.0.0 → 5.0.0

package/src/lib/common/firestore/query/watcher.js

@@ -16,15 +16,19 @@ function iterationQueryDocChangeWatcher(config) {
         )));
     }), (0, rxjs_1.shareReplay)(1));
     const event$ = stream$.pipe((0, rxjs_1.map)(event => {
-        var _a, _b, _c;
         const changes = event.docChanges();
-        const results = (0, util_1.groupValues)(changes, (x) => x.type);
-        results.time = new Date();
-        results.changes = changes;
-        results.added = (_a = results.added) !== null && _a !== void 0 ? _a : [];
-        results.removed = (_b = results.removed) !== null && _b !== void 0 ? _b : [];
-        results.modified = (_c = results.modified) !== null && _c !== void 0 ? _c : [];
-        results.type = iterationQueryDocChangeWatcherChangeTypeForGroup(results);
+        const results = (0, util_1.build)({
+            base: (0, util_1.groupValues)(changes, (x) => x.type),
+            build: (x) => {
+                var _a, _b, _c;
+                x.time = new Date();
+                x.changes = changes;
+                x.added = (_a = x.added) !== null && _a !== void 0 ? _a : [];
+                x.removed = (_b = x.removed) !== null && _b !== void 0 ? _b : [];
+                x.modified = (_c = x.modified) !== null && _c !== void 0 ? _c : [];
+                x.type = iterationQueryDocChangeWatcherChangeTypeForGroup(x);
+            }
+        });
         return results;
     }), (0, rxjs_1.shareReplay)(1));
     return {

package/src/lib/common/firestore/query/watcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"watcher.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/query/watcher.ts"],"names":[],"mappings":";;;AAAA,wCAA4C;AAC5C,wCAA0C;AAC1C,+BAA4E;AAI/D,QAAA,kCAAkC,GAAG,CAAC,CAAC;AAsCpD,SAAgB,8BAA8B,CAAU,MAA+C;IACrG,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,GAAG,0CAAkC,EAAE,GAAG,MAAM,CAAC;IAEzF,MAAM,OAAO,GAAG,QAAQ,CAAC,iBAAiB,CAAC,2BAA2B,CAAC,IAAI,CACzE,IAAA,gBAAS,EAAC,CAAC,KAAK,EAAE,EAAE;;QAClB,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,KAAM,CAAC,KAAM,CAAC;QAC7C,MAAM,eAAe,GAAG,IAAA,gBAAS,EAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QAEzD,gDAAgD;QAChD,OAAO,IAAA,YAAK,EAAC,MAAA,eAAe,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAS,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CACtF,IAAA,WAAI,EAAC,CAAC,CAAC,CAAE,+EAA+E;SACzF,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,EACF,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;IAEF,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CACzB,IAAA,UAAG,EAAC,KAAK,CAAC,EAAE;;QACV,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QAEnC,MAAM,OAAO,GAAQ,IAAA,kBAAW,EAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzD,OAAO,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAC1B,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;QAC1B,OAAO,CAAC,KAAK,GAAG,MAAA,OAAO,CAAC,KAAK,mCAAI,EAAE,CAAC;QACpC,OAAO,CAAC,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC;QACxC,OAAO,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,EAAE,CAAC;QAC1C,OAAO,CAAC,IAAI,GAAG,gDAAgD,CAAC,OAAO,CAAC,CAAC;QAEzE,OAAO,OAAiD,CAAC;IAC3D,CAAC,CAAC,EACF,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;IAEF,OAAO;QACL,OAAO;QACP,MAAM;KACP,CAAC;AACJ,CAAC;AArCD,wEAqCC;AAED,SAAgB,gDAAgD,CAAU,KAAmD;IAC3H,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACxC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5C,IAAI,IAA8C,CAAC;IAEnD,IAAI,QAAQ,IAAI,UAAU,EAAE;QAC1B,IAAI,GAAG,iBAAiB,CAAC;KAC1B;SAAM,IAAI,QAAQ,EAAE;QACnB,IAAI,GAAG,OAAO,CAAC;KAChB;SAAM,IAAI,UAAU,EAAE;QACrB,IAAI,GAAG,SAAS,CAAC;KAClB;SAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACpC,IAAI,GAAG,UAAU,CAAC;KACnB;SAAM;QACL,IAAI,GAAG,MAAM,CAAC;KACf;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAlBD,4GAkBC"}
+{"version":3,"file":"watcher.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/query/watcher.ts"],"names":[],"mappings":";;;AAAA,wCAA6D;AAC7D,wCAA0C;AAC1C,+BAA4E;AAK/D,QAAA,kCAAkC,GAAG,CAAC,CAAC;AAsCpD,SAAgB,8BAA8B,CAAc,MAA+C;IACzG,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,GAAG,0CAAkC,EAAE,GAAG,MAAM,CAAC;IAEzF,MAAM,OAAO,GAAG,QAAQ,CAAC,iBAAiB,CAAC,2BAA2B,CAAC,IAAI,CACzE,IAAA,gBAAS,EAAC,CAAC,KAAK,EAAE,EAAE;;QAClB,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAI,KAAK,CAAC,KAAiE,CAAC,KAAwC,CAAC;QAC3I,MAAM,eAAe,GAAG,IAAA,gBAAS,EAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QAEzD,gDAAgD;QAChD,OAAO,IAAA,YAAK,EAAC,MAAA,eAAe,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAS,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CACtF,IAAA,WAAI,EAAC,CAAC,CAAC,CAAE,+EAA+E;SACzF,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,EACF,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;IAEF,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CACzB,IAAA,UAAG,EAAC,KAAK,CAAC,EAAE;QACV,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QAEnC,MAAM,OAAO,GAAG,IAAA,YAAK,EAAC;YACpB,IAAI,EAAE,IAAA,kBAAW,EAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAqD;YAC7F,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE;;gBACX,CAAC,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBACpB,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC;gBACpB,CAAC,CAAC,KAAK,GAAG,MAAA,CAAC,CAAC,KAAK,mCAAI,EAAE,CAAC;gBACxB,CAAC,CAAC,OAAO,GAAG,MAAA,CAAC,CAAC,OAAO,mCAAI,EAAE,CAAC;gBAC5B,CAAC,CAAC,QAAQ,GAAG,MAAA,CAAC,CAAC,QAAQ,mCAAI,EAAE,CAAC;gBAC9B,CAAC,CAAC,IAAI,GAAG,gDAAgD,CAAC,CAA2C,CAAC,CAAC;YACzG,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,EACF,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;IAEF,OAAO;QACL,OAAO;QACP,MAAM;KACP,CAAC;AACJ,CAAC;AAzCD,wEAyCC;AAED,SAAgB,gDAAgD,CAAc,KAAmD;IAC/H,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACxC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5C,IAAI,IAA8C,CAAC;IAEnD,IAAI,QAAQ,IAAI,UAAU,EAAE;QAC1B,IAAI,GAAG,iBAAiB,CAAC;KAC1B;SAAM,IAAI,QAAQ,EAAE;QACnB,IAAI,GAAG,OAAO,CAAC;KAChB;SAAM,IAAI,UAAU,EAAE;QACrB,IAAI,GAAG,SAAS,CAAC;KAClB;SAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACpC,IAAI,GAAG,UAAU,CAAC;KACnB;SAAM;QACL,IAAI,GAAG,MAAM,CAAC;KACf;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAlBD,4GAkBC"}

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

@@ -1,13 +1,62 @@
-import { ModelFieldsConversionConfig, ApplyMapFunctionWithOptions } from "@dereekb/util";
-import { DocumentData, SnapshotOptions, SetOptions, DocumentSnapshot, FirestoreDataConverter } from "../types";
-export interface SnapshotConverterConfig<T extends object> {
-    fields: ModelFieldsConversionConfig<T>;
+import { MaybeMap, ModelFieldConversions, ApplyMapFunctionWithOptions, ModelFieldConversionsConfig, TypedMappedModelData } from "@dereekb/util";
+import { SnapshotOptions, SetOptions, DocumentSnapshot, FirestoreDataConverter } from "../types";
+/**
+ * The default "empty" value in the Firestore.
+ */
+export declare const FIRESTORE_EMPTY_VALUE: null;
+/**
+ * The expected firestore document data for a specific type.
+ *
+ * This declaration allows a second type to defined overrides for how the data is stored within Firestore. For example, since by default
+ * this library choses to store dates as an ISO8601String, you can strictly specify that, and gain the type checking benefits.
+ */
+export declare type ExpectedFirestoreModelData<T extends object, R extends object = object> = TypedMappedModelData<T, R>;
+/**
+ * What is considered the typings for the true "stored" data.
+ *
+ * All items are marked as partial and Maybe. This is because by design the firestore has no schema and has no obligation to require fields.
+ * It is better to be cognizant of this fact in our typings, and let the Snapshot conversions handle this.
+ *
+ * Fields that existing on the database type can only replace typings on the specific type, and not declare new typings.
+ * This is to prevent accidents related to adding/removing fields but not adding the correct conversions.
+ *
+ * This declaration allows a second type to defined overrides for how the data is stored within Firestore. For example, since by default
+ * this library choses to store dates as an ISO8601String, you can strictly specify that, and gain the type checking benefits. For other data types
+ * that are the same in the datastore as they are here, they are considered "any".
+ *
+ * The reason for this is that FirestoreModelData types are typically never used directly, execept for our snapshotConverterFunctions(),
+ * and using the built-in snapshot firestore field converters. Unless we have specified a strict new type that we expect in the data,
+ * most of the time we are unconcerned with the final type of our ExpectedFirestoreModelData.
+ *
+ * This is a more lose type that takes the above into account. You will only see typing information for fields of R that override the converted type T.
+ * If you find yourself needing full typings, extend ExpectedFirestoreModelData instead.
+ *
+ * Example:
+ *
+ * export interface MockItem {
+ *    string: string;
+ *    date: Date;
+ * }
+ *
+ * export type MockItemData = ExpectedFirestoreModelData<MockItem, {
+ *    // string field is not defined directly, will be treated as any.
+ *    date: string; // we want typescript typing help for this in our converters.
+ * }>;
+ *
+ */
+export declare type FirestoreModelData<T extends object, R extends object = object> = Partial<ExpectedFirestoreModelData<T, MaybeMap<R>>>;
+export declare type SnapshotConverterConfigWithFields<T extends object, O extends object = FirestoreModelData<T>> = {
+    fields: ModelFieldConversionsConfig<T, O>;
+};
+export declare type SnapshotConverterConfigWithConversions<T extends object, O extends object = FirestoreModelData<T>> = {
+    fieldConversions: ModelFieldConversions<T, O>;
+};
+export declare type SnapshotConverterConfig<T extends object, O extends object = FirestoreModelData<T>> = SnapshotConverterConfigWithFields<T, O> | SnapshotConverterConfigWithConversions<T, O>;
+export interface SnapshotConverterFunctions<T extends object, O extends object = FirestoreModelData<T>> extends FirestoreDataConverter<T, O> {
+    from: SnapshotConverterFromFunction<T, O>;
+    to: SnapshotConverterToFunction<T, O>;
 }
-export interface SnapshotConverterFunctions<T extends object> extends FirestoreDataConverter<T> {
-    from: SnapshotConverterFromFunction<T>;
-    to: SnapshotConverterToFunction<T>;
-}
-export declare type SnapshotConverterFromFirestoreFunction<T extends object> = (snapshot: DocumentSnapshot, options?: SnapshotOptions) => T;
-export declare type SnapshotConverterFromFunction<T extends object> = ApplyMapFunctionWithOptions<DocumentSnapshot, T, SnapshotOptions>;
-export declare type SnapshotConverterToFunction<T extends object> = ApplyMapFunctionWithOptions<T, DocumentData, SetOptions>;
-export declare function makeSnapshotConverterFunctions<T extends object>(config: SnapshotConverterConfig<T>): SnapshotConverterFunctions<T>;
+export declare type SnapshotConverterFromFirestoreFunction<T extends object, O extends object = FirestoreModelData<T>> = (snapshot: DocumentSnapshot<O>, options?: SnapshotOptions) => T;
+export declare type SnapshotConverterFromFunction<T extends object, O extends object = FirestoreModelData<T>> = ApplyMapFunctionWithOptions<DocumentSnapshot<O>, T, SnapshotOptions>;
+export declare type SnapshotConverterToFunction<T extends object, O extends object = FirestoreModelData<T>> = ApplyMapFunctionWithOptions<T, O, SetOptions>;
+export declare function snapshotConverterFunctions<T extends object, O extends object = FirestoreModelData<T>>(config: SnapshotConverterConfig<T, O>): SnapshotConverterFunctions<T, O>;

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

@@ -1,25 +1,42 @@
-import { MapFunction, ModelFieldConversionConfig, GetterOrValue } from '@dereekb/util';
-export declare type FirestoreDatastoreType = any;
-export interface FirestoreFieldConfig<V, D = any> {
-    default?: GetterOrValue<V>;
+import { ModelFieldMapFunctionsConfig, GetterOrValue, Maybe, ModelFieldMapConvertFunction } from '@dereekb/util';
+export interface BaseFirestoreFieldConfig<V, D = unknown> {
+    fromData: ModelFieldMapConvertFunction<D, V>;
+    toData: ModelFieldMapConvertFunction<V, D>;
     defaultBeforeSave?: GetterOrValue<D | null>;
-    fromData: MapFunction<D, V>;
-    toData: MapFunction<V, D>;
 }
-export interface DefaultOnlyFirestoreFieldConfig<V, D = any> extends Pick<FirestoreFieldConfig<V, D>, 'default' | 'defaultBeforeSave'> {
+export interface FirestoreFieldConfigWithDefault<V, D = unknown> extends BaseFirestoreFieldConfig<V, D> {
+    default: GetterOrValue<V>;
 }
-export declare function firestoreField<V, D = any>(config: FirestoreFieldConfig<V, D>): ModelFieldConversionConfig<V, D>;
-export interface FirestoreStringFieldConfig extends DefaultOnlyFirestoreFieldConfig<string, string> {
+export interface FirestoreFieldConfigWithDefaultData<V, D = unknown> extends BaseFirestoreFieldConfig<V, D> {
+    defaultData: GetterOrValue<D>;
 }
-export declare function firestoreString(config?: FirestoreStringFieldConfig): ModelFieldConversionConfig<string, string>;
-export declare function firestoreUID(): ModelFieldConversionConfig<string, string>;
-export interface FirestoreDateFieldConfig extends DefaultOnlyFirestoreFieldConfig<Date, string> {
+export declare type FirestoreFieldConfig<V, D = unknown> = FirestoreFieldConfigWithDefault<V, D> | FirestoreFieldConfigWithDefaultData<V, D>;
+/**
+ * All firebase ModelFieldMapFunctionsConfig are configured to handle the read field value as null/undefined. This implies that
+ * by design, the firebase database documents do not need to be fully intact for the system to handle them properly.
+ */
+export declare type FirestoreModelFieldMapFunctionsConfig<V, D> = ModelFieldMapFunctionsConfig<V, Maybe<D>>;
+export declare function firestoreField<V, D = unknown>(config: FirestoreFieldConfig<V, D>): FirestoreModelFieldMapFunctionsConfig<V, D>;
+export declare const FIRESTORE_PASSTHROUGH_FIELD: FirestoreModelFieldMapFunctionsConfig<unknown, unknown>;
+export declare function firestorePassThroughField<T>(): ModelFieldMapFunctionsConfig<T, T>;
+export declare type MapConfiguredFirestoreFieldConfigWithDefault<V, D = unknown> = Omit<FirestoreFieldConfigWithDefault<V, D>, 'fromData' | 'toData'>;
+export declare type MapConfiguredFirestoreFieldConfigWithDefaultData<V, D = unknown> = Omit<FirestoreFieldConfigWithDefaultData<V, D>, 'fromData' | 'toData'>;
+export declare type MapConfiguredFirestoreFieldConfig<V, D = unknown> = MapConfiguredFirestoreFieldConfigWithDefault<V, D> | MapConfiguredFirestoreFieldConfigWithDefaultData<V, D>;
+export declare type DefaultMapConfiguredFirestoreFieldConfig<V, D = unknown> = Omit<FirestoreFieldConfigWithDefault<V, D>, 'fromData' | 'toData' | 'default'> & Partial<Pick<FirestoreFieldConfigWithDefault<V, D>, 'default'>>;
+export declare type OptionalMapConfiguredFirestoreFieldConfig<V, D = unknown> = Omit<BaseFirestoreFieldConfig<V, D>, 'fromData' | 'toData' | 'defaultBeforeSave'>;
+export declare type FirestoreStringConfig = DefaultMapConfiguredFirestoreFieldConfig<string, string>;
+export declare function firestoreString(config: FirestoreStringConfig): FirestoreModelFieldMapFunctionsConfig<string, string>;
+export declare function optionalFirestoreString(): ModelFieldMapFunctionsConfig<Maybe<string>, Maybe<string>>;
+export declare function firestoreUID(): FirestoreModelFieldMapFunctionsConfig<string, string>;
+export declare function optionalFirestoreUID(): ModelFieldMapFunctionsConfig<Maybe<string>, Maybe<string>>;
+export declare type FirestoreDateFieldConfig = DefaultMapConfiguredFirestoreFieldConfig<Date, string> & {
     saveDefaultAsNow?: boolean;
-}
-export declare function firestoreDate(config?: FirestoreDateFieldConfig): ModelFieldConversionConfig<Date, string>;
-export interface FirestoreBooleanFieldConfig extends DefaultOnlyFirestoreFieldConfig<boolean, boolean> {
-}
-export declare function firestoreBoolean(config?: FirestoreBooleanFieldConfig): ModelFieldConversionConfig<boolean, boolean>;
-export interface FirestoreNumberFieldConfig extends DefaultOnlyFirestoreFieldConfig<number, number> {
-}
-export declare function firestoreNumber(config?: FirestoreNumberFieldConfig): ModelFieldConversionConfig<number, number>;
+};
+export declare function firestoreDate(config?: FirestoreDateFieldConfig): FirestoreModelFieldMapFunctionsConfig<Date, string>;
+export declare function optionalFirestoreDate(): FirestoreModelFieldMapFunctionsConfig<Maybe<Date>, Maybe<string>>;
+export declare type FirestoreBooleanFieldConfig = MapConfiguredFirestoreFieldConfigWithDefault<boolean, boolean>;
+export declare function firestoreBoolean(config: FirestoreBooleanFieldConfig): FirestoreModelFieldMapFunctionsConfig<boolean, boolean>;
+export declare function optionalFirestoreBoolean(): ModelFieldMapFunctionsConfig<Maybe<boolean>, Maybe<boolean>>;
+export declare type FirestoreNumberFieldConfig = MapConfiguredFirestoreFieldConfigWithDefault<number, number>;
+export declare function firestoreNumber(config: FirestoreNumberFieldConfig): FirestoreModelFieldMapFunctionsConfig<number, number>;
+export declare function optionalFirestoreNumber(): ModelFieldMapFunctionsConfig<Maybe<number>, Maybe<number>>;

package/src/lib/common/firestore/snapshot/snapshot.field.js

@@ -1,57 +1,95 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.firestoreNumber = exports.firestoreBoolean = exports.firestoreDate = exports.firestoreUID = exports.firestoreString = exports.firestoreField = void 0;
+exports.optionalFirestoreNumber = exports.firestoreNumber = exports.optionalFirestoreBoolean = exports.firestoreBoolean = exports.optionalFirestoreDate = exports.firestoreDate = exports.optionalFirestoreUID = exports.firestoreUID = exports.optionalFirestoreString = exports.firestoreString = exports.firestorePassThroughField = exports.FIRESTORE_PASSTHROUGH_FIELD = exports.firestoreField = void 0;
 const date_1 = require("@dereekb/date");
+const util_1 = require("@dereekb/util");
+const snapshot_1 = require("./snapshot");
+;
+;
 function firestoreField(config) {
     var _a;
     return {
-        from: {
+        from: (config.default) ? {
             default: config.default,
             convert: config.fromData
+        } : {
+            defaultInput: config.defaultData,
+            convert: config.fromData
         },
         to: {
-            default: (_a = config.defaultBeforeSave) !== null && _a !== void 0 ? _a : null,
+            default: (_a = config.defaultBeforeSave) !== null && _a !== void 0 ? _a : snapshot_1.FIRESTORE_EMPTY_VALUE,
             convert: config.toData
         }
     };
 }
 exports.firestoreField = firestoreField;
-function firestoreString(config = {}) {
-    return firestoreField({
-        default: config.default,
-        fromData: (input) => input,
-        toData: (input) => input
-    });
+exports.FIRESTORE_PASSTHROUGH_FIELD = firestoreField({
+    default: null,
+    fromData: util_1.passThrough,
+    toData: util_1.passThrough,
+});
+function firestorePassThroughField() {
+    return exports.FIRESTORE_PASSTHROUGH_FIELD;
+}
+exports.firestorePassThroughField = firestorePassThroughField;
+function firestoreString(config) {
+    return firestoreField(Object.assign(Object.assign({ default: '' }, config), { fromData: util_1.passThrough, toData: util_1.passThrough }));
 }
 exports.firestoreString = firestoreString;
+function optionalFirestoreString() {
+    return firestorePassThroughField();
+}
+exports.optionalFirestoreString = optionalFirestoreString;
 function firestoreUID() {
-    return firestoreString({});
+    return firestoreString({
+        default: ''
+    });
 }
 exports.firestoreUID = firestoreUID;
+function optionalFirestoreUID() {
+    return optionalFirestoreString();
+}
+exports.optionalFirestoreUID = optionalFirestoreUID;
 function firestoreDate(config = {}) {
-    var _a;
+    var _a, _b;
     return firestoreField({
-        default: config.default,
-        defaultBeforeSave: (_a = config.defaultBeforeSave) !== null && _a !== void 0 ? _a : (config.saveDefaultAsNow ? () => (0, date_1.toISODateString)(new Date()) : null),
+        default: (_a = config.default) !== null && _a !== void 0 ? _a : (() => new Date()),
+        defaultBeforeSave: (_b = config.defaultBeforeSave) !== null && _b !== void 0 ? _b : (config.saveDefaultAsNow ? date_1.nowISODateString : null),
         fromData: (input) => (0, date_1.toJsDate)(input),
         toData: (input) => (0, date_1.toISODateString)(input)
     });
 }
 exports.firestoreDate = firestoreDate;
-function firestoreBoolean(config = {}) {
+function optionalFirestoreDate() {
+    return firestoreField({
+        default: null,
+        fromData: (input) => (0, date_1.toJsDate)(input),
+        toData: (input) => (0, date_1.toISODateString)(input)
+    });
+}
+exports.optionalFirestoreDate = optionalFirestoreDate;
+function firestoreBoolean(config) {
     return firestoreField({
         default: config.default,
-        fromData: (input) => input,
-        toData: (input) => input
+        fromData: util_1.passThrough,
+        toData: util_1.passThrough,
     });
 }
 exports.firestoreBoolean = firestoreBoolean;
-function firestoreNumber(config = {}) {
+function optionalFirestoreBoolean() {
+    return firestorePassThroughField();
+}
+exports.optionalFirestoreBoolean = optionalFirestoreBoolean;
+function firestoreNumber(config) {
     return firestoreField({
         default: config.default,
-        fromData: (input) => input,
-        toData: (input) => input
+        fromData: util_1.passThrough,
+        toData: util_1.passThrough,
     });
 }
 exports.firestoreNumber = firestoreNumber;
+function optionalFirestoreNumber() {
+    return firestorePassThroughField();
+}
+exports.optionalFirestoreNumber = optionalFirestoreNumber;
 //# sourceMappingURL=snapshot.field.js.map

package/src/lib/common/firestore/snapshot/snapshot.field.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot.field.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/snapshot/snapshot.field.ts"],"names":[],"mappings":";;;AAAA,wCAA0D;AAc1D,SAAgB,cAAc,CAAa,MAAkC;;IAC3E,OAAO;QACL,IAAI,EAAE;YACJ,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,MAAM,CAAC,QAAQ;SACzB;QACD,EAAE,EAAE;YACF,OAAO,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,IAAW;YAChD,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB;KACF,CAAA;AACH,CAAC;AAXD,wCAWC;AAID,SAAgB,eAAe,CAAC,SAAqC,EAAE;IACrE,OAAO,cAAc,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK;QAClC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK;KACjC,CAAC,CAAC;AACL,CAAC;AAND,0CAMC;AAED,SAAgB,YAAY;IAC1B,OAAO,eAAe,CAAC,EAAE,CAAC,CAAC;AAC7B,CAAC;AAFD,oCAEC;AAMD,SAAgB,aAAa,CAAC,SAAmC,EAAE;;IACjE,OAAO,cAAc,CAAe;QAClC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,iBAAiB,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAA,sBAAe,EAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnH,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,eAAQ,EAAC,KAAK,CAAC;QAC5C,MAAM,EAAE,CAAC,KAAW,EAAE,EAAE,CAAC,IAAA,sBAAe,EAAC,KAAK,CAAC;KAChD,CAAC,CAAC;AACL,CAAC;AAPD,sCAOC;AAID,SAAgB,gBAAgB,CAAC,SAAsC,EAAE;IACvE,OAAO,cAAc,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK;QACnC,MAAM,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK;KAClC,CAAC,CAAC;AACL,CAAC;AAND,4CAMC;AAID,SAAgB,eAAe,CAAC,SAAqC,EAAE;IACrE,OAAO,cAAc,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK;QAClC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK;KACjC,CAAC,CAAC;AACL,CAAC;AAND,0CAMC"}
+{"version":3,"file":"snapshot.field.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/snapshot/snapshot.field.ts"],"names":[],"mappings":";;;AAAA,wCAA4E;AAC5E,wCAA8H;AAC9H,yCAAmD;AAUlD,CAAC;AAID,CAAC;AAUF,SAAgB,cAAc,CAAiB,MAAkC;;IAC/E,OAAO;QACL,IAAI,EAAE,CAAE,MAAgD,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAClE,OAAO,EAAG,MAAgD,CAAC,OAAO;YAClE,OAAO,EAAE,MAAM,CAAC,QAAQ;SACzB,CAAC,CAAC,CAAC;YACF,YAAY,EAAG,MAAoD,CAAC,WAAW;YAC/E,OAAO,EAAE,MAAM,CAAC,QAAQ;SACzB;QACD,EAAE,EAAE;YACF,OAAO,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,gCAAqB;YAC1D,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB;KAC6C,CAAC;AACnD,CAAC;AAdD,wCAcC;AAEY,QAAA,2BAA2B,GAAG,cAAc,CAAmB;IAC1E,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,kBAAW;IACrB,MAAM,EAAE,kBAAW;CACpB,CAAC,CAAC;AAEH,SAAgB,yBAAyB;IACvC,OAAO,mCAAiE,CAAC;AAC3E,CAAC;AAFD,8DAEC;AAWD,SAAgB,eAAe,CAAC,MAA6B;IAC3D,OAAO,cAAc,+BACnB,OAAO,EAAE,EAAE,IACR,MAAM,KACT,QAAQ,EAAE,kBAAW,EACrB,MAAM,EAAE,kBAAW,IACnB,CAAC;AACL,CAAC;AAPD,0CAOC;AAED,SAAgB,uBAAuB;IACrC,OAAO,yBAAyB,EAAiB,CAAC;AACpD,CAAC;AAFD,0DAEC;AAED,SAAgB,YAAY;IAC1B,OAAO,eAAe,CAAC;QACrB,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;AACL,CAAC;AAJD,oCAIC;AAED,SAAgB,oBAAoB;IAClC,OAAO,uBAAuB,EAAE,CAAC;AACnC,CAAC;AAFD,oDAEC;AAMD,SAAgB,aAAa,CAAC,SAAmC,EAAE;;IACjE,OAAO,cAAc,CAAe;QAClC,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC7C,iBAAiB,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,uBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC;QAClG,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,eAAQ,EAAC,KAAK,CAAC;QAC5C,MAAM,EAAE,CAAC,KAAW,EAAE,EAAE,CAAC,IAAA,sBAAe,EAAC,KAAK,CAAC;KAChD,CAAC,CAAC;AACL,CAAC;AAPD,sCAOC;AAED,SAAgB,qBAAqB;IACnC,OAAO,cAAc,CAA6B;QAChD,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,eAAQ,EAAC,KAAK,CAAC;QAC5C,MAAM,EAAE,CAAC,KAAW,EAAE,EAAE,CAAC,IAAA,sBAAe,EAAC,KAAK,CAAC;KAChD,CAAC,CAAC;AACL,CAAC;AAND,sDAMC;AAID,SAAgB,gBAAgB,CAAC,MAAmC;IAClE,OAAO,cAAc,CAAmB;QACtC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,kBAAW;KACpB,CAAC,CAAC;AACL,CAAC;AAND,4CAMC;AAED,SAAgB,wBAAwB;IACtC,OAAO,yBAAyB,EAAkB,CAAC;AACrD,CAAC;AAFD,4DAEC;AAID,SAAgB,eAAe,CAAC,MAAkC;IAChE,OAAO,cAAc,CAAiB;QACpC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,kBAAW;KACpB,CAAC,CAAC;AACL,CAAC;AAND,0CAMC;AAED,SAAgB,uBAAuB;IACrC,OAAO,yBAAyB,EAAiB,CAAC;AACpD,CAAC;AAFD,0DAEC"}

package/src/lib/common/firestore/snapshot/snapshot.js

@@ -1,11 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeSnapshotConverterFunctions = void 0;
+exports.snapshotConverterFunctions = exports.FIRESTORE_EMPTY_VALUE = void 0;
 const util_1 = require("@dereekb/util");
 const types_1 = require("../types");
-function makeSnapshotConverterFunctions(config) {
-    const { from: fromData, to: toData } = (0, util_1.makeModelMapFunctions)(config.fields);
-    const from = (input, target, options) => {
+// MARK: Type
+/**
+ * The default "empty" value in the Firestore.
+ */
+exports.FIRESTORE_EMPTY_VALUE = null;
+function snapshotConverterFunctions(config) {
+    var _a;
+    const conversions = (_a = config.fieldConversions) !== null && _a !== void 0 ? _a : (0, util_1.modelFieldConversions)(config.fields);
+    const { from: fromData, to: toData } = (0, util_1.makeModelMapFunctions)(conversions);
+    const from = (input, target) => {
         const data = input.data();
         return fromData(data, target);
     };
@@ -31,5 +38,5 @@ function makeSnapshotConverterFunctions(config) {
         toFirestore: (modelObject, options) => to(modelObject, undefined, options)
     };
 }
-exports.makeSnapshotConverterFunctions = makeSnapshotConverterFunctions;
+exports.snapshotConverterFunctions = snapshotConverterFunctions;
 //# sourceMappingURL=snapshot.js.map

package/src/lib/common/firestore/snapshot/snapshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/snapshot/snapshot.ts"],"names":[],"mappings":";;;AAAA,wCAA+I;AAC/I,oCAAoN;AAgBpN,SAAgB,8BAA8B,CAAmB,MAAkC;IACjG,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAqB,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE5E,MAAM,IAAI,GAAqC,CAAC,KAAuB,EAAE,MAA0B,EAAE,OAAgC,EAAE,EAAE;QACvI,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,OAAO,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC,CAAC;IAEF,MAAM,EAAE,GAAmC,CAAC,KAAQ,EAAE,MAAqC,EAAE,OAA2B,EAAE,EAAE;QAC1H,IAAI,SAAmD,CAAC;QAExD,IAAI,OAAO,EAAE;YACX,MAAM,WAAW,GAAI,OAAiC,CAAC,WAAW,CAAC;YAEnE,IAAK,OAA2B,CAAC,KAAK,EAAE;gBACtC,SAAS,GAAG;oBACV,WAAW,EAAE,IAAI;iBAClB,CAAC;aACH;YAED,IAAI,WAAW,EAAE;gBACf,SAAS,mCACJ,SAAS,KACZ,MAAM,EAAE,IAAA,4BAAoB,EAAC,WAAW,CAAgB,GACzD,CAAC;aACH;SACF;QAED,OAAO,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,EAAE;QACF,aAAa,EAAE,CAAC,QAA0B,EAAE,OAAyB,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;QAC5G,WAAW,EAAE,CAAC,WAAyD,EAAE,OAAoB,EAAE,EAAE,CAAC,EAAE,CAAC,WAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;KAC3I,CAAA;AACH,CAAC;AArCD,wEAqCC"}
+{"version":3,"file":"snapshot.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/snapshot/snapshot.ts"],"names":[],"mappings":";;;AAAA,wCAA6N;AAC7N,oCAAsM;AAEtM,aAAa;AACb;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAI,CAAC;AAiE1C,SAAgB,0BAA0B,CAA6D,MAAqC;;IAC1I,MAAM,WAAW,GACf,MAAC,MAAuD,CAAC,gBAAgB,mCAAI,IAAA,4BAAqB,EAAQ,MAAkD,CAAC,MAAM,CAAC,CAAC;IACvK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAA,4BAAqB,EAAO,WAAW,CAAC,CAAC;IAEhF,MAAM,IAAI,GAAwC,CAAC,KAAuB,EAAE,MAA0B,EAAE,EAAE;QACxG,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,OAAO,QAAQ,CAAC,IAAS,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF,MAAM,EAAE,GAAsC,CAAC,KAAQ,EAAE,MAA0B,EAAE,OAA2B,EAAE,EAAE;QAClH,IAAI,SAA2C,CAAC;QAEhD,IAAI,OAAO,EAAE;YACX,MAAM,WAAW,GAAI,OAAiC,CAAC,WAAW,CAAC;YAEnE,IAAK,OAA2B,CAAC,KAAK,EAAE;gBACtC,SAAS,GAAG;oBACV,WAAW,EAAE,IAAI;iBAClB,CAAC;aACH;YAED,IAAI,WAAW,EAAE;gBACf,SAAS,mCACJ,SAAS,KACZ,MAAM,EAAE,IAAA,4BAAoB,EAAC,WAAW,CAAgB,GACzD,CAAC;aACH;SACF;QAED,OAAO,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,EAAE;QACF,aAAa,EAAE,CAAC,QAA6B,EAAE,OAAyB,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;QAC/G,WAAW,EAAE,CAAC,WAAyD,EAAE,OAAoB,EAAE,EAAE,CAAC,EAAE,CAAC,WAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;KAC3I,CAAA;AACH,CAAC;AAvCD,gEAuCC"}

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

@@ -73,10 +73,10 @@ export interface SnapshotListenOptions {
 /**
  * Mirrors the types/methods of FirestoreDataConverter.
  */
-export interface FirestoreDataConverter<T> {
-    toFirestore(modelObject: WithFieldValue<T>): DocumentData;
-    toFirestore(modelObject: PartialWithFieldValue<T>, options: SetOptions): DocumentData;
-    fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData>, options?: SnapshotOptions): T;
+export interface FirestoreDataConverter<T, O = DocumentData> {
+    toFirestore(modelObject: WithFieldValue<T>): O;
+    toFirestore(modelObject: PartialWithFieldValue<T>, options: SetOptions): O;
+    fromFirestore(snapshot: QueryDocumentSnapshot<O>, options?: SnapshotOptions): T;
 }
 export interface DocumentReference<T = DocumentData> {
     readonly converter?: FirestoreDataConverter<T> | null;
@@ -96,8 +96,13 @@ export interface CollectionReference<T = DocumentData> extends Query<T> {
     withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
     withConverter(converter: null): CollectionReference<DocumentData>;
 }
-export declare type WriteBatch = {};
-export declare type Transaction = {};
+export interface WriteBatch {
+    /**
+     * Commits the changes.
+     */
+    commit(): Promise<WriteResult[] | void>;
+}
+export declare type Transaction = object;
 export interface Query<T = DocumentData> {
     readonly converter?: FirestoreDataConverter<T> | null;
     readonly type?: 'query' | 'collection';
@@ -114,7 +119,7 @@ export interface QuerySnapshot<T = DocumentData> {
     readonly docs: Array<QueryDocumentSnapshot<T>>;
     readonly size: number;
     readonly empty: boolean;
-    forEach(callback: (result: QueryDocumentSnapshot<T>) => void, thisArg?: any): void;
+    forEach(callback: (result: QueryDocumentSnapshot<T>) => void, thisArg?: unknown): void;
     docChanges(): DocumentChange<T>[];
 }
 export interface QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<T> {

package/src/lib/common/firestore/types.js

@@ -1,5 +1,6 @@
 "use strict";
 // A set of copied types from @google-cloud/firestore and firebase/firestore to allow cross-compatability.
+/* eslint-disable */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.asTopLevelFieldPath = exports.asTopLevelFieldPaths = void 0;
 function asTopLevelFieldPaths(input) {
@@ -20,4 +21,5 @@ function asTopLevelFieldPath(input) {
 exports.asTopLevelFieldPath = asTopLevelFieldPath;
 ;
 ;
+;
 //# sourceMappingURL=types.js.map

package/src/lib/common/firestore/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/firestore/types.ts"],"names":[],"mappings":";AAAA,0GAA0G;;;AA6C1G,SAAgB,oBAAoB,CAAC,KAA6B;IAChE,OAAO,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AACxC,CAAC;AAFD,oDAEC;AAED,SAAgB,mBAAmB,CAAC,KAA2B;IAC7D,IAAI,IAAY,CAAC;IAEjB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAI,GAAG,KAAK,CAAC;KACd;SAAM;QACL,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC/B;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,kDAWC;AAgCA,CAAC;AAID,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/firestore/types.ts"],"names":[],"mappings":";AAAA,0GAA0G;AAC1G,oBAAoB;;;AA6CpB,SAAgB,oBAAoB,CAAC,KAA6B;IAChE,OAAO,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AACxC,CAAC;AAFD,oDAEC;AAED,SAAgB,mBAAmB,CAAC,KAA2B;IAC7D,IAAI,IAAY,CAAC;IAEjB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAI,GAAG,KAAK,CAAC;KACd;SAAM;QACL,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC/B;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,kDAWC;AAgCA,CAAC;AAID,CAAC;AAkDD,CAAC"}

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

@@ -8,5 +8,4 @@ export interface UserRelated {
 /**
  * The model is related to a user by the model's own identifier.
  */
-export interface UserRelatedById {
-}
+export declare type UserRelatedById = object;

package/test/CHANGELOG.md

@@ -2,4 +2,26 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [5.0.0](https://github.com/dereekb/dbx-components/compare/v4.1.0-dev...v5.0.0) (2022-05-25)
+
+
+### Code Refactoring
+
+* refactored @dereekb/firebase snapshot field ([c88d278](https://github.com/dereekb/dbx-components/commit/c88d2780d66f965a41ae299e013109f6860e9496))
+
+
+### BREAKING CHANGES
+
+* refactored @dereekb/firebase SnapshotConverterFunction and related components and @dereekb/util model conversion components to have better type safety and inference
+
+
+
+# [4.1.0](https://github.com/dereekb/dbx-components/compare/v4.0.1-dev...v4.1.0) (2022-05-17)
+
+
+
+## [4.0.1](https://github.com/dereekb/dbx-components/compare/v4.0.0-dev...v4.0.1) (2022-05-14)
+
+
+
 # [4.0.0](https://github.com/dereekb/dbx-components/compare/v3.0.0...v4.0.0) (2022-05-14)

package/test/package.json

@@ -1,28 +1,27 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
   "dependencies": {},
   "peerDependencies": {
-    "@dereekb/util/test": "4.0.0",
-    "@dereekb/util": "4.0.0",
+    "@dereekb/util/test": "5.0.0",
+    "@dereekb/util": "5.0.0",
     "make-error": "^1.3.0",
     "extra-set": "^2.2.11",
-    "change-case": "^4.1.2",
-    "@dereekb/firebase": "4.0.0",
+    "@dereekb/firebase": "5.0.0",
     "rxjs": "^7.0.0",
     "rxfire": "^6.0.3",
     "firebase": "^9.8.0",
-    "@dereekb/rxjs": "4.0.0",
+    "@dereekb/rxjs": "5.0.0",
     "ms": "^3.0.0-canary.1",
-    "@dereekb/date": "4.0.0",
+    "@dereekb/date": "5.0.0",
     "class-transformer": "^0.5.1",
     "date-fns": "^2.28.0",
     "class-validator": "^0.13.2",
     "date-fns-tz": "^1.3.0",
     "rrule": "git+https://git@github.com/dereekb/rrule.git#17adf5708d6567b4d01a3a8afd106261421ea492",
-    "@dereekb/model": "4.0.0",
+    "@dereekb/model": "5.0.0",
     "tslib": "^2.0.0"
   }
 }

package/test/src/lib/common/firestore.mock.item.d.ts

@@ -1,17 +1,28 @@
 import { Maybe } from '@dereekb/util';
-import { CollectionReference, FirestoreCollection, FirestoreContext, AbstractFirestoreDocument, SingleItemFirestoreCollection, FirestoreCollectionWithParent, AbstractFirestoreDocumentWithParent } from '@dereekb/firebase';
+import { CollectionReference, FirestoreCollection, FirestoreContext, AbstractFirestoreDocument, SingleItemFirestoreCollection, FirestoreCollectionWithParent, AbstractFirestoreDocumentWithParent, ExpectedFirestoreModelData, FirestoreModelData } from '@dereekb/firebase';
 /**
- * Data for a test item in our firestore collection.
+ * Converted data for a test item in our firestore collection.
  */
 export interface MockItem {
-    test?: boolean;
     value?: Maybe<string>;
+    /**
+     * The test value is alway present.
+     */
+    test: boolean;
 }
-/**
- * FirestoreDocument for MockItem
- */
 export declare class MockItemDocument extends AbstractFirestoreDocument<MockItem, MockItemDocument> {
 }
+/**
+ * MockItem as it is stored into the database.
+ *
+ * Test is optional.
+ */
+export declare type MockItemData = FirestoreModelData<MockItem, {
+    /**
+     * The test value may not be defined in the database.
+     */
+    test?: Maybe<boolean>;
+}>;
 /**
  * Firestore collection path name.
  */
@@ -19,7 +30,12 @@ export declare const mockItemCollectionPath = "test";
 /**
  * Used to build a FirestoreDataConverter. Fields are configured via configuration. See the SnapshotConverterFunctions for more info.
  */
-export declare const mockItemConverter: import("@dereekb/firebase").SnapshotConverterFunctions<MockItem>;
+export declare const mockItemConverter: import("@dereekb/firebase").SnapshotConverterFunctions<MockItem, Partial<import("@dereekb/util").ReplaceType<MockItem, import("@dereekb/util").MaybeMap<{
+    /**
+     * The test value may not be defined in the database.
+     */
+    test?: Maybe<boolean>;
+}>, any>>>;
 /**
  * Used to build a mockItemCollection from a firestore instance with a converter setup.
  *
@@ -34,34 +50,41 @@ export declare function mockItemFirestoreCollection(firestoreContext: FirestoreC
  *
  * There is only a single private data item per each MockItem.
  */
-export interface MockItemPrivateData {
-    comments?: string;
-    createdAt?: Date;
+export interface MockItemPrivate {
+    comments?: Maybe<string>;
+    createdAt: Date;
 }
 /**
  * FirestoreDocument for MockItem
  */
-export declare class MockItemPrivateDataDocument extends AbstractFirestoreDocument<MockItemPrivateData, MockItemPrivateDataDocument> {
+export declare class MockItemPrivateDocument extends AbstractFirestoreDocument<MockItemPrivate, MockItemPrivateDocument> {
 }
+export declare type MockItemPrivateData = FirestoreModelData<MockItemPrivate, {}>;
 /**
  * Firestore collection path name.
  */
-export declare const mockItemPrivateDataCollectionPath = "private";
-export declare const mockItemPrivateDataIdentifier = "0";
+export declare const mockItemPrivateCollectionPath = "private";
+export declare const mockItemPrivateIdentifier = "0";
 /**
  * Used to build a FirestoreDataConverter. Fields are configured via configuration. See the SnapshotConverterFunctions for more info.
  */
-export declare const mockItemPrivateDataConverter: import("@dereekb/firebase").SnapshotConverterFunctions<MockItemPrivateData>;
+export declare const mockItemPrivateConverter: import("@dereekb/firebase").SnapshotConverterFunctions<{
+    comments?: Maybe<string>;
+    createdAt: Date;
+}, Partial<import("@dereekb/util").ReplaceType<{
+    comments?: Maybe<string>;
+    createdAt: Date;
+}, import("@dereekb/util").MaybeMap<object>, any>>>;
 /**
  * Used to build a mockItemCollection from a firestore instance with a converter setup.
  *
  * @param firestore
  * @returns
  */
-export declare function mockItemPrivateDataCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemDocument) => CollectionReference<MockItemPrivateData>;
-export declare type MockItemPrivateDataFirestoreCollection = SingleItemFirestoreCollection<MockItemPrivateData, MockItem, MockItemPrivateDataDocument>;
-export declare type MockItemPrivateDataFirestoreCollectionFactory = (parent: MockItemDocument) => MockItemPrivateDataFirestoreCollection;
-export declare function mockItemPrivateDataFirestoreCollection(firestoreContext: FirestoreContext): MockItemPrivateDataFirestoreCollectionFactory;
+export declare function mockItemPrivateCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemDocument) => CollectionReference<MockItemPrivate>;
+export declare type MockItemPrivateFirestoreCollection = SingleItemFirestoreCollection<MockItemPrivate, MockItem, MockItemPrivateDocument>;
+export declare type MockItemPrivateFirestoreCollectionFactory = (parent: MockItemDocument) => MockItemPrivateFirestoreCollection;
+export declare function mockItemPrivateFirestoreCollection(firestoreContext: FirestoreContext): MockItemPrivateFirestoreCollectionFactory;
 /**
  * Data for a sub item in our firestore collection.
  *
@@ -75,6 +98,7 @@ export interface MockItemSubItem {
  */
 export declare class MockItemSubItemDocument extends AbstractFirestoreDocumentWithParent<MockItem, MockItemSubItem, MockItemSubItemDocument> {
 }
+export declare type MockItemSubItemData = ExpectedFirestoreModelData<MockItemSubItem>;
 /**
  * Firestore collection path name.
  */
@@ -82,14 +106,14 @@ export declare const mockItemSubItemCollectionPath = "sub";
 /**
  * Used to build a FirestoreDataConverter. Fields are configured via configuration. See the SnapshotConverterFunctions for more info.
  */
-export declare const mockItemSubItemConverter: import("@dereekb/firebase").SnapshotConverterFunctions<MockItemSubItem>;
+export declare const mockItemSubItemConverter: import("@dereekb/firebase").SnapshotConverterFunctions<MockItemSubItem, import("@dereekb/util").ReplaceType<MockItemSubItem, object, any>>;
 export declare function mockItemSubItemCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemDocument) => CollectionReference<MockItemSubItem>;
 export declare type MockItemSubItemFirestoreCollection = FirestoreCollectionWithParent<MockItemSubItem, MockItem, MockItemSubItemDocument, MockItemDocument>;
 export declare type MockItemSubItemFirestoreCollectionFactory = (parent: MockItemDocument) => MockItemSubItemFirestoreCollection;
 export declare function mockItemSubItemFirestoreCollection(firestoreContext: FirestoreContext): MockItemSubItemFirestoreCollectionFactory;
 export declare abstract class MockItemCollections {
     abstract readonly mockItem: MockItemFirestoreCollection;
-    abstract readonly mockItemPrivateData: MockItemPrivateDataFirestoreCollectionFactory;
+    abstract readonly mockItemPrivate: MockItemPrivateFirestoreCollectionFactory;
     abstract readonly mockItemSubItem: MockItemSubItemFirestoreCollectionFactory;
 }
 export declare function makeMockItemCollections(firestoreContext: FirestoreContext): MockItemCollections;

package/test/src/lib/common/firestore.mock.item.fixture.d.ts

@@ -7,7 +7,7 @@ export declare class MockItemCollectionFixtureInstance {
     readonly collections: import("./firestore.mock.item").MockItemCollections;
     get collection(): CollectionReference<MockItem>;
     get firestoreCollection(): MockItemFirestoreCollection;
-    get mockItemPrivateDataCollection(): import("./firestore.mock.item").MockItemPrivateDataFirestoreCollectionFactory;
+    get mockItemPrivateCollection(): import("./firestore.mock.item").MockItemPrivateFirestoreCollectionFactory;
     get mockItemSubItemCollection(): import("./firestore.mock.item").MockItemSubItemFirestoreCollectionFactory;
     constructor(fixture: MockItemCollectionFixture);
 }