@asterdoc/schemas 0.0.0-stage → 0.10.0

package/schemas/2026-10-28/form-party.json

@@ -0,0 +1,150 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/form-party.json",
+  "type": "object",
+  "properties": {
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "Display name for this role"
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 500,
+      "description": "Description of this role"
+    },
+    "partyType": {
+      "anyOf": [
+        {
+          "type": "string",
+          "const": "person"
+        },
+        {
+          "type": "string",
+          "const": "organization"
+        },
+        {
+          "type": "string",
+          "const": "any"
+        }
+      ],
+      "description": "Constraint on party type (default: any)"
+    },
+    "min": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "Minimum parties required (default: 1)"
+    },
+    "max": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991,
+      "description": "Maximum parties allowed (default: 1)"
+    },
+    "required": {
+      "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/CondExpr"
+    },
+    "signature": {
+      "type": "object",
+      "properties": {
+        "required": {
+          "type": "boolean",
+          "description": "Whether signature is required for this role (default: false)"
+        },
+        "witnesses": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Number of caller-declared witness attestations required for this signature (default: 0)"
+        },
+        "notarized": {
+          "type": "boolean",
+          "description": "Whether at least one caller-declared attesting witness must have notary status (default: false)"
+        }
+      },
+      "additionalProperties": false,
+      "title": "FormSignature",
+      "description": "Design-time signature requirements for a party role"
+    },
+    "payment": {
+      "type": "object",
+      "properties": {
+        "required": {
+          "type": "boolean",
+          "description": "Whether payment is required for this role (default: false)"
+        },
+        "amount": {
+          "anyOf": [
+            {
+              "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Money"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "label": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 200,
+                  "description": "Display label for the computed value"
+                },
+                "description": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 1000,
+                  "description": "Description or documentation of the computed value"
+                },
+                "type": {
+                  "type": "string",
+                  "const": "money"
+                },
+                "value": {
+                  "type": "object",
+                  "properties": {
+                    "amount": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 2000,
+                      "description": "Expression string to evaluate"
+                    },
+                    "currency": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 2000,
+                      "description": "Expression string to evaluate"
+                    }
+                  },
+                  "required": [
+                    "amount",
+                    "currency"
+                  ],
+                  "additionalProperties": false,
+                  "description": "Money object with amount and currency expressions"
+                }
+              },
+              "required": [
+                "type",
+                "value"
+              ],
+              "additionalProperties": false
+            }
+          ],
+          "description": "Amount owed: a fixed Money value, or a MoneyExpression resolved from filled data at request time"
+        }
+      },
+      "required": [
+        "amount"
+      ],
+      "additionalProperties": false,
+      "title": "FormPayment",
+      "description": "Design-time payment requirement for a party role"
+    }
+  },
+  "required": [
+    "label"
+  ],
+  "additionalProperties": false,
+  "description": "Design-time party role definition. Defines what roles exist and what constraints apply when filling a form.",
+  "title": "FormParty"
+}

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

@@ -0,0 +1,369 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/form.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": "form"
+    },
+    "defs": {
+      "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/DefsSection"
+    },
+    "rules": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 100,
+        "pattern": "^[a-z][a-zA-Z0-9_]*$",
+        "description": "Validation rule identifier (camelCase, starts with lowercase letter)"
+      },
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "expr": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 2000,
+            "description": "Boolean expression that must evaluate to true for the form to be valid. Has access to field values directly (e.g., \"ssn or ein\") and defs section values."
+          },
+          "message": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 500,
+            "description": "Error message displayed when the rule fails (expression evaluates to false)"
+          },
+          "severity": {
+            "type": "string",
+            "enum": [
+              "error",
+              "warning"
+            ],
+            "description": "Severity level: error (default) blocks submission, warning allows but warns"
+          }
+        },
+        "required": [
+          "expr",
+          "message"
+        ],
+        "additionalProperties": false,
+        "title": "ValidationRule",
+        "description": "A form-level validation rule with a boolean expression and error message"
+      },
+      "title": "RulesSection",
+      "description": "Form-level validation rules for cross-field constraints. Rules use expressions with direct access to field values and defs section values."
+    },
+    "fields": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 100,
+        "pattern": "^[a-z][a-zA-Z0-9_]*$",
+        "description": "Field identifier (camelCase, starts with lowercase letter)"
+      },
+      "additionalProperties": {
+        "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/FormField"
+      },
+      "description": "Form field definitions keyed by field identifier. Fields define the input structure and validation rules for the form"
+    },
+    "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 form into different formats. Keys are user-defined identifiers (e.g., markdown, pdf, html)"
+    },
+    "defaultLayer": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "Key of the default layer to use when none specified at render time"
+    },
+    "allowAdditionalAnnexes": {
+      "type": "boolean",
+      "description": "Whether additional ad-hoc annexes can be attached beyond those defined in the annexes record (default: false)"
+    },
+    "annexes": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 100,
+        "pattern": "^[a-z][a-zA-Z0-9_]*$",
+        "description": "Annex identifier (camelCase, starts with lowercase letter)"
+      },
+      "additionalProperties": {
+        "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/FormAnnex"
+      },
+      "description": "Predefined annex slots keyed by identifier. Each slot can be marked as required (must be filled at runtime) or optional"
+    },
+    "parties": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 50,
+        "pattern": "^[a-z][a-zA-Z0-9_]*$",
+        "description": "Party role identifier (e.g., buyer, seller, landlord, buyerRepresentative)"
+      },
+      "additionalProperties": {
+        "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/FormParty"
+      },
+      "description": "Party role definitions keyed by role identifier. Each role specifies constraints on who can fill it (person/organization) and signature requirements."
+    }
+  },
+  "required": [
+    "name",
+    "kind"
+  ],
+  "additionalProperties": false,
+  "description": "A form artifact that defines a data contract with field definitions, optional layers for rendering, and optional annexes. Forms are the primary artifact type for structured data collection and document generation.",
+  "title": "Form"
+}

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

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/identification.json",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 50,
+      "description": "Type of identification document (e.g., ssn, passport, license, ein)"
+    },
+    "number": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "Identification number or identifier"
+    },
+    "issuer": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "Issuing authority, country, or state (e.g., US, CA, DMV)"
+    },
+    "issueDate": {
+      "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": "Issue date in ISO 8601 format (YYYY-MM-DD)"
+    },
+    "expiryDate": {
+      "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": "Expiry date in ISO 8601 format (YYYY-MM-DD)"
+    }
+  },
+  "required": [
+    "type",
+    "number"
+  ],
+  "additionalProperties": false,
+  "description": "Identification document with type, number, issuer, and optional issue and expiry dates",
+  "title": "Identification"
+}