@folotoy/folotoy-openclaw-plugin 0.6.2 → 0.8.0

package/openclaw.plugin.json

@@ -2,51 +2,110 @@
   "id": "folotoy-openclaw-plugin",
   "name": "FoloToy",
   "description": "Empower your FoloToy with OpenClaw AI capabilities.",
-  "version": "0.6.2",
-  "channels": ["folotoy"],
+  "version": "0.8.0",
+  "channels": [
+    "folotoy"
+  ],
   "configSchema": {
     "type": "object",
     "additionalProperties": false,
-    "properties": {
-      "flow": {
-        "type": "string",
-        "enum": ["direct", "api"],
-        "description": "Authentication flow",
-        "default": "direct"
-      },
-      "toy_sn": {
-        "type": "string",
-        "description": "Toy serial number"
-      },
-      "toy_key": {
-        "type": "string",
-        "description": "Toy key (direct flow)"
-      },
-      "api_url": {
-        "type": "string",
-        "description": "FoloToy API base URL (api flow)"
-      },
-      "api_key": {
-        "type": "string",
-        "description": "FoloToy API key (api flow)"
-      },
-      "mqtt_host": {
-        "type": "string",
-        "description": "MQTT broker host"
-      },
-      "mqtt_port": {
-        "type": "number",
-        "description": "MQTT broker port"
+    "properties": {}
+  },
+  "channelConfigs": {
+    "folotoy": {
+      "label": "FoloToy",
+      "description": "FoloToy smart toy channel — bridges toys to OpenClaw via MQTT.",
+      "schema": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "flow": {
+            "default": "direct",
+            "description": "Auth flow",
+            "type": "string",
+            "enum": [
+              "direct",
+              "api"
+            ]
+          },
+          "toy_sn": {
+            "description": "Toy serial number",
+            "type": "string"
+          },
+          "toy_key": {
+            "description": "Toy key (used as MQTT password in direct flow)",
+            "type": "string"
+          },
+          "api_url": {
+            "default": "https://api.folotoy.cn",
+            "description": "FoloToy API base URL (api flow)",
+            "type": "string"
+          },
+          "api_key": {
+            "description": "FoloToy API key (api flow)",
+            "type": "string"
+          },
+          "mqtt_host": {
+            "default": "f.folotoy.cn",
+            "description": "MQTT broker host",
+            "type": "string"
+          },
+          "mqtt_port": {
+            "default": 1883,
+            "description": "MQTT broker port",
+            "type": "integer",
+            "minimum": -9007199254740991,
+            "maximum": 9007199254740991
+          },
+          "summary_enabled": {
+            "default": true,
+            "description": "Enable reply summarization for over-long replies",
+            "type": "boolean"
+          },
+          "summary_max_chars": {
+            "default": 200,
+            "description": "Character threshold that triggers summarization",
+            "type": "integer",
+            "minimum": -9007199254740991,
+            "maximum": 9007199254740991
+          },
+          "sentence_split_enabled": {
+            "default": true,
+            "description": "Stream replies sentence-by-sentence for faster TTS",
+            "type": "boolean"
+          },
+          "sentence_split_delimiters": {
+            "default": "！。？；!.?;~",
+            "description": "Punctuation characters that split sentences",
+            "type": "string"
+          },
+          "soothing_loop_enabled": {
+            "default": true,
+            "description": "Repeat soothing replies while waiting for the LLM. Disable to send only the initial order=1 reply.",
+            "type": "boolean"
+          },
+          "soothing_loop_interval_ms": {
+            "default": 8000,
+            "description": "Interval (ms) between soothing replies during the LLM wait",
+            "type": "integer",
+            "minimum": -9007199254740991,
+            "maximum": 9007199254740991
+          }
+        },
+        "required": [
+          "flow",
+          "api_url",
+          "mqtt_host",
+          "mqtt_port",
+          "summary_enabled",
+          "summary_max_chars",
+          "sentence_split_enabled",
+          "sentence_split_delimiters",
+          "soothing_loop_enabled",
+          "soothing_loop_interval_ms"
+        ],
+        "additionalProperties": false
       }
     }
-  },
-  "uiHints": {
-    "flow": { "label": "Auth Flow" },
-    "toy_sn": { "label": "Toy SN" },
-    "toy_key": { "label": "Toy Key", "sensitive": true },
-    "api_url": { "label": "API URL", "placeholder": "https://api.folotoy.cn" },
-    "api_key": { "label": "API Key", "sensitive": true },
-    "mqtt_host": { "label": "MQTT Host", "placeholder": "198.19.249.25" },
-    "mqtt_port": { "label": "MQTT Port", "placeholder": "1883" }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@folotoy/folotoy-openclaw-plugin",
-  "version": "0.6.2",
+  "version": "0.8.0",
   "description": "Empower your FoloToy with OpenClaw AI capabilities.",
   "keywords": [
     "folotoy",
@@ -22,17 +22,18 @@
   },
   "main": "./src/index.ts",
   "types": "./src/index.ts",
-  "bin": {
-    "folotoy-openclaw-plugin": "./bin/folotoy.mjs"
-  },
   "files": [
-    "src",
-    "bin",
+    "src/index.ts",
+    "src/mqtt.ts",
+    "src/config.ts",
+    "src/config-schema.ts",
+    "src/soothing.ts",
+    "src/strip-markdown.ts",
     "dist",
     "openclaw.plugin.json"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && node scripts/sync-manifest.mjs",
     "prepublishOnly": "npm run build",
     "dev": "tsc --watch",
     "typecheck": "tsc --noEmit",
@@ -42,7 +43,7 @@
   },
   "dependencies": {
     "mqtt": "^5.10.1",
-    "qrcode-terminal": "^0.12.0"
+    "zod": "^4.0.0"
   },
   "devDependencies": {
     "@types/node": "^22.13.10",

package/src/config-schema.ts

@@ -0,0 +1,71 @@
+import { z } from 'zod'
+
+import {
+  DEFAULT_API_URL,
+  DEFAULT_MQTT_HOST,
+  DEFAULT_MQTT_PORT,
+  DEFAULT_SENTENCE_SPLIT_DELIMITERS,
+  DEFAULT_SENTENCE_SPLIT_ENABLED,
+  DEFAULT_SOOTHING_LOOP_ENABLED,
+  DEFAULT_SOOTHING_LOOP_INTERVAL_MS,
+  DEFAULT_SUMMARY_ENABLED,
+  DEFAULT_SUMMARY_MAX_CHARS,
+} from './config.js'
+
+/**
+ * Top-level zod schema for `channels.folotoy.*` config.
+ *
+ * Used both as runtime input validation (via openclaw plugin SDK's
+ * `buildChannelConfigSchema()`) and as the source of the JSON Schema that
+ * OpenClaw's web UI renders. OpenClaw 2026.4.x's UI requires a zod-derived
+ * schema for form rendering — a raw JSON Schema in the old shape causes
+ * "Unsupported type" / "Use Raw mode" fallback.
+ *
+ * Field set matches the flat config currently consumed by index.ts:
+ * `account.<field> ?? DEFAULT_*`.
+ */
+export const FolotoyConfigSchema = z.object({
+  flow: z.enum(['direct', 'api']).default('direct').describe('Auth flow'),
+
+  toy_sn: z.string().optional().describe('Toy serial number'),
+  toy_key: z.string().optional().describe('Toy key (used as MQTT password in direct flow)'),
+
+  api_url: z.string().default(DEFAULT_API_URL).describe('FoloToy API base URL (api flow)'),
+  api_key: z.string().optional().describe('FoloToy API key (api flow)'),
+
+  mqtt_host: z.string().default(DEFAULT_MQTT_HOST).describe('MQTT broker host'),
+  mqtt_port: z.number().int().default(DEFAULT_MQTT_PORT).describe('MQTT broker port'),
+
+  summary_enabled: z
+    .boolean()
+    .default(DEFAULT_SUMMARY_ENABLED)
+    .describe('Enable reply summarization for over-long replies'),
+  summary_max_chars: z
+    .number()
+    .int()
+    .default(DEFAULT_SUMMARY_MAX_CHARS)
+    .describe('Character threshold that triggers summarization'),
+
+  sentence_split_enabled: z
+    .boolean()
+    .default(DEFAULT_SENTENCE_SPLIT_ENABLED)
+    .describe('Stream replies sentence-by-sentence for faster TTS'),
+  sentence_split_delimiters: z
+    .string()
+    .default(DEFAULT_SENTENCE_SPLIT_DELIMITERS)
+    .describe('Punctuation characters that split sentences'),
+
+  soothing_loop_enabled: z
+    .boolean()
+    .default(DEFAULT_SOOTHING_LOOP_ENABLED)
+    .describe(
+      'Repeat soothing replies while waiting for the LLM. Disable to send only the initial order=1 reply.',
+    ),
+  soothing_loop_interval_ms: z
+    .number()
+    .int()
+    .default(DEFAULT_SOOTHING_LOOP_INTERVAL_MS)
+    .describe('Interval (ms) between soothing replies during the LLM wait'),
+})
+
+export type FolotoyConfig = z.infer<typeof FolotoyConfigSchema>

package/src/config.ts

@@ -44,7 +44,7 @@ export const DEFAULT_SUMMARY_MAX_CHARS = 200
 export const DEFAULT_SENTENCE_SPLIT_ENABLED = true
 export const DEFAULT_SENTENCE_SPLIT_DELIMITERS = '！。？；!.?;~'
 export const DEFAULT_SOOTHING_LOOP_ENABLED = true
-export const DEFAULT_SOOTHING_LOOP_INTERVAL_MS = 3000
+export const DEFAULT_SOOTHING_LOOP_INTERVAL_MS = 8000
 
 export function flatToPluginConfig(flat: FlatChannelConfig): PluginConfig {
   const flow = flat.flow ?? 'direct'

package/src/index.ts

@@ -1,9 +1,11 @@
 import type { OpenClawPluginApi, ChannelPlugin, PluginRuntime } from 'openclaw/plugin-sdk/core'
+import { buildChannelConfigSchema } from 'openclaw/plugin-sdk'
 import { resolveCredentials, createMqttClient, buildInboundTopic, buildOutboundTopic, buildNotificationTopic } from './mqtt.js'
 import { createSoothingPicker } from './soothing.js'
 import { stripMarkdown } from './strip-markdown.js'
-import { DEFAULT_MQTT_HOST, DEFAULT_MQTT_PORT, DEFAULT_SUMMARY_ENABLED, DEFAULT_SUMMARY_MAX_CHARS, DEFAULT_SENTENCE_SPLIT_ENABLED, DEFAULT_SENTENCE_SPLIT_DELIMITERS, DEFAULT_SOOTHING_LOOP_ENABLED, DEFAULT_SOOTHING_LOOP_INTERVAL_MS, flatToPluginConfig } from './config.js'
+import { DEFAULT_SUMMARY_ENABLED, DEFAULT_SUMMARY_MAX_CHARS, DEFAULT_SENTENCE_SPLIT_ENABLED, DEFAULT_SENTENCE_SPLIT_DELIMITERS, DEFAULT_SOOTHING_LOOP_ENABLED, DEFAULT_SOOTHING_LOOP_INTERVAL_MS, flatToPluginConfig } from './config.js'
 import type { FlatChannelConfig } from './config.js'
+import { FolotoyConfigSchema } from './config-schema.js'
 import type { MqttClient } from 'mqtt'
 
 type InboundMessage = {
@@ -42,40 +44,12 @@ const folotoyChannel: ChannelPlugin<FlatChannelConfig> = {
   capabilities: {
     chatTypes: ['direct'],
   },
+  // ChannelPlugin's per-channel configSchema is left empty here on purpose:
+  // the plugin-level configSchema (set on the default-exported plugin object
+  // below) is what OpenClaw 2026.4.x's web UI reads. Mirrors what
+  // openclaw-weixin and other 2026.4.x-compatible plugins do.
   configSchema: {
-    schema: {
-      type: 'object',
-      properties: {
-        flow: { type: 'string', enum: ['direct', 'api'], default: 'direct' },
-        toy_sn: { type: 'string' },
-        toy_key: { type: 'string' },
-        api_url: { type: 'string', default: 'https://api.folotoy.cn' },
-        api_key: { type: 'string' },
-        mqtt_host: { type: 'string', default: DEFAULT_MQTT_HOST },
-        mqtt_port: { type: 'number', default: DEFAULT_MQTT_PORT },
-        summary_enabled: { type: 'boolean', default: DEFAULT_SUMMARY_ENABLED },
-        summary_max_chars: { type: 'number', default: DEFAULT_SUMMARY_MAX_CHARS },
-        sentence_split_enabled: { type: 'boolean', default: DEFAULT_SENTENCE_SPLIT_ENABLED },
-        sentence_split_delimiters: { type: 'string', default: DEFAULT_SENTENCE_SPLIT_DELIMITERS },
-        soothing_loop_enabled: { type: 'boolean', default: DEFAULT_SOOTHING_LOOP_ENABLED },
-        soothing_loop_interval_ms: { type: 'number', default: DEFAULT_SOOTHING_LOOP_INTERVAL_MS },
-      },
-    },
-    uiHints: {
-      flow: { label: 'Auth Flow' },
-      toy_sn: { label: 'Toy SN' },
-      toy_key: { label: 'Toy Key', sensitive: true },
-      api_url: { label: 'API URL', placeholder: 'https://api.folotoy.com' },
-      api_key: { label: 'API Key', sensitive: true },
-      mqtt_host: { label: 'MQTT Host', placeholder: DEFAULT_MQTT_HOST },
-      mqtt_port: { label: 'MQTT Port' },
-      summary_enabled: { label: 'Enable Summary' },
-      summary_max_chars: { label: 'Summary Max Characters' },
-      sentence_split_enabled: { label: 'Enable Sentence Splitting' },
-      sentence_split_delimiters: { label: 'Sentence Delimiters' },
-      soothing_loop_enabled: { label: 'Enable Soothing Loop' },
-      soothing_loop_interval_ms: { label: 'Soothing Loop Interval (ms)' },
-    },
+    schema: { type: 'object', additionalProperties: false, properties: {} },
   },
   config: {
     listAccountIds: (cfg) => {
@@ -455,7 +429,21 @@ export function sendNotification({ text, accountId }: { text: string; accountId?
   return { channel: 'folotoy', messageId: String(msgId) }
 }
 
-export default (api: OpenClawPluginApi) => {
-  subagent = api.runtime.subagent
-  api.registerChannel({ plugin: folotoyChannel })
+/**
+ * Plugin manifest exposed to OpenClaw. Top-level fields (id/name/description/
+ * configSchema) are what the OpenClaw 2026.4.x web UI reads to render the
+ * config form — the per-channel configSchema on `folotoyChannel` above is
+ * intentionally empty so the UI uses this one.
+ */
+const folotoyPlugin = {
+  id: 'folotoy-openclaw-plugin',
+  name: 'FoloToy',
+  description: 'Empower your FoloToy with OpenClaw AI capabilities.',
+  configSchema: buildChannelConfigSchema(FolotoyConfigSchema),
+  register(api: OpenClawPluginApi) {
+    subagent = api.runtime.subagent
+    api.registerChannel({ plugin: folotoyChannel })
+  },
 }
+
+export default folotoyPlugin

package/bin/folotoy.mjs

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-import('../dist/cli/install.js')

package/src/__tests__/channel.test.ts

@@ -1,126 +0,0 @@
-import { describe, it, expect, vi } from 'vitest'
-import { EventEmitter } from 'events'
-import { buildInboundTopic, buildOutboundTopic } from '../mqtt.js'
-
-// Replicate the message parsing logic from index.ts for unit testing
-type InboundMessage = {
-  msgId: number
-  identifier: 'chat_input'
-  inputParams: { text: string; recording_id: number }
-}
-
-type OutboundMessage = {
-  msgId: number
-  identifier: 'chat_output'
-  outParams: { content: string; recording_id: number; order: number; is_finished: boolean }
-}
-
-function makeMockClient() {
-  const emitter = new EventEmitter()
-  return Object.assign(emitter, {
-    subscribe: vi.fn((_topic: string, cb: (err: null) => void) => cb(null)),
-    publish: vi.fn(),
-  })
-}
-
-function setupSubscriber(client: ReturnType<typeof makeMockClient>, toy_sn: string, onMessage: (msgId: number, text: string, recording_id: number) => void) {
-  const topic = buildInboundTopic(toy_sn)
-  client.subscribe(topic, () => {})
-  client.on('message', (_topic: string, payload: Buffer) => {
-    if (_topic !== topic) return
-    try {
-      const msg = JSON.parse(payload.toString()) as InboundMessage
-      if (msg.identifier !== 'chat_input' || typeof msg.inputParams?.text !== 'string') return
-      onMessage(msg.msgId, msg.inputParams.text, msg.inputParams.recording_id)
-    } catch {
-      // ignore
-    }
-  })
-}
-
-describe('inbound message parsing', () => {
-  const toy_sn = 'SN001'
-  const inboundTopic = buildInboundTopic(toy_sn)
-
-  it('calls onMessage with msgId, text and recording_id on valid chat_input', () => {
-    const client = makeMockClient()
-    const onMessage = vi.fn()
-    setupSubscriber(client, toy_sn, onMessage)
-
-    const msg: InboundMessage = { msgId: 42, identifier: 'chat_input', inputParams: { text: 'hello', recording_id: 100 } }
-    client.emit('message', inboundTopic, Buffer.from(JSON.stringify(msg)))
-
-    expect(onMessage).toHaveBeenCalledWith(42, 'hello', 100)
-  })
-
-  it('ignores messages on other topics', () => {
-    const client = makeMockClient()
-    const onMessage = vi.fn()
-    setupSubscriber(client, toy_sn, onMessage)
-
-    const msg: InboundMessage = { msgId: 1, identifier: 'chat_input', inputParams: { text: 'hi', recording_id: 1 } }
-    client.emit('message', '/openapi/folotoy/OTHER/thing/command/call', Buffer.from(JSON.stringify(msg)))
-
-    expect(onMessage).not.toHaveBeenCalled()
-  })
-
-  it('ignores messages with unknown identifier', () => {
-    const client = makeMockClient()
-    const onMessage = vi.fn()
-    setupSubscriber(client, toy_sn, onMessage)
-
-    client.emit('message', inboundTopic, Buffer.from(JSON.stringify({ msgId: 1, identifier: 'other', inputParams: { text: 'hi', recording_id: 1 } })))
-
-    expect(onMessage).not.toHaveBeenCalled()
-  })
-
-  it('ignores malformed JSON', () => {
-    const client = makeMockClient()
-    const onMessage = vi.fn()
-    setupSubscriber(client, toy_sn, onMessage)
-
-    client.emit('message', inboundTopic, Buffer.from('not json'))
-
-    expect(onMessage).not.toHaveBeenCalled()
-  })
-})
-
-describe('outbound message format', () => {
-  const toy_sn = 'SN001'
-  const outboundTopic = buildOutboundTopic(toy_sn)
-
-  it('publishes chat_output with recording_id, order and is_finished', () => {
-    const client = makeMockClient()
-    const outMsg: OutboundMessage = {
-      msgId: 42,
-      identifier: 'chat_output',
-      outParams: { content: 'world', recording_id: 100, order: 1, is_finished: false },
-    }
-    client.publish(outboundTopic, JSON.stringify(outMsg))
-
-    expect(client.publish).toHaveBeenCalledOnce()
-    const [t, payload] = client.publish.mock.calls[0] as [string, string]
-    expect(t).toBe(outboundTopic)
-    expect(JSON.parse(payload)).toEqual({
-      msgId: 42,
-      identifier: 'chat_output',
-      outParams: { content: 'world', recording_id: 100, order: 1, is_finished: false },
-    })
-  })
-
-  it('publishes finish message with is_finished=true', () => {
-    const client = makeMockClient()
-    const finishMsg: OutboundMessage = {
-      msgId: 42,
-      identifier: 'chat_output',
-      outParams: { content: '', recording_id: 100, order: 2, is_finished: true },
-    }
-    client.publish(outboundTopic, JSON.stringify(finishMsg))
-
-    const [, payload] = client.publish.mock.calls[0] as [string, string]
-    const parsed = JSON.parse(payload)
-    expect(parsed.outParams.is_finished).toBe(true)
-    expect(parsed.outParams.order).toBe(2)
-    expect(parsed.outParams.content).toBe('')
-  })
-})

package/src/__tests__/mqtt.test.ts

@@ -1,14 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { buildInboundTopic, buildOutboundTopic } from '../mqtt.js'
-
-describe('buildInboundTopic', () => {
-  it('builds the correct inbound topic for a given SN', () => {
-    expect(buildInboundTopic('SN001')).toBe('/openapi/folotoy/SN001/thing/command/call')
-  })
-})
-
-describe('buildOutboundTopic', () => {
-  it('builds the correct outbound topic for a given SN', () => {
-    expect(buildOutboundTopic('SN001')).toBe('/openapi/folotoy/SN001/thing/command/callAck')
-  })
-})

package/src/__tests__/soothing.test.ts

@@ -1,47 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { pickSoothingReply } from '../soothing.js'
-
-const CATEGORIES = [
-  { input: '我今天好难过', label: '难过类' },
-  { input: '我很生气', label: '生气类' },
-  { input: '我好累', label: '累/怕类' },
-  { input: '给我讲个故事', label: '故事类' },
-  { input: '唱首儿歌', label: '唱歌类' },
-  { input: '讲个笑话', label: '笑话类' },
-  { input: '为什么天是蓝的', label: '知识类' },
-  { input: '然后呢', label: '继续类' },
-  { input: '你好', label: '打招呼类' },
-  { input: '晚安', label: '告别类' },
-  { input: '帮我连接wifi', label: '配网类' },
-  { input: '帮我查天气', label: '查询类' },
-  { input: '随便说点什么', label: '兜底' },
-]
-
-describe('pickSoothingReply', () => {
-  it.each(CATEGORIES)('$label — returns a non-empty string', ({ input }) => {
-    const reply = pickSoothingReply(input)
-    expect(typeof reply).toBe('string')
-    expect(reply.length).toBeGreaterThan(0)
-  })
-
-  it.each(CATEGORIES)('$label — never contains 马上', ({ input }) => {
-    // Run multiple times to cover random selection
-    for (let i = 0; i < 20; i++) {
-      expect(pickSoothingReply(input)).not.toContain('马上')
-    }
-  })
-
-  it('randomly selects from candidates (not always the same reply)', () => {
-    const results = new Set(
-      Array.from({ length: 40 }, () => pickSoothingReply('我今天好难过'))
-    )
-    expect(results.size).toBeGreaterThan(1)
-  })
-
-  it('告别类 returns only short affirmatives', () => {
-    const allowed = new Set(['好嘞~', '嗯嗯~', '好的~', '哦~', '嗯~'])
-    for (let i = 0; i < 20; i++) {
-      expect(allowed.has(pickSoothingReply('晚安'))).toBe(true)
-    }
-  })
-})