@theglitchking/hit-em-with-the-docs 2.2.0 → 2.4.0

package/dist/core/metadata/errors.js

@@ -0,0 +1,95 @@
+/**
+ * Error codes for knowledge-base primitive validation (introduced in 2.3.0).
+ *
+ * The schema's .refine() rules prefix their messages with one of these codes
+ * in square brackets, e.g. `[FACT_MISSING_ID] id is required when tier is "fact"`.
+ * The audit layer parses the code out of the message to populate AuditIssue.code,
+ * which lets CI and tooling switch on specific violation types without
+ * substring-matching prose.
+ *
+ * Codes are namespaced by primitive:
+ *   FACT_*       — facts
+ *   INCIDENT_*   — incident folders (narrative + facts.md)
+ *   PLAYBOOK_*   — playbook symptoms blocks (the symptoms: frontmatter field)
+ */
+export const KB_ERROR_CODES = {
+    // Facts
+    FACT_MISSING_ID: 'FACT_MISSING_ID',
+    FACT_ID_FILENAME_MISMATCH: 'FACT_ID_FILENAME_MISMATCH',
+    FACT_MISSING_PROVENANCE: 'FACT_MISSING_PROVENANCE',
+    FACT_INVALID_CONFIDENCE: 'FACT_INVALID_CONFIDENCE',
+    FACT_MISSING_LAST_VERIFIED: 'FACT_MISSING_LAST_VERIFIED',
+    FACT_VERIFY_COMMAND_MULTILINE_SHEBANG: 'FACT_VERIFY_COMMAND_MULTILINE_SHEBANG',
+    // Incidents
+    INCIDENT_FOLDER_MISSING_NARRATIVE: 'INCIDENT_FOLDER_MISSING_NARRATIVE',
+    INCIDENT_FOLDER_MISSING_FACTS: 'INCIDENT_FOLDER_MISSING_FACTS',
+    INCIDENT_NARRATIVE_MISSING_DATE: 'INCIDENT_NARRATIVE_MISSING_DATE',
+    INCIDENT_NARRATIVE_MISSING_SEVERITY: 'INCIDENT_NARRATIVE_MISSING_SEVERITY',
+    INCIDENT_NARRATIVE_INVALID_SEVERITY: 'INCIDENT_NARRATIVE_INVALID_SEVERITY',
+    INCIDENT_NARRATIVE_MISSING_RESOLUTION_STATUS: 'INCIDENT_NARRATIVE_MISSING_RESOLUTION_STATUS',
+    INCIDENT_NARRATIVE_INVALID_RESOLUTION_STATUS: 'INCIDENT_NARRATIVE_INVALID_RESOLUTION_STATUS',
+    INCIDENT_NARRATIVE_MISSING_COMPONENTS: 'INCIDENT_NARRATIVE_MISSING_COMPONENTS',
+    INCIDENT_FACTS_MISSING_INCIDENT_ID: 'INCIDENT_FACTS_MISSING_INCIDENT_ID',
+    INCIDENT_FACTS_MISSING_PRODUCED: 'INCIDENT_FACTS_MISSING_PRODUCED',
+    INCIDENT_FACTS_DANGLING_REF: 'INCIDENT_FACTS_DANGLING_REF',
+    // Playbook symptoms blocks
+    PLAYBOOK_SYMPTOM_MISSING_KEY: 'PLAYBOOK_SYMPTOM_MISSING_KEY',
+    PLAYBOOK_SYMPTOM_MISSING_TARGET: 'PLAYBOOK_SYMPTOM_MISSING_TARGET',
+    PLAYBOOK_SYMPTOM_MISSING_CITES: 'PLAYBOOK_SYMPTOM_MISSING_CITES',
+    PLAYBOOK_SYMPTOM_DANGLING_CITE: 'PLAYBOOK_SYMPTOM_DANGLING_CITE',
+};
+/**
+ * Severity for each KB error code.
+ *
+ * Most violations are `error`. The shebang check on verify_command is `warning`
+ * because the spec calls it out as "warning only — multi-line is fine, shebang
+ * missing is OK". Dangling refs (facts referencing non-existent fact-ids, or
+ * playbook citations to non-existent fact-ids) are `error`.
+ */
+export const KB_ERROR_SEVERITY = {
+    FACT_MISSING_ID: 'error',
+    FACT_ID_FILENAME_MISMATCH: 'error',
+    FACT_MISSING_PROVENANCE: 'error',
+    FACT_INVALID_CONFIDENCE: 'error',
+    FACT_MISSING_LAST_VERIFIED: 'error',
+    FACT_VERIFY_COMMAND_MULTILINE_SHEBANG: 'warning',
+    INCIDENT_FOLDER_MISSING_NARRATIVE: 'error',
+    INCIDENT_FOLDER_MISSING_FACTS: 'error',
+    INCIDENT_NARRATIVE_MISSING_DATE: 'error',
+    INCIDENT_NARRATIVE_MISSING_SEVERITY: 'error',
+    INCIDENT_NARRATIVE_INVALID_SEVERITY: 'error',
+    INCIDENT_NARRATIVE_MISSING_RESOLUTION_STATUS: 'error',
+    INCIDENT_NARRATIVE_INVALID_RESOLUTION_STATUS: 'error',
+    INCIDENT_NARRATIVE_MISSING_COMPONENTS: 'error',
+    INCIDENT_FACTS_MISSING_INCIDENT_ID: 'error',
+    INCIDENT_FACTS_MISSING_PRODUCED: 'error',
+    INCIDENT_FACTS_DANGLING_REF: 'error',
+    PLAYBOOK_SYMPTOM_MISSING_KEY: 'error',
+    PLAYBOOK_SYMPTOM_MISSING_TARGET: 'error',
+    PLAYBOOK_SYMPTOM_MISSING_CITES: 'error',
+    PLAYBOOK_SYMPTOM_DANGLING_CITE: 'error',
+};
+/**
+ * Format a code-prefixed error message. The audit layer parses the leading
+ * `[CODE]` to populate `AuditIssue.code` without losing the human-readable
+ * description.
+ */
+export function formatKbError(code, message) {
+    return `[${code}] ${message}`;
+}
+const KB_ERROR_PREFIX_RE = /^\[([A-Z_]+)\]\s+(.*)$/;
+/**
+ * Extract a KB error code from a refine() message, if present. Returns null
+ * for messages that don't begin with `[CODE] `.
+ */
+export function parseKbErrorCode(message) {
+    const match = message.match(KB_ERROR_PREFIX_RE);
+    if (!match)
+        return null;
+    const code = match[1];
+    const remainder = match[2] ?? '';
+    if (!(code in KB_ERROR_SEVERITY))
+        return null;
+    return { code: code, message: remainder };
+}
+//# sourceMappingURL=errors.js.map

package/dist/core/metadata/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/core/metadata/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,QAAQ;IACR,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,uBAAuB,EAAE,yBAAyB;IAClD,0BAA0B,EAAE,4BAA4B;IACxD,qCAAqC,EAAE,uCAAuC;IAE9E,YAAY;IACZ,iCAAiC,EAAE,mCAAmC;IACtE,6BAA6B,EAAE,+BAA+B;IAC9D,+BAA+B,EAAE,iCAAiC;IAClE,mCAAmC,EAAE,qCAAqC;IAC1E,mCAAmC,EAAE,qCAAqC;IAC1E,4CAA4C,EAC1C,8CAA8C;IAChD,4CAA4C,EAC1C,8CAA8C;IAChD,qCAAqC,EAAE,uCAAuC;IAC9E,kCAAkC,EAAE,oCAAoC;IACxE,+BAA+B,EAAE,iCAAiC;IAClE,2BAA2B,EAAE,6BAA6B;IAE1D,2BAA2B;IAC3B,4BAA4B,EAAE,8BAA8B;IAC5D,+BAA+B,EAAE,iCAAiC;IAClE,8BAA8B,EAAE,gCAAgC;IAChE,8BAA8B,EAAE,gCAAgC;CACxD,CAAC;AAIX;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAA6C;IACzE,eAAe,EAAE,OAAO;IACxB,yBAAyB,EAAE,OAAO;IAClC,uBAAuB,EAAE,OAAO;IAChC,uBAAuB,EAAE,OAAO;IAChC,0BAA0B,EAAE,OAAO;IACnC,qCAAqC,EAAE,SAAS;IAChD,iCAAiC,EAAE,OAAO;IAC1C,6BAA6B,EAAE,OAAO;IACtC,+BAA+B,EAAE,OAAO;IACxC,mCAAmC,EAAE,OAAO;IAC5C,mCAAmC,EAAE,OAAO;IAC5C,4CAA4C,EAAE,OAAO;IACrD,4CAA4C,EAAE,OAAO;IACrD,qCAAqC,EAAE,OAAO;IAC9C,kCAAkC,EAAE,OAAO;IAC3C,+BAA+B,EAAE,OAAO;IACxC,2BAA2B,EAAE,OAAO;IACpC,4BAA4B,EAAE,OAAO;IACrC,+BAA+B,EAAE,OAAO;IACxC,8BAA8B,EAAE,OAAO;IACvC,8BAA8B,EAAE,OAAO;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAAiB,EAAE,OAAe;IAC9D,OAAO,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;AAChC,CAAC;AAED,MAAM,kBAAkB,GAAG,wBAAwB,CAAC;AAEpD;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAe;IAEf,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAChD,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IAExB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAW,CAAC;IAChC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAEjC,IAAI,CAAC,CAAC,IAAI,IAAI,iBAAiB,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9C,OAAO,EAAE,IAAI,EAAE,IAAmB,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAC3D,CAAC"}