@folotoy/folotoy-openclaw-plugin 0.3.1 → 0.4.0

package/bin/folotoy.mjs

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

package/dist/cli/install.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=install.d.ts.map

package/dist/cli/install.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../../src/cli/install.ts"],"names":[],"mappings":""}

package/dist/cli/install.js

@@ -0,0 +1,113 @@
+import { execSync } from 'node:child_process';
+import qrcode from 'qrcode-terminal';
+import { DEFAULT_MQTT_HOST, DEFAULT_MQTT_PORT } from '../config.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
+// ── Helpers ────────────────────────────────────────────
+function checkOpenClaw() {
+    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() {
+    try {
+        const list = execSync('openclaw plugins list', { stdio: 'pipe' }).toString();
+        if (list.includes('folotoy-openclaw-plugin')) {
+            return; // already installed
+        }
+    }
+    catch {
+        // ignore
+    }
+    console.log('Installing FoloToy plugin...');
+    execSync('openclaw plugins install @folotoy/folotoy-openclaw-plugin', { stdio: 'inherit' });
+}
+async function createSession() {
+    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();
+}
+function displayQR(url) {
+    qrcode.generate(url, { small: true }, (qr) => {
+        console.log(qr);
+    });
+    console.log(`Or open this URL on your phone: ${url}\n`);
+}
+async function sleep(ms) {
+    return new Promise((r) => setTimeout(r, ms));
+}
+async function pollSession(sessionId) {
+    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());
+        if (data.status === 'completed') {
+            process.stdout.write('\r\x1b[32m✓\x1b[0m Paired successfully!        \n');
+            return data;
+        }
+        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 writeConfig(result) {
+    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' });
+}
+// ── Main ───────────────────────────────────────────────
+async function main() {
+    const command = process.argv[2];
+    if (command !== 'install') {
+        console.log('Usage: npx @folotoy/folotoy-openclaw-plugin install');
+        process.exit(command ? 1 : 0);
+    }
+    console.log('🧸 FoloToy OpenClaw Plugin Installer\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);
+    // Step 7: done
+    console.log('\n\x1b[32m✓ FoloToy plugin installed and configured!\x1b[0m');
+    console.log(`  Toy SN:    ${result.toy_sn}`);
+    console.log(`  MQTT Host: ${result.mqtt_host ?? DEFAULT_MQTT_HOST}`);
+    console.log('\nRestart the gateway to apply: openclaw gateway start --force');
+}
+main().catch((err) => {
+    console.error(`\n\x1b[31mError:\x1b[0m ${err instanceof Error ? err.message : String(err)}`);
+    process.exit(1);
+});
+//# sourceMappingURL=install.js.map

package/dist/cli/install.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.js","sourceRoot":"","sources":["../../src/cli/install.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,MAAM,MAAM,iBAAiB,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEnE,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,yBAAyB,CAAA;AAC5E,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAC7B,MAAM,eAAe,GAAG,OAAO,CAAA,CAAC,YAAY;AAe5C,0DAA0D;AAE1D,SAAS,aAAa;IACpB,IAAI,CAAC;QACH,QAAQ,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IACnD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACjE,OAAO,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC;AAED,SAAS,aAAa;IACpB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,QAAQ,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC5E,IAAI,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,CAAC;YAC7C,OAAM,CAAC,oBAAoB;QAC7B,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,SAAS;IACX,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAA;IAC3C,QAAQ,CAAC,2DAA2D,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;AAC7F,CAAC;AAED,KAAK,UAAU,aAAa;IAC1B,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,aAAa,WAAW,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IACxE,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,0CAA0C,GAAG,CAAC,MAAM,GAAG,CAAC,CAAA;IACrF,OAAO,GAAG,CAAC,IAAI,EAAoC,CAAA;AACrD,CAAC;AAED,SAAS,SAAS,CAAC,GAAW;IAC5B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,EAAU,EAAE,EAAE;QACnD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IACjB,CAAC,CAAC,CAAA;IACF,OAAO,CAAC,GAAG,CAAC,mCAAmC,GAAG,IAAI,CAAC,CAAA;AACzD,CAAC;AAED,KAAK,UAAU,KAAK,CAAC,EAAU;IAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;AAC9C,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,SAAiB;IAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,eAAe,CAAA;IAC7C,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IACjE,IAAI,CAAC,GAAG,CAAC,CAAA;IAET,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QAC7B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAA;QAE/E,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,aAAa,aAAa,SAAS,EAAE,CAAC,CAAA;QACjE,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,CAAC,MAAM,GAAG,CAAC,CAAA;QAChE,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAiB,CAAA;QAE/C,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAA;YACzE,OAAO,IAA8C,CAAA;QACvD,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC1B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;QAC/D,CAAC;QAED,MAAM,KAAK,CAAC,gBAAgB,CAAC,CAAA;IAC/B,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;AACvD,CAAC;AAED,SAAS,WAAW,CAAC,MAAmF;IACtG,QAAQ,CAAC,kDAAkD,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IAC/E,QAAQ,CAAC,+CAA+C,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IAC3F,QAAQ,CAAC,gDAAgD,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IAE7F,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,IAAI,iBAAiB,CAAA;IACtD,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,IAAI,iBAAiB,CAAA;IACtD,QAAQ,CAAC,kDAAkD,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IACzF,QAAQ,CAAC,kDAAkD,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;AAC3F,CAAC;AAED,0DAA0D;AAE1D,KAAK,UAAU,IAAI;IACjB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAE/B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,qDAAqD,CAAC,CAAA;QAClE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/B,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAA;IAErD,8BAA8B;IAC9B,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;IACnC,aAAa,EAAE,CAAA;IACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;IAEjC,wCAAwC;IACxC,aAAa,EAAE,CAAA;IAEf,iCAAiC;IACjC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAA;IAC5C,MAAM,OAAO,GAAG,MAAM,aAAa,EAAE,CAAA;IAErC,0BAA0B;IAC1B,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAA;IACjD,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAA;IAC5D,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE3B,0BAA0B;IAC1B,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IAEpD,uBAAuB;IACvB,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAA;IACzC,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnB,eAAe;IACf,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAA;IAC1E,OAAO,CAAC,GAAG,CAAC,gBAAgB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;IAC5C,OAAO,CAAC,GAAG,CAAC,gBAAgB,MAAM,CAAC,SAAS,IAAI,iBAAiB,EAAE,CAAC,CAAA;IACpE,OAAO,CAAC,GAAG,CAAC,gEAAgE,CAAC,CAAA;AAC/E,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,2BAA2B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAC5F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@folotoy/folotoy-openclaw-plugin",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Empower your FoloToy with OpenClaw AI capabilities.",
   "keywords": [
     "folotoy",
@@ -22,12 +22,18 @@
   },
   "main": "./src/index.ts",
   "types": "./src/index.ts",
+  "bin": {
+    "folotoy-openclaw-plugin": "./bin/folotoy.mjs"
+  },
   "files": [
     "src",
+    "bin",
+    "dist/cli",
     "openclaw.plugin.json"
   ],
   "scripts": {
     "build": "tsc",
+    "prepublishOnly": "npm run build",
     "dev": "tsc --watch",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
@@ -35,7 +41,8 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "mqtt": "^5.10.1"
+    "mqtt": "^5.10.1",
+    "qrcode-terminal": "^0.12.0"
   },
   "devDependencies": {
     "@types/node": "^22.13.10",

package/src/cli/install.ts

@@ -0,0 +1,147 @@
+import { execSync } from 'node:child_process'
+import qrcode from 'qrcode-terminal'
+import { DEFAULT_MQTT_HOST, DEFAULT_MQTT_PORT } from '../config.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
+  }
+  console.log('Installing FoloToy plugin...')
+  execSync('openclaw plugins install @folotoy/folotoy-openclaw-plugin', { 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 writeConfig(result: { toy_sn: string; toy_key: string; mqtt_host?: string; mqtt_port?: number }): 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' })
+}
+
+// ── Main ───────────────────────────────────────────────
+
+async function main() {
+  const command = process.argv[2]
+
+  if (command !== 'install') {
+    console.log('Usage: npx @folotoy/folotoy-openclaw-plugin install')
+    process.exit(command ? 1 : 0)
+  }
+
+  console.log('🧸 FoloToy OpenClaw Plugin Installer\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)
+
+  // Step 7: done
+  console.log('\n\x1b[32m✓ FoloToy plugin installed and configured!\x1b[0m')
+  console.log(`  Toy SN:    ${result.toy_sn}`)
+  console.log(`  MQTT Host: ${result.mqtt_host ?? DEFAULT_MQTT_HOST}`)
+  console.log('\nRestart the gateway to apply: openclaw gateway start --force')
+}
+
+main().catch((err) => {
+  console.error(`\n\x1b[31mError:\x1b[0m ${err instanceof Error ? err.message : String(err)}`)
+  process.exit(1)
+})

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

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