@capyclaw/editor-host 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,37 @@
-# Temporary Holding Version
+# dsh-editor-host
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+DSH 公共编辑器宿主插件。功能插件只提供 `editor/` 静态目录，不再自己写静态路由、租约和连接状态。
+
+## 使用
+
+```js
+export const inject = ['editorHost', 'serviceHost']
+
+export function apply(ctx, config) {
+  const editor = ctx.editorHost.createEditorHost({
+    id: 'my-editor',
+    dir: path.join(packageDir, 'editor'),
+    basePath: '/editor',
+    files: { '/': 'index.html', '/app.js': 'app.js' },
+  })
+  const app = ctx.serviceHost.createApp({
+    id: 'my-plugin',
+    health: () => editor.status(),
+  })
+  for (const route of editor.routes()) app.use(route)
+}
+```
+
+## 提供什么
+
+- `createEditorHost({ id, dir, basePath, index, files })`
+  - `routes()`：静态文件 + 租约端点
+  - `status()`：`{ connected, lease }`，可直接并入 `/healthz`
+- `createLease()`：`dsh-plugin-kit/editor/lease` 的租约仲裁
+- 端点：`POST <base>/claim`、`POST <base>/release`、`GET <base>/status`
+
+## 约定
+
+- “显示即连接”：页面加载后自动 claim；后打开者强制抢占
+- 租约状态只用于内部仲裁，不渲染成“未连接/待命”
+- 心跳间隔应小于 TTL（默认 3s / 15s）

package/cordis.patch.yml

@@ -0,0 +1,4 @@
+# 由 dsh-editor-host 提供；功能插件通过 inject: ['editorHost'] 或 ctx.get('editorHost') 使用。
+- insert:
+    - id: editor-host
+      name: "dsh-editor-host"

package/dsh-suite.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "../dsh-suite-kit/suite.schema.json",
+  "name": "dsh-editor-host-suite",
+  "version": "0.1.0",
+  "title": "Editor Host",
+  "description": "通用编辑器宿主：静态托管、租约、心跳、连接状态。",
+  "packages": {
+    "@capyclaw/editor-host": {
+      "role": "provider",
+      "version": "^0.1.1",
+      "path": ".",
+      "provides": {
+        "services": [
+          "editorHost"
+        ],
+        "capabilities": {
+          "editor.host": "1.0.0"
+        }
+      }
+    }
+  },
+  "rows": [
+    {
+      "id": "editor-host",
+      "name": "@capyclaw/editor-host"
+    }
+  ],
+  "checks": []
+}

package/lib/host.mjs

@@ -0,0 +1,11 @@
+/** dsh-editor-host 插件：向同进程插件提供 ctx.editorHost。 */
+import { createEditorHostService } from '../src/index.mjs'
+
+export const name = 'editor-host'
+
+export function apply(ctx, config = {}) {
+  const service = createEditorHostService(config)
+  const dispose = ctx.provide('editorHost', service)
+  console.log('[editor-host] ready')
+  return () => { if (typeof dispose === 'function') dispose() }
+}

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@capyclaw/editor-host",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "DSH 公共编辑器宿主插件：静态托管、租约仲裁、心跳与连接状态，向插件提供 ctx.editorHost。",
+  "type": "module",
+  "main": "./lib/host.mjs",
+  "exports": {
+    ".": "./lib/host.mjs",
+    "./src": "./src/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=18",
+    "dsh": "^0.2.0-rc.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "suite": "./dsh-suite.json",
+    "apiVersion": "1.0.0",
+    "category": "service",
+    "platform": "both"
+  },
+  "meta": {
+    "title": "公共编辑器宿主",
+    "description": "静态托管、租约仲裁、心跳与连接状态，向插件提供 ctx.editorHost"
+  },
+  "files": [
+    "lib/",
+    "src/",
+    "cordis.patch.yml",
+    "dsh-suite.json",
+    "README.md"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "test": "node --test test/unit.test.mjs"
+  },
+  "dependencies": {
+    "@capyclaw/plugin-kit": "^0.2.0"
+  }
+}

package/src/index.mjs

@@ -0,0 +1,125 @@
+/**
+ * dsh-editor-host —— 通用浏览器编辑器宿主。
+ *
+ * 功能插件只提供 editor/ 静态目录，不再自己写：
+ *   - 静态文件路由 / content-type / 404
+ *   - “显示即连接”的租约仲裁（后打开者抢占，旧窗口静默待命）
+ *   - claim / release / status / heartbeat 端点
+ *   - 连接状态供 /healthz 使用
+ *
+ * 浏览器端可直接使用 @capyclaw/plugin-kit 的 editor/lease.mjs（无 Node 依赖）。
+ */
+import fs from 'node:fs'
+import path from 'node:path'
+import { createEditorLease } from '@capyclaw/plugin-kit/editor/lease'
+import { send, readBody } from '@capyclaw/plugin-kit/service/http'
+import { createServiceApi } from '@capyclaw/plugin-kit/service/api'
+
+const MIME = {
+  '.html': 'text/html; charset=utf-8',
+  '.js': 'text/javascript; charset=utf-8',
+  '.mjs': 'text/javascript; charset=utf-8',
+  '.css': 'text/css; charset=utf-8',
+  '.json': 'application/json; charset=utf-8',
+  '.svg': 'image/svg+xml',
+  '.png': 'image/png',
+  '.jpg': 'image/jpeg',
+  '.jpeg': 'image/jpeg',
+  '.webp': 'image/webp',
+  '.woff2': 'font/woff2',
+}
+
+function safeJoin(root, rel) {
+  const target = path.resolve(root, `.${path.sep}${rel}`)
+  const base = path.resolve(root)
+  return target === base || target.startsWith(base + path.sep) ? target : null
+}
+
+function contentType(file) {
+  return MIME[path.extname(file).toLowerCase()] || 'application/octet-stream'
+}
+
+/**
+ * @param {{ id: string, dir: string, basePath?: string, index?: string, files?: Record<string,string|string[]> }} options
+ */
+export function createEditorHost({ id, dir, basePath = '', index = 'index.html', files = null } = {}) {
+  if (!id) throw new Error('createEditorHost: id 必填')
+  const prefix = basePath === '/' ? '' : String(basePath || '').replace(/\/+$/, '')
+  const lease = createEditorLease()
+
+  const staticRoutes = async function editorStatic(req, res, u) {
+    if (req.method !== 'GET' && req.method !== 'HEAD') return false
+    if (prefix && u.pathname !== prefix && !u.pathname.startsWith(prefix + '/')) return false
+    const relRaw = prefix ? u.pathname.slice(prefix.length) : u.pathname
+    const rel = relRaw === '' || relRaw === '/' ? index : decodeURIComponent(relRaw.replace(/^\/+/, ''))
+    let file = null
+    if (files) {
+      const hit = files[relRaw === '' ? '/' : relRaw] || files[relRaw]
+      if (!hit) return false
+      const name = Array.isArray(hit) ? hit[0] : hit
+      file = safeJoin(dir, name)
+    } else {
+      file = safeJoin(dir, rel)
+    }
+    if (!file) return false
+    try {
+      const data = fs.readFileSync(file)
+      res.writeHead(200, {
+        'content-type': contentType(file),
+        'content-length': data.length,
+        'x-content-type-options': 'nosniff',
+        'referrer-policy': 'no-referrer',
+        'cache-control': 'no-cache',
+      })
+      res.end(req.method === 'HEAD' ? undefined : data)
+      return true
+    } catch {
+      return false
+    }
+  }
+
+  const leaseRoutes = async function editorLeaseRoutes(req, res, u) {
+    const claimPath = `${prefix}/claim`
+    const releasePath = `${prefix}/release`
+    const statusPath = `${prefix}/status`
+    if (u.pathname === claimPath && req.method === 'POST') {
+      const body = await readBody(req)
+      const result = lease.claim(String(body.id || ''), !!body.force)
+      send(req, res, result.ok ? 200 : 409, result)
+      return true
+    }
+    if (u.pathname === releasePath && req.method === 'POST') {
+      const body = await readBody(req)
+      send(req, res, 200, lease.release(String(body.id || '')))
+      return true
+    }
+    if (u.pathname === statusPath && req.method === 'GET') {
+      send(req, res, 200, { ok: true, connected: lease.isLive(), lease: lease.status() })
+      return true
+    }
+    return false
+  }
+
+  return {
+    id,
+    lease,
+    routes() {
+      return [staticRoutes, leaseRoutes]
+    },
+    staticRoutes,
+    leaseRoutes,
+    status() {
+      return { connected: lease.isLive(), lease: lease.status() }
+    },
+  }
+}
+
+export function createEditorHostService(config = {}) {
+  return {
+    api: createServiceApi('editorHost', '1.0.0', ['static', 'lease', 'heartbeat', 'status']),
+    version: '0.1.0',
+    createEditorHost,
+    createLease: createEditorLease,
+    defaultHost: config.dir ? createEditorHost({ id: config.id || 'editor', ...config }) : null,
+  }
+}