@toolproof-core/schema 1.0.0

package/src/generated/schemas/ResourceType.json

@@ -0,0 +1,140 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "#/$defs/DocumentationFacet"
+    },
+    {
+      "$ref": "#/$defs/ResourceTypeImplementationKindFacet"
+    }
+  ],
+  "properties": {
+    "embeddingUriMap": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/Uri"
+      },
+      "$comment": "A ResourceType may specify a set of embedding models that convert the raw data (or one of its alternative representations) into vector embeddings. The build process enforces that the keys of this map are members of a set of predefined embedding models.",
+      "minProperties": 1,
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^EMBEDDING-.+$"
+      }
+    },
+    "generatorUriMap": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/Uri"
+      },
+      "$comment": "A ResourceType may specify a set of generators that generate different representations of its instances from the raw file. A ToolProof Resource is always backed by a raw file. This is also true for the Resources (of type ResourceType) defined in this file! The build process enforces that the keys of this map are members of a set of predefined generators. GENERATOR-Json is an identifier for a generator that generates JSON data from the raw file. If the raw file is a JSON file, GENERATOR-Json is an implicit identity operation (i.e. an operation that does nothing) and must not be present in the map. A ResourceType may also specify other generators, such as GENERATOR-LeanTerm, which generates an instance (or 'term' in Lean jargon) of a corresponding Lean type from the raw file. ResourceTypes that specify GENERATOR-LeanTerm must also specify a corresponding GENERATOR-LeanType. While the term-version runs when data instances enter the ecosystem, the type-version runs when the ResourceType itself enters the ecosystem.",
+      "minProperties": 1,
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^GENERATOR-.+$"
+      }
+    },
+    "identity": {
+      "$ref": "#/$defs/ResourceTypeIdentity"
+    },
+    "nucleusSchema": true
+  },
+  "required": [
+    "identity",
+    "nucleusSchema"
+  ],
+  "$anchor": "ResourceType",
+  "$defs": {
+    "DocumentationFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/NameFacet"
+        },
+        {
+          "$ref": "#/$defs/DescriptionFacet"
+        }
+      ],
+      "$anchor": "DocumentationFacet"
+    },
+    "ResourceTypeImplementationKindFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "resourceTypeImplementationKind": {
+          "$ref": "#/$defs/ResourceTypeImplementationKind"
+        }
+      },
+      "required": [
+        "resourceTypeImplementationKind"
+      ],
+      "$anchor": "ResourceTypeImplementationKindFacet"
+    },
+    "Uri": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "Uri",
+      "format": "uri"
+    },
+    "ResourceTypeIdentity": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "ResourceTypeIdentity",
+      "pattern": "^TYPE-.+$"
+    },
+    "NameFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "name": {
+          "$ref": "#/$defs/Name"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "$anchor": "NameFacet"
+    },
+    "DescriptionFacet": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object",
+      "properties": {
+        "description": {
+          "$ref": "#/$defs/Description"
+        }
+      },
+      "required": [
+        "description"
+      ],
+      "$anchor": "DescriptionFacet"
+    },
+    "ResourceTypeImplementationKind": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "ResourceTypeImplementationKind",
+      "enum": [
+        "internal-without-identity",
+        "internal-with-identity",
+        "external"
+      ]
+    },
+    "Name": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "Name",
+      "$comment": "Validation is intercepted by an AI Agent that verifies the name against Toolproof's naming conventions.",
+      "minLength": 1,
+      "pattern": "^(?:[A-Z][^0-9]*|[a-z]+/[a-z.+&-]+)$",
+      "semanticValidation": "Ajv custom keyword to verify name."
+    },
+    "Description": {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "string",
+      "$anchor": "Description",
+      "$comment": "Validation is intercepted by an AI Agent that verifies the description against Toolproof's documentation standards.",
+      "minLength": 1,
+      "semanticValidation": "Ajv custom keyword to verify description."
+    }
+  }
+}

package/src/generated/schemas/ResourceType.ts

@@ -0,0 +1,2 @@
+import schema from './ResourceType.json' with { type: 'json' };
+export default schema;