@asterdoc/schemas 0.0.0-stage → 0.9.0

package/schemas/config.json

@@ -0,0 +1,174 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/config.json",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI for validation"
+    },
+    "registries": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^@[a-zA-Z0-9][a-zA-Z0-9-_]*$",
+        "description": "Registry namespace (must start with @)"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/RegistryEntry"
+      },
+      "description": "Configured registries by namespace"
+    },
+    "defaults": {
+      "$ref": "#/$defs/GlobalDefaults"
+    },
+    "cache": {
+      "type": "object",
+      "properties": {
+        "ttl": {
+          "default": 3600,
+          "description": "Default cache TTL in seconds. 0 disables caching. Default: 3600 (1 hour)",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "directory": {
+          "type": "string",
+          "description": "Custom cache directory. A leading ~ uses the home directory; relative paths use the config file directory. Default: ~/.asterdoc/cache"
+        }
+      },
+      "additionalProperties": false,
+      "title": "CacheConfig",
+      "description": "Global cache configuration for registry data"
+    },
+    "security": {
+      "type": "object",
+      "properties": {
+        "allowedContentTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Content types permitted for layer downloads, added to the built-in defaults. Blocked types are never allowed."
+        }
+      },
+      "additionalProperties": false,
+      "title": "SecurityConfig",
+      "description": "Security settings for layer downloads"
+    },
+    "telemetry": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Send anonymous CLI usage telemetry. Set to false to opt out. Default: true"
+        }
+      },
+      "additionalProperties": false,
+      "title": "TelemetryConfig",
+      "description": "Telemetry preferences"
+    },
+    "anonymousId": {
+      "type": "string",
+      "format": "uuid",
+      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
+      "description": "Anonymous telemetry identifier. The CLI generates it once and keeps it across resets."
+    }
+  },
+  "additionalProperties": false,
+  "title": "Asterdoc Global Config",
+  "description": "Schema for ~/.asterdoc/config.json global configuration file",
+  "$defs": {
+    "RegistryEntry": {
+      "anyOf": [
+        {
+          "type": "string",
+          "format": "uri",
+          "description": "Simple registry URL"
+        },
+        {
+          "$ref": "#/$defs/RegistryEntryObject"
+        }
+      ],
+      "title": "RegistryEntry",
+      "description": "Registry configuration - URL string or object with authentication"
+    },
+    "RegistryEntryObject": {
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "Registry base URL"
+        },
+        "headers": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "HTTP headers for authentication (supports ${ENV_VAR} expansion)"
+        },
+        "cache": {
+          "type": "object",
+          "properties": {
+            "ttl": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991,
+              "description": "Cache TTL in seconds. 0 disables caching for this registry."
+            }
+          },
+          "additionalProperties": false,
+          "title": "RegistryCacheConfig",
+          "description": "Per-registry cache settings"
+        }
+      },
+      "required": [
+        "url"
+      ],
+      "additionalProperties": false,
+      "title": "RegistryEntryObject",
+      "description": "Registry configuration with authentication options"
+    },
+    "GlobalDefaults": {
+      "type": "object",
+      "properties": {
+        "output": {
+          "default": "json",
+          "description": "Default output format for artifacts: json, yaml, typed (json + .d.ts), or ts (TypeScript module)",
+          "anyOf": [
+            {
+              "type": "string",
+              "const": "json"
+            },
+            {
+              "type": "string",
+              "const": "yaml"
+            },
+            {
+              "type": "string",
+              "const": "typed"
+            },
+            {
+              "type": "string",
+              "const": "ts"
+            }
+          ],
+          "title": "ArtifactOutputFormat"
+        },
+        "artifactsDir": {
+          "default": "artifacts",
+          "description": "Default directory for installed artifacts",
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "title": "GlobalDefaults",
+      "description": "Default settings for CLI operations"
+    }
+  }
+}

package/schemas/lock.json

@@ -0,0 +1,151 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/lock.json",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI for validation"
+    },
+    "version": {
+      "default": 1,
+      "description": "Lock file format version",
+      "type": "number"
+    },
+    "artifacts": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^(?:@[a-zA-Z0-9][a-zA-Z0-9-_]*|@[a-z0-9-]+(?:\\.[a-z0-9-]+)+)\\/[A-Za-z0-9]([A-Za-z0-9]|-[A-Za-z0-9])*$",
+        "description": "Artifact reference (@namespace/name)"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/LockedArtifact"
+      },
+      "description": "Installed artifacts by reference"
+    }
+  },
+  "required": [
+    "version",
+    "artifacts"
+  ],
+  "additionalProperties": false,
+  "title": "Asterdoc Lock File",
+  "description": "Schema for .asterdoc/lock.json lock file",
+  "$defs": {
+    "LockedArtifact": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "form",
+            "document",
+            "checklist",
+            "bundle"
+          ],
+          "description": "Artifact kind"
+        },
+        "edition": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^(?!(?:current|latest|editions|tags|diff)$)[a-z0-9]([a-z0-9]|-[a-z0-9])*$",
+          "description": "Key of the installed edition, as the registry manifest lists it. Omitted for an artifact that has no editions."
+        },
+        "version": {
+          "type": "string",
+          "description": "Installed artifact version"
+        },
+        "resolved": {
+          "type": "string",
+          "format": "uri",
+          "description": "Full URL used to fetch the artifact"
+        },
+        "integrity": {
+          "type": "string",
+          "pattern": "^sha256-[A-Za-z0-9+/]{43}=$",
+          "description": "SHA-256 integrity of the artifact file as written (sha256-<base64>)"
+        },
+        "installedAt": {
+          "type": "string",
+          "format": "date-time",
+          "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])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+          "description": "ISO 8601 timestamp when artifact was installed"
+        },
+        "output": {
+          "anyOf": [
+            {
+              "type": "string",
+              "const": "json"
+            },
+            {
+              "type": "string",
+              "const": "yaml"
+            },
+            {
+              "type": "string",
+              "const": "typed"
+            },
+            {
+              "type": "string",
+              "const": "ts"
+            }
+          ],
+          "title": "ArtifactOutputFormat",
+          "description": "Output format the artifact was written in"
+        },
+        "path": {
+          "type": "string",
+          "description": "Relative path to the artifact file from project root"
+        },
+        "layers": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "description": "Layer key"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/LockedLayer"
+          },
+          "description": "Installed layers and their metadata"
+        }
+      },
+      "required": [
+        "kind",
+        "version",
+        "resolved",
+        "integrity",
+        "installedAt",
+        "output",
+        "path",
+        "layers"
+      ],
+      "additionalProperties": false,
+      "title": "LockedArtifact",
+      "description": "Information about an installed artifact"
+    },
+    "LockedLayer": {
+      "type": "object",
+      "properties": {
+        "integrity": {
+          "type": "string",
+          "pattern": "^sha256-[A-Za-z0-9+/]{43}=$",
+          "description": "SHA-256 integrity of the layer file (sha256-<base64>)"
+        },
+        "path": {
+          "type": "string",
+          "description": "Relative path to the layer file from project root"
+        }
+      },
+      "required": [
+        "integrity",
+        "path"
+      ],
+      "additionalProperties": false,
+      "title": "LockedLayer",
+      "description": "Information about an installed layer file"
+    }
+  }
+}

package/schemas/manifest.json

@@ -0,0 +1,184 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/manifest.json",
+  "title": "Asterdoc Project Manifest",
+  "description": "Schema for asterdoc.json project manifest files",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI for validation"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 214,
+      "pattern": "^@[a-z0-9-]+\\/[a-z0-9-]+$",
+      "description": "Scoped package name (@org/repo-name)"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "description": "Human-readable project title"
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 1000,
+      "description": "Project description"
+    },
+    "visibility": {
+      "default": "private",
+      "description": "Project visibility",
+      "anyOf": [
+        {
+          "type": "string",
+          "const": "public"
+        },
+        {
+          "type": "string",
+          "const": "private"
+        }
+      ]
+    },
+    "registries": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^@[a-zA-Z0-9][a-zA-Z0-9-_]*$",
+        "description": "Registry namespace (must start with @)"
+      },
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "type": "string",
+            "format": "uri",
+            "description": "Simple registry URL"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "url": {
+                "type": "string",
+                "format": "uri",
+                "description": "Registry base URL"
+              },
+              "headers": {
+                "type": "object",
+                "propertyNames": {
+                  "type": "string"
+                },
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "description": "HTTP headers for authentication (supports ${ENV_VAR} expansion)"
+              },
+              "cache": {
+                "type": "object",
+                "properties": {
+                  "ttl": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 9007199254740991,
+                    "description": "Cache TTL in seconds. 0 disables caching for this registry."
+                  }
+                },
+                "additionalProperties": false,
+                "title": "RegistryCacheConfig",
+                "description": "Per-registry cache settings"
+              }
+            },
+            "required": [
+              "url"
+            ],
+            "additionalProperties": false,
+            "title": "RegistryEntryObject",
+            "description": "Registry configuration with authentication options"
+          }
+        ],
+        "title": "RegistryEntry",
+        "description": "Registry configuration - URL string or object with authentication"
+      },
+      "description": "Custom registries for this project (overrides global config)"
+    },
+    "artifacts": {
+      "type": "object",
+      "properties": {
+        "dir": {
+          "default": "artifacts",
+          "description": "Directory for installed artifacts (default: \"artifacts\")",
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "output": {
+          "default": "json",
+          "description": "Default output format for artifacts: json, yaml, typed (json + .d.ts), or ts (TypeScript module)",
+          "anyOf": [
+            {
+              "type": "string",
+              "const": "json"
+            },
+            {
+              "type": "string",
+              "const": "yaml"
+            },
+            {
+              "type": "string",
+              "const": "typed"
+            },
+            {
+              "type": "string",
+              "const": "ts"
+            }
+          ],
+          "title": "ArtifactOutputFormat"
+        }
+      },
+      "additionalProperties": false,
+      "title": "ManifestArtifactConfig",
+      "description": "Configuration for artifact management"
+    },
+    "cache": {
+      "type": "object",
+      "properties": {
+        "ttl": {
+          "default": 3600,
+          "description": "Default cache TTL in seconds. 0 disables caching. Default: 3600 (1 hour)",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "directory": {
+          "type": "string",
+          "description": "Custom cache directory. A leading ~ uses the home directory; relative paths use the project root"
+        }
+      },
+      "additionalProperties": false,
+      "title": "ManifestCacheConfig",
+      "description": "Project-level cache configuration (overrides global config)"
+    },
+    "security": {
+      "type": "object",
+      "properties": {
+        "allowedContentTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Content types permitted for layer downloads, added to the built-in defaults. Blocked types are never allowed."
+        }
+      },
+      "additionalProperties": false,
+      "title": "SecurityConfig",
+      "description": "Security settings for layer downloads (overrides global config)"
+    }
+  },
+  "required": [
+    "name",
+    "title",
+    "visibility"
+  ],
+  "additionalProperties": false
+}