@dereekb/dbx-components-mcp 13.10.3 → 13.10.5

package/generated/rule-catalog.generated.json

@@ -290,34 +290,50 @@
     "canonicalFix": "Update the getter body to return the matching identity constant."
   },
   {
-    "code": "MODEL_FIELD_JSDOC_NO_FULL_NAME",
+    "code": "MODEL_FIELD_MISSING_JSDOC",
     "source": "dbx_model_validate",
     "severity": "warning",
-    "title": "A persisted field's JSDoc doesn't open with `<fullName> -- <description>`",
-    "whatItFlags": "A persisted field's JSDoc doesn't open with `<fullName> -- <description>`.",
-    "whenItApplies": "Every field with JSDoc — the first line should match the `<fullName> -- <description>` pattern so the long-name extractor and decoder agree on field semantics.",
-    "whenItDoesNotApply": "When the project deliberately uses a non-standard JSDoc convention (rare).",
-    "canonicalFix": "Reformat the JSDoc opener to `<longName> -- <one-line description>`."
+    "title": "A persisted field has no JSDoc description",
+    "whatItFlags": "A persisted field has no JSDoc description.",
+    "whenItApplies": "Every persisted field — short field names need a JSDoc description so a reader knows what the field is actually for. The long-name itself is carried by the `@dbxModelVariable` tag, so the JSDoc body just needs a one-line description.",
+    "whenItDoesNotApply": "Fields whose name is unambiguously self-describing (rare with 1-4 char abbreviations).",
+    "canonicalFix": "Add `/** <one-line description> *\\/` above the field declaration (and append `@dbxModelVariable <longName>` for the canonical long name)."
   },
   {
-    "code": "MODEL_FIELD_MISSING_JSDOC",
+    "code": "MODEL_FIELD_MISSING_VARIABLE_TAG",
     "source": "dbx_model_validate",
     "severity": "warning",
-    "title": "A persisted field has no JSDoc",
-    "whatItFlags": "A persisted field has no JSDoc.",
-    "whenItApplies": "Every persisted field — short field names need JSDoc to document what they mean.",
-    "whenItDoesNotApply": "Fields whose name is unambiguously self-describing (rare with 1-4 char abbreviations).",
-    "canonicalFix": "Add `/** <fullName> -- <description> *\\/` above the field declaration."
+    "title": "A persisted field is missing its `@dbxModelVariable <name>` JSDoc tag",
+    "whatItFlags": "A persisted field is missing its `@dbxModelVariable <name>` JSDoc tag.",
+    "whenItApplies": "Every field on a `@dbxModel` interface — the tag carries the human-readable long name the catalog and decoder use when surfacing the field to operators. The long name is the variable name the field would have unabbreviated, written in camelCase (e.g. `uid` → `userUid`, `n` → `name`, `crAt` → `createdAt`).",
+    "whenItDoesNotApply": "Fields on embedded sub-object interfaces (no `@dbxModel` parent) and fields the project deliberately leaves untagged (rare).",
+    "canonicalFix": "Append `@dbxModelVariable <longName>` to the field's JSDoc block, where `<longName>` is the field's unabbreviated camelCase variable name."
   },
   {
     "code": "MODEL_FIELD_NAME_TOO_LONG",
     "source": "dbx_model_validate",
     "severity": "warning",
-    "title": "A persisted field's name exceeds the workspace's 4-character convention",
-    "whatItFlags": "A persisted field's name exceeds the workspace's 4-character convention.",
-    "whenItApplies": "Every persisted field on a model interface (or sub-object interface).",
-    "whenItDoesNotApply": "Fields that compose well-known multi-character abbreviations the project intentionally allows.",
-    "canonicalFix": "Rename the field to a 1–4 character abbreviation (e.g. `name` → `n`, `userId` → `uid`)."
+    "title": "A persisted field's name exceeds the workspace's 5-character convention",
+    "whatItFlags": "A persisted field's name exceeds the workspace's 5-character convention.",
+    "whenItApplies": "Every persisted field on a model interface (or sub-object interface). The default limit is 5; override via `dbx-mcp.config.json` `modelValidate.maxFieldNameLength`.",
+    "whenItDoesNotApply": "Fields whose name is listed in `dbx-mcp.config.json` `modelValidate.ignoredFieldNames`, or fields that compose well-known multi-character abbreviations the project intentionally allows.",
+    "canonicalFix": "Rename the field to a 1–5 character abbreviation (e.g. `name` → `n`, `userId` → `uid`). To exempt specific names workspace-wide, add them to `modelValidate.ignoredFieldNames` in `dbx-mcp.config.json`."
+  },
+  {
+    "code": "MODEL_GROUP_INTERFACE_MISSING_TAG",
+    "source": "dbx_model_validate",
+    "severity": "error",
+    "title": "The `<Group>FirestoreCollections` interface is missing its `@dbxModelGroup` JSDoc tag",
+    "whatItFlags": "The `<Group>FirestoreCollections` interface is missing its `@dbxModelGroup` JSDoc tag.",
+    "whenItApplies": "Every group container — the rich catalog extractor (`scan/extract-models`) requires the tag to register the group, and downstream traversal/referencing depends on that registration.",
+    "whenItDoesNotApply": "Files in `@dereekb/firebase` itself (upstream-owned sources).",
+    "canonicalFix": "Add `@dbxModelGroup <Group>` to the JSDoc above the `<Group>FirestoreCollections` declaration.",
+    "seeAlso": [
+      {
+        "kind": "artifact",
+        "target": "firestore-model"
+      }
+    ]
   },
   {
     "code": "MODEL_IDENTITY_BAD_ARGS",
@@ -339,6 +355,38 @@
     "whenItDoesNotApply": "When intentionally module-private (rare).",
     "canonicalFix": "Add `export` to the identity constant declaration."
   },
+  {
+    "code": "MODEL_IDENTITY_NOT_TAGGED",
+    "source": "dbx_model_validate",
+    "severity": "error",
+    "title": "`firestoreModelIdentity(...)` was found but its corresponding model interface lacks the `@dbxModel` JSDoc tag, leaving the model invisible to the catalog and to downstream traversal/referencing code",
+    "whatItFlags": "`firestoreModelIdentity(...)` was found but its corresponding model interface lacks the `@dbxModel` JSDoc tag, leaving the model invisible to the catalog and to downstream traversal/referencing code.",
+    "whenItApplies": "Every `firestoreModelIdentity(...)` call whose `<PascalName>` interface is missing `@dbxModel`. Anchored at the identity line so the fix points at both the interface and the identity.",
+    "whenItDoesNotApply": "Files in `@dereekb/firebase` itself.",
+    "canonicalFix": "Add `@dbxModel` to the JSDoc on the `<PascalName>` interface so the catalog and decoder recognise it as a model.",
+    "seeAlso": [
+      {
+        "kind": "artifact",
+        "target": "firestore-model"
+      }
+    ]
+  },
+  {
+    "code": "MODEL_INTERFACE_MISSING_TAG",
+    "source": "dbx_model_validate",
+    "severity": "error",
+    "title": "The model's data interface is missing its `@dbxModel` JSDoc tag",
+    "whatItFlags": "The model's data interface is missing its `@dbxModel` JSDoc tag.",
+    "whenItApplies": "Every `<PascalName>` interface that anchors a `firestoreModelIdentity(...)` model — the rich catalog extractor (`scan/extract-models`) requires the tag to register the model.",
+    "whenItDoesNotApply": "Embedded sub-object interfaces (no matching identity) and files in `@dereekb/firebase` itself.",
+    "canonicalFix": "Add `@dbxModel` to the JSDoc above the `<PascalName>` interface declaration.",
+    "seeAlso": [
+      {
+        "kind": "artifact",
+        "target": "firestore-model"
+      }
+    ]
+  },
   {
     "code": "MODEL_INTERFACE_NOT_EXPORTED",
     "source": "dbx_model_validate",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-components-mcp",
-  "version": "13.10.3",
+  "version": "13.10.5",
   "type": "module",
   "bin": {
     "dbx-components-mcp": "dbx-components-mcp.js"