@folotoy/folotoy-openclaw-plugin 0.7.0 → 0.8.1

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)
-    }
-  })
-})

package/src/__tests__/test-message.mjs

@@ -1,190 +0,0 @@
-/**
- * MQTT integration test — simulates a FoloToy toy.
- *
- * Modes:
- *   chat     — send a message, verify outbound reply format (soothing + reply + finish)
- *   reminder — send a reminder request, verify reply, wait for notification delivery
- *
- * Configuration (via .env or environment variables):
- *   FOLOTOY_TOY_SN    — toy serial number
- *   FOLOTOY_TOY_KEY   — toy key (MQTT password)
- *   FOLOTOY_MQTT_HOST — MQTT broker host
- *   FOLOTOY_MQTT_PORT           — MQTT broker port (default 1883)
- *   FOLOTOY_TEST_MQTT_USERNAME  — MQTT username for test client (default: FOLOTOY_TOY_SN)
- *   FOLOTOY_TEST_MQTT_PASSWORD  — MQTT password for test client (default: FOLOTOY_TOY_KEY)
- *
- * Usage:
- *   node --env-file=.env test-mqtt.mjs chat "你好"
- *   node --env-file=.env test-mqtt.mjs reminder
- *   node --env-file=.env test-mqtt.mjs          # defaults to: chat "你好"
- */
-import mqtt from 'mqtt'
-
-const SN = process.env.FOLOTOY_TOY_SN
-const KEY = process.env.FOLOTOY_TOY_KEY
-const HOST = process.env.FOLOTOY_MQTT_HOST
-const PORT = Number(process.env.FOLOTOY_MQTT_PORT || 1883)
-
-if (!SN || !HOST) {
-  console.error('Missing FOLOTOY_TOY_SN or FOLOTOY_MQTT_HOST. Set them in .env or as env vars.')
-  process.exit(1)
-}
-
-// Parse args
-const args = process.argv.slice(2)
-let mode = 'chat'
-let message = '你好'
-
-if (args[0] === 'chat') {
-  mode = 'chat'
-  message = args[1] || '你好'
-} else if (args[0] === 'reminder') {
-  mode = 'reminder'
-  message = args[1] || '1分钟后提醒我站起来'
-} else if (args[0]) {
-  message = args[0]
-}
-
-const inboundTopic = `/openapi/folotoy/${SN}/thing/command/call`
-const outboundTopic = `/openapi/folotoy/${SN}/thing/command/callAck`
-const notificationTopic = `/openapi/folotoy/${SN}/thing/event/post`
-
-// ── Validation state ──
-const errors = []
-let gotSoothing = false
-let gotReply = false
-let gotFinish = false
-let gotNotification = false
-
-function validateOutboundMessage(msg) {
-  if (msg.identifier !== 'chat_output') {
-    errors.push(`Expected identifier "chat_output", got "${msg.identifier}"`)
-  }
-  const p = msg.outParams
-  if (typeof p?.recording_id !== 'number') {
-    errors.push(`Missing or invalid recording_id in outbound message (order=${p?.order})`)
-  }
-  if (typeof p?.order !== 'number') {
-    errors.push('Missing or invalid order in outbound message')
-  }
-  if (typeof p?.is_finished !== 'boolean') {
-    errors.push(`Missing or invalid is_finished in outbound message (order=${p?.order})`)
-  }
-}
-
-function validateNotificationMessage(msg) {
-  if (msg.identifier !== 'send_notification') {
-    errors.push(`Expected notification identifier "send_notification", got "${msg.identifier}"`)
-  }
-  if (typeof msg.outParams?.text !== 'string' || !msg.outParams.text) {
-    errors.push('Notification missing outParams.text')
-  }
-  if ('recording_id' in (msg.outParams || {})) {
-    errors.push('Notification should not contain recording_id')
-  }
-}
-
-function printSummary() {
-  console.log('\n' + '='.repeat(60))
-  console.log(`TEST SUMMARY (mode: ${mode})`)
-  console.log('='.repeat(60))
-
-  const checks = [
-    ['Soothing ack (order=1)', gotSoothing],
-    ['AI reply (order=2+)', gotReply],
-    ['Finish message (is_finished=true)', gotFinish],
-  ]
-
-  for (const [label, ok] of checks) {
-    console.log(`  ${ok ? '✅' : '❌'} ${label}`)
-  }
-
-  if (mode === 'reminder') {
-    console.log(`  ${gotNotification ? '✅' : 'ℹ️ '} Notification on event/post${gotNotification ? '' : ' (not received within timeout — may arrive later)'}`)
-  }
-
-  if (errors.length > 0) {
-    console.log('\nErrors:')
-    for (const e of errors) console.log(`  ❌ ${e}`)
-  }
-
-  const allPassed = checks.every(([, ok]) => ok) && errors.length === 0
-  console.log(`\n${allPassed ? '✅ ALL CHECKS PASSED' : '❌ SOME CHECKS FAILED'}`)
-  return allPassed
-}
-
-function done() {
-  const passed = printSummary()
-  client.end()
-  process.exit(passed ? 0 : 1)
-}
-
-// ── MQTT ──
-const MQTT_USERNAME = process.env.FOLOTOY_TEST_MQTT_USERNAME || SN
-const MQTT_PASSWORD = process.env.FOLOTOY_TEST_MQTT_PASSWORD || KEY
-
-const client = mqtt.connect(`mqtt://${HOST}:${PORT}`, {
-  clientId: `test-toy-${Date.now()}`,
-  username: MQTT_USERNAME,
-  password: MQTT_PASSWORD,
-})
-
-client.on('connect', () => {
-  console.log(`[connected] ${HOST}:${PORT} as ${SN}`)
-  console.log(`[mode] ${mode}`)
-  console.log(`[message] ${message}`)
-
-  client.subscribe([outboundTopic, notificationTopic], (err) => {
-    if (err) {
-      console.error('[subscribe error]', err.message)
-      process.exit(1)
-    }
-
-    const msg = {
-      msgId: 1,
-      identifier: 'chat_input',
-      inputParams: { text: message, recording_id: 999 },
-    }
-    console.log(`\n[publish] ${inboundTopic}`)
-    console.log(JSON.stringify(msg, null, 2))
-    client.publish(inboundTopic, JSON.stringify(msg))
-  })
-})
-
-client.on('message', (topic, payload) => {
-  let msg
-  try { msg = JSON.parse(payload.toString()) } catch { return }
-
-  if (topic === outboundTopic) {
-    const p = msg.outParams
-    const label = p?.is_finished ? 'FINISH' : `REPLY(order=${p?.order})`
-    console.log(`\n[OUTBOUND ${label}] ${p?.content || '(empty)'}`)
-    validateOutboundMessage(msg)
-
-    if (p?.order === 1 && !p?.is_finished) gotSoothing = true
-    if (p?.order >= 2 && !p?.is_finished && p?.content) gotReply = true
-    if (p?.is_finished) {
-      gotFinish = true
-      if (mode === 'chat') {
-        setTimeout(done, 500)
-      } else {
-        console.log('\n[waiting up to 90s for notification on event/post topic...]')
-      }
-    }
-  }
-
-  if (topic === notificationTopic) {
-    console.log(`\n[NOTIFICATION] ${msg.outParams?.text || JSON.stringify(msg)}`)
-    validateNotificationMessage(msg)
-    gotNotification = true
-    setTimeout(done, 500)
-  }
-})
-
-client.on('error', (err) => {
-  console.error('[mqtt error]', err.message)
-})
-
-// Timeout: chat 30s, reminder 120s
-const timeoutMs = mode === 'reminder' ? 120_000 : 30_000
-setTimeout(done, timeoutMs)

package/src/cli/install.ts

@@ -1,195 +0,0 @@
-import { execSync } from 'node:child_process'
-import qrcode from 'qrcode-terminal'
-import { DEFAULT_MQTT_HOST, DEFAULT_MQTT_PORT } from '../config.js'
-import { getInstallSpec, getPluginName } from './package-info.js'
-import { loadPreset, listPresets, type Preset } from './preset.js'
-
-const PAIR_API_BASE = process.env.PAIR_API_BASE ?? 'https://pair.folotoy.cn'
-const POLL_INTERVAL_MS = 3000
-const POLL_TIMEOUT_MS = 300_000 // 5 minutes
-
-// ── Types ──────────────────────────────────────────────
-
-type CreateSessionResponse = {
-  session_id: string
-  pair_url: string
-  expires_at: string
-}
-
-type PollResponse =
-  | { status: 'pending' }
-  | { status: 'completed'; toy_sn: string; toy_key: string; mqtt_host?: string; mqtt_port?: number }
-  | { status: 'expired' }
-
-// ── Helpers ────────────────────────────────────────────
-
-function checkOpenClaw(): void {
-  try {
-    execSync('openclaw --version', { stdio: 'pipe' })
-  } catch {
-    console.error('Error: openclaw is not installed or not in PATH.')
-    console.error('Install it first: npm i -g openclaw')
-    process.exit(1)
-  }
-}
-
-function installPlugin(): void {
-  try {
-    const list = execSync('openclaw plugins list', { stdio: 'pipe' }).toString()
-    if (list.includes('folotoy-openclaw-plugin')) {
-      return // already installed
-    }
-  } catch {
-    // ignore
-  }
-  const spec = getInstallSpec()
-  console.log(`Installing FoloToy plugin (${spec})...`)
-  execSync(`openclaw plugins install ${spec}`, { stdio: 'inherit' })
-}
-
-async function createSession(): Promise<CreateSessionResponse> {
-  const res = await fetch(`${PAIR_API_BASE}/api/pair`, { method: 'POST' })
-  if (!res.ok) throw new Error(`Failed to create pairing session (HTTP ${res.status})`)
-  return res.json() as Promise<CreateSessionResponse>
-}
-
-function displayQR(url: string): void {
-  qrcode.generate(url, { small: true }, (qr: string) => {
-    console.log(qr)
-  })
-  console.log(`Or open this URL on your phone: ${url}\n`)
-}
-
-async function sleep(ms: number): Promise<void> {
-  return new Promise((r) => setTimeout(r, ms))
-}
-
-async function pollSession(sessionId: string): Promise<PollResponse & { status: 'completed' }> {
-  const deadline = Date.now() + POLL_TIMEOUT_MS
-  const frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
-  let i = 0
-
-  while (Date.now() < deadline) {
-    process.stdout.write(`\r${frames[i++ % frames.length]} Waiting for pairing...`)
-
-    const res = await fetch(`${PAIR_API_BASE}/api/pair/${sessionId}`)
-    if (!res.ok) throw new Error(`Poll failed (HTTP ${res.status})`)
-    const data = (await res.json()) as PollResponse
-
-    if (data.status === 'completed') {
-      process.stdout.write('\r\x1b[32m✓\x1b[0m Paired successfully!        \n')
-      return data as PollResponse & { status: 'completed' }
-    }
-    if (data.status === 'expired') {
-      process.stdout.write('\r')
-      throw new Error('Pairing session expired. Please try again.')
-    }
-
-    await sleep(POLL_INTERVAL_MS)
-  }
-  throw new Error('Pairing timed out after 5 minutes.')
-}
-
-function restartGateway(): void {
-  try {
-    execSync('openclaw gateway restart', { stdio: 'inherit' })
-  } catch {
-    console.warn('⚠ Failed to restart gateway. You can restart manually: openclaw gateway restart')
-  }
-}
-
-function writeConfig(
-  result: { toy_sn: string; toy_key: string; mqtt_host?: string; mqtt_port?: number },
-  preset: Preset = {},
-): void {
-  execSync(`openclaw config set channels.folotoy.flow direct`, { stdio: 'pipe' })
-  execSync(`openclaw config set channels.folotoy.toy_sn ${result.toy_sn}`, { stdio: 'pipe' })
-  execSync(`openclaw config set channels.folotoy.toy_key ${result.toy_key}`, { stdio: 'pipe' })
-
-  const mqttHost = result.mqtt_host ?? DEFAULT_MQTT_HOST
-  const mqttPort = result.mqtt_port ?? DEFAULT_MQTT_PORT
-  execSync(`openclaw config set channels.folotoy.mqtt_host ${mqttHost}`, { stdio: 'pipe' })
-  execSync(`openclaw config set channels.folotoy.mqtt_port ${mqttPort}`, { stdio: 'pipe' })
-
-  for (const [key, value] of Object.entries(preset)) {
-    execSync(`openclaw config set channels.folotoy.${key} ${value}`, { stdio: 'pipe' })
-  }
-}
-
-function parsePresetArg(argv: readonly string[]): string | undefined {
-  for (let i = 0; i < argv.length; i++) {
-    const arg = argv[i]
-    if (arg === '--preset') {
-      const value = argv[i + 1]
-      if (!value || value.startsWith('--')) {
-        throw new Error('--preset requires a name (e.g. --preset single-soothing)')
-      }
-      return value
-    }
-    if (arg && arg.startsWith('--preset=')) {
-      return arg.slice('--preset='.length)
-    }
-  }
-  return undefined
-}
-
-// ── Main ───────────────────────────────────────────────
-
-async function main() {
-  const argv = process.argv.slice(2)
-  const command = argv[0]
-
-  if (command !== 'install') {
-    const presets = listPresets()
-    console.log(`Usage: npx ${getPluginName()} install [--preset <name>]`)
-    if (presets.length) console.log(`Available presets: ${presets.join(', ')}`)
-    process.exit(command ? 1 : 0)
-  }
-
-  // Resolve preset before any side effects (pairing, plugin install) so a bad
-  // preset name fails fast without making the user scan a QR.
-  const presetName = parsePresetArg(argv.slice(1))
-  const preset: Preset = presetName ? loadPreset(presetName) : {}
-
-  console.log('🧸 FoloToy OpenClaw Plugin Installer\n')
-  if (presetName) {
-    console.log(`Using preset: ${presetName} → ${JSON.stringify(preset)}\n`)
-  }
-
-  // Step 1: check prerequisites
-  console.log('Checking openclaw...')
-  checkOpenClaw()
-  console.log('✓ openclaw found\n')
-
-  // Step 2: install plugin if not present
-  installPlugin()
-
-  // Step 3: create pairing session
-  console.log('Creating pairing session...\n')
-  const session = await createSession()
-
-  // Step 4: display QR code
-  console.log('Scan this QR code with your phone,')
-  console.log('then scan your toy\'s QR code on the phone:\n')
-  displayQR(session.pair_url)
-
-  // Step 5: poll for result
-  const result = await pollSession(session.session_id)
-
-  // Step 6: write config
-  console.log('\nWriting configuration...')
-  writeConfig(result, preset)
-
-  // Step 7: restart gateway
-  console.log('\nRestarting gateway...')
-  restartGateway()
-
-  // Step 8: done
-  console.log('\n\x1b[32m✓ FoloToy plugin installed and configured!\x1b[0m')
-  console.log(`  Toy SN:    ${result.toy_sn}`)
-}
-
-main().catch((err) => {
-  console.error(`\n\x1b[31mError:\x1b[0m ${err instanceof Error ? err.message : String(err)}`)
-  process.exit(1)
-})

package/src/cli/package-info.ts

@@ -1,48 +0,0 @@
-import { existsSync, readFileSync } from 'node:fs'
-import { dirname, join } from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-export function findPackageRoot(): string {
-  let dir = dirname(fileURLToPath(import.meta.url))
-  while (true) {
-    if (existsSync(join(dir, 'package.json'))) return dir
-    const parent = dirname(dir)
-    if (parent === dir) throw new Error('package.json not found while resolving package root')
-    dir = parent
-  }
-}
-
-type PackageInfo = { name: string; version: string }
-
-let cached: PackageInfo | undefined
-
-function readPackageInfo(): PackageInfo {
-  if (cached) return cached
-  const pkg = JSON.parse(
-    readFileSync(join(findPackageRoot(), 'package.json'), 'utf8'),
-  ) as { name?: unknown; version?: unknown }
-  if (typeof pkg.name !== 'string' || typeof pkg.version !== 'string') {
-    throw new Error('package.json is missing name or version')
-  }
-  cached = { name: pkg.name, version: pkg.version }
-  return cached
-}
-
-export function getPluginName(): string {
-  return readPackageInfo().name
-}
-
-export function getPluginVersion(): string {
-  return readPackageInfo().version
-}
-
-/**
- * Returns the npm spec string `<name>@<version>` to pass to
- * `openclaw plugins install`. Pinning the exact version prevents OpenClaw
- * from rejecting the install when `latest` happens to point at a prerelease
- * — without this, `openclaw plugins install <bare-name>` resolves through
- * the `latest` dist-tag and refuses prereleases for safety.
- */
-export function getInstallSpec(): string {
-  return `${getPluginName()}@${getPluginVersion()}`
-}

package/src/cli/preset.ts

@@ -1,54 +0,0 @@
-import { existsSync, readFileSync, readdirSync } from 'node:fs'
-import { join } from 'node:path'
-import { findPackageRoot } from './package-info.js'
-
-export const PRESET_WHITELIST = ['soothing_loop_enabled'] as const
-export type PresetKey = (typeof PRESET_WHITELIST)[number]
-export type Preset = Partial<Record<PresetKey, boolean>>
-
-function presetDir(): string {
-  return join(findPackageRoot(), 'src', 'presets')
-}
-
-export function listPresets(dir: string = presetDir()): string[] {
-  if (!existsSync(dir)) return []
-  return readdirSync(dir)
-    .filter((f) => f.endsWith('.json'))
-    .map((f) => f.slice(0, -'.json'.length))
-    .sort()
-}
-
-export function loadPreset(name: string, dir: string = presetDir()): Preset {
-  const file = join(dir, `${name}.json`)
-  if (!existsSync(file)) {
-    const available = listPresets(dir)
-    throw new Error(
-      `Preset "${name}" not found. Available: ${available.length ? available.join(', ') : '(none)'}`,
-    )
-  }
-
-  let parsed: unknown
-  try {
-    parsed = JSON.parse(readFileSync(file, 'utf8'))
-  } catch (err) {
-    throw new Error(`Preset "${name}" is not valid JSON: ${(err as Error).message}`)
-  }
-
-  if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) {
-    throw new Error(`Preset "${name}" must be a JSON object`)
-  }
-
-  const allowed = PRESET_WHITELIST as readonly string[]
-  const result: Preset = {}
-  for (const [key, value] of Object.entries(parsed as Record<string, unknown>)) {
-    if (!allowed.includes(key)) {
-      throw new Error(`Preset "${name}" has unknown key "${key}". Allowed: ${PRESET_WHITELIST.join(', ')}`)
-    }
-    if (typeof value !== 'boolean') {
-      throw new Error(`Preset "${name}" key "${key}" must be a boolean (got ${typeof value})`)
-    }
-    result[key as PresetKey] = value
-  }
-
-  return result
-}

package/src/cli/qrcode-terminal.d.ts

@@ -1,3 +0,0 @@
-declare module 'qrcode-terminal' {
-  export function generate(text: string, opts?: { small?: boolean }, cb?: (qr: string) => void): void
-}

package/src/presets/single-soothing.json

@@ -1,3 +0,0 @@
-{
-  "soothing_loop_enabled": false
-}