@dereekb/firebase 10.0.13 → 10.0.14

package/index.cjs.js

@@ -3667,9 +3667,10 @@ function firestorePassThroughField() {
 function optionalFirestoreField(config) {
   if (config) {
     const {
-      dontStoreDefaultReturnValue,
-      defaultReadValue: defaultValue,
-      dontStoreIfValue = dontStoreDefaultReturnValue && defaultValue != null ? defaultValue : undefined,
+      dontStoreDefaultReadValue,
+      defaultReadValue: inputDefaultReadValue,
+      dontStoreIfValue: inputDontStoreIfValue,
+      dontStoreIf: inputDontStoreIf = inputDontStoreIfValue,
       transformData: inputTransformData,
       transformFromData,
       transformToData
@@ -3677,17 +3678,54 @@ function optionalFirestoreField(config) {
     const transformData = inputTransformData !== null && inputTransformData !== void 0 ? inputTransformData : util.passThrough;
     const transformFrom = transformFromData !== null && transformFromData !== void 0 ? transformFromData : transformData;
     const transformTo = transformToData !== null && transformToData !== void 0 ? transformToData : transformData;
-    return firestoreField({
-      default: null,
-      fromData: defaultValue != null ? x => transformFrom(x == null ? defaultValue : x) : transformFrom != null ? x => x != null ? transformFrom(x) : x : util.passThrough,
-      toData: dontStoreIfValue != null ? x => {
+    let loadDefaultReadValueFn; // set if a default read value is provided
+    // setup fromData
+    let fromData;
+    if (inputDefaultReadValue != null) {
+      if (typeof inputDefaultReadValue === 'function') {
+        loadDefaultReadValueFn = inputDefaultReadValue;
+      } else {
+        loadDefaultReadValueFn = () => inputDefaultReadValue;
+      }
+      fromData = x => transformFrom(x == null ? loadDefaultReadValueFn() : x);
+    } else if (transformFrom !== util.passThrough) {
+      fromData = x => x != null ? transformFrom(x) : x;
+    } else {
+      fromData = util.passThrough;
+    }
+    // setup toData
+    let dontStoreIf;
+    if (inputDontStoreIf != null) {
+      if (typeof inputDontStoreIf === 'function') {
+        dontStoreIf = inputDontStoreIf;
+      } else {
+        dontStoreIf = x => inputDontStoreIf === x;
+      }
+    } else if (dontStoreDefaultReadValue && loadDefaultReadValueFn != null) {
+      dontStoreIf = x => x === loadDefaultReadValueFn();
+    }
+    let toData;
+    if (dontStoreIf != null) {
+      const dontStoreValue = dontStoreIf;
+      toData = x => {
         if (x != null) {
           const transformedValue = transformTo(x);
-          return transformedValue === dontStoreIfValue ? null : transformedValue;
+          const finalValue = transformedValue != null && !dontStoreValue(transformedValue) ? transformedValue : null;
+          return finalValue;
         } else {
           return x;
         }
-      } : util.passThrough
+      };
+    } else {
+      toData = x => {
+        var _a;
+        return x != null ? (_a = transformTo(x)) !== null && _a !== void 0 ? _a : null : x;
+      };
+    }
+    return firestoreField({
+      default: null,
+      fromData,
+      toData
     });
   } else {
     return FIRESTORE_PASSTHROUGH_FIELD;
@@ -3791,13 +3829,36 @@ function firestoreArray(config) {
     toData: x => sortFn(x, true)
   });
 }
-function optionalFirestoreArray() {
-  return firestorePassThroughField();
+function optionalFirestoreArray(config) {
+  var _a;
+  const sortFn = util.sortValuesFunctionOrMapIdentityWithSortRef(config);
+  const inputDontStoreIf = config === null || config === void 0 ? void 0 : config.dontStoreIf;
+  const shouldNotStoreIfEmpty = (_a = config === null || config === void 0 ? void 0 : config.dontStoreIfEmpty) !== null && _a !== void 0 ? _a : false;
+  let dontStoreIf;
+  if (inputDontStoreIf != null) {
+    dontStoreIf = shouldNotStoreIfEmpty ? x => x.length === 0 || inputDontStoreIf(x) : inputDontStoreIf;
+  } else {
+    dontStoreIf = shouldNotStoreIfEmpty ? x => {
+      return x.length === 0;
+    } : undefined;
+  }
+  const inputFilterUnique = config === null || config === void 0 ? void 0 : config.filterUnique;
+  const filterUniqueValuesFn = inputFilterUnique != null ? x => {
+    const result = inputFilterUnique(x);
+    return result;
+  } : undefined;
+  const inputTransformData = config === null || config === void 0 ? void 0 : config.transformData;
+  const sortArrayFn = util.isMapIdentityFunction(sortFn) ? undefined : x => sortFn(x, true);
+  const transformData = util.chainMapSameFunctions([filterUniqueValuesFn, inputTransformData, sortArrayFn]);
+  return optionalFirestoreField(Object.assign(Object.assign({}, config), {
+    dontStoreIf,
+    transformData
+  }));
 }
 function firestoreUniqueArray(config) {
   var _a;
   const {
-    filterUnique: filterUnique
+    filterUnique
   } = config;
   const sortFn = util.sortValuesFunctionOrMapIdentityWithSortRef(config);
   return firestoreField({

package/index.esm.js

@@ -1,5 +1,5 @@
 import { increment, onSnapshot, getDoc, deleteDoc, setDoc, updateDoc, doc, collectionGroup, collection, runTransaction, writeBatch, limit as limit$1, limitToLast as limitToLast$1, orderBy as orderBy$1, documentId, where as where$1, startAt as startAt$1, startAfter as startAfter$1, endAt as endAt$1, endBefore as endBefore$1, getDocs, query } from 'firebase/firestore';
-import { cachedGetter, mergeModifiers, asArray, filterUndefinedValues, objectHasNoKeys, filterFalsyAndEmptyValues, build, wrapUseAsyncFunction, makeWithFactory, performMakeLoop, runAsyncTasksForValues, filterMaybeValues, useAsync, toModelFieldConversions, makeModelMapFunctions, modifyModelMapFunctions, assignValuesToPOJOFunction, KeyValueTypleValueFilter, asObjectCopyFactory, passThrough, transformStringFunctionConfig, transformStringFunction, transformNumberFunction, sortValuesFunctionOrMapIdentityWithSortRef, filterUniqueFunction, unique, filterUniqueTransform, filterFromPOJOFunction, mapObjectMapFunction, copyObject, mapObjectMap, filterEmptyValues, modelFieldMapFunctions, toModelMapFunctions, latLngStringFunction, DEFAULT_LAT_LNG_STRING_VALUE, sortAscendingIndexNumberRefFunction, bitwiseSetDencoder, convertToArray, pushItemOrArrayItemsIntoArray, separateValues, UTF_8_START_CHARACTER, UTF_PRIVATE_USAGE_AREA_START, mergeArraysIntoArray, lastValue, flattenArrayOrValueArray, performAsyncTasks, batch, asGetter, groupValues, forEachInIterable, arrayToObject, takeFront, isOddNumber, objectToMap, ServerErrorResponse, toReadableError, capitalizeFirstLetter, lowercaseFirstLetter, toRelativeSlashPathStartType, mappedUseFunction, iterableToArray, getValueFromGetter, setContainsAllValues, usePromise, slashPathFactory, errorMessageContainsString } from '@dereekb/util';
+import { cachedGetter, mergeModifiers, asArray, filterUndefinedValues, objectHasNoKeys, filterFalsyAndEmptyValues, build, wrapUseAsyncFunction, makeWithFactory, performMakeLoop, runAsyncTasksForValues, filterMaybeValues, useAsync, toModelFieldConversions, makeModelMapFunctions, modifyModelMapFunctions, assignValuesToPOJOFunction, KeyValueTypleValueFilter, asObjectCopyFactory, passThrough, transformStringFunctionConfig, transformStringFunction, transformNumberFunction, sortValuesFunctionOrMapIdentityWithSortRef, isMapIdentityFunction, chainMapSameFunctions, filterUniqueFunction, unique, filterUniqueTransform, filterFromPOJOFunction, mapObjectMapFunction, copyObject, mapObjectMap, filterEmptyValues, modelFieldMapFunctions, toModelMapFunctions, latLngStringFunction, DEFAULT_LAT_LNG_STRING_VALUE, sortAscendingIndexNumberRefFunction, bitwiseSetDencoder, convertToArray, pushItemOrArrayItemsIntoArray, separateValues, UTF_8_START_CHARACTER, UTF_PRIVATE_USAGE_AREA_START, mergeArraysIntoArray, lastValue, flattenArrayOrValueArray, performAsyncTasks, batch, asGetter, groupValues, forEachInIterable, arrayToObject, takeFront, isOddNumber, objectToMap, ServerErrorResponse, toReadableError, capitalizeFirstLetter, lowercaseFirstLetter, toRelativeSlashPathStartType, mappedUseFunction, iterableToArray, getValueFromGetter, setContainsAllValues, usePromise, slashPathFactory, errorMessageContainsString } from '@dereekb/util';
 import { filterMaybe, lazyFrom, itemAccumulator, ItemPageIterator, MappedPageItemIterationInstance } from '@dereekb/rxjs';
 import { from, map, combineLatest, shareReplay, of, exhaustMap, Observable, switchMap, timer, skip } from 'rxjs';
 import { UNKNOWN_WEBSITE_LINK_TYPE, decodeWebsiteLinkEncodedDataToWebsiteFileLink, encodeWebsiteFileLinkToWebsiteLinkEncodedData, AbstractModelPermissionService, grantedRoleMapReader, noAccessRoleMap, fullAccessRoleMap } from '@dereekb/model';
@@ -3854,9 +3854,10 @@ function firestorePassThroughField() {
 function optionalFirestoreField(config) {
   if (config) {
     const {
-      dontStoreDefaultReturnValue,
-      defaultReadValue: defaultValue,
-      dontStoreIfValue = dontStoreDefaultReturnValue && defaultValue != null ? defaultValue : undefined,
+      dontStoreDefaultReadValue,
+      defaultReadValue: inputDefaultReadValue,
+      dontStoreIfValue: inputDontStoreIfValue,
+      dontStoreIf: inputDontStoreIf = inputDontStoreIfValue,
       transformData: inputTransformData,
       transformFromData,
       transformToData
@@ -3864,17 +3865,56 @@ function optionalFirestoreField(config) {
     const transformData = inputTransformData != null ? inputTransformData : passThrough;
     const transformFrom = transformFromData != null ? transformFromData : transformData;
     const transformTo = transformToData != null ? transformToData : transformData;
-    return firestoreField({
-      default: null,
-      fromData: defaultValue != null ? x => transformFrom(x == null ? defaultValue : x) : transformFrom != null ? x => x != null ? transformFrom(x) : x : passThrough,
-      toData: dontStoreIfValue != null ? x => {
+    let loadDefaultReadValueFn; // set if a default read value is provided
+
+    // setup fromData
+    let fromData;
+    if (inputDefaultReadValue != null) {
+      if (typeof inputDefaultReadValue === 'function') {
+        loadDefaultReadValueFn = inputDefaultReadValue;
+      } else {
+        loadDefaultReadValueFn = () => inputDefaultReadValue;
+      }
+      fromData = x => transformFrom(x == null ? loadDefaultReadValueFn() : x);
+    } else if (transformFrom !== passThrough) {
+      fromData = x => x != null ? transformFrom(x) : x;
+    } else {
+      fromData = passThrough;
+    }
+
+    // setup toData
+    let dontStoreIf;
+    if (inputDontStoreIf != null) {
+      if (typeof inputDontStoreIf === 'function') {
+        dontStoreIf = inputDontStoreIf;
+      } else {
+        dontStoreIf = x => inputDontStoreIf === x;
+      }
+    } else if (dontStoreDefaultReadValue && loadDefaultReadValueFn != null) {
+      dontStoreIf = x => x === loadDefaultReadValueFn();
+    }
+    let toData;
+    if (dontStoreIf != null) {
+      const dontStoreValue = dontStoreIf;
+      toData = x => {
         if (x != null) {
           const transformedValue = transformTo(x);
-          return transformedValue === dontStoreIfValue ? null : transformedValue;
+          const finalValue = transformedValue != null && !dontStoreValue(transformedValue) ? transformedValue : null;
+          return finalValue;
         } else {
           return x;
         }
-      } : passThrough
+      };
+    } else {
+      toData = x => {
+        var _transformTo;
+        return x != null ? (_transformTo = transformTo(x)) != null ? _transformTo : null : x;
+      };
+    }
+    return firestoreField({
+      default: null,
+      fromData,
+      toData
     });
   } else {
     return FIRESTORE_PASSTHROUGH_FIELD;
@@ -3978,13 +4018,36 @@ function firestoreArray(config) {
     toData: x => sortFn(x, true)
   });
 }
-function optionalFirestoreArray() {
-  return firestorePassThroughField();
+function optionalFirestoreArray(config) {
+  var _config$dontStoreIfEm;
+  const sortFn = sortValuesFunctionOrMapIdentityWithSortRef(config);
+  const inputDontStoreIf = config == null ? void 0 : config.dontStoreIf;
+  const shouldNotStoreIfEmpty = (_config$dontStoreIfEm = config == null ? void 0 : config.dontStoreIfEmpty) != null ? _config$dontStoreIfEm : false;
+  let dontStoreIf;
+  if (inputDontStoreIf != null) {
+    dontStoreIf = shouldNotStoreIfEmpty ? x => x.length === 0 || inputDontStoreIf(x) : inputDontStoreIf;
+  } else {
+    dontStoreIf = shouldNotStoreIfEmpty ? x => {
+      return x.length === 0;
+    } : undefined;
+  }
+  const inputFilterUnique = config == null ? void 0 : config.filterUnique;
+  const filterUniqueValuesFn = inputFilterUnique != null ? x => {
+    const result = inputFilterUnique(x);
+    return result;
+  } : undefined;
+  const inputTransformData = config == null ? void 0 : config.transformData;
+  const sortArrayFn = isMapIdentityFunction(sortFn) ? undefined : x => sortFn(x, true);
+  const transformData = chainMapSameFunctions([filterUniqueValuesFn, inputTransformData, sortArrayFn]);
+  return optionalFirestoreField(Object.assign({}, config, {
+    dontStoreIf,
+    transformData
+  }));
 }
 function firestoreUniqueArray(config) {
   var _config$default3;
   const {
-    filterUnique: filterUnique
+    filterUnique
   } = config;
   const sortFn = sortValuesFunctionOrMapIdentityWithSortRef(config);
   return firestoreField({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "10.0.13",
+  "version": "10.0.14",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/common/firestore/collection/collection.query.d.ts

@@ -8,7 +8,7 @@ import { type Observable } from 'rxjs';
 export interface FirestoreCollectionExecutableDocumentQuery<T, D extends FirestoreDocument<T>> {
     readonly baseQuery: FirestoreExecutableQuery<T>;
     /**
-     * Returns the first/single document.
+     * Limits the results to a single document, then returns that first/single document if it exists.
      */
     getFirstDoc(transaction?: Transaction): Promise<Maybe<D>>;
     /**

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

@@ -13,7 +13,7 @@ export interface FirestoreExecutableQueryGetDocsContext {
 export interface FirestoreExecutableQuery<T> {
     readonly query: Query<T>;
     /**
-     * Returns the first/single document.
+     * Limits the results to a single document, then returns that first/single document if it exists.
      */
     getFirstDoc(transaction?: Transaction): Promise<Maybe<QueryDocumentSnapshot<T>>>;
     /**

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

@@ -1,6 +1,6 @@
 import { type WebsiteLink, type GrantedRole, type WebsiteFileLink } from '@dereekb/model';
 import { type DateCellRange, type DateCellSchedule } from '@dereekb/date';
-import { type ModelFieldMapFunctionsConfig, type GetterOrValue, type Maybe, type ModelFieldMapConvertFunction, type PrimativeKey, type ReadKeyFunction, type ModelFieldMapFunctionsWithDefaultsConfig, type FilterUniqueStringsTransformConfig, type MapFunction, type FilterKeyValueTuplesInput, type ModelKey, type ToModelMapFunctionsInput, type ModelMapFunctionsRef, type LatLngPrecision, type LatLngString, type TimezoneString, type PrimativeKeyStringDencoderFunction, type PrimativeKeyDencoderFunction, type UnitedStatesAddress, type ZoomLevel, type FilterUniqueFunction, type BitwiseEncodedSet, type BitwiseObjectDencoder, type SortCompareFunctionRef, type TransformNumberFunctionConfigInput, type TransformStringFunctionConfigInput } from '@dereekb/util';
+import { type ModelFieldMapFunctionsConfig, type GetterOrValue, type Maybe, type ModelFieldMapConvertFunction, type PrimativeKey, type ReadKeyFunction, type ModelFieldMapFunctionsWithDefaultsConfig, type FilterUniqueStringsTransformConfig, type MapFunction, type FilterKeyValueTuplesInput, type ModelKey, type ToModelMapFunctionsInput, type ModelMapFunctionsRef, type LatLngPrecision, type LatLngString, type TimezoneString, type PrimativeKeyStringDencoderFunction, type PrimativeKeyDencoderFunction, type UnitedStatesAddress, type ZoomLevel, type FilterUniqueFunction, type BitwiseEncodedSet, type BitwiseObjectDencoder, type SortCompareFunctionRef, type TransformNumberFunctionConfigInput, type TransformStringFunctionConfigInput, type DecisionFunction } from '@dereekb/util';
 import { type FirestoreModelData } from './snapshot.type';
 export interface BaseFirestoreFieldConfig<V, D = unknown> {
     fromData: ModelFieldMapConvertFunction<D, V>;
@@ -46,17 +46,25 @@ export interface OptionalFirestoreFieldConfig<T> {
     /**
      * Defaults the dontStoreIfValue value to this value.
      *
-     * This is ignored if no default value is set.
+     * This is ignored if defaultReadValue is not set or if dontStoreIf is provided.
      */
-    readonly dontStoreDefaultReturnValue?: boolean;
+    readonly dontStoreDefaultReadValue?: boolean;
     /**
-     * Removes the value from the object if the stored value would equal this value.
+     * Removes the value from the object if the decision returns true.
      */
-    readonly dontStoreIfValue?: T;
+    readonly dontStoreIf?: T | DecisionFunction<T>;
     /**
      * Value to optionally return if there is no value in the database when reading from the database.
+     *
+     * If using a getter the getter is invoked each time.
+     */
+    readonly defaultReadValue?: GetterOrValue<T>;
+    /**
+     * Removes the value from the object if the stored value would equal this value.
+     *
+     * @deprecated use dontStoreIf instead.
      */
-    readonly defaultReadValue?: T;
+    readonly dontStoreIfValue?: T;
 }
 export interface OptionalFirestoreFieldConfigWithTransform<T> extends OptionalFirestoreFieldConfig<T> {
     /**
@@ -97,8 +105,8 @@ export type OptionalFirestoreString<S extends string = string> = OptionalFiresto
 export declare function optionalFirestoreString<S extends string = string>(config?: OptionalFirestoreString<S>): ModelFieldMapFunctionsConfig<Maybe<S>, Maybe<S>>;
 export type FirestoreEnumConfig<S extends string | number> = MapConfiguredFirestoreFieldConfigWithDefault<S, S>;
 export declare function firestoreEnum<S extends string | number>(config: FirestoreEnumConfig<S>): FirestoreModelFieldMapFunctionsConfig<S, S>;
-export type OptionalFirestoreEnum<S extends string | number> = OptionalFirestoreFieldConfig<S>;
-export declare function optionalFirestoreEnum<S extends string | number>(config?: OptionalFirestoreEnum<S>): ModelFieldMapFunctionsConfig<Maybe<S>, Maybe<S>>;
+export type OptionalFirestoreEnumConfig<S extends string | number> = OptionalFirestoreFieldConfig<S>;
+export declare function optionalFirestoreEnum<S extends string | number>(config?: OptionalFirestoreEnumConfig<S>): ModelFieldMapFunctionsConfig<Maybe<S>, Maybe<S>>;
 export declare function firestoreUID(): FirestoreModelFieldMapFunctionsConfig<string, string>;
 export declare function optionalFirestoreUID(): ModelFieldMapFunctionsConfig<Maybe<string>, Maybe<string>>;
 export declare const firestoreModelKeyString: FirestoreModelFieldMapFunctionsConfig<string, string>;
@@ -121,7 +129,23 @@ export type OptionalFirestoreNumberFieldConfig<N extends number = number> = Opti
 export declare function optionalFirestoreNumber<N extends number = number>(config?: OptionalFirestoreNumberFieldConfig<N>): ModelFieldMapFunctionsConfig<Maybe<N>, Maybe<N>>;
 export type FirestoreArrayFieldConfig<T> = DefaultMapConfiguredFirestoreFieldConfig<T[], T[]> & Partial<SortCompareFunctionRef<T>> & Partial<FirestoreFieldDefault<T[]>>;
 export declare function firestoreArray<T>(config: FirestoreArrayFieldConfig<T>): FirestoreModelFieldMapFunctionsConfig<T[], T[]>;
-export declare function optionalFirestoreArray<T>(): ModelFieldMapFunctionsConfig<Maybe<T[]>, Maybe<T[]>>;
+export type OptionalFirestoreArrayFieldConfig<T> = Omit<OptionalFirestoreFieldConfigWithTransform<T[]>, 'dontStoreIf' | 'dontStoreIfValue' | 'transformFromData' | 'transformToData'> & Pick<FirestoreArrayFieldConfig<T>, 'sortWith'> & {
+    /**
+     * Filters the function uniquely. If true uses the unique function.
+     */
+    readonly filterUnique?: T extends PrimativeKey ? FilterUniqueFunction<T, T> : never;
+    /**
+     * Removes the value from the object if the decision returns true.
+     */
+    readonly dontStoreIf?: DecisionFunction<T[]>;
+    /**
+     * The array is not stored if it is empty.
+     *
+     * Defaults to false.
+     */
+    readonly dontStoreIfEmpty?: boolean;
+};
+export declare function optionalFirestoreArray<T>(config?: OptionalFirestoreArrayFieldConfig<T>): ModelFieldMapFunctionsConfig<Maybe<T[]>, Maybe<T[]>>;
 export type FirestoreUniqueArrayFieldConfig<T, K extends PrimativeKey = T extends PrimativeKey ? T : PrimativeKey> = FirestoreArrayFieldConfig<T> & Partial<SortCompareFunctionRef<T>> & {
     readonly filterUnique: FilterUniqueFunction<T, K>;
 };

package/test/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [10.0.14](https://github.com/dereekb/dbx-components/compare/v10.0.13-dev...v10.0.14) (2024-01-31)
+
+
+
 ## [10.0.13](https://github.com/dereekb/dbx-components/compare/v10.0.12-dev...v10.0.13) (2024-01-29)
 
 

package/test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "10.0.13",
+  "version": "10.0.14",
   "type": "commonjs",
   "peerDependencies": {
     "@dereekb/util": "*",