@asterdoc/schemas 0.0.0-stage → 0.10.0

package/schemas/registry.json

@@ -0,0 +1,281 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.asterdoc.com/registry.json",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI for validation"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "pattern": "^[a-z0-9]([a-z0-9-]*[a-z0-9])?$",
+      "description": "Registry name/identifier (lowercase slug, used for data attributes and metadata)"
+    },
+    "homepage": {
+      "type": "string",
+      "format": "uri",
+      "description": "Homepage URL for the registry"
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 2000,
+      "description": "Description of the registry"
+    },
+    "enableTelemetry": {
+      "default": true,
+      "description": "Enable anonymous usage telemetry for artifact installs. Defaults to true.",
+      "type": "boolean"
+    },
+    "enableDirectory": {
+      "default": true,
+      "description": "Allow this registry to appear in the Asterdoc Hub directory. Defaults to true.",
+      "type": "boolean"
+    },
+    "items": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/RegistryItemSummary"
+      },
+      "description": "Every artifact in the registry, one item for each artifact name. No two items have the same name, and no two versions in the manifest have the same path."
+    }
+  },
+  "required": [
+    "name",
+    "items"
+  ],
+  "additionalProperties": false,
+  "title": "Asterdoc Registry Manifest",
+  "description": "Schema for registry.json, the manifest of a file registry. It lists every artifact the registry serves, with every edition and version of each. Every path is relative to the registry base address: the address of the folder that holds registry.json.",
+  "$defs": {
+    "RegistryItemSummary": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "pattern": "^[a-z0-9](?:[a-z0-9]|-[a-z0-9])*$",
+          "description": "Artifact name, unique within the registry. Lowercase letters and digits with single hyphens. It is the name segment of a reference such as @acme/w-9, and every edition and version of the artifact shares it."
+        },
+        "kind": {
+          "anyOf": [
+            {
+              "type": "string",
+              "const": "form"
+            },
+            {
+              "type": "string",
+              "const": "document"
+            },
+            {
+              "type": "string",
+              "const": "checklist"
+            },
+            {
+              "type": "string",
+              "const": "bundle"
+            }
+          ],
+          "description": "Artifact kind"
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200,
+          "description": "Human-readable title"
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 2000,
+          "description": "Brief description of the artifact"
+        },
+        "currentEdition": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^(?!(?:current|latest|editions|tags|diff)$)[a-z0-9]([a-z0-9]|-[a-z0-9])*$",
+          "description": "The edition to use when a request names none. It is the publisher's statement and must be a key of editions. It is not the newest edition by date: a publisher may list an edition that takes effect in the future. A reader uses this value and never compares dates. Present only with editions."
+        },
+        "editions": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 64,
+            "pattern": "^(?!(?:current|latest|editions|tags|diff)$)[a-z0-9]([a-z0-9]|-[a-z0-9])*$"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/RegistryEditionEntry"
+          },
+          "title": "RegistryEditions",
+          "description": "The issuer's editions of this artifact, keyed by edition key. Present only on an artifact that is issued in editions; then latestVersion and versions are inside each edition and absent on the item.",
+          "minProperties": 1
+        },
+        "latestVersion": {
+          "type": "string",
+          "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-]*))*))?$",
+          "description": "The version to use when a request names none. It is the publisher's statement and must be a key of versions. It is normally the highest stable version; a pre-release is the default only when the publisher points at it. A reader uses this value and never compares version numbers. Present only with versions, on an artifact that has no editions."
+        },
+        "versions": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "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-]*))*))?$"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/RegistryVersionEntry"
+          },
+          "title": "RegistryVersions",
+          "description": "The versions of an artifact that has no editions, keyed by version. Present only when editions is absent.",
+          "minProperties": 1
+        },
+        "layers": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "description": "Layer key"
+          },
+          "description": "Available layer keys"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 50,
+            "description": "Tag for categorization"
+          },
+          "description": "Tags for search and filtering"
+        }
+      },
+      "required": [
+        "name",
+        "kind"
+      ],
+      "additionalProperties": false,
+      "title": "RegistryItemSummary",
+      "description": "One artifact in the registry, with every release of it. An artifact that is issued in editions has currentEdition and editions; an artifact that is not has latestVersion and versions. Never both, and never neither.",
+      "oneOf": [
+        {
+          "required": [
+            "currentEdition",
+            "editions"
+          ],
+          "not": {
+            "anyOf": [
+              {
+                "required": [
+                  "latestVersion"
+                ]
+              },
+              {
+                "required": [
+                  "versions"
+                ]
+              }
+            ]
+          }
+        },
+        {
+          "required": [
+            "latestVersion",
+            "versions"
+          ],
+          "not": {
+            "anyOf": [
+              {
+                "required": [
+                  "currentEdition"
+                ]
+              },
+              {
+                "required": [
+                  "editions"
+                ]
+              }
+            ]
+          }
+        }
+      ]
+    },
+    "RegistryEditionEntry": {
+      "type": "object",
+      "properties": {
+        "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."
+        },
+        "latestVersion": {
+          "type": "string",
+          "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-]*))*))?$",
+          "description": "The version to use when a request names none. It is the publisher's statement and must be a key of versions. It is normally the highest stable version; a pre-release is the default only when the publisher points at it. A reader uses this value and never compares version numbers."
+        },
+        "versions": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "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-]*))*))?$"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/RegistryVersionEntry"
+          },
+          "title": "RegistryVersions",
+          "description": "Versions keyed by version. Each key is a SemVer 2.0.0 version with no build metadata, such as 1.2.0 or 1.3.0-beta.1, and never latest or current. At least one version. The order of the keys has no meaning.",
+          "minProperties": 1
+        }
+      },
+      "required": [
+        "label",
+        "latestVersion",
+        "versions"
+      ],
+      "additionalProperties": false,
+      "title": "RegistryEditionEntry",
+      "description": "One edition of an issued artifact, as printed by its issuer, and the publisher's versions of it. The edition key is the key of this entry."
+    },
+    "RegistryVersionEntry": {
+      "type": "object",
+      "properties": {
+        "path": {
+          "type": "string",
+          "maxLength": 500,
+          "pattern": "^(?:(?!\\.{1,2}\\/)[A-Za-z0-9._-]+\\/)*[A-Za-z0-9._-]+\\.(?:json|yaml|yml)$",
+          "description": "Path to the artifact file, relative to the registry base address (the address of the folder that holds registry.json), such as w-9/2024-03/1.0.0/w-9.json. Forward slashes only, no leading slash, no . or .. segment, ending in .json, .yaml or .yml. No two versions in one manifest have the same path."
+        },
+        "sha256": {
+          "type": "string",
+          "pattern": "^[a-f0-9]{64}$",
+          "description": "SHA-256 digest of the bytes of the artifact file at path, as 64 lowercase hex digits. A reader refuses a file whose digest is different."
+        }
+      },
+      "required": [
+        "path",
+        "sha256"
+      ],
+      "additionalProperties": false,
+      "title": "RegistryVersionEntry",
+      "description": "One version of an artifact in a registry: the path of its file and the checksum of that file. The version itself is the key of this entry."
+    }
+  }
+}