@mdbase-dev/connect-protocol 0.1.0-beta.93 → 0.1.0-beta.95

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdbase-dev/connect-protocol",
-  "version": "0.1.0-beta.93",
+  "version": "0.1.0-beta.95",
   "private": false,
   "type": "module",
   "license": "MIT",
@@ -36,7 +36,7 @@
   },
   "scripts": {
     "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.json",
-    "test": "node --test test/*.test.mjs && node ../../scripts/generate-connect-problems.mjs --check && node ../../scripts/generate-operation-catalog.mjs --check",
+    "test": "node --test test/*.test.mjs && node ../../scripts/generate-connect-problems.mjs --check && node ../../scripts/generate-operation-catalog.mjs --check && node ../../scripts/generate-application-capabilities.mjs --check",
     "typecheck": "tsc -p tsconfig.json --noEmit"
   }
 }

package/schemas/application-capability-catalog.v1.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "catalog_version": 1,
+  "capabilities": [
+    { "id": "collection.inspect", "operations": ["describe"] },
+    { "id": "records.watch", "operations": ["changes"] },
+    { "id": "records.read", "operations": ["read"] },
+    { "id": "records.query", "operations": ["query"] },
+    { "id": "records.validate", "operations": ["validate"] },
+    { "id": "records.create", "operations": ["create"] },
+    { "id": "records.update", "operations": ["update"] },
+    { "id": "records.delete", "operations": ["delete"] },
+    { "id": "records.rename", "operations": ["rename"] },
+    { "id": "views.list", "operations": ["list_views"] },
+    { "id": "views.execute", "operations": ["execute_view"] },
+    { "id": "views.source.read", "operations": ["read_view_source"] },
+    { "id": "views.source.create", "operations": ["create_view_source"] },
+    { "id": "views.source.update", "operations": ["update_view_source"] },
+    { "id": "views.source.delete", "operations": ["delete_view_source"] },
+    { "id": "definitions.contracts.current", "operations": [] },
+    { "id": "definitions.read", "operations": ["read_type"] },
+    { "id": "definitions.create", "operations": ["create_type"] },
+    { "id": "definitions.update", "operations": ["update_type"] },
+    { "id": "definitions.type-pack.inspect", "operations": ["assess_type_pack"] },
+    { "id": "definitions.type-pack.apply", "operations": ["assess_type_pack", "apply_type_pack"] },
+    { "id": "collection.setup.apply", "operations": ["assess_collection_setup", "apply_collection_setup"] },
+    { "id": "timers.list", "operations": ["list_timers"] },
+    { "id": "timers.put", "operations": ["put_timer"] },
+    { "id": "timers.cancel", "operations": ["cancel_timer"] },
+    { "id": "timers.reconcile", "operations": ["reconcile_timers"] },
+    { "id": "sync.offline-replica", "operations": ["sync"] },
+    { "id": "notifications.background-delivery", "operations": [] },
+    { "id": "files.list", "operations": [] },
+    { "id": "files.read", "operations": [] },
+    { "id": "files.add", "operations": [] },
+    { "id": "files.replace", "operations": [] },
+    { "id": "files.move", "operations": [] },
+    { "id": "files.delete", "operations": [] }
+  ]
+}

package/schemas/application-capability-catalog.v2.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "catalog_version": 2,
+  "capabilities": [
+    {
+      "id": "collection.read",
+      "operations": [
+        "describe",
+        "changes",
+        "read",
+        "query",
+        "list_views",
+        "execute_view",
+        "read_view_source",
+        "validate",
+        "read_type"
+      ]
+    },
+    {
+      "id": "records.create",
+      "operations": ["create"]
+    },
+    {
+      "id": "records.edit",
+      "operations": ["update", "rename"]
+    },
+    {
+      "id": "records.delete",
+      "operations": ["delete"]
+    },
+    {
+      "id": "views.manage",
+      "operations": [
+        "create_view_source",
+        "update_view_source",
+        "delete_view_source"
+      ]
+    },
+    {
+      "id": "definitions.manage",
+      "operations": [
+        "create_type",
+        "update_type",
+        "assess_type_pack",
+        "apply_type_pack"
+      ]
+    },
+    {
+      "id": "background.schedule",
+      "operations": [
+        "list_timers",
+        "put_timer",
+        "cancel_timer",
+        "reconcile_timers"
+      ]
+    },
+    {
+      "id": "offline.replica",
+      "operations": ["sync"]
+    }
+  ],
+  "structured_authorities": {
+    "application_setup": [
+      "assess_collection_setup",
+      "apply_collection_setup"
+    ]
+  }
+}

package/schemas/connect-problem.v1.schema.json

@@ -2955,6 +2955,46 @@
         }
       }
     },
+    {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "problem_version",
+        "code",
+        "category",
+        "recovery",
+        "message"
+      ],
+      "properties": {
+        "problem_version": {
+          "const": 1
+        },
+        "code": {
+          "const": "legacy_scope_reauthorization_required"
+        },
+        "category": {
+          "const": "authorization"
+        },
+        "recovery": {
+          "const": "reauthorize"
+        },
+        "message": {
+          "type": "string",
+          "minLength": 1
+        },
+        "operation_outcome": {
+          "enum": [
+            "not_sent",
+            "rejected",
+            "unknown"
+          ]
+        },
+        "trace_id": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
     {
       "type": "object",
       "additionalProperties": false,

package/schemas/connect-problems.v1.catalog.json

@@ -250,6 +250,7 @@
     "invalid_read_cursor": { "category": "validation", "recovery": "fix_request" },
     "invalid_request": { "category": "validation", "recovery": "fix_request" },
     "invalid_token_response": { "category": "integrity", "recovery": "contact_support" },
+    "legacy_scope_reauthorization_required": { "category": "authorization", "recovery": "reauthorize" },
     "managed_fcm_not_declared": { "category": "compatibility", "recovery": "fix_request" },
     "manifest_load_failed": { "category": "availability", "recovery": "retry" },
     "manifest_required": { "category": "validation", "recovery": "fix_request" },

package/schemas/connect-protocol.v1.schema.json

@@ -274,6 +274,7 @@
         "file_capability": {
           "$ref": "https://mdbase.dev/connect/schemas/files.v1.json#/$defs/fileCapability"
         },
+        "application_declaration": {},
         "application_authorization": { "$ref": "#/$defs/applicationAuthorizationProof" }
       }
     },

package/schemas/mdbase-app.legacy-v1.schema.json

@@ -0,0 +1,405 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/connect/schemas/mdbase-app.legacy-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": 1 },
+        "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.inspect",
+        "records.watch",
+        "records.read",
+        "records.query",
+        "records.validate",
+        "records.create",
+        "records.update",
+        "records.delete",
+        "records.rename",
+        "views.list",
+        "views.execute",
+        "views.source.read",
+        "views.source.create",
+        "views.source.update",
+            "views.source.delete",
+            "definitions.contracts.current",
+            "definitions.read",
+        "definitions.create",
+        "definitions.update",
+        "definitions.type-pack.inspect",
+        "definitions.type-pack.apply",
+        "collection.setup.apply",
+        "timers.list",
+        "timers.put",
+        "timers.cancel",
+        "timers.reconcile",
+        "sync.offline-replica",
+        "notifications.background-delivery",
+        "files.list",
+        "files.read",
+        "files.add",
+        "files.replace",
+        "files.move",
+        "files.delete"
+      ]
+    },
+    "fileRequirement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["actions", "scope"],
+      "properties": {
+        "actions": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 6,
+          "uniqueItems": true,
+          "items": {
+            "enum": ["list", "read", "add", "replace", "move", "delete"]
+          }
+        },
+        "scope": { "$ref": "#/$defs/fileScope" }
+      }
+    },
+    "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://"
+            }
+          }
+        }
+      ]
+    }
+  }
+}