@dereekb/firebase 11.1.1 → 11.1.3

package/index.cjs.js

@@ -9073,6 +9073,12 @@ const notificationConverter = snapshotConverterFunctions({
     r: firestoreObjectArray({
       objectField: firestoreNotificationRecipientWithConfig
     }),
+    ois: optionalFirestoreBoolean({
+      dontStoreIf: false
+    }),
+    ots: optionalFirestoreBoolean({
+      dontStoreIf: true
+    }),
     sat: firestoreDate(),
     a: firestoreNumber({
       default: 0
@@ -9713,8 +9719,13 @@ function createNotificationTemplate(input) {
   const notificationModel = readFirestoreModelKey(inputNotification);
   const targetModel = inputTargetModel ? readFirestoreModelKey(inputTargetModel) : undefined;
   let d = data != null ? data : inputD;
-  if (d && util.objectHasNoKeys(d)) {
-    d = undefined;
+  if (d != null) {
+    const filteredData = util.filterUndefinedValues(d, true); // filter both null and undefined values
+    if (util.objectHasNoKeys(filteredData)) {
+      d = undefined;
+    } else {
+      d = filteredData;
+    }
   }
   const template = {
     notificationModel,
@@ -9826,7 +9837,7 @@ function createNotificationDocumentPair(input) {
 }
 
 /**
- * Creates a NotificationTemplateTypeInfoRecord from the input details array.
+ * Creates a NotificationTemplateTypeInfoRecord from the input info array.
  *
  * @param infoArray
  * @returns
@@ -9851,19 +9862,19 @@ function appNotificationTemplateTypeInfoRecordService(appNotificationTemplateTyp
   const targetModelTypeInfoMapBuilder = util.multiValueMapBuilder();
   const allKnownTemplateTypes = [];
   const allKnownTemplateTypeInfo = [];
-  Object.entries(appNotificationTemplateTypeInfoRecord).forEach(([_, details]) => {
+  Object.entries(appNotificationTemplateTypeInfoRecord).forEach(([_, info]) => {
     const {
       notificationModelIdentity,
       targetModelIdentity,
       alternativeModelIdentities
-    } = details;
+    } = info;
     function addInfoForIdentity(modelIdentity, targetIdentity) {
       var _targetIdentity$colle;
       const {
         collectionType
       } = modelIdentity;
-      notificationModelTypeInfoMapBuilder.add(collectionType, details);
-      targetModelTypeInfoMapBuilder.add((_targetIdentity$colle = targetIdentity == null ? void 0 : targetIdentity.collectionType) != null ? _targetIdentity$colle : collectionType, details);
+      notificationModelTypeInfoMapBuilder.add(collectionType, info);
+      targetModelTypeInfoMapBuilder.add((_targetIdentity$colle = targetIdentity == null ? void 0 : targetIdentity.collectionType) != null ? _targetIdentity$colle : collectionType, info);
       allNotificationModelIdentityValuesSet.add(modelIdentity);
     }
     addInfoForIdentity(notificationModelIdentity, targetModelIdentity);
@@ -9873,8 +9884,8 @@ function appNotificationTemplateTypeInfoRecordService(appNotificationTemplateTyp
         addInfoForIdentity(x.altNotificationModelIdentity, (_x$altTargetModelIden = x.altTargetModelIdentity) != null ? _x$altTargetModelIden : targetModelIdentity);
       });
     }
-    allKnownTemplateTypeInfo.push(details);
-    allKnownTemplateTypes.push(details.type);
+    allKnownTemplateTypeInfo.push(info);
+    allKnownTemplateTypes.push(info.type);
   });
   const allNotificationModelIdentityValues = Array.from(allNotificationModelIdentityValuesSet);
   const notificationModelTemplateInfoMap = notificationModelTypeInfoMapBuilder.map();

package/index.esm.js

@@ -9902,6 +9902,12 @@ const notificationConverter = snapshotConverterFunctions({
     r: firestoreObjectArray({
       objectField: firestoreNotificationRecipientWithConfig
     }),
+    ois: optionalFirestoreBoolean({
+      dontStoreIf: false
+    }),
+    ots: optionalFirestoreBoolean({
+      dontStoreIf: true
+    }),
     sat: firestoreDate(),
     a: firestoreNumber({
       default: 0
@@ -10717,8 +10723,14 @@ function createNotificationTemplate(input) {
   const notificationModel = readFirestoreModelKey(inputNotification);
   const targetModel = inputTargetModel ? readFirestoreModelKey(inputTargetModel) : undefined;
   let d = data != null ? data : inputD;
-  if (d && objectHasNoKeys(d)) {
-    d = undefined;
+  if (d != null) {
+    const filteredData = filterUndefinedValues(d, true); // filter both null and undefined values
+
+    if (objectHasNoKeys(filteredData)) {
+      d = undefined;
+    } else {
+      d = filteredData;
+    }
   }
   const template = {
     notificationModel,
@@ -10890,7 +10902,7 @@ async function createNotificationDocumentIfSending(input) {
  */
 
 /**
- * Creates a NotificationTemplateTypeInfoRecord from the input details array.
+ * Creates a NotificationTemplateTypeInfoRecord from the input info array.
  *
  * @param infoArray
  * @returns
@@ -10966,19 +10978,19 @@ function appNotificationTemplateTypeInfoRecordService(appNotificationTemplateTyp
   const targetModelTypeInfoMapBuilder = multiValueMapBuilder();
   const allKnownTemplateTypes = [];
   const allKnownTemplateTypeInfo = [];
-  Object.entries(appNotificationTemplateTypeInfoRecord).forEach(([_, details]) => {
+  Object.entries(appNotificationTemplateTypeInfoRecord).forEach(([_, info]) => {
     const {
       notificationModelIdentity,
       targetModelIdentity,
       alternativeModelIdentities
-    } = details;
+    } = info;
     function addInfoForIdentity(modelIdentity, targetIdentity) {
       var _targetIdentity$colle;
       const {
         collectionType
       } = modelIdentity;
-      notificationModelTypeInfoMapBuilder.add(collectionType, details);
-      targetModelTypeInfoMapBuilder.add((_targetIdentity$colle = targetIdentity == null ? void 0 : targetIdentity.collectionType) != null ? _targetIdentity$colle : collectionType, details);
+      notificationModelTypeInfoMapBuilder.add(collectionType, info);
+      targetModelTypeInfoMapBuilder.add((_targetIdentity$colle = targetIdentity == null ? void 0 : targetIdentity.collectionType) != null ? _targetIdentity$colle : collectionType, info);
       allNotificationModelIdentityValuesSet.add(modelIdentity);
     }
     addInfoForIdentity(notificationModelIdentity, targetModelIdentity);
@@ -10988,8 +11000,8 @@ function appNotificationTemplateTypeInfoRecordService(appNotificationTemplateTyp
         addInfoForIdentity(x.altNotificationModelIdentity, (_x$altTargetModelIden = x.altTargetModelIdentity) != null ? _x$altTargetModelIden : targetModelIdentity);
       });
     }
-    allKnownTemplateTypeInfo.push(details);
-    allKnownTemplateTypes.push(details.type);
+    allKnownTemplateTypeInfo.push(info);
+    allKnownTemplateTypes.push(info.type);
   });
   const allNotificationModelIdentityValues = Array.from(allNotificationModelIdentityValuesSet);
   const notificationModelTemplateInfoMap = notificationModelTypeInfoMapBuilder.map();

package/package.json

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

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

@@ -4,7 +4,7 @@ import { type NotificationBoxId } from './notification.id';
 import { type NotificationBoxRecipient, type NotificationRecipientWithConfig, type NotificationUserNotificationBoxRecipientConfig, type NotificationUserDefaultNotificationBoxRecipientConfig } from './notification.config';
 import { type YearWeekCode } from '@dereekb/date';
 import { type UserRelatedById, type UserRelated } from '../user';
-import { AbstractFirestoreDocument, AbstractFirestoreDocumentWithParent, type CollectionGroup, type CollectionReference, type FirestoreCollection, type FirestoreCollectionGroup, type FirestoreCollectionWithParent, type FirestoreContext, type FirestoreModelKey, type SavedToFirestoreIfTrue } from '../../common';
+import { AbstractFirestoreDocument, AbstractFirestoreDocumentWithParent, type CollectionGroup, type CollectionReference, type FirestoreCollection, type FirestoreCollectionGroup, type FirestoreCollectionWithParent, type FirestoreContext, type FirestoreModelKey, type SavedToFirestoreIfTrue, type SavedToFirestoreIfFalse } from '../../common';
 import { type NotificationItem } from './notification.item';
 export declare abstract class NotificationFirestoreCollections {
     abstract readonly notificationUserCollection: NotificationUserFirestoreCollection;
@@ -340,8 +340,28 @@ export interface Notification extends NotificationSendFlags, NotificationSendChe
     n: NotificationItem;
     /**
      * Additional embedded recipients.
+     *
+     * Any values for the NotificationBoxRecipientTemplateConfig-related parameters will be used when considering explicit opt-in/op-out.
+     * (I.E. setting "st" to true for a user with no other config for the notification template type will mark them as opt-in for texts, and
+     * can only be overridden by the user's own config)
      */
     r: NotificationRecipientWithConfig[];
+    /**
+     * Explicit opt-in send only.
+     *
+     * If true, will only send to users that have explicitly opted in to recieving notifications via specific methods.
+     *
+     * This setting takes priority over the system's configured default for this notification's template type.
+     */
+    ois?: Maybe<SavedToFirestoreIfTrue>;
+    /**
+     * Explicit opt-in text/sms send only.
+     *
+     * If false, will send text/sms to all users regardless if they have not explicitly opted in to text/sms. Will still take their opt-out into account.
+     *
+     * This setting takes priority over the system's configured default for this notification's template type.
+     */
+    ots?: Maybe<SavedToFirestoreIfFalse>;
     /**
      * Minimum time at which this notification should be sent.
      *

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

@@ -67,13 +67,21 @@ export interface NotificationTemplateTypeInfo extends NotificationTemplateTypeIn
      * Description of the notification's content.
      */
     readonly description: string;
+    /**
+     * If true, this notification will only be sent to recipients that explicitly enable recieving via respective NotificationBoxRecipientTemplateConfig for this type.
+     */
+    readonly onlySendToExplicitlyEnabledRecipients?: boolean;
+    /**
+     * If false, this notification will send sms/texts to all recipients, even if they have not explicitly opted in to recieving sms/texts.
+     */
+    readonly onlyTextExplicitlyEnabledRecipients?: boolean;
 }
 /**
  * Record of NotificationTemplateTypeInfo keyed by type.
  */
 export type NotificationTemplateTypeInfoRecord = Record<NotificationTemplateType, NotificationTemplateTypeInfo>;
 /**
- * Creates a NotificationTemplateTypeInfoRecord from the input details array.
+ * Creates a NotificationTemplateTypeInfoRecord from the input info array.
  *
  * @param infoArray
  * @returns

package/test/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [11.1.3](https://github.com/dereekb/dbx-components/compare/v11.1.2-dev...v11.1.3) (2025-03-07)
+
+
+
+## [11.1.2](https://github.com/dereekb/dbx-components/compare/v11.1.1-dev...v11.1.2) (2025-03-04)
+
+
+
 ## [11.1.1](https://github.com/dereekb/dbx-components/compare/v11.1.0-dev...v11.1.1) (2025-03-03)
 
 

package/test/package.json

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