@asterdoc/schemas 0.0.0-stage → 0.10.0

package/package.json

@@ -1,6 +1,85 @@
 {
   "name": "@asterdoc/schemas",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.10.0",
+  "description": "JSON Schema definitions for Asterdoc framework artifacts, blocks, and primitives",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./schema.json": "./schemas/schema.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "schemas",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "asterdoc",
+    "forms",
+    "json-schema",
+    "schemas",
+    "zod",
+    "validation"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Asterdoc",
+    "url": "https://asterdoc.com"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/asterdoc/asterdoc.git",
+    "directory": "packages/schemas"
+  },
+  "homepage": "https://asterdoc.com",
+  "bugs": {
+    "url": "https://github.com/asterdoc/asterdoc/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "safe-regex": "^2.1.1",
+    "zod": "^4.1.12",
+    "@asterdoc/types": "0.10.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.3",
+    "@types/safe-regex": "^1.1.6",
+    "@vitest/coverage-v8": "^2.1.8",
+    "eslint": "^9.34.0",
+    "tsup": "^8.4.0",
+    "tsx": "^4.20.6",
+    "typescript": "5.9.2",
+    "vitest": "^2.1.8",
+    "@asterdoc/eslint-config": "0.1.0",
+    "@asterdoc/typescript-config": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsx scripts/prepare-schema-output.ts && tsup && pnpm export:all",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist schemas",
+    "pack:dry": "npm pack --dry-run",
+    "lint": "eslint .",
+    "check-types": "tsc --noEmit",
+    "check": "pnpm lint && pnpm check-types",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "export:bundled-schema": "tsx scripts/export-root-schema-zod.ts",
+    "export:individual-schemas": "tsx scripts/export-all-schemas-zod.ts",
+    "export:manifest": "tsx scripts/export-manifest-schema-zod.ts",
+    "export:registry": "tsx scripts/export-registry-schemas-zod.ts",
+    "export:all": "pnpm export:bundled-schema && pnpm export:individual-schemas && pnpm export:manifest && pnpm export:registry"
+  }
 }

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

@@ -0,0 +1,53 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/address.json",
+  "type": "object",
+  "properties": {
+    "line1": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "description": "Primary address line"
+    },
+    "line2": {
+      "type": "string",
+      "maxLength": 200,
+      "description": "Secondary address line"
+    },
+    "locality": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "description": "City or locality name"
+    },
+    "region": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "State, province, or region name"
+    },
+    "postalCode": {
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 20,
+      "pattern": "^[A-Z0-9\\s-]+$",
+      "description": "Postal or ZIP code"
+    },
+    "country": {
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 100,
+      "description": "ISO 3166-1 country code (e.g., \"US\", \"GB\", \"FRA\") or full country name"
+    }
+  },
+  "required": [
+    "line1",
+    "locality",
+    "region",
+    "postalCode",
+    "country"
+  ],
+  "additionalProperties": false,
+  "description": "Physical address with street, locality, region, postal code, and country",
+  "title": "Address"
+}

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

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/attachment.json",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "description": "Original file name"
+    },
+    "mimeType": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "MIME type of the attached file"
+    },
+    "checksum": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$",
+      "description": "SHA-256 checksum for integrity verification"
+    }
+  },
+  "required": [
+    "name",
+    "mimeType"
+  ],
+  "additionalProperties": false,
+  "description": "Attachment data representing an attached document. The key in the record is the annex identifier (the key from form.annexes).",
+  "title": "Attachment"
+}

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

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/bbox.json",
+  "type": "object",
+  "properties": {
+    "southWest": {
+      "description": "Southwest corner coordinate (minimum latitude and longitude)",
+      "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Coordinate"
+    },
+    "northEast": {
+      "description": "Northeast corner coordinate (maximum latitude and longitude)",
+      "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Coordinate"
+    }
+  },
+  "required": [
+    "southWest",
+    "northEast"
+  ],
+  "additionalProperties": false,
+  "description": "Geographic bounding box defined by southwest (minimum) and northeast (maximum) corner coordinates",
+  "title": "Bbox"
+}

package/schemas/2026-10-28/bundle-content-item.json

@@ -0,0 +1,122 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/bundle-content-item.json",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
+          "description": "Unique identifier for this content item, used to reference it in defs expressions"
+        },
+        "include": {
+          "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/CondExpr"
+        },
+        "type": {
+          "type": "string",
+          "const": "inline"
+        },
+        "artifact": {
+          "description": "Inline artifact definition (document, form, checklist, or nested bundle)",
+          "anyOf": [
+            {
+              "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Document"
+            },
+            {
+              "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Form"
+            },
+            {
+              "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Checklist"
+            },
+            {
+              "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/Bundle"
+            }
+          ]
+        }
+      },
+      "required": [
+        "key",
+        "type",
+        "artifact"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
+          "description": "Unique identifier for this content item, used to reference it in defs expressions"
+        },
+        "include": {
+          "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/CondExpr"
+        },
+        "type": {
+          "type": "string",
+          "const": "path"
+        },
+        "path": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Path to the artifact file, relative to the bundle file's directory"
+        }
+      },
+      "required": [
+        "key",
+        "type",
+        "path"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
+          "description": "Unique identifier for this content item, used to reference it in defs expressions"
+        },
+        "include": {
+          "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/CondExpr"
+        },
+        "type": {
+          "type": "string",
+          "const": "registry"
+        },
+        "slug": {
+          "type": "string",
+          "pattern": "^@?[a-z0-9](?:[a-z0-9]|-[a-z0-9])*\\/[a-z0-9](?:[a-z0-9]|-[a-z0-9])*\\/[a-z0-9](?:[a-z0-9]|-[a-z0-9])*$",
+          "description": "Artifact address @org/repo/name, with no edition or version"
+        },
+        "edition": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^(?!(?:current|latest|editions|tags|diff)$)[a-z0-9]([a-z0-9]|-[a-z0-9])*$",
+          "description": "Edition key. When omitted, the registry's current edition is used."
+        },
+        "version": {
+          "type": "string",
+          "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": "Exact version. When omitted, the latest version of the edition is used."
+        }
+      },
+      "required": [
+        "key",
+        "type",
+        "slug"
+      ],
+      "additionalProperties": false
+    }
+  ],
+  "description": "Bundle content item: an inline artifact, path reference, or registry reference with optional include condition",
+  "title": "BundleContentItem"
+}

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

@@ -0,0 +1,267 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/2026-10-28/bundle.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": "bundle"
+    },
+    "defs": {
+      "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/DefsSection"
+    },
+    "contents": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.asterdoc.com/2026-10-28.json#/$defs/BundleContentItem"
+      },
+      "description": "Ordered bundle contents. Each item has a key and is either an inline artifact, path reference, or registry reference."
+    }
+  },
+  "required": [
+    "name",
+    "kind",
+    "contents"
+  ],
+  "additionalProperties": false,
+  "description": "A bundle artifact that groups together related artifacts into a single distributable unit. Bundles can contain documents, forms, checklists, and other bundles.",
+  "title": "Bundle"
+}