@dp-bohrium/widget-sdk 0.5.0 → 0.7.0

package/schemas/widget-plugin-manifest.schema.json

@@ -0,0 +1,162 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "widget-plugin-manifest.schema.json",
+  "title": "Widget Plugin Manifest",
+  "description": "插件作者维护的插件清单；打包阶段会生成宿主清单的运行时字段。",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "name",
+    "version",
+    "contributes"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?$"
+    },
+    "displayName": {
+      "type": "string",
+      "maxLength": 128
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 2000
+    },
+    "entry": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^(?!/)(?!.*\\.\\.)(?!.*\\\\)(?!.*://).+\\.(?:[cm]?js|tsx?|jsx?)$",
+      "description": "插件源码入口；CLI 默认使用 src/widget.ts。"
+    },
+    "activationEvents": {
+      "$ref": "widget-manifest.schema.json#/$defs/ActivationEvents"
+    },
+    "contributes": {
+      "$ref": "#/$defs/WidgetPluginContributions"
+    },
+    "capabilities": {
+      "$ref": "widget-manifest.schema.json#/$defs/RequestedCapabilities"
+    },
+    "runtime": {
+      "$ref": "widget-manifest.schema.json#/$defs/RuntimeOptions"
+    },
+    "samples": {
+      "$ref": "widget-manifest.schema.json#/$defs/Samples"
+    }
+  },
+  "$defs": {
+    "WidgetPluginContributions": {
+      "description": "插件声明的一组扩展点；当前仅支持 widget 贡献点。",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "widget"
+      ],
+      "properties": {
+        "widget": {
+          "$ref": "#/$defs/WidgetContribution"
+        }
+      }
+    },
+    "WidgetContribution": {
+      "description": "作者贡献点联合：以 type 判别 Panel 或文件预览。",
+      "oneOf": [
+        {
+          "$ref": "#/$defs/WidgetPanelContribution"
+        },
+        {
+          "$ref": "#/$defs/WidgetFilePreviewContribution"
+        }
+      ]
+    },
+    "WidgetPanelContribution": {
+      "description": "面板贡献：声明 panel 类型与 id；surfaces、title、placement 可选。",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "id"
+      ],
+      "properties": {
+        "type": {
+          "const": "panel"
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "pattern": "^[A-Za-z0-9_.:-]+$"
+        },
+        "title": {
+          "type": "string",
+          "maxLength": 128
+        },
+        "surfaces": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 3,
+          "uniqueItems": true,
+          "items": { "enum": ["workspace", "floating", "overlay"] }
+        },
+        "placement": {
+          "oneOf": [
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["kind"],
+              "properties": {
+                "kind": { "const": "panel" }
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["kind", "region", "mode"],
+              "properties": {
+                "kind": { "const": "region" },
+                "region": { "const": "session.rightRail" },
+                "mode": { "const": "replace" }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "WidgetFilePreviewContribution": {
+      "description": "文件预览贡献：声明一组小写且不含前导点的扩展名。",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "extensions"
+      ],
+      "properties": {
+        "type": {
+          "const": "file-preview"
+        },
+        "extensions": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 32,
+            "pattern": "^[a-z0-9][a-z0-9.-]*$"
+          }
+        }
+      }
+    }
+  }
+}