@hyperscale0/udl 2.6.1 → 3.0.0

package/src/diagnostics.ts

@@ -1,257 +1,62 @@
-export type UdlIssueCategory =
-  | "invalid_evolution"
-  | "invalid_json"
-  | "invalid_semantics"
-  | "invalid_shape"
-  | "invalid_utf8"
-  | "resource_limit";
-
-export type UdlDiagnosticFamily =
-  | "admission"
-  | "document"
-  | "evolution"
-  | "finance"
-  | "gates"
-  | "lifecycle"
-  | "schema";
-
-const diagnosticDefinitions = {
-  UDL1001: {
-    category: "invalid_utf8",
-    family: "admission",
-    title: "Invalid UTF-8",
-    fix: "Encode the document as valid UTF-8.",
-  },
-  UDL1002: {
-    category: "invalid_json",
-    family: "admission",
-    title: "Invalid JSON",
-    fix: "Repair the JSON syntax before validation.",
-  },
-  UDL1003: {
-    category: "invalid_shape",
-    family: "admission",
-    title: "Invalid document shape",
-    fix: "Match the published UDL JSON Schema.",
-  },
-  UDL1004: {
-    category: "resource_limit",
-    family: "admission",
-    title: "Resource limit exceeded",
-    fix: "Reduce the source size, nesting, values, strings, references, or financial paths named by the message.",
-  },
-
-  UDL2001: {
-    category: "invalid_semantics",
-    family: "document",
-    title: "Duplicate declaration",
-    fix: "Give each declaration a unique name.",
-  },
-  UDL2002: {
-    category: "invalid_semantics",
-    family: "document",
-    title: "Document law violation",
-    fix: "Repair the declaration, subject contract, or derived effects named by the message.",
-  },
-  UDL2005: {
-    category: "invalid_semantics",
-    family: "document",
-    title: "Derived effects mismatch",
-    fix: "Regenerate the action effects from its clauses.",
-  },
-  UDL2010: {
-    category: "invalid_semantics",
-    family: "document",
-    title: "Action graph violation",
-    fix: "Order all actions and calls without cycles or collisions, within depth and count limits.",
-  },
-  UDL2011: {
-    category: "invalid_semantics",
-    family: "document",
-    title: "Action binding violation",
-    fix: "Bind parameters to declared instance, piece, or caller variables without forward references or duplicate captures.",
-  },
-  UDL2012: {
-    category: "invalid_semantics",
-    family: "document",
-    title: "Action authority violation",
-    fix: "Match principal, approval, and recovery policies and keep field paths within tenant boundary.",
-  },
-  UDL2013: {
-    category: "invalid_semantics",
-    family: "document",
-    title: "Action effect or evidence violation",
-    fix: "Provide valid effect kind, matching effect signature, and non-empty evidence for every leaf.",
-  },
-
-  UDL3001: {
-    category: "invalid_semantics",
-    family: "lifecycle",
-    title: "Lifecycle is not closed",
-    fix: "Declare every state and action transition, and make every state reachable.",
-  },
-
-  UDL4001: {
-    category: "invalid_semantics",
-    family: "finance",
-    title: "Money graph violation",
-    fix: "Balance every funded amount and close every hold on each lifecycle path.",
-  },
-  UDL4002: {
-    category: "invalid_semantics",
-    family: "finance",
-    title: "Piece partition violation",
-    fix: "Match piece plan total, amounts, and payees to required immutable fields and declared partition.",
-  },
-
-  UDL5001: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Reference gate violation",
-    fix: "Point the gate at a declared instrument, action, state, field, and reference.",
-  },
-  UDL5002: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Check requirement violation",
-    fix: "Use a declared check with compatible evidence and recurrence.",
-  },
-  UDL5003: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Exposure gate violation",
-    fix: "Use declared account and money fields for the exposure gate.",
-  },
-  UDL5004: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Aggregate law violation",
-    fix: "Point the aggregate at compatible parent and child fields.",
-  },
-  UDL5005: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Settlement or payout violation",
-    fix: "Use a declared settlement account and a compatible payout statement line.",
-  },
-  UDL5006: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Quote and commit violation",
-    fix: "Declare one complete quote freeze set and one matching commit action.",
-  },
-  UDL5007: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Reconcile exception child violation",
-    fix: "Name a declared child whose reference points back to this instrument.",
-  },
-  UDL5008: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Action clause violation",
-    fix: "Repair the clause fields and keep incompatible clauses separate.",
-  },
-  UDL5009: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Reconcile exception amount field is missing or optional",
-    fix: "Name the exception child's required money field in amountField.",
-  },
-  UDL5010: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Reconcile exception amount field has the wrong type",
-    fix: "Point amountField at a money field declared by the exception child.",
-  },
-  UDL5011: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Reconcile exception reason field is missing or optional",
-    fix: "Name the exception child's required text field in reasonField.",
-  },
-  UDL5012: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Reconcile exception reason field has the wrong type",
-    fix: "Point reasonField at a required plain text field declared by the exception child.",
-  },
-  UDL5013: {
-    category: "invalid_semantics",
-    family: "gates",
-    title: "Piece stage violation",
-    fix: "Reference a declared piece plan and stage in the containing instrument.",
-  },
-
-  UDL6001: {
-    category: "invalid_semantics",
-    family: "schema",
-    title: "Unsupported JSON Schema",
-    fix: "Use only the sealed UDL JSON Schema subset.",
-  },
-
-  UDL7001: {
-    category: "invalid_evolution",
-    family: "evolution",
-    title: "Stored contract changed",
-    fix: "Keep stored identities and contracts unchanged, and add only allowed optional declarations.",
-  },
-  UDL7002: {
-    category: "invalid_evolution",
-    family: "evolution",
-    title: "Version was not increased",
-    fix: "Increase the product version for every semantic change.",
-  },
-} as const satisfies Record<
-  string,
-  {
-    readonly category: UdlIssueCategory;
-    readonly family: UdlDiagnosticFamily;
-    readonly fix: string;
-    readonly title: string;
-  }
->;
-
-export type UdlIssueCode = keyof typeof diagnosticDefinitions;
-
-export interface UdlDiagnostic {
-  readonly category: UdlIssueCategory;
-  readonly code: UdlIssueCode;
-  readonly family: UdlDiagnosticFamily;
-  readonly fix: string;
-  readonly title: string;
-}
-
-export const udlDiagnostics: readonly UdlDiagnostic[] = Object.entries(
-  diagnosticDefinitions,
-).map(([code, diagnostic]) => ({
-  code: code as UdlIssueCode,
-  ...diagnostic,
-}));
-
-export function udlDiagnostic(code: string): UdlDiagnostic | undefined {
-  return udlDiagnostics.find((diagnostic) => diagnostic.code === code);
-}
-
+export type UdlIssueCode =
+  | "UDL1001"
+  | "UDL1002"
+  | "UDL1003"
+  | "UDL1004"
+  | "UDL2001"
+  | "UDL2002"
+  | "UDL2010"
+  | "UDL3001"
+  | "UDL4001"
+  | "UDL5001"
+  | "UDL7001"
+  | "UDL7002";
 export interface UdlIssue {
-  readonly category: UdlIssueCategory;
-  readonly code: UdlIssueCode;
-  readonly fix: string;
-  readonly message: string;
-  readonly path: string;
+  code: UdlIssueCode;
+  path: string;
+  message: string;
+  fix: string;
+  category: string;
 }
-
+const fixes: Record<UdlIssueCode, string> = {
+  UDL1001: "Encode the source as UTF-8.",
+  UDL1002: "Repair JSON syntax.",
+  UDL1003: "Use the UDL 3 typed grammar.",
+  UDL1004: "Reduce the declared structure or expansion.",
+  UDL2001: "Give each declaration a distinct name.",
+  UDL2002: "Repair the named type or declaration.",
+  UDL2010: "Remove the invocation cycle or reduce its expansion.",
+  UDL3001: "Declare reachable states and one transition per action.",
+  UDL4001:
+    "Fund owned accounts before spending and close them with zero balances.",
+  UDL5001: "Use a declared reference of the required type.",
+  UDL7001: "Preserve existing instance meaning or recreate the estate.",
+  UDL7002: "Increase the contract version.",
+};
 export function issue(
   code: UdlIssueCode,
   path: string,
-  messageDetail?: string,
+  message: string,
 ): UdlIssue {
-  const diagnostic = diagnosticDefinitions[code];
   return {
-    category: diagnostic.category,
     code,
-    fix: diagnostic.fix,
-    message: messageDetail ?? diagnostic.title,
     path,
+    message,
+    fix: fixes[code],
+    category:
+      code === "UDL1003"
+        ? "invalid_shape"
+        : code === "UDL1004"
+          ? "resource_limit"
+          : "invalid_semantics",
   };
 }
+export const udlDiagnostics = Object.entries(fixes).map(([code, fix]) => ({
+  code,
+  fix,
+  title: fix,
+  category: "invalid_semantics",
+  family: "document",
+}));
+export const udlDiagnostic = (code: string) =>
+  udlDiagnostics.find((d) => d.code === code);