@dereekb/dbx-components-mcp 14.16.0 → 14.17.0

package/generated/dereekb-dbx-core.filters.mcp.generated.json

@@ -114,7 +114,7 @@
       "selector": "[dbxFilterMapRouteParams]",
       "className": "DbxFilterMapRouteParamsDirective",
       "module": "@dereekb/dbx-core",
-      "description": "Loads the filter of a keyed entry in an ancestor {@link FilterMap} from the current route params, so a link can open the page on a specific filter.\n\nThe params' filter becomes the key's default filter when the page loads, and a later change to the params (such as a link to\nthe same page with other params) sets the key's filter. When {@link DbxFilterMapRouteParamsConfig.paramsFromFilter} is set,\nevery change to the key is also written back to the URL, so reloading the page keeps the filter.\n\nThe params must be declared on the current route (for UIRouter, as query params of an ancestor state, ideally `dynamic: true`\nso writing them does not reload the state). Do not use it together with {@link DbxFilterMapStorageDirective} on the same key,\nsince both set the key's default filter.",
+      "description": "Loads the filter of a keyed entry in an ancestor {@link FilterMap} from the current route params, so a link can open the page on a specific filter.\n\nThe params' filter becomes the key's default filter when the page loads, and a later change to the params (such as a link to\nthe same page with other params) sets the key's filter. When {@link DbxFilterMapRouteParamsConfig.paramsFromFilter} is set,\nevery change to the key is also written back to the URL, so reloading the page keeps the filter.\n\nThe params must be declared on the current route (for UIRouter, as query params of an ancestor state, ideally `dynamic: true`\nso writing them does not reload the state). Do not use it together with {@link DbxFilterMapStorageDirective} on the same key,\nsince both set the key's default filter.\n\nA filter popover that edits the key should set `closeOnFilterChange: false` on its `DbxFilterComponentConfig`, which also keeps it\nopen across the route transition each change causes (`closeOnTransition`).",
       "inputs": [
         {
           "name": "dbxFilterMapRouteParams",

package/generated/dereekb-dbx-web.ui-components.mcp.generated.json

@@ -988,6 +988,45 @@
       "example": "<dbx-dialog-content>\n  <h2>Confirm</h2>\n  <p>Are you sure?</p>\n</dbx-dialog-content>",
       "minimalExample": "<div dbxDialogContent>Body</div>"
     },
+    {
+      "slug": "filter-popover-button",
+      "category": "overlay",
+      "kind": "component",
+      "selector": "dbx-filter-popover-button",
+      "className": "DbxFilterPopoverButtonComponent",
+      "module": "@dereekb/dbx-web",
+      "description": "Renders an icon button that opens a filter popover when clicked.\n\nThe popover closes when the filter changes unless `closeOnFilterChange` is false, and closes on a route transition unless\n`closeOnTransition` (which defaults to `closeOnFilterChange`) is false — so a popover editing a filter that is written to the\nURL stays open while it is edited. The popover always closes when this button is destroyed, such as when leaving the page.\nA `dbx-filter-wrapper` without its own Apply button applies its last change before the popover closes on its close button\nor a click outside.",
+      "inputs": [
+        {
+          "name": "disabled",
+          "type": "Maybe<boolean>",
+          "description": "",
+          "required": false
+        },
+        {
+          "name": "buttonDisplayStyle",
+          "type": "Maybe<DbxButtonDisplayStylePair>",
+          "description": "",
+          "required": false
+        },
+        {
+          "name": "config",
+          "type": "Maybe<DbxFilterComponentConfig<F, any, any, any>>",
+          "description": "",
+          "required": false,
+          "default": "undefined"
+        }
+      ],
+      "outputs": [],
+      "relatedSlugs": [
+        "popover"
+      ],
+      "skillRefs": [
+        "dbx__ref__dbx-component-patterns"
+      ],
+      "example": "<dbx-filter-popover-button [config]=\"filterConfig\" [buttonDisplayStyle]=\"{ display: { icon: 'filter_alt' } }\"></dbx-filter-popover-button>",
+      "minimalExample": "<dbx-filter-popover-button [config]=\"filterConfig\"></dbx-filter-popover-button>"
+    },
     {
       "slug": "popover",
       "category": "overlay",

package/generated/dereekb-firebase.model-firebase-index.mcp.generated.json

@@ -1047,6 +1047,122 @@
         }
       ]
     },
+    {
+      "slug": "notification-task-bots-due-for-repair-query",
+      "name": "notificationTaskBotsDueForRepairQuery",
+      "module": "@dereekb/firebase",
+      "subpath": "model/notification/notification.query",
+      "signature": "notificationTaskBotsDueForRepairQuery(before: Date): FirestoreQueryConstraint[]",
+      "description": "Query constraints for finding {@link NotificationTaskBot} documents whose soonest live run (`nat`) is at or before the given time.\n\nUsed by the repair sweep to find bots with an overdue run, whose run task may have gone missing.",
+      "model": "NotificationTaskBot",
+      "collection": "ntb",
+      "isNested": false,
+      "scope": "COLLECTION",
+      "manual": false,
+      "skip": false,
+      "category": "sweep",
+      "params": [
+        {
+          "name": "before",
+          "type": "Date",
+          "description": "- Bots with a `nat` at or before this time are returned.",
+          "optional": false
+        }
+      ],
+      "returns": "Array of Firestore query constraints filtering for overdue bots.",
+      "tags": [
+        "sweep",
+        "notificationtaskbot",
+        "notification",
+        "task",
+        "bots",
+        "due",
+        "for",
+        "repair",
+        "query",
+        "notificationtaskbotsdueforrepairquery",
+        "bot",
+        "constraints",
+        "finding",
+        "link",
+        "documents",
+        "whose",
+        "soonest",
+        "live",
+        "run"
+      ],
+      "constraintSequences": [
+        {
+          "pathLabel": "all",
+          "entries": [
+            {
+              "kind": "where",
+              "fieldPath": "nat",
+              "operator": "<="
+            }
+          ]
+        }
+      ],
+      "derivedComposites": [],
+      "derivedFieldOverrides": []
+    },
+    {
+      "slug": "notification-task-bots-stalled-query",
+      "name": "notificationTaskBotsStalledQuery",
+      "module": "@dereekb/firebase",
+      "subpath": "model/notification/notification.query",
+      "signature": "notificationTaskBotsStalledQuery(stalledBefore?: Date): FirestoreQueryConstraint[]",
+      "description": "Query constraints for finding {@link NotificationTaskBot} documents with a stalled entry: their `stl` (the earliest\nentry `stl`) is at or before the given time.\n\nThe repair sweep marks a live run stalled when its task keeps failing or nothing picks it up. Pass an earlier time to\nfind the bots that have been stalled at least that long. Use it for an admin list (`NotificationTaskBotCollectionStore`)\nor an alerting cron. Firestore's automatic single-field index covers it.",
+      "model": "NotificationTaskBot",
+      "collection": "ntb",
+      "isNested": false,
+      "scope": "COLLECTION",
+      "manual": false,
+      "skip": false,
+      "category": "lookup",
+      "params": [
+        {
+          "name": "stalledBefore",
+          "type": "Date",
+          "description": "- Bots whose earliest stalled entry was marked at or before this time are returned. Defaults to now.",
+          "optional": true
+        }
+      ],
+      "returns": "Array of Firestore query constraints filtering for stalled bots.",
+      "tags": [
+        "lookup",
+        "notificationtaskbot",
+        "notification",
+        "task",
+        "bots",
+        "stalled",
+        "query",
+        "notificationtaskbotsstalledquery",
+        "bot",
+        "constraints",
+        "finding",
+        "link",
+        "documents",
+        "entry",
+        "their",
+        "stl",
+        "earliest"
+      ],
+      "constraintSequences": [
+        {
+          "pathLabel": "all",
+          "entries": [
+            {
+              "kind": "where",
+              "fieldPath": "stl",
+              "operator": "<="
+            }
+          ]
+        }
+      ],
+      "derivedComposites": [],
+      "derivedFieldOverrides": []
+    },
     {
       "slug": "oidc-entries-with-type-query",
       "name": "oidcEntriesWithTypeQuery",

package/generated/dereekb-firebase.semantic-types.mcp.generated.json

@@ -312,6 +312,52 @@
       ],
       "notes": "Key of a {@link NotificationTemplateTypeInfoGroup}. Template types whose groups share a key are shown together."
     },
+    {
+      "name": "NotificationTaskBotEntryId",
+      "package": "@dereekb/firebase",
+      "module": "src/lib/model/notification/notification.id",
+      "kind": "semantic-type",
+      "definition": "string",
+      "baseType": "string",
+      "topics": [
+        "string",
+        "dereekb-firebase:notification"
+      ],
+      "guards": [
+        "isNotificationTaskBotEntryId"
+      ],
+      "notes": "Identifier of a {@link NotificationTaskBotEmbeddedScriptEntry}, unique within its bot.\n\nMust match {@link NOTIFICATION_TASK_BOT_ENTRY_ID_REGEX}."
+    },
+    {
+      "name": "NotificationTaskBotScriptGroupKey",
+      "package": "@dereekb/firebase",
+      "module": "src/lib/model/notification/notification.id",
+      "kind": "semantic-type",
+      "definition": "string",
+      "baseType": "string",
+      "topics": [
+        "identifier",
+        "string",
+        "dereekb-firebase:notification"
+      ],
+      "guards": [
+        "isNotificationTaskBotScriptGroupKey"
+      ],
+      "notes": "Key of a NotificationTaskBotScriptGroup, the topic a script belongs to (e.g. \"Email reminders\").\n\nThe bot's owner opts out of a whole group at once rather than individual entries.\n\nMust match {@link NOTIFICATION_TASK_BOT_SCRIPT_GROUP_KEY_REGEX}."
+    },
+    {
+      "name": "NotificationTaskBotRunNumber",
+      "package": "@dereekb/firebase",
+      "module": "src/lib/model/notification/notification.id",
+      "kind": "semantic-type",
+      "definition": "number",
+      "baseType": "number",
+      "topics": [
+        "numeric",
+        "dereekb-firebase:notification"
+      ],
+      "notes": "Run number of a single NotificationTaskBot run. Taken from the bot's monotonic run counter, so it never repeats within a bot."
+    },
     {
       "name": "NotificationTemplateType",
       "package": "@dereekb/firebase",
@@ -381,6 +427,32 @@
       ],
       "notes": "Discriminator string that routes the subtask to the correct processing configuration."
     },
+    {
+      "name": "NotificationTaskBotScriptType",
+      "package": "@dereekb/firebase",
+      "module": "src/lib/model/notification/notification.taskbot",
+      "kind": "semantic-type",
+      "definition": "string",
+      "baseType": "string",
+      "topics": [
+        "string",
+        "dereekb-firebase:notification"
+      ],
+      "notes": "Type of a NotificationTaskBot script, registered by the app. Selects the server-side processor that runs an entry."
+    },
+    {
+      "name": "NotificationTaskBotPauseReason",
+      "package": "@dereekb/firebase",
+      "module": "src/lib/model/notification/notification.taskbot",
+      "kind": "semantic-type",
+      "definition": "string",
+      "baseType": "string",
+      "topics": [
+        "string",
+        "dereekb-firebase:notification"
+      ],
+      "notes": "Reason an entry was paused. The library defines {@link NOTIFICATION_TASK_BOT_PAUSE_REASON_MANUAL} and\n{@link NOTIFICATION_TASK_BOT_PAUSE_REASON_FAILED}; scripts may add their own (e.g. `'no_progress'`)."
+    },
     {
       "name": "NotificationTaskCheckpointString",
       "package": "@dereekb/firebase",

package/generated/dereekb-firebase.utils.mcp.generated.json

@@ -263,6 +263,74 @@
         "firebase-auth-oob-code-data-pair-delimiter"
       ]
     },
+    {
+      "slug": "form-space-submission-notification-task-key",
+      "name": "formSpaceSubmissionNotificationTaskKey",
+      "kind": "function",
+      "category": "firestore",
+      "module": "@dereekb/firebase",
+      "subpath": "model/formspace/formspace.task",
+      "signature": "formSpaceSubmissionNotificationTaskKey(input: FormSpaceSubmissionNotificationTaskUniqueIdInput): NotificationTaskKey",
+      "description": "Returns the full key of the NotificationTask processing one SUBMISSION ATTEMPT of a FormSpace.\n\nThe task lives in the framework task box because {@link formSpaceSubmissionNotificationTaskTemplate} sets no notification model, and {@link uniqueNotificationTaskKey} applies the same default.",
+      "params": [
+        {
+          "name": "input",
+          "type": "FormSpaceSubmissionNotificationTaskUniqueIdInput",
+          "description": "- The FormSpace id and the attempt's reopen count.",
+          "optional": false
+        }
+      ],
+      "returns": "The unique notification task's full key.",
+      "tags": [
+        "formspace",
+        "notification",
+        "task",
+        "submission",
+        "attempt",
+        "key",
+        "firestore",
+        "form",
+        "space",
+        "formspacesubmissionnotificationtaskkey"
+      ],
+      "example": "formSpaceSubmissionNotificationTaskKey({ formSpaceId: 'abc' }); // 'nb/not_not/nbn/abc_FSPS'\nformSpaceSubmissionNotificationTaskKey({ formSpaceId: 'abc', reopenCount: 2 }); // 'nb/not_not/nbn/abc_FSPS_r2'",
+      "relatedSlugs": [
+        "unique-notification-task-key"
+      ]
+    },
+    {
+      "slug": "unique-notification-task-key",
+      "name": "uniqueNotificationTaskKey",
+      "kind": "function",
+      "category": "firestore",
+      "module": "@dereekb/firebase",
+      "subpath": "model/notification/notification.create",
+      "signature": "uniqueNotificationTaskKey(input: UniqueNotificationTaskKeyInput): NotificationTaskKey",
+      "description": "Returns the key of a unique notification task: the notification with the unique id in the notification model's box.\n\nThis is the location {@link createNotificationDocumentPair} loads a unique task from when its accessor comes from `context`, so a key recorded with this function always points at the created task.",
+      "params": [
+        {
+          "name": "input",
+          "type": "UniqueNotificationTaskKeyInput",
+          "description": "- The notification model and the unique task id.",
+          "optional": false
+        }
+      ],
+      "returns": "The full key of the unique notification task.",
+      "tags": [
+        "notification",
+        "task",
+        "unique",
+        "key",
+        "notification-box",
+        "location",
+        "firestore",
+        "uniquenotificationtaskkey"
+      ],
+      "example": "uniqueNotificationTaskKey({ notificationModel: 'profile/abc', uniqueId: 'abc_T' }); // 'nb/profile_abc/nbn/abc_T'\nuniqueNotificationTaskKey({ uniqueId: 'abc_T' }); // 'nb/not_not/nbn/abc_T'",
+      "relatedSlugs": [
+        "form-space-submission-notification-task-key"
+      ]
+    },
     {
       "slug": "is-nth-hour-of-day",
       "name": "isNthHourOfDay",
@@ -1186,6 +1254,50 @@
         "load-documents-for-document-references"
       ]
     },
+    {
+      "slug": "load-document-for-id-or-key",
+      "name": "loadDocumentForIdOrKey",
+      "kind": "function",
+      "category": "firestore",
+      "module": "@dereekb/firebase",
+      "subpath": "common/firestore/accessor/document.utility",
+      "signature": "loadDocumentForIdOrKey(accessor: FirestoreDocumentAccessor<T, D>, idOrKey: FirestoreModelId | FirestoreModelKey): D",
+      "description": "Loads the {@link FirestoreDocument} a document id or a full key refers to.\n\nA value containing `/` is a full key, loaded with `accessor.loadDocumentForKey()`, which refuses a key of another\ncollection. Anything else is a document id, loaded relative to the accessor's collection with `accessor.loadDocumentForId()`.\nResolving an id through the accessor, rather than prefixing a collection name onto it, keeps a subcollection's parent and\na test driver's fuzzed collection names intact. No network calls are made.",
+      "params": [
+        {
+          "name": "accessor",
+          "type": "FirestoreDocumentAccessor<T, D>",
+          "description": "- Accessor to load the document with (must have collection context to resolve an id).",
+          "optional": false
+        },
+        {
+          "name": "idOrKey",
+          "type": "FirestoreModelId | FirestoreModelKey",
+          "description": "- A document id (`abc123`) or a full key (`gb/abc123`).",
+          "optional": false
+        }
+      ],
+      "returns": "The document instance.",
+      "tags": [
+        "firestore",
+        "document",
+        "loader",
+        "accessor",
+        "id",
+        "key",
+        "path",
+        "either",
+        "promote",
+        "load",
+        "for",
+        "or",
+        "loaddocumentforidorkey"
+      ],
+      "relatedSlugs": [
+        "load-documents-for-ids",
+        "load-documents-for-keys"
+      ]
+    },
     {
       "slug": "firestore-document-loader",
       "name": "firestoreDocumentLoader",

package/generated/dereekb-model.utils.mcp.generated.json

@@ -5,6 +5,47 @@
   "generatedAt": "1970-01-01T00:00:00.000Z",
   "generator": "@dereekb/dbx-components-mcp/scripts/generate-manifests.mjs",
   "entries": [
+    {
+      "slug": "merge-clearable-object-update",
+      "name": "mergeClearableObjectUpdate",
+      "kind": "function",
+      "category": "object",
+      "module": "@dereekb/model",
+      "subpath": "type/type",
+      "signature": "mergeClearableObjectUpdate(current: Maybe<Partial<T>>, update: Maybe<ClearableObjectUpdate<T>>): Partial<T>",
+      "description": "Merges a {@link ClearableObjectUpdate} into the current object and returns the result as a new object.\n\nA `null` value in the update deletes the key, and an `undefined` value leaves the current value unchanged.\n`null` and `undefined` values already on the current object are dropped too, so the result only holds set values.",
+      "params": [
+        {
+          "name": "current",
+          "type": "Maybe<Partial<T>>",
+          "description": "- The current object. Null/undefined is treated as an empty object.",
+          "optional": false
+        },
+        {
+          "name": "update",
+          "type": "Maybe<ClearableObjectUpdate<T>>",
+          "description": "- The update to merge in. Null/undefined returns a copy of the current values.",
+          "optional": false
+        }
+      ],
+      "returns": "A new object with the update applied. Neither input is modified.",
+      "tags": [
+        "object",
+        "merge",
+        "update",
+        "patch",
+        "clear",
+        "clearable",
+        "null",
+        "delete",
+        "mergeclearableobjectupdate"
+      ],
+      "example": "mergeClearableObjectUpdate({ a: 1, b: 2 }, { b: null, c: 3, d: undefined });\n// { a: 1, c: 3 }",
+      "relatedSlugs": [
+        "merge-objects",
+        "strip-object"
+      ]
+    },
     {
       "slug": "iso8601-day-string-type",
       "name": "iso8601DayStringType",

package/generated/dereekb-util.utils.mcp.generated.json

@@ -1528,6 +1528,55 @@
         "random-number-factory"
       ]
     },
+    {
+      "slug": "array-to-object",
+      "name": "arrayToObject",
+      "kind": "function",
+      "category": "array",
+      "module": "@dereekb/util",
+      "subpath": "array/array.map",
+      "signature": "arrayToObject(values: T[], keyFnOrConfig: ReadKeyFunction<T, K> | ArrayToObjectConfig<T, K, V>, valueFn?: (t: T) => V): Record<K, V>",
+      "description": "Maps the values of the input array to a Record object, keyed by the result of a key function.\nItems with undefined keys are omitted. Optionally transforms each value using a value function.\n\nAlso accepts an {@link ArrayToObjectConfig} as the second argument, which can throw when two values share a key instead of letting the last value win.",
+      "params": [
+        {
+          "name": "values",
+          "type": "T[]",
+          "description": "- source array of items to map",
+          "optional": false
+        },
+        {
+          "name": "keyFnOrConfig",
+          "type": "ReadKeyFunction<T, K> | ArrayToObjectConfig<T, K, V>",
+          "description": "",
+          "optional": false
+        },
+        {
+          "name": "valueFn",
+          "type": "(t: T) => V",
+          "description": "- optional function to transform each item into the desired record value",
+          "optional": true
+        }
+      ],
+      "returns": "a Record of keys to values derived from the input array",
+      "tags": [
+        "array",
+        "object",
+        "record",
+        "index",
+        "key",
+        "lookup",
+        "duplicate",
+        "unique",
+        "registry",
+        "to",
+        "arraytoobject"
+      ],
+      "example": "const byId = arrayToObject([{ id: 'a' }, { id: 'b' }], (x) => x.id);\n// { a: { id: 'a' }, b: { id: 'b' } }\n\nconst registry = arrayToObject(configs, {\n  readKey: (x) => x.type,\n  throwOnDuplicateKey: (type) => new Error(`duplicate type in registry: ${type}`)\n});",
+      "relatedSlugs": [
+        "is-unique-keyed-function",
+        "key-value-map-factory"
+      ]
+    },
     {
       "slug": "random-pick-factory",
       "name": "randomPickFactory",
@@ -10089,6 +10138,40 @@
         "handler-factory"
       ]
     },
+    {
+      "slug": "typed-config-registry",
+      "name": "typedConfigRegistry",
+      "kind": "factory",
+      "category": "service",
+      "module": "@dereekb/util",
+      "subpath": "service/typed.service",
+      "signature": "typedConfigRegistry(config: TypedConfigRegistrySetupConfig<C, T>): TypedConfigRegistry<C, T>",
+      "description": "Creates a {@link TypedConfigRegistry} over a record of configs.\n\nLookups read the passed record with an own-property check, so a type such as `constructor` never resolves to an `Object.prototype` member. The known types and configs are captured when the registry is created and returned as copies.",
+      "params": [
+        {
+          "name": "config",
+          "type": "TypedConfigRegistrySetupConfig<C, T>",
+          "description": "- The configs and the fallback for unregistered types.",
+          "optional": false
+        }
+      ],
+      "returns": "A registry whose members can be re-exposed under domain-specific names.",
+      "tags": [
+        "service",
+        "registry",
+        "config",
+        "type",
+        "lookup",
+        "fallback",
+        "default",
+        "typed",
+        "typedconfigregistry"
+      ],
+      "example": "const registry = typedConfigRegistry({\n  configs: { a: { type: 'a', label: 'A' } },\n  defaultConfigForType: (type) => ({ type, label: 'Unknown' })\n});\n\nregistry.configForType('a'); // { type: 'a', label: 'A' }\nregistry.configForType('b'); // { type: 'b', label: 'Unknown' }\nregistry.registeredConfigForType('b'); // undefined",
+      "relatedSlugs": [
+        "array-to-object"
+      ]
+    },
     {
       "slug": "is-in-set-decision-function",
       "name": "isInSetDecisionFunction",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-components-mcp",
-  "version": "14.16.0",
+  "version": "14.17.0",
   "sideEffects": false,
   "type": "module",
   "bin": {
@@ -12,7 +12,7 @@
     "ts-morph": "^21.0.0"
   },
   "peerDependencies": {
-    "@dereekb/dbx-cli": "14.16.0",
-    "@dereekb/util": "14.16.0"
+    "@dereekb/dbx-cli": "14.17.0",
+    "@dereekb/util": "14.17.0"
   }
 }