@asterdoc/schemas 0.0.0-stage → 0.10.0

package/schemas/2026-10-28/checklist-item.json

@@ -0,0 +1,113 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/checklist-item.json",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Unique identifier for the checklist item (e.g., \"task-1\", \"step-a\"). Used to link to runtime status."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Title or label for the checklist item"
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "description": "Detailed description or instructions for the item"
+    },
+    "status": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "boolean"
+            },
+            "default": {
+              "type": "boolean",
+              "description": "Default status value (true/false) for new instances"
+            }
+          },
+          "required": [
+            "kind"
+          ],
+          "additionalProperties": false,
+          "title": "BooleanStatusSpec",
+          "description": "Boolean status (e.g., incomplete/complete) with an optional default value."
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "enum"
+            },
+            "options": {
+              "minItems": 1,
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 64,
+                    "description": "Internal status value (e.g., \"todo\", \"in-progress\", \"done\")"
+                  },
+                  "label": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256,
+                    "description": "Human-readable label for the status option"
+                  },
+                  "description": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 2000,
+                    "description": "Optional description or help text for this status option"
+                  }
+                },
+                "required": [
+                  "value",
+                  "label"
+                ],
+                "additionalProperties": false,
+                "title": "EnumStatusOption"
+              },
+              "description": "Allowed status options"
+            },
+            "default": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 64,
+              "description": "Default status value for new instances (must match one of the option values)"
+            }
+          },
+          "required": [
+            "kind",
+            "options"
+          ],
+          "additionalProperties": false,
+          "title": "EnumStatusSpec",
+          "description": "Enum-based status with a set of allowed options and an optional default."
+        }
+      ],
+      "title": "StatusSpec",
+      "description": "Specification for how checklist item status should be represented (boolean or enum)."
+    }
+  },
+  "required": [
+    "id",
+    "title"
+  ],
+  "additionalProperties": false,
+  "description": "A single item in a checklist artifact. Each item has an ID, title, optional description, and an optional status specification (boolean or enum). If status is omitted, a default boolean status may be assumed (implementation-defined).",
+  "title": "ChecklistItem"
+}

package/schemas/2026-10-28/checklist.json

@@ -0,0 +1,300 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/checklist.json",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI for this artifact instance."
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9]([A-Za-z0-9]|-[A-Za-z0-9])*$",
+      "description": "Artifact identifier. Must start with a letter or digit, can contain letters, numbers, and hyphens (no leading/trailing/consecutive hyphens). Every edition of one artifact shares the same name."
+    },
+    "version": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
+      "description": "Artifact version (SemVer 2.0.0, such as 1.2.3 or 1.3.0-beta.1). It counts the publisher's own changes, never the issuer's edition; each edition has its own version line. Required for publishing to registry."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "description": "Human-readable title. Recommended for published/shared artifacts and directory browsing."
+    },
+    "description": {
+      "type": "string",
+      "minLength": 0,
+      "maxLength": 2000,
+      "description": "Detailed description or context for the artifact."
+    },
+    "code": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "description": "The form number as printed by its issuer, such as W-9 or ACORD 25, or a self-issued form's own number."
+    },
+    "issuer": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "description": "The organization that issues the form, such as U.S. Internal Revenue Service."
+    },
+    "edition": {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^(?!(?:current|latest|editions|tags|diff)$)[a-z0-9]([a-z0-9]|-[a-z0-9])*$",
+          "description": "Stable edition identifier, unique among the editions of one artifact (for example 2024-03 or 3b). Lowercase letters and digits with single hyphens, and not current, latest, editions, tags or diff. It is the edition segment of a coordinate such as @org/repo/w-9/2024-03 and never changes once published."
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200,
+          "description": "The issuer's edition text exactly as printed, such as \"Rev. March 2024\". For display only."
+        },
+        "date": {
+          "type": "string",
+          "pattern": "^(?:\\d{4}(?:-(?:0[1-9]|1[0-2]))?|(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8]))))$",
+          "description": "When the issuer released the edition, at the precision the issuer gives: YYYY, YYYY-MM or YYYY-MM-DD."
+        },
+        "effectiveFrom": {
+          "type": "string",
+          "format": "date",
+          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+          "description": "The date the edition takes effect. Only when the issuer prints one."
+        }
+      },
+      "required": [
+        "key",
+        "label"
+      ],
+      "additionalProperties": false,
+      "title": "ArtifactEdition",
+      "description": "The issuer's edition this artifact encodes. Omitted for artifacts that are not issued in editions."
+    },
+    "language": {
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 35,
+      "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$",
+      "description": "BCP 47-style source language tag for this artifact. Defaults to en when omitted."
+    },
+    "metadata": {
+      "description": "Custom key-value pairs for storing domain-specific or organizational metadata",
+      "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Metadata"
+    },
+    "instructions": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "inline"
+            },
+            "text": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1000000,
+              "description": "Inline text content"
+            }
+          },
+          "required": [
+            "kind",
+            "text"
+          ],
+          "additionalProperties": false,
+          "title": "InlineContentRef",
+          "description": "Inline content reference with embedded text"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "file"
+            },
+            "path": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1000,
+              "description": "Path to the content file"
+            },
+            "mimeType": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 100,
+              "description": "MIME type of the file content"
+            },
+            "title": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 200,
+              "description": "Human-readable title"
+            },
+            "description": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 2000,
+              "description": "Description of the content"
+            },
+            "checksum": {
+              "type": "string",
+              "pattern": "^sha256:[a-f0-9]{64}$",
+              "description": "SHA-256 checksum for integrity verification"
+            }
+          },
+          "required": [
+            "kind",
+            "path",
+            "mimeType"
+          ],
+          "additionalProperties": false,
+          "title": "FileContentRef",
+          "description": "File content reference with path and metadata"
+        }
+      ],
+      "title": "ContentRef",
+      "description": "Domain or compliance reference content (e.g., IRS instructions, regulatory guidance)"
+    },
+    "agentInstructions": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "inline"
+            },
+            "text": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1000000,
+              "description": "Inline text content"
+            }
+          },
+          "required": [
+            "kind",
+            "text"
+          ],
+          "additionalProperties": false,
+          "title": "InlineContentRef",
+          "description": "Inline content reference with embedded text"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "file"
+            },
+            "path": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1000,
+              "description": "Path to the content file"
+            },
+            "mimeType": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 100,
+              "description": "MIME type of the file content"
+            },
+            "title": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 200,
+              "description": "Human-readable title"
+            },
+            "description": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 2000,
+              "description": "Description of the content"
+            },
+            "checksum": {
+              "type": "string",
+              "pattern": "^sha256:[a-f0-9]{64}$",
+              "description": "SHA-256 checksum for integrity verification"
+            }
+          },
+          "required": [
+            "kind",
+            "path",
+            "mimeType"
+          ],
+          "additionalProperties": false,
+          "title": "FileContentRef",
+          "description": "File content reference with path and metadata"
+        }
+      ],
+      "title": "ContentRef",
+      "description": "LLM/agent prompts for field ordering, grouping, tone, and presentation guidance"
+    },
+    "kind": {
+      "type": "string",
+      "const": "checklist"
+    },
+    "items": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/ChecklistItem"
+      },
+      "description": "Array of checklist items. Each item represents a task, step, or requirement."
+    },
+    "layers": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 100,
+        "pattern": "^[a-z][a-zA-Z0-9_]*$",
+        "description": "Layer identifier (camelCase, starts with lowercase letter)"
+      },
+      "additionalProperties": {
+        "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Layer"
+      },
+      "description": "Named layers for rendering this checklist into different formats. Keys are user-defined identifiers (e.g., markdown, pdf, html)",
+      "allOf": [
+        {
+          "additionalProperties": {
+            "not": {
+              "properties": {
+                "mimeType": {
+                  "pattern": "^(?:[tT][eE][xX][tT]/[tT][sS][xX]|[tT][eE][xX][tT]/[jJ][sS][xX])$"
+                }
+              },
+              "required": [
+                "mimeType"
+              ]
+            }
+          }
+        }
+      ]
+    },
+    "defaultLayer": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "Key of the default layer to use when none specified at render time"
+    }
+  },
+  "required": [
+    "name",
+    "kind",
+    "items"
+  ],
+  "additionalProperties": false,
+  "description": "A checklist artifact containing an ordered list of items to track. Each item may define how its status should be represented at runtime (boolean or enum).",
+  "title": "Checklist"
+}

package/schemas/2026-10-28/cond-expr.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/cond-expr.json",
+  "anyOf": [
+    {
+      "type": "boolean",
+      "description": "Literal boolean value"
+    },
+    {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "description": "Expression string - either inline expression or reference to a defs key"
+    }
+  ],
+  "description": "Conditional expression: boolean literal or expression string",
+  "title": "CondExpr"
+}

package/schemas/2026-10-28/content-ref.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/content-ref.json",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "inline"
+        },
+        "text": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000000,
+          "description": "Inline text content"
+        }
+      },
+      "required": [
+        "kind",
+        "text"
+      ],
+      "additionalProperties": false,
+      "title": "InlineContentRef",
+      "description": "Inline content reference with embedded text"
+    },
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "file"
+        },
+        "path": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000,
+          "description": "Path to the content file"
+        },
+        "mimeType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "description": "MIME type of the file content"
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200,
+          "description": "Human-readable title"
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2000,
+          "description": "Description of the content"
+        },
+        "checksum": {
+          "type": "string",
+          "pattern": "^sha256:[a-f0-9]{64}$",
+          "description": "SHA-256 checksum for integrity verification"
+        }
+      },
+      "required": [
+        "kind",
+        "path",
+        "mimeType"
+      ],
+      "additionalProperties": false,
+      "title": "FileContentRef",
+      "description": "File content reference with path and metadata"
+    }
+  ],
+  "description": "Content reference — inline text or file reference",
+  "title": "ContentRef"
+}

package/schemas/2026-10-28/coordinate.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/coordinate.json",
+  "type": "object",
+  "properties": {
+    "lat": {
+      "type": "number",
+      "minimum": -90,
+      "maximum": 90,
+      "description": "Latitude in decimal degrees (WGS84), range -90 (South Pole) to 90 (North Pole)"
+    },
+    "lon": {
+      "type": "number",
+      "minimum": -180,
+      "maximum": 180,
+      "description": "Longitude in decimal degrees (WGS84), range -180 (west) to 180 (east)"
+    }
+  },
+  "required": [
+    "lat",
+    "lon"
+  ],
+  "additionalProperties": false,
+  "description": "Geographic coordinate (WGS84) with latitude and longitude in decimal degrees",
+  "title": "Coordinate"
+}