yarramate 0.1.0

package/schema/yarramate-likec4-generated-project-v2.schema.json

@@ -0,0 +1,100 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/likec4-generated-project/v2",
+  "title": "YarraMate generated multi-view LikeC4 project marker",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "project", "mapping", "views", "files", "digests"],
+  "properties": {
+    "format": {
+      "const": "yarramate/likec4-generated-project/v2"
+    },
+    "project": {
+      "$ref": "#/$defs/versionedIdentity"
+    },
+    "mapping": {
+      "$ref": "#/$defs/versionedIdentity"
+    },
+    "kindMapping": {
+      "$ref": "#/$defs/versionedIdentity"
+    },
+    "views": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/view"
+      }
+    },
+    "digests": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "likec4.config.json",
+        "model.likec4",
+        "specification.likec4"
+      ],
+      "properties": {
+        "likec4.config.json": {
+          "$ref": "#/$defs/sha256"
+        },
+        "model.likec4": {
+          "$ref": "#/$defs/sha256"
+        },
+        "specification.likec4": {
+          "$ref": "#/$defs/sha256"
+        }
+      }
+    },
+    "files": {
+      "const": [
+        "likec4.config.json",
+        "model.likec4",
+        "specification.likec4"
+      ]
+    }
+  },
+  "$defs": {
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "versionedIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*@[0-9]+\\.[0-9]+$"
+    },
+    "subjectIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "view": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["projection"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "projection": {
+          "$ref": "#/$defs/versionedIdentity"
+        },
+        "comparison": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["from", "to"],
+          "properties": {
+            "from": {
+              "$ref": "#/$defs/subjectIdentity"
+            },
+            "to": {
+              "$ref": "#/$defs/subjectIdentity"
+            }
+          }
+        }
+      }
+    },
+    "sha256": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    }
+  }
+}

package/schema/yarramate-likec4-generated-project.schema.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/likec4-generated-project/v1",
+  "title": "YarraMate generated LikeC4 project marker",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "projection", "mapping", "files"],
+  "properties": {
+    "format": {
+      "const": "yarramate/likec4-generated-project/v1"
+    },
+    "projection": {
+      "$ref": "#/$defs/versionedIdentity"
+    },
+    "mapping": {
+      "$ref": "#/$defs/versionedIdentity"
+    },
+    "kindMapping": {
+      "$ref": "#/$defs/versionedIdentity"
+    },
+    "comparison": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["from", "to"],
+      "properties": {
+        "from": {
+          "$ref": "#/$defs/subjectIdentity"
+        },
+        "to": {
+          "$ref": "#/$defs/subjectIdentity"
+        }
+      }
+    },
+    "digests": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "likec4.config.json",
+        "model.likec4",
+        "specification.likec4"
+      ],
+      "properties": {
+        "likec4.config.json": {
+          "$ref": "#/$defs/sha256"
+        },
+        "model.likec4": {
+          "$ref": "#/$defs/sha256"
+        },
+        "specification.likec4": {
+          "$ref": "#/$defs/sha256"
+        }
+      }
+    },
+    "files": {
+      "const": [
+        "likec4.config.json",
+        "model.likec4",
+        "specification.likec4"
+      ]
+    }
+  },
+  "$defs": {
+    "versionedIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*@[0-9]+\\.[0-9]+$"
+    },
+    "subjectIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "sha256": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    }
+  }
+}

package/schema/yarramate-likec4-kind-mapping.schema.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/likec4-kind-mapping/v1",
+  "title": "YarraMate LikeC4 kind mapping",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "format",
+    "id",
+    "version",
+    "conceptKinds",
+    "relationshipKinds"
+  ],
+  "properties": {
+    "format": {
+      "const": "yarramate/likec4-kind-mapping/v1"
+    },
+    "id": {
+      "$ref": "#/$defs/id"
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+$"
+    },
+    "conceptKinds": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/kindMapping"
+      }
+    },
+    "relationshipKinds": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/kindMapping"
+      }
+    }
+  },
+  "$defs": {
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "qualifiedKind": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]*(?:/[a-z][a-z0-9-]*)+@[0-9]+\\.[0-9]+#[a-z][A-Za-z0-9-]*$"
+    },
+    "likec4Identifier": {
+      "type": "string",
+      "pattern": "^[A-Za-z_][A-Za-z0-9_-]*$"
+    },
+    "kindMapping": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["native", "external"],
+      "properties": {
+        "native": {
+          "$ref": "#/$defs/qualifiedKind"
+        },
+        "external": {
+          "$ref": "#/$defs/likec4Identifier"
+        }
+      }
+    }
+  }
+}

package/schema/yarramate-likec4-project.schema.json

@@ -0,0 +1,160 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/likec4-project/v1",
+  "title": "YarraMate LikeC4 project definition",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "id", "version", "title", "mapping", "views"],
+  "properties": {
+    "format": {
+      "const": "yarramate/likec4-project/v1"
+    },
+    "id": {
+      "$ref": "#/$defs/id"
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+$"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1
+    },
+    "mapping": {
+      "$ref": "#/$defs/path"
+    },
+    "kindMapping": {
+      "$ref": "#/$defs/path"
+    },
+    "views": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/view"
+      }
+    }
+  },
+  "$defs": {
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^(?!/)(?!.*(?:^|/)\\.\\.(?:/|$))(?!.*\\\\).+$"
+    },
+    "subjectIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "comparison": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["from", "to"],
+      "properties": {
+        "from": {
+          "$ref": "#/$defs/subjectIdentity"
+        },
+        "to": {
+          "$ref": "#/$defs/subjectIdentity"
+        }
+      }
+    },
+    "view": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["projection"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "projection": {
+          "$ref": "#/$defs/path"
+        },
+        "compare": {
+          "$ref": "#/$defs/comparison"
+        },
+        "dynamic": {
+          "$ref": "#/$defs/dynamic"
+        },
+        "deployment": {
+          "$ref": "#/$defs/deployment"
+        }
+      },
+      "not": {
+        "required": ["dynamic", "deployment"]
+      }
+    },
+    "dynamic": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["steps"],
+      "properties": {
+        "steps": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/dynamicStep"
+          }
+        }
+      }
+    },
+    "dynamicStep": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["relationship"],
+      "properties": {
+        "relationship": {
+          "$ref": "#/$defs/subjectIdentity"
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "deployment": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodes", "instances"],
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/deploymentNode" }
+        },
+        "instances": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/deploymentInstance" }
+        }
+      }
+    },
+    "deploymentNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind", "name"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "kind": {
+          "enum": ["environment", "zone", "host", "runtime"]
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "parent": { "$ref": "#/$defs/id" }
+      }
+    },
+    "deploymentInstance": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "subject", "node"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "subject": { "$ref": "#/$defs/subjectIdentity" },
+        "node": { "$ref": "#/$defs/id" }
+      }
+    }
+  }
+}

package/schema/yarramate-profile.schema.json

@@ -0,0 +1,113 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/profile/v1",
+  "title": "YarraMate extension profile",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "format",
+    "id",
+    "version",
+    "extends",
+    "conceptKinds",
+    "relationshipKinds"
+  ],
+  "properties": {
+    "format": {
+      "const": "yarramate/profile/v1"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]*(?:/[a-z][a-z0-9-]*)+$"
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+$"
+    },
+    "extends": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]*(?:/[a-z][a-z0-9-]*)+@[0-9]+\\.[0-9]+$"
+    },
+    "conceptKinds": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/conceptKind"
+      }
+    },
+    "relationshipKinds": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/relationshipKind"
+      }
+    }
+  },
+  "$defs": {
+    "localKindId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "qualifiedKindId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]*(?:/[a-z][a-z0-9-]*)+@[0-9]+\\.[0-9]+#[a-z][A-Za-z0-9-]*$"
+    },
+    "aspect": {
+      "enum": [
+        "motivation",
+        "active-structure",
+        "behavior",
+        "passive-structure",
+        "composite"
+      ]
+    },
+    "conceptKind": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "name", "parent"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/localKindId"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "parent": {
+          "$ref": "#/$defs/qualifiedKindId"
+        }
+      }
+    },
+    "relationshipKind": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "name", "parent"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/localKindId"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "parent": {
+          "$ref": "#/$defs/qualifiedKindId"
+        },
+        "sourceAspects": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/aspect"
+          }
+        },
+        "targetAspects": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/aspect"
+          }
+        }
+      }
+    }
+  }
+}

package/schema/yarramate-projection-result.schema.json

@@ -0,0 +1,177 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/projection-result/v1",
+  "title": "YarraMate projection result",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "projection", "documents", "subjects", "claims"],
+  "properties": {
+    "format": {
+      "const": "yarramate/projection-result/v1"
+    },
+    "projection": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*@[0-9]+\\.[0-9]+$"
+    },
+    "presentation": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "title": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "documents": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/document"
+      }
+    },
+    "subjects": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/subject"
+      }
+    },
+    "claims": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/claim"
+      }
+    }
+  },
+  "$defs": {
+    "localId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "subjectIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "claimIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:~[a-z][a-z0-9-]*)?$"
+    },
+    "document": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "source"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/localId"
+        },
+        "source": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "subject": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "type"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/subjectIdentity"
+        },
+        "type": {
+          "enum": ["concept", "relationship"]
+        }
+      }
+    },
+    "claimObject": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["ref"],
+          "properties": {
+            "ref": {
+              "$ref": "#/$defs/subjectIdentity"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["value"],
+          "properties": {
+            "value": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        }
+      ]
+    },
+    "source": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["document", "path", "pointer", "line", "column"],
+      "properties": {
+        "document": {
+          "$ref": "#/$defs/localId"
+        },
+        "path": {
+          "type": "string",
+          "minLength": 1
+        },
+        "pointer": {
+          "type": "string",
+          "pattern": "^/"
+        },
+        "line": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "column": {
+          "type": "integer",
+          "minimum": 1
+        }
+      }
+    },
+    "claim": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "subject",
+        "predicate",
+        "object",
+        "origin",
+        "source"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/claimIdentity"
+        },
+        "subject": {
+          "$ref": "#/$defs/subjectIdentity"
+        },
+        "predicate": {
+          "type": "string",
+          "pattern": "^\\S+$"
+        },
+        "object": {
+          "$ref": "#/$defs/claimObject"
+        },
+        "origin": {
+          "const": "declared"
+        },
+        "source": {
+          "$ref": "#/$defs/source"
+        }
+      }
+    }
+  }
+}