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

package/schemas/mdbase-app.schema.json

@@ -0,0 +1,381 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/connect/schemas/mdbase-app.v1.json",
+  "title": "mdbase connect bundled application manifest v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["manifest_version", "id", "name"],
+  "properties": {
+    "manifest_version": { "const": 1 },
+    "distribution": {
+      "enum": ["web", "portable"],
+      "description": "Portable declarations use device authorization and do not claim a browser origin."
+    },
+    "id": {
+      "type": "string",
+      "minLength": 5,
+      "maxLength": 150,
+      "pattern": "^[a-z][a-z0-9-]*(\\.[a-z][a-z0-9-]*){2,}$",
+      "description": "Stable reverse-domain application identifier. This is presentation metadata, not publisher authentication."
+    },
+    "name": { "type": "string", "minLength": 1, "maxLength": 100 },
+    "homepage": { "type": "string", "format": "uri", "pattern": "^https://" },
+    "project_url": { "type": "string", "format": "uri", "pattern": "^https://" },
+    "icon": { "type": "string", "format": "uri", "pattern": "^https://" },
+    "redirect_uris": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 10,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "format": "uri",
+        "description": "An HTTPS URI on the homepage origin or a private-use scheme derived from the application ID."
+      }
+    },
+    "requirements": { "$ref": "#/$defs/requirements" },
+    "provisions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type_packs"],
+      "properties": {
+        "configuration": {
+          "type": "array",
+          "maxItems": 50,
+          "items": { "$ref": "#/$defs/configurationProvision" }
+        },
+        "type_packs": {
+          "type": "array",
+          "maxItems": 20,
+          "items": { "$ref": "#/$defs/typePackProvision" }
+        }
+      }
+    },
+    "notifications": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["criteria"],
+      "properties": {
+        "criteria": {
+          "type": "array",
+          "maxItems": 50,
+          "items": { "$ref": "#/$defs/notificationCriterion" }
+        },
+        "native_delivery": { "$ref": "#/$defs/nativeNotificationDelivery" }
+      }
+    }
+  },
+  "oneOf": [
+    {
+      "required": ["homepage", "redirect_uris"],
+      "properties": {
+        "distribution": { "const": "web" },
+        "homepage": true,
+        "redirect_uris": true,
+        "project_url": false
+      }
+    },
+    {
+      "required": ["distribution"],
+      "properties": {
+        "distribution": { "const": "portable" },
+        "homepage": false,
+        "redirect_uris": false
+      }
+    }
+  ],
+  "$defs": {
+    "identifier": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$"
+    },
+    "duration": {
+      "type": "string",
+      "pattern": "^[0-9]+(ms|s|m|h|d)$"
+    },
+    "contract": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "version", "digest"],
+      "properties": {
+        "id": { "$ref": "#/$defs/identifier" },
+        "version": {
+          "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-]+)*)?$"
+        },
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }
+      }
+    },
+    "requirements": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["access", "contracts"],
+      "properties": {
+        "capabilities": { "$ref": "#/$defs/capabilityRequirements" },
+        "access": {
+          "const": "full_collection",
+          "description": "Compatibility declaration for collection-level application authorization."
+        },
+      "collection_kind": {
+          "const": "hosted",
+          "description": "Require a durable provider-backed collection with direct sync support."
+        },
+        "files": { "$ref": "#/$defs/fileRequirement" },
+        "configuration": {
+          "type": "array",
+          "maxItems": 50,
+          "items": { "$ref": "#/$defs/configurationRequirement" }
+        },
+        "contracts": {
+          "type": "array",
+          "maxItems": 20,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/contract" }
+        }
+      }
+    },
+    "capabilityRequirements": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["contract_version", "required"],
+      "properties": {
+        "contract_version": { "const": 2 },
+        "required": {
+          "type": "array",
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/applicationCapability" }
+        },
+        "optional": {
+          "type": "array",
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/applicationCapability" }
+        }
+      }
+    },
+    "configurationValue": {
+      "anyOf": [
+        { "type": "string" },
+        { "type": "number" },
+        { "type": "boolean" },
+        { "type": "null" }
+      ]
+    },
+    "configurationRequirement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "path", "predicate", "value"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+        },
+        "path": { "type": "string", "minLength": 1, "maxLength": 1024 },
+        "predicate": { "const": "contains" },
+        "value": { "$ref": "#/$defs/configurationValue" }
+      }
+    },
+    "configurationProvision": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["requirement", "operation", "path", "value"],
+      "properties": {
+        "requirement": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+        },
+        "operation": { "const": "set_add" },
+        "path": { "type": "string", "minLength": 1, "maxLength": 1024 },
+        "value": { "$ref": "#/$defs/configurationValue" }
+      }
+    },
+    "applicationCapability": {
+      "enum": [
+        "collection.read",
+        "records.create",
+        "records.edit",
+        "records.delete",
+        "views.manage",
+        "definitions.manage",
+        "background.schedule",
+        "offline.replica"
+      ]
+    },
+    "fileRequirement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["required", "scope"],
+      "properties": {
+        "required": { "$ref": "#/$defs/fileActions" },
+        "optional": { "$ref": "#/$defs/fileActions" },
+        "scope": { "$ref": "#/$defs/fileScope" }
+      }
+    },
+    "fileActions": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 6,
+      "uniqueItems": true,
+      "items": {
+        "enum": ["list", "read", "add", "replace", "move", "delete"]
+      }
+    },
+    "fileScope": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "folders"],
+          "properties": {
+            "kind": { "const": "selected_folders" },
+            "folders": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 100,
+              "uniqueItems": true,
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024,
+                "pattern": "^(?!/)(?!\\.)(?!.*//)(?!.*\\\\)(?!.*/\\.)(?!(?:_contracts|_schemas|_types|_views|node_modules)(?:/|$))(?!.*\\/(?:_contracts|_schemas|_types|_views|node_modules)(?:/|$))(?!.*/$).+$"
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind"],
+          "properties": { "kind": { "const": "collection" } }
+        }
+      ]
+    },
+    "typePackProvision": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["manifest", "resources", "provides"],
+      "properties": {
+        "manifest": { "$ref": "#/$defs/typePackManifest" },
+        "resources": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "items": { "$ref": "#/$defs/typePackSourceResource" }
+        },
+        "provides": {
+          "type": "array",
+          "maxItems": 20,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/contract" }
+        }
+      }
+    },
+    "typePackManifest": {
+      "type": "object",
+      "required": ["kind", "id", "version", "resources"],
+      "properties": {
+        "kind": { "const": "mdbase.type-pack" },
+        "id": { "$ref": "#/$defs/identifier" },
+        "version": { "$ref": "#/$defs/contract/properties/version" },
+        "name": { "type": "string", "minLength": 1, "maxLength": 100 },
+        "description": { "type": "string", "maxLength": 500 },
+        "resources": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "items": { "$ref": "#/$defs/typePackManifestResource" }
+        }
+      },
+      "patternProperties": { "^x-[A-Za-z][A-Za-z0-9._:-]{0,127}$": true },
+      "additionalProperties": false
+    },
+    "typePackManifestResource": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "mode", "source", "target", "digest"],
+      "properties": {
+        "kind": { "enum": ["contract", "type", "schema"] },
+        "mode": { "enum": ["managed", "seed"] },
+        "source": { "type": "string", "minLength": 1, "maxLength": 240 },
+        "target": { "type": "string", "minLength": 1, "maxLength": 240 },
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }
+      }
+    },
+    "typePackSourceResource": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["source", "document"],
+      "properties": {
+        "source": { "type": "string", "minLength": 1, "maxLength": 240 },
+        "document": { "type": "string", "maxLength": 262144 }
+      }
+    },
+    "notificationCriterion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "event", "presentation"],
+      "properties": {
+        "id": { "$ref": "#/$defs/identifier" },
+        "event": { "$ref": "#/$defs/contract" },
+        "if": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["$expr"],
+          "properties": {
+            "$expr": { "type": "string", "minLength": 1, "maxLength": 4096 }
+          }
+        },
+        "debounce": { "$ref": "#/$defs/duration" },
+        "minimum_interval": { "$ref": "#/$defs/duration" },
+        "presentation": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["title"],
+          "properties": {
+            "title": { "type": "string", "minLength": 1, "maxLength": 80 },
+            "body": { "type": "string", "maxLength": 160 },
+            "tag": { "type": "string", "minLength": 1, "maxLength": 80 }
+          }
+        }
+      }
+    },
+    "nativeNotificationDelivery": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mode", "firebase_project_id"],
+          "properties": {
+            "mode": { "const": "managed_fcm" },
+            "firebase_project_id": {
+              "type": "string",
+              "minLength": 6,
+              "maxLength": 63,
+              "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mode", "url"],
+          "properties": {
+            "mode": { "const": "webhook" },
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "pattern": "^https://"
+            }
+          }
+        }
+      ]
+    }
+  }
+}

package/schemas/mdbase-query.v0.3.schema.json

@@ -0,0 +1,171 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/schemas/v0.3/query.schema.json",
+  "title": "mdbase v0.3 query object",
+  "type": "object",
+  "properties": {
+    "types": { "$ref": "#/$defs/typeList" },
+    "context": { "$ref": "#/$defs/queryContext" },
+    "projections": { "$ref": "#/$defs/projectionSet" },
+    "where": { "$ref": "#/$defs/expression" },
+    "select": { "$ref": "#/$defs/select" },
+    "order_by": { "$ref": "#/$defs/orderBy" },
+    "group_by": { "$ref": "#/$defs/groupBy" },
+    "summary_functions": { "$ref": "#/$defs/summaryFunctionSet" },
+    "summaries": { "$ref": "#/$defs/summaries" },
+    "limit": { "type": "integer", "minimum": 0 },
+    "offset": { "type": "integer", "minimum": 0 },
+    "include_body": { "type": "boolean", "default": false },
+    "frontmatter_mode": {
+      "enum": ["effective", "persisted", "both"],
+      "default": "effective"
+    }
+  },
+  "patternProperties": {
+    "^x-[A-Za-z][A-Za-z0-9._:-]{0,127}$": { "$ref": "#/$defs/extension" }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "identifier": {
+      "type": "string",
+      "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"
+    },
+    "typeName": {
+      "type": "string",
+      "pattern": "^[A-Za-z][A-Za-z0-9_-]{0,127}$"
+    },
+    "fieldName": {
+      "type": "string",
+      "pattern": "^[A-Za-z_][A-Za-z0-9_:-]*$"
+    },
+    "expression": {
+      "type": "string",
+      "minLength": 1
+    },
+    "extension": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "typeList": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "items": { "$ref": "#/$defs/typeName" }
+    },
+    "queryContext": {
+      "type": "object",
+      "required": ["this"],
+      "properties": {
+        "this": {
+          "type": "object",
+          "required": ["path"],
+          "properties": {
+            "path": { "type": "string", "minLength": 1 }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "projectionSet": {
+      "type": "object",
+      "propertyNames": { "$ref": "#/$defs/fieldName" },
+      "additionalProperties": { "$ref": "#/$defs/projection" }
+    },
+    "projection": {
+      "type": "object",
+      "required": ["expr"],
+      "properties": {
+        "expr": { "$ref": "#/$defs/expression" },
+        "description": { "type": "string" }
+      },
+      "patternProperties": {
+        "^x-[A-Za-z][A-Za-z0-9._:-]{0,127}$": { "$ref": "#/$defs/extension" }
+      },
+      "additionalProperties": false
+    },
+    "select": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "oneOf": [
+          { "type": "string", "minLength": 1 },
+          { "$ref": "#/$defs/selectExpression" }
+        ]
+      }
+    },
+    "selectExpression": {
+      "type": "object",
+      "required": ["name", "expr"],
+      "properties": {
+        "name": { "$ref": "#/$defs/fieldName" },
+        "expr": { "$ref": "#/$defs/expression" },
+        "label": { "type": "string" },
+        "description": { "type": "string" }
+      },
+      "patternProperties": {
+        "^x-[A-Za-z][A-Za-z0-9._:-]{0,127}$": { "$ref": "#/$defs/extension" }
+      },
+      "additionalProperties": false
+    },
+    "orderBy": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": ["field"],
+        "properties": {
+          "field": { "type": "string", "minLength": 1 },
+          "direction": { "enum": ["asc", "desc"], "default": "asc" }
+        },
+        "additionalProperties": false
+      }
+    },
+    "groupBy": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": ["field"],
+        "properties": {
+          "field": { "type": "string", "minLength": 1 },
+          "direction": { "enum": ["asc", "desc"], "default": "asc" }
+        },
+        "additionalProperties": false
+      }
+    },
+    "summaryFunctionSet": {
+      "type": "object",
+      "propertyNames": { "$ref": "#/$defs/fieldName" },
+      "additionalProperties": { "$ref": "#/$defs/summaryFunction" }
+    },
+    "summaryFunction": {
+      "type": "object",
+      "required": ["expr"],
+      "properties": {
+        "expr": { "$ref": "#/$defs/expression" },
+        "description": { "type": "string" }
+      },
+      "patternProperties": {
+        "^x-[A-Za-z][A-Za-z0-9._:-]{0,127}$": { "$ref": "#/$defs/extension" }
+      },
+      "additionalProperties": false
+    },
+    "summaries": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/summary" }
+    },
+    "summary": {
+      "type": "object",
+      "required": ["field", "function"],
+      "properties": {
+        "field": { "type": "string", "minLength": 1 },
+        "function": { "$ref": "#/$defs/identifier" },
+        "name": { "$ref": "#/$defs/fieldName" },
+        "label": { "type": "string" }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/notification-webhook.v1.schema.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/connect/schemas/notification-webhook.v1.json",
+  "title": "mdbase notification webhook v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "type",
+    "version",
+    "delivery_id",
+    "connection_id",
+    "notification"
+  ],
+  "properties": {
+    "type": { "const": "mdbase.notification.webhook" },
+    "version": { "const": 1 },
+    "delivery_id": { "type": "string", "format": "uuid" },
+    "connection_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Opaque application grant reference returned during authorization."
+    },
+    "notification": { "$ref": "#/$defs/notification" }
+  },
+  "$defs": {
+    "notification": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "version",
+        "signal_id",
+        "criterion_id",
+        "cursor",
+        "presentation"
+      ],
+      "properties": {
+        "type": { "const": "mdbase.notification" },
+        "version": { "const": 1 },
+        "signal_id": { "type": "string", "minLength": 1, "maxLength": 200 },
+        "criterion_id": { "type": "string", "minLength": 1, "maxLength": 100 },
+        "cursor": { "type": "string", "minLength": 1, "maxLength": 2000 },
+        "presentation": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["title"],
+          "properties": {
+            "title": { "type": "string", "minLength": 1, "maxLength": 80 },
+            "body": { "type": "string", "maxLength": 160 },
+            "tag": { "type": "string", "minLength": 1, "maxLength": 80 }
+          }
+        }
+      }
+    }
+  }
+}

package/schemas/operation-catalog.v1.json

@@ -0,0 +1,42 @@
+{
+  "catalog_version": 1,
+  "collection_operations": [
+    { "id": "describe", "input_schema_version": 1, "mutation": "never" },
+    { "id": "changes", "input_schema_version": 1, "mutation": "never" },
+    { "id": "read", "input_schema_version": 1, "mutation": "never" },
+    { "id": "query", "input_schema_version": 1, "mutation": "never" },
+    { "id": "list_views", "input_schema_version": 1, "mutation": "never" },
+    { "id": "execute_view", "input_schema_version": 1, "mutation": "never" },
+    { "id": "read_view_source", "input_schema_version": 1, "mutation": "never" },
+    { "id": "create_view_source", "input_schema_version": 1, "mutation": "always" },
+    { "id": "update_view_source", "input_schema_version": 1, "mutation": "always" },
+    { "id": "delete_view_source", "input_schema_version": 1, "mutation": "always" },
+    { "id": "validate", "input_schema_version": 1, "mutation": "never" },
+    { "id": "create", "input_schema_version": 1, "mutation": "always" },
+    { "id": "update", "input_schema_version": 1, "mutation": "always" },
+    { "id": "delete", "input_schema_version": 1, "mutation": "always", "dry_run": "nonmutating" },
+    { "id": "rename", "input_schema_version": 1, "mutation": "always", "dry_run": "nonmutating" },
+    { "id": "read_type", "input_schema_version": 1, "mutation": "never" },
+    { "id": "create_type", "input_schema_version": 1, "mutation": "always" },
+    { "id": "update_type", "input_schema_version": 1, "mutation": "always" },
+    { "id": "assess_type_pack", "input_schema_version": 1, "mutation": "never" },
+    { "id": "apply_type_pack", "input_schema_version": 1, "mutation": "always" },
+    { "id": "assess_collection_setup", "input_schema_version": 1, "mutation": "never" },
+    { "id": "apply_collection_setup", "input_schema_version": 1, "mutation": "always" },
+    { "id": "list_timers", "input_schema_version": 1, "mutation": "never", "requires_timer_criterion": true },
+    { "id": "put_timer", "input_schema_version": 1, "mutation": "always", "requires_timer_criterion": true },
+    { "id": "cancel_timer", "input_schema_version": 1, "mutation": "always", "requires_timer_criterion": true },
+    { "id": "reconcile_timers", "input_schema_version": 1, "mutation": "always", "requires_timer_criterion": true },
+    { "id": "sync", "input_schema_version": 1, "mutation": "sync_action" }
+  ],
+  "file_control_messages": [
+    { "id": "list_files", "input_schema_version": 1, "mutation": false },
+    { "id": "open_file_upload", "input_schema_version": 1, "mutation": true },
+    { "id": "open_file_download", "input_schema_version": 1, "mutation": false },
+    { "id": "move_file", "input_schema_version": 1, "mutation": true },
+    { "id": "delete_file", "input_schema_version": 1, "mutation": true },
+    { "id": "get_file_transfer_status", "input_schema_version": 1, "mutation": false },
+    { "id": "commit_file_upload", "input_schema_version": 1, "mutation": true },
+    { "id": "abort_file_transfer", "input_schema_version": 1, "mutation": true }
+  ]
+}