@dp-bohrium/widget-contracts 0.0.1

package/schemas/widget-manifest.schema.json

@@ -0,0 +1,227 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "widget-manifest.schema.json",
+  "title": "Widget Manifest",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["name", "widgetConfig"],
+  "properties": {
+    "name": { "type": "string", "minLength": 1, "maxLength": 128 },
+    "description": { "type": "string", "maxLength": 2000 },
+    "widgetConfig": { "$ref": "#/$defs/WidgetConfig" }
+  },
+  "$defs": {
+    "WidgetConfig": {
+      "title": "WidgetConfig",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schemaVersion",
+        "hostApiVersion",
+        "widgetSdkVersion",
+        "entry",
+        "slot",
+        "samples"
+      ],
+      "properties": {
+        "schemaVersion": { "const": 1 },
+        "hostApiVersion": { "const": 1 },
+        "widgetSdkVersion": { "$ref": "#/$defs/WidgetSdkVersion" },
+        "entry": { "$ref": "#/$defs/EntryPath" },
+        "slot": { "$ref": "#/$defs/WidgetSlotConfig" },
+        "requestedCapabilities": {
+          "$ref": "#/$defs/RequestedCapabilities"
+        },
+        "runtime": { "$ref": "#/$defs/RuntimeOptions" },
+        "samples": { "$ref": "#/$defs/Samples" }
+      }
+    },
+    "RequestedCapabilities": {
+      "title": "RequestedCapabilities",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "files": { "$ref": "#/$defs/FilesCapabilityRequest" },
+        "events": { "$ref": "#/$defs/EventsCapabilityRequest" },
+        "actions": { "$ref": "#/$defs/ActionsCapabilityRequest" },
+        "network": { "$ref": "#/$defs/NetworkCapabilityRequest" },
+        "presentation": {
+          "$ref": "#/$defs/RequestedPresentationCapability"
+        }
+      }
+    },
+    "FilesCapabilityRequest": {
+      "title": "FilesCapabilityRequest",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "list": { "type": "boolean" },
+        "metadata": { "type": "boolean" },
+        "read": { "type": "boolean" }
+      }
+    },
+    "EventsCapabilityRequest": {
+      "title": "EventsCapabilityRequest",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["topics"],
+      "properties": {
+        "topics": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128,
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
+          }
+        }
+      }
+    },
+    "ActionsCapabilityRequest": {
+      "title": "ActionsCapabilityRequest",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["names"],
+      "properties": {
+        "names": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128,
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
+          }
+        }
+      }
+    },
+    "NetworkCapabilityRequest": {
+      "title": "NetworkCapabilityRequest",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["fetch"],
+      "properties": {
+        "fetch": { "const": true }
+      }
+    },
+    "RequestedPresentationCapability": {
+      "title": "RequestedPresentationCapability",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["surfaces"],
+      "properties": {
+        "surfaces": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 2,
+          "uniqueItems": true,
+          "items": { "enum": ["floating", "overlay"] }
+        }
+      }
+    },
+    "WidgetSdkVersion": {
+      "title": "WidgetSdkVersion",
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?$"
+    },
+    "EntryPath": {
+      "title": "EntryPath",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^(?!/)(?!.*\\.\\.)(?!.*\\\\)(?!.*://).+\\.m?js$"
+    },
+    "RuntimeOptions": {
+      "title": "RuntimeOptions",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "worker": { "type": "boolean" },
+        "webAssembly": { "type": "boolean" }
+      }
+    },
+    "Samples": {
+      "title": "Samples",
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "title", "request"],
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 64,
+            "pattern": "^[A-Za-z0-9_-]+$"
+          },
+          "title": { "type": "string", "minLength": 1, "maxLength": 128 },
+          "request": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "pattern": "^(?!/)(?!.*\\.\\.)(?!.*\\\\)(?!.*://).+\\.json$"
+          }
+        }
+      }
+    },
+    "WidgetSlotConfig": {
+      "title": "WidgetSlotConfig",
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "toolName"],
+          "properties": {
+            "type": { "const": "tool-result" },
+            "toolName": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 128,
+              "pattern": "^[A-Za-z0-9_.:-]+$"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "extensions"],
+          "properties": {
+            "type": { "const": "file-preview" },
+            "extensions": {
+              "type": "array",
+              "minItems": 1,
+              "uniqueItems": true,
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 32,
+                "pattern": "^[a-z0-9][a-z0-9.-]*$"
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "panelType"],
+          "properties": {
+            "type": { "const": "panel" },
+            "panelType": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 128,
+              "pattern": "^[A-Za-z0-9_.:-]+$"
+            }
+          }
+        }
+      ]
+    }
+  }
+}