@citeark/agent 0.3.20

package/schemas/cap/v2/activity.schema.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://citeark.com/schemas/cap/v2/activity.schema.json",
+  "title": "CAP 2 activity",
+  "type": "object",
+  "required": [
+    "id",
+    "type",
+    "role",
+    "status"
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://citeark.com/schemas/cap/v2/activity.schema.json"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^(urn:|https?://)"
+    },
+    "type": {
+      "const": "https://citeark.com/cap/record-types/activity/2.0"
+    },
+    "role": {
+      "type": "string",
+      "minLength": 1
+    },
+    "status": {
+      "enum": [
+        "running",
+        "succeeded",
+        "failed",
+        "cancelled",
+        "partial",
+        "timedOut",
+        "unknown"
+      ]
+    },
+    "startedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "endedAt": {
+      "type": "string",
+      "format": "date-time"
+    }
+  }
+}

package/schemas/cap/v2/agent.schema.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://citeark.com/schemas/cap/v2/agent.schema.json",
+  "title": "CAP 2 agent",
+  "type": "object",
+  "required": [
+    "id",
+    "type",
+    "role",
+    "name"
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://citeark.com/schemas/cap/v2/agent.schema.json"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^(urn:|https?://)"
+    },
+    "type": {
+      "const": "https://citeark.com/cap/record-types/agent/2.0"
+    },
+    "role": {
+      "type": "string",
+      "minLength": 1
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    }
+  }
+}

package/schemas/cap/v2/assertion.schema.json

@@ -0,0 +1,110 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://citeark.com/schemas/cap/v2/assertion.schema.json",
+  "title": "CAP 2 assertion",
+  "type": "object",
+  "required": [
+    "id",
+    "type",
+    "role"
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://citeark.com/schemas/cap/v2/assertion.schema.json"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^(urn:|https?://)"
+    },
+    "type": {
+      "const": "https://citeark.com/cap/record-types/assertion/2.0"
+    },
+    "role": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "role": {
+            "const": "assessment"
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "conclusion",
+          "method",
+          "evidence",
+          "performedBy",
+          "scope",
+          "limitations"
+        ],
+        "anyOf": [
+          {
+            "required": [
+              "subject"
+            ]
+          },
+          {
+            "required": [
+              "claim"
+            ]
+          }
+        ],
+        "properties": {
+          "conclusion": {
+            "enum": [
+              "supports",
+              "challenges",
+              "contradicts",
+              "inconclusive"
+            ]
+          },
+          "method": {
+            "type": "object"
+          },
+          "evidence": {
+            "type": "array",
+            "items": {
+              "$ref": "descriptor.schema.json#/$defs/recordReference"
+            }
+          },
+          "performedBy": {
+            "$ref": "descriptor.schema.json#/$defs/recordReference"
+          },
+          "scope": {
+            "type": "object"
+          },
+          "limitations": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "else": {
+        "required": [
+          "statement"
+        ],
+        "properties": {
+          "statement": {
+            "type": "object",
+            "required": [
+              "value"
+            ],
+            "properties": {
+              "value": {
+                "type": "string",
+                "minLength": 1
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/schemas/cap/v2/descriptor.schema.json

@@ -0,0 +1,243 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://citeark.com/schemas/cap/v2/descriptor.schema.json",
+  "title": "CAP 2.0 descriptor primitives",
+  "oneOf": [
+    {
+      "$ref": "#/$defs/recordDescriptor"
+    },
+    {
+      "$ref": "#/$defs/blobDescriptor"
+    },
+    {
+      "$ref": "#/$defs/recordReference"
+    }
+  ],
+  "$defs": {
+    "digest": {
+      "type": "string",
+      "pattern": "^sha256:[0-9a-f]{64}$"
+    },
+    "path": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^(?!/)(?!.*(?:^|/)\\.{1,2}(?:/|$))(?!.*//)(?!.*\\\\)[^\\u0000]+$"
+    },
+    "recordReference": {
+      "type": "object",
+      "required": [
+        "ref"
+      ],
+      "properties": {
+        "ref": {
+          "type": "string",
+          "minLength": 1
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        },
+        "artifactDigest": {
+          "$ref": "#/$defs/digest"
+        },
+        "recordType": {
+          "type": "string",
+          "format": "uri"
+        },
+        "role": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "required": [
+              "artifactDigest"
+            ]
+          },
+          "then": {
+            "required": [
+              "digest",
+              "recordType"
+            ]
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "recordDescriptor": {
+      "type": "object",
+      "required": [
+        "id",
+        "recordType",
+        "mediaType",
+        "schema",
+        "digest",
+        "size",
+        "path",
+        "role"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "recordType": {
+          "type": "string",
+          "format": "uri"
+        },
+        "mediaType": {
+          "type": "string",
+          "minLength": 1
+        },
+        "schema": {
+          "type": "string",
+          "format": "uri"
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "path": {
+          "$ref": "#/$defs/path"
+        },
+        "role": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "blobDescriptor": {
+      "type": "object",
+      "required": [
+        "id",
+        "roles",
+        "mediaType",
+        "digest",
+        "size",
+        "availability"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "roles": {
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "mediaType": {
+          "type": "string",
+          "minLength": 1
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "availability": {
+          "enum": [
+            "embedded",
+            "external",
+            "withheld"
+          ]
+        },
+        "path": {
+          "$ref": "#/$defs/path"
+        },
+        "rights": {
+          "type": "object"
+        },
+        "accessPolicy": {
+          "type": "object"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "availability": {
+                "const": "embedded"
+              }
+            }
+          },
+          "then": {
+            "required": [
+              "path"
+            ]
+          },
+          "else": {
+            "not": {
+              "required": [
+                "path"
+              ]
+            }
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "decimal": {
+      "type": "string",
+      "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$"
+    },
+    "selector": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "TextQuoteSelector",
+            "TextPositionSelector",
+            "TableSelector",
+            "FigureSelector"
+          ]
+        },
+        "exact": {
+          "type": "string"
+        },
+        "prefix": {
+          "type": "string"
+        },
+        "suffix": {
+          "type": "string"
+        },
+        "start": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "end": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "label": {
+          "type": "string"
+        }
+      }
+    },
+    "exactReference": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/recordReference"
+        }
+      ],
+      "required": [
+        "ref",
+        "digest",
+        "recordType"
+      ]
+    }
+  }
+}

package/schemas/cap/v2/entity.schema.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://citeark.com/schemas/cap/v2/entity.schema.json",
+  "title": "CAP 2 entity",
+  "type": "object",
+  "required": [
+    "id",
+    "type",
+    "role"
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://citeark.com/schemas/cap/v2/entity.schema.json"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^(urn:|https?://)"
+    },
+    "type": {
+      "const": "https://citeark.com/cap/record-types/entity/2.0"
+    },
+    "role": {
+      "type": "string",
+      "minLength": 1
+    },
+    "measurement": {
+      "type": "object",
+      "required": [
+        "metric",
+        "value",
+        "unit"
+      ],
+      "properties": {
+        "metric": {
+          "type": "string",
+          "minLength": 1
+        },
+        "value": {
+          "type": "object",
+          "required": [
+            "decimal"
+          ],
+          "properties": {
+            "decimal": {
+              "$ref": "descriptor.schema.json#/$defs/decimal"
+            }
+          }
+        },
+        "unit": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "object"
+        },
+        "uncertainty": {
+          "type": "object"
+        },
+        "method": {
+          "type": "object"
+        }
+      }
+    }
+  }
+}

package/schemas/cap/v2/manifest.schema.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://citeark.com/schemas/cap/v2/manifest.schema.json",
+  "title": "CAP 2.0 Artifact manifest",
+  "type": "object",
+  "required": ["$schema", "mediaType", "specVersion", "artifact", "profiles", "roots", "records", "blobs", "relations"],
+  "properties": {
+    "$schema": { "const": "https://citeark.com/schemas/cap/v2/manifest.schema.json" },
+    "mediaType": { "const": "application/vnd.citeark.cap.manifest.v2+json" },
+    "specVersion": { "enum": ["2.0.0-alpha.1", "2.0.0-alpha.2"] },
+    "artifact": {
+      "type": "object",
+      "required": ["createdAt", "createdBy"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "createdAt": { "type": "string", "format": "date-time" },
+        "createdBy": { "$ref": "descriptor.schema.json#/$defs/recordReference" }
+      },
+      "additionalProperties": false
+    },
+    "profiles": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "contains": { "const": "https://citeark.com/cap/profiles/core/2.0" },
+      "items": { "type": "string", "format": "uri" }
+    },
+    "roots": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": ["role", "ref", "digest"],
+        "properties": {
+          "role": { "type": "string", "minLength": 1 },
+          "ref": { "type": "string", "minLength": 1 },
+          "digest": { "$ref": "descriptor.schema.json#/$defs/digest" }
+        },
+        "additionalProperties": false
+      }
+    },
+    "records": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "descriptor.schema.json#/$defs/recordDescriptor" }
+    },
+    "blobs": {
+      "type": "array",
+      "items": { "$ref": "descriptor.schema.json#/$defs/blobDescriptor" }
+    },
+    "relations": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["relationship", "artifactDigest"],
+        "properties": {
+          "relationship": { "enum": ["derivedFrom", "revises", "reproduces", "extends", "supersedes", "refersTo"] },
+          "artifactDigest": { "$ref": "descriptor.schema.json#/$defs/digest" },
+          "recordDigest": { "$ref": "descriptor.schema.json#/$defs/digest" },
+          "summary": { "type": "string" }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/cap/v2/relation.schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://citeark.com/schemas/cap/v2/relation.schema.json",
+  "title": "CAP 2 relation",
+  "type": "object",
+  "required": [
+    "id",
+    "type",
+    "role",
+    "predicate",
+    "subject",
+    "object",
+    "basis",
+    "attributedTo",
+    "sources"
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://citeark.com/schemas/cap/v2/relation.schema.json"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^(urn:|https?://)"
+    },
+    "type": {
+      "const": "https://citeark.com/cap/record-types/relation/2.0"
+    },
+    "role": {
+      "type": "string",
+      "minLength": 1
+    },
+    "predicate": {
+      "enum": [
+        "used",
+        "generated",
+        "follows",
+        "associatedWith",
+        "derivedFrom",
+        "assertedIn",
+        "attributedTo",
+        "plannedFor",
+        "evidenceFor",
+        "assesses",
+        "basedOn",
+        "describes",
+        "revises",
+        "supersedes",
+        "requires",
+        "partOf",
+        "expects",
+        "hasStep",
+        "about"
+      ]
+    },
+    "basis": {
+      "enum": [
+        "observed",
+        "declared",
+        "inferred",
+        "attested"
+      ]
+    },
+    "sources": {
+      "type": "array",
+      "items": {
+        "$ref": "descriptor.schema.json#/$defs/exactReference"
+      }
+    },
+    "qualifiers": {
+      "type": "object"
+    },
+    "subject": {
+      "$ref": "descriptor.schema.json#/$defs/exactReference"
+    },
+    "object": {
+      "$ref": "descriptor.schema.json#/$defs/exactReference"
+    },
+    "attributedTo": {
+      "$ref": "descriptor.schema.json#/$defs/exactReference"
+    }
+  }
+}