@mdbase-dev/connect-protocol 0.1.0-beta.100

package/schemas/data-contract.schema.json

@@ -0,0 +1,163 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/schemas/v0.3/data-contract.schema.json",
+  "title": "mdbase v0.3 contract frontmatter",
+  "type": "object",
+  "required": ["kind", "contract_type", "id", "version"],
+  "properties": {
+    "kind": {
+      "const": "mdbase.contract"
+    },
+    "contract_type": {
+      "enum": ["record", "event", "action"]
+    },
+    "id": {
+      "$ref": "#/$defs/contractId"
+    },
+    "version": {
+      "$ref": "#/$defs/semanticVersion"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "description": {
+      "type": "string"
+    },
+    "record_schema": {
+      "$ref": "#/$defs/schemaWrapper"
+    },
+    "binding_schema": {
+      "$ref": "#/$defs/schemaWrapper"
+    },
+    "data_schema": {
+      "$ref": "#/$defs/schemaWrapper"
+    },
+    "source_schema": {
+      "$ref": "#/$defs/schemaWrapper"
+    },
+    "input_schema": {
+      "$ref": "#/$defs/schemaWrapper"
+    },
+    "output_schema": {
+      "$ref": "#/$defs/schemaWrapper"
+    },
+    "error_schema": {
+      "$ref": "#/$defs/schemaWrapper"
+    },
+    "provider_schema": {
+      "$ref": "#/$defs/schemaWrapper"
+    },
+    "behavior": {
+      "$ref": "#/$defs/actionBehavior"
+    }
+  },
+  "patternProperties": {
+    "^x-[A-Za-z][A-Za-z0-9._:-]{0,127}$": true
+  },
+  "oneOf": [
+    {
+      "properties": {
+        "contract_type": { "const": "record" },
+        "record_schema": true,
+        "binding_schema": true,
+        "data_schema": false,
+        "source_schema": false,
+        "input_schema": false,
+        "output_schema": false,
+        "error_schema": false,
+        "provider_schema": false,
+        "behavior": false
+      },
+      "required": ["record_schema"]
+    },
+    {
+      "properties": {
+        "contract_type": { "const": "event" },
+        "record_schema": false,
+        "binding_schema": false,
+        "data_schema": true,
+        "source_schema": true,
+        "input_schema": false,
+        "output_schema": false,
+        "error_schema": false,
+        "provider_schema": false,
+        "behavior": false
+      },
+      "required": ["data_schema"]
+    },
+    {
+      "properties": {
+        "contract_type": { "const": "action" },
+        "record_schema": false,
+        "binding_schema": false,
+        "data_schema": false,
+        "source_schema": false,
+        "input_schema": true,
+        "output_schema": true,
+        "error_schema": true,
+        "provider_schema": true,
+        "behavior": true
+      },
+      "required": ["input_schema"]
+    }
+  ],
+  "additionalProperties": false,
+  "$defs": {
+    "contractId": {
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 128,
+      "pattern": "^[a-z][a-z0-9]*(?:[._-][a-z0-9]+)+$"
+    },
+    "semanticVersion": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
+    },
+    "schemaWrapper": {
+      "type": "object",
+      "required": ["dialect"],
+      "properties": {
+        "dialect": {
+          "const": "json-schema-2020-12"
+        },
+        "value": {
+          "type": "object"
+        },
+        "ref": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "oneOf": [
+        {
+          "required": ["value"],
+          "properties": {
+            "value": true,
+            "ref": false
+          }
+        },
+        {
+          "required": ["ref"],
+          "properties": {
+            "ref": true,
+            "value": false
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "actionBehavior": {
+      "type": "object",
+      "properties": {
+        "idempotency": {
+          "enum": ["none", "optional", "required"]
+        },
+        "cancellation": {
+          "enum": ["none", "cooperative"]
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/encrypted-relay.v1.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/connect/schemas/encrypted-relay.v1.json",
+  "title": "mdbase connect encrypted relay protocol 1",
+  "description": "Opaque authenticated operation envelopes routed between an application and connector.",
+  "oneOf": [
+    { "$ref": "#/$defs/request" },
+    { "$ref": "#/$defs/response" },
+    { "$ref": "#/$defs/rejected" }
+  ],
+  "$defs": {
+    "uuid": {
+      "type": "string",
+      "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}$"
+    },
+    "operation": {
+      "enum": ["describe", "changes", "read", "query", "list_views", "execute_view", "read_view_source", "create_view_source", "update_view_source", "delete_view_source", "validate", "create", "update", "delete", "rename", "read_type", "create_type", "update_type", "assess_type_pack", "apply_type_pack", "assess_collection_setup", "apply_collection_setup", "list_timers", "put_timer", "cancel_timer", "reconcile_timers", "file_control"]
+    },
+    "envelope": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "protocol_version", "suite", "request_id", "grant_id", "application_id", "connector_id", "collection_id", "operation", "scope_epoch", "key_id", "counter", "ciphertext"],
+      "properties": {
+        "type": { "enum": ["encrypted_operation_request", "encrypted_operation_response"] },
+        "protocol_version": { "const": 1 },
+        "suite": { "const": "P256-HKDF-SHA256-AES256GCM" },
+        "request_id": { "$ref": "#/$defs/uuid" },
+        "grant_id": { "$ref": "#/$defs/uuid" },
+        "application_id": { "$ref": "#/$defs/uuid" },
+        "connector_id": { "$ref": "#/$defs/uuid" },
+        "collection_id": { "$ref": "#/$defs/uuid" },
+        "operation": { "$ref": "#/$defs/operation" },
+        "scope_epoch": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 },
+        "key_id": { "type": "string", "minLength": 1, "maxLength": 200 },
+        "counter": { "type": "string", "pattern": "^[1-9][0-9]{0,19}$" },
+        "ciphertext": { "type": "string", "minLength": 1, "maxLength": 2800000, "pattern": "^[A-Za-z0-9_-]+$" }
+      }
+    },
+    "request": {
+      "allOf": [
+        { "$ref": "#/$defs/envelope" },
+        { "type": "object", "properties": { "type": { "const": "encrypted_operation_request" } } }
+      ]
+    },
+    "response": {
+      "allOf": [
+        { "$ref": "#/$defs/envelope" },
+        { "type": "object", "properties": { "type": { "const": "encrypted_operation_response" } } }
+      ]
+    },
+    "rejected": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "protocol_version", "request_id", "problem"],
+      "properties": {
+        "type": { "const": "encrypted_operation_rejected" },
+        "protocol_version": { "const": 1 },
+        "request_id": { "$ref": "#/$defs/uuid" },
+        "problem": { "$ref": "https://schemas.mdbase.dev/connect/problem/v1" }
+      }
+    }
+  }
+}

package/schemas/encrypted-relay.v2.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/connect/schemas/encrypted-relay.v2.json",
+  "title": "mdbase connect encrypted operation transport 2",
+  "description": "Opaque authenticated operation envelopes routed between an application and authority.",
+  "oneOf": [
+    { "$ref": "#/$defs/request" },
+    { "$ref": "#/$defs/response" },
+    { "$ref": "#/$defs/rejected" }
+  ],
+  "$defs": {
+    "uuid": {
+      "type": "string",
+      "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}$"
+    },
+    "operation": {
+      "enum": ["describe", "changes", "read", "query", "list_views", "execute_view", "read_view_source", "create_view_source", "update_view_source", "delete_view_source", "validate", "create", "update", "delete", "rename", "read_type", "create_type", "update_type", "assess_type_pack", "apply_type_pack", "assess_collection_setup", "apply_collection_setup", "list_timers", "put_timer", "cancel_timer", "reconcile_timers", "sync", "file_control"]
+    },
+    "envelope": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "protocol_version", "suite", "request_id", "grant_id", "application_id", "connector_id", "collection_id", "operation", "scope_epoch", "key_id", "counter", "ciphertext"],
+      "properties": {
+        "type": { "enum": ["encrypted_operation_request", "encrypted_operation_response"] },
+        "protocol_version": { "const": 2 },
+        "suite": { "const": "P256-HKDF-SHA256-AES256GCM" },
+        "request_id": { "$ref": "#/$defs/uuid" },
+        "grant_id": { "$ref": "#/$defs/uuid" },
+        "application_id": { "$ref": "#/$defs/uuid" },
+        "connector_id": { "$ref": "#/$defs/uuid" },
+        "collection_id": { "$ref": "#/$defs/uuid" },
+        "operation": { "$ref": "#/$defs/operation" },
+        "scope_epoch": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 },
+        "key_id": { "type": "string", "minLength": 1, "maxLength": 200 },
+        "counter": { "type": "string", "pattern": "^[1-9][0-9]{0,19}$" },
+        "ciphertext": { "type": "string", "minLength": 1, "maxLength": 2800000, "pattern": "^[A-Za-z0-9_-]+$" }
+      }
+    },
+    "request": {
+      "allOf": [
+        { "$ref": "#/$defs/envelope" },
+        { "type": "object", "properties": { "type": { "const": "encrypted_operation_request" } } }
+      ]
+    },
+    "response": {
+      "allOf": [
+        { "$ref": "#/$defs/envelope" },
+        { "type": "object", "properties": { "type": { "const": "encrypted_operation_response" } } }
+      ]
+    },
+    "rejected": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "protocol_version", "request_id", "problem"],
+      "properties": {
+        "type": { "const": "encrypted_operation_rejected" },
+        "protocol_version": { "const": 2 },
+        "request_id": { "$ref": "#/$defs/uuid" },
+        "problem": { "$ref": "https://schemas.mdbase.dev/connect/problem/v1" }
+      }
+    }
+  }
+}

package/schemas/encrypted-relay.v3.schema.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/connect/schemas/encrypted-relay.v3.json",
+  "title": "mdbase connect encrypted operation transport 3",
+  "description": "Opaque authenticated operation envelopes routed between an application and authority.",
+  "oneOf": [
+    { "$ref": "#/$defs/request" },
+    { "$ref": "#/$defs/response" },
+    { "$ref": "#/$defs/rejected" }
+  ],
+  "$defs": {
+    "uuid": {
+      "type": "string",
+      "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}$"
+    },
+    "operation": {
+      "enum": ["describe", "changes", "read", "query", "list_views", "execute_view", "read_view_source", "create_view_source", "update_view_source", "delete_view_source", "validate", "create", "update", "delete", "rename", "read_type", "create_type", "update_type", "assess_type_pack", "apply_type_pack", "assess_collection_setup", "apply_collection_setup", "list_timers", "put_timer", "cancel_timer", "reconcile_timers", "sync", "file_control"]
+    },
+    "envelope": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "protocol_version", "suite", "request_id", "grant_id", "application_id", "connector_id", "collection_id", "operation", "scope_epoch", "key_id", "counter", "ciphertext"],
+      "properties": {
+        "type": { "enum": ["encrypted_operation_request", "encrypted_operation_response"] },
+        "protocol_version": { "const": 3 },
+        "suite": { "const": "P256-HKDF-SHA256-AES256GCM" },
+        "request_id": { "$ref": "#/$defs/uuid" },
+        "grant_id": { "$ref": "#/$defs/uuid" },
+        "application_id": { "$ref": "#/$defs/uuid" },
+        "connector_id": { "$ref": "#/$defs/uuid" },
+        "collection_id": { "$ref": "#/$defs/uuid" },
+        "operation": { "$ref": "#/$defs/operation" },
+        "scope_epoch": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 },
+        "key_id": { "type": "string", "minLength": 1, "maxLength": 200 },
+        "counter": { "type": "string", "pattern": "^[1-9][0-9]{0,19}$" },
+        "deadline_unix_ms": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 },
+        "ciphertext": { "type": "string", "minLength": 1, "maxLength": 2800000, "pattern": "^[A-Za-z0-9_-]+$" }
+      }
+    },
+    "request": {
+      "allOf": [
+        { "$ref": "#/$defs/envelope" },
+        { "type": "object", "properties": { "type": { "const": "encrypted_operation_request" } } }
+      ]
+    },
+    "response": {
+      "allOf": [
+        { "$ref": "#/$defs/envelope" },
+        { "type": "object", "properties": { "type": { "const": "encrypted_operation_response" } } }
+      ]
+    },
+    "rejected": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "protocol_version", "request_id", "problem"],
+      "properties": {
+        "type": { "const": "encrypted_operation_rejected" },
+        "protocol_version": { "const": 3 },
+        "request_id": { "$ref": "#/$defs/uuid" },
+        "problem": { "$ref": "https://schemas.mdbase.dev/connect/problem/v1" }
+      }
+    }
+  }
+}