@acpfx/play-file 0.2.2 → 0.2.3

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024-2026 acpfx contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# @acpfx/play-file
+
+Writes received audio chunks to a WAV file. Useful for recording pipeline output during testing.
+
+## Usage
+
+This package is a pipeline node for [@acpfx/cli](../orchestrator/README.md). See the CLI package for installation and usage.
+
+## Manifest
+
+- **Consumes:** `audio.chunk`, `control.interrupt`, `lifecycle.done`
+- **Emits:** `lifecycle.ready`, `lifecycle.done`
+
+## Settings
+
+| Name | Type | Default | Description |
+|------|------|---------|-------------|
+| `path` | string | **(required)** | Output WAV file path |
+
+## Pipeline Example
+
+```yaml
+nodes:
+  output:
+    use: "@acpfx/play-file"
+    settings: { path: ./output.wav }
+```
+
+## License
+
+ISC

package/dist/index.js

@@ -0,0 +1,231 @@
+// src/index.ts
+import { createWriteStream } from "node:fs";
+import { open } from "node:fs/promises";
+import { resolve } from "node:path";
+
+// ../node-sdk/src/index.ts
+import { createInterface } from "node:readline";
+
+// ../core/src/config.ts
+import { parse as parseYaml } from "yaml";
+
+// ../core/src/manifest.ts
+import { readFileSync } from "node:fs";
+import { join, dirname } from "node:path";
+import { z as z2 } from "zod";
+
+// ../core/src/acpfx-flags.ts
+import { z } from "zod";
+var SetupCheckResponseSchema = z.object({
+  needed: z.boolean(),
+  description: z.string().optional()
+});
+var SetupProgressSchema = z.discriminatedUnion("type", [
+  z.object({
+    type: z.literal("progress"),
+    message: z.string(),
+    pct: z.number().optional()
+  }),
+  z.object({ type: z.literal("complete"), message: z.string() }),
+  z.object({ type: z.literal("error"), message: z.string() })
+]);
+var UnsupportedFlagResponseSchema = z.object({
+  unsupported: z.boolean(),
+  flag: z.string()
+});
+
+// ../core/src/manifest.ts
+var ArgumentTypeSchema = z2.enum(["string", "number", "boolean"]);
+var ManifestArgumentSchema = z2.object({
+  type: ArgumentTypeSchema,
+  default: z2.unknown().optional(),
+  description: z2.string().optional(),
+  required: z2.boolean().optional(),
+  enum: z2.array(z2.unknown()).optional()
+});
+var ManifestEnvFieldSchema = z2.object({
+  required: z2.boolean().optional(),
+  description: z2.string().optional()
+});
+var NodeManifestSchema = z2.object({
+  name: z2.string(),
+  description: z2.string().optional(),
+  consumes: z2.array(z2.string()),
+  emits: z2.array(z2.string()),
+  arguments: z2.record(z2.string(), ManifestArgumentSchema).optional(),
+  additional_arguments: z2.boolean().optional(),
+  env: z2.record(z2.string(), ManifestEnvFieldSchema).optional()
+});
+function handleAcpfxFlags(manifestPath) {
+  const acpfxFlag = process.argv.find((a) => a.startsWith("--acpfx-"));
+  const legacyManifest = process.argv.includes("--manifest");
+  if (!acpfxFlag && !legacyManifest) return;
+  const flag = acpfxFlag ?? "--acpfx-manifest";
+  switch (flag) {
+    case "--acpfx-manifest":
+      printManifest(manifestPath);
+      break;
+    case "--acpfx-setup-check":
+      process.stdout.write(JSON.stringify({ needed: false }) + "\n");
+      process.exit(0);
+      break;
+    default:
+      process.stdout.write(
+        JSON.stringify({ unsupported: true, flag }) + "\n"
+      );
+      process.exit(0);
+  }
+}
+function handleManifestFlag(manifestPath) {
+  handleAcpfxFlags(manifestPath);
+}
+function printManifest(manifestPath) {
+  if (!manifestPath) {
+    const script = process.argv[1];
+    const scriptDir = dirname(script);
+    const scriptBase = script.replace(/\.[^.]+$/, "");
+    const colocated = `${scriptBase}.manifest.json`;
+    try {
+      readFileSync(colocated);
+      manifestPath = colocated;
+    } catch {
+      manifestPath = join(scriptDir, "manifest.json");
+    }
+  }
+  try {
+    const content = readFileSync(manifestPath, "utf8");
+    process.stdout.write(content.trim() + "\n");
+    process.exit(0);
+  } catch (err) {
+    process.stderr.write(`Failed to read manifest: ${err}
+`);
+    process.exit(1);
+  }
+}
+
+// ../node-sdk/src/index.ts
+var NODE_NAME = process.env.ACPFX_NODE_NAME ?? "unknown";
+function emit(event) {
+  process.stdout.write(JSON.stringify(event) + "\n");
+}
+function log(level, message) {
+  emit({ type: "log", level, component: NODE_NAME, message });
+}
+log.info = (message) => log("info", message);
+log.warn = (message) => log("warn", message);
+log.error = (message) => log("error", message);
+log.debug = (message) => log("debug", message);
+function onEvent(handler) {
+  const rl2 = createInterface({ input: process.stdin });
+  rl2.on("line", (line) => {
+    if (!line.trim()) return;
+    try {
+      const event = JSON.parse(line);
+      handler(event);
+    } catch {
+    }
+  });
+  return rl2;
+}
+
+// src/index.ts
+handleManifestFlag();
+var settings = JSON.parse(
+  process.env.ACPFX_SETTINGS || "{}"
+);
+if (!settings.path) {
+  log.error("settings.path is required");
+  process.exit(1);
+}
+var filePath = resolve(settings.path);
+var stream = null;
+var bytesWritten = 0;
+var sampleRate = 16e3;
+var channels = 1;
+var started = false;
+function createWavHeader(dataSize, sr, ch) {
+  const bitsPerSample = 16;
+  const byteRate = sr * ch * bitsPerSample / 8;
+  const blockAlign = ch * bitsPerSample / 8;
+  const header = Buffer.alloc(44);
+  let off = 0;
+  header.write("RIFF", off);
+  off += 4;
+  header.writeUInt32LE(dataSize + 36, off);
+  off += 4;
+  header.write("WAVE", off);
+  off += 4;
+  header.write("fmt ", off);
+  off += 4;
+  header.writeUInt32LE(16, off);
+  off += 4;
+  header.writeUInt16LE(1, off);
+  off += 2;
+  header.writeUInt16LE(ch, off);
+  off += 2;
+  header.writeUInt32LE(sr, off);
+  off += 4;
+  header.writeUInt32LE(byteRate, off);
+  off += 4;
+  header.writeUInt16LE(blockAlign, off);
+  off += 2;
+  header.writeUInt16LE(bitsPerSample, off);
+  off += 2;
+  header.write("data", off);
+  off += 4;
+  header.writeUInt32LE(dataSize, off);
+  return header;
+}
+function startWriting() {
+  if (started) return;
+  started = true;
+  stream = createWriteStream(filePath);
+  bytesWritten = 0;
+  stream.write(Buffer.alloc(44));
+}
+async function finalize() {
+  if (!stream) return;
+  await new Promise((resolve2, reject) => {
+    stream.end(() => resolve2());
+    stream.on("error", reject);
+  });
+  const header = createWavHeader(bytesWritten, sampleRate, channels);
+  const fd = await open(filePath, "r+");
+  await fd.write(header, 0, header.length, 0);
+  await fd.close();
+  stream = null;
+}
+emit({ type: "lifecycle.ready", component: "play-file" });
+var rl = onEvent((event) => {
+  if (event.type === "audio.chunk") {
+    startWriting();
+    if (bytesWritten === 0) {
+      sampleRate = event.sampleRate ?? 16e3;
+      channels = event.channels ?? 1;
+    }
+    const pcm = Buffer.from(event.data, "base64");
+    if (stream?.writable) {
+      stream.write(pcm);
+      bytesWritten += pcm.length;
+    }
+  } else if (event.type === "control.interrupt") {
+    finalize().then(() => {
+      emit({ type: "lifecycle.done", component: "play-file" });
+      process.exit(0);
+    });
+  } else if (event.type === "lifecycle.done") {
+    finalize().then(() => {
+      emit({ type: "lifecycle.done", component: "play-file" });
+      process.exit(0);
+    });
+  }
+});
+rl.on("close", () => {
+  finalize().then(() => {
+    emit({ type: "lifecycle.done", component: "play-file" });
+    process.exit(0);
+  });
+});
+process.on("SIGTERM", () => {
+  finalize().then(() => process.exit(0));
+});

package/dist/manifest.json

@@ -0,0 +1 @@
+{"name":"play-file","description":"Writes audio chunks to a WAV file","consumes":["audio.chunk","control.interrupt","lifecycle.done"],"emits":["lifecycle.ready","lifecycle.done"],"arguments":{"path":{"type":"string","required":true,"description":"Output WAV file path"}}}

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "@acpfx/play-file",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "type": "module",
   "bin": {
     "acpfx-play-file": "./dist/index.js"
   },
   "main": "./dist/index.js",
+  "files": [
+    "dist",
+    "manifest.yaml"
+  ],
   "dependencies": {
     "@acpfx/core": "0.4.0",
     "@acpfx/node-sdk": "0.3.0"
   },
   "scripts": {
-    "build": "esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --packages=external"
+    "build": "esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --packages=external && node ../../scripts/copy-manifest.js"
   }
 }

package/CHANGELOG.md

@@ -1,38 +0,0 @@
-# @acpfx/play-file
-
-## 0.2.2
-
-### Patch Changes
-
-- Updated dependencies [0e6838e]
-  - @acpfx/core@0.4.0
-  - @acpfx/node-sdk@0.3.0
-
-## 0.2.1
-
-### Patch Changes
-
-- Updated dependencies [79c6694]
-- Updated dependencies [a0320a1]
-  - @acpfx/core@0.3.0
-  - @acpfx/node-sdk@0.2.1
-
-## 0.2.0
-
-### Minor Changes
-
-- d757640: Initial release: type-safe contracts, Rust orchestrator, manifest-driven event filtering
-
-  - Rust schema crate as canonical event type source of truth with codegen to TypeScript + Zod
-  - Node manifests (manifest.yaml) declaring consumes/emits contracts
-  - Orchestrator event filtering: nodes only receive declared events
-  - Rust orchestrator with ratatui TUI (--ui flag)
-  - node-sdk with structured logging helpers
-  - CI/CD with GitHub Actions and changesets
-  - Platform-specific npm packages for Rust binaries (esbuild-style distribution)
-
-### Patch Changes
-
-- Updated dependencies [d757640]
-  - @acpfx/core@0.2.0
-  - @acpfx/node-sdk@0.2.0

package/src/index.ts

@@ -1,125 +0,0 @@
-/**
- * play-file node — reads audio.chunk events from stdin and writes a WAV file.
- * Handles control.interrupt by stopping and finalizing the WAV header.
- *
- * Settings (via ACPFX_SETTINGS):
- *   path: string — output WAV file path
- */
-
-import { createWriteStream, type WriteStream } from "node:fs";
-import { open } from "node:fs/promises";
-import { resolve } from "node:path";
-import { emit, log, onEvent, handleManifestFlag } from "@acpfx/node-sdk";
-
-handleManifestFlag();
-
-type Settings = {
-  path: string;
-};
-
-const settings: Settings = JSON.parse(
-  process.env.ACPFX_SETTINGS || "{}",
-);
-
-if (!settings.path) {
-  log.error("settings.path is required");
-  process.exit(1);
-}
-
-const filePath = resolve(settings.path);
-let stream: WriteStream | null = null;
-let bytesWritten = 0;
-let sampleRate = 16000;
-let channels = 1;
-let started = false;
-
-function createWavHeader(dataSize: number, sr: number, ch: number): Buffer {
-  const bitsPerSample = 16;
-  const byteRate = (sr * ch * bitsPerSample) / 8;
-  const blockAlign = (ch * bitsPerSample) / 8;
-  const header = Buffer.alloc(44);
-  let off = 0;
-
-  header.write("RIFF", off); off += 4;
-  header.writeUInt32LE(dataSize + 36, off); off += 4;
-  header.write("WAVE", off); off += 4;
-  header.write("fmt ", off); off += 4;
-  header.writeUInt32LE(16, off); off += 4;
-  header.writeUInt16LE(1, off); off += 2;
-  header.writeUInt16LE(ch, off); off += 2;
-  header.writeUInt32LE(sr, off); off += 4;
-  header.writeUInt32LE(byteRate, off); off += 4;
-  header.writeUInt16LE(blockAlign, off); off += 2;
-  header.writeUInt16LE(bitsPerSample, off); off += 2;
-  header.write("data", off); off += 4;
-  header.writeUInt32LE(dataSize, off);
-
-  return header;
-}
-
-function startWriting(): void {
-  if (started) return;
-  started = true;
-  stream = createWriteStream(filePath);
-  bytesWritten = 0;
-  // Write placeholder WAV header
-  stream.write(Buffer.alloc(44));
-}
-
-async function finalize(): Promise<void> {
-  if (!stream) return;
-
-  await new Promise<void>((resolve, reject) => {
-    stream!.end(() => resolve());
-    stream!.on("error", reject);
-  });
-
-  // Update WAV header with correct sizes
-  const header = createWavHeader(bytesWritten, sampleRate, channels);
-  const fd = await open(filePath, "r+");
-  await fd.write(header, 0, header.length, 0);
-  await fd.close();
-
-  stream = null;
-}
-
-// Emit lifecycle.ready
-emit({ type: "lifecycle.ready", component: "play-file" });
-
-const rl = onEvent((event) => {
-  if (event.type === "audio.chunk") {
-    startWriting();
-    // Capture format from first chunk
-    if (bytesWritten === 0) {
-      sampleRate = (event.sampleRate as number) ?? 16000;
-      channels = (event.channels as number) ?? 1;
-    }
-    const pcm = Buffer.from(event.data as string, "base64");
-    if (stream?.writable) {
-      stream.write(pcm);
-      bytesWritten += pcm.length;
-    }
-  } else if (event.type === "control.interrupt") {
-    finalize().then(() => {
-      emit({ type: "lifecycle.done", component: "play-file" });
-      process.exit(0);
-    });
-  } else if (event.type === "lifecycle.done") {
-    finalize().then(() => {
-      emit({ type: "lifecycle.done", component: "play-file" });
-      process.exit(0);
-    });
-  }
-});
-
-rl.on("close", () => {
-  // stdin EOF — finalize and exit
-  finalize().then(() => {
-    emit({ type: "lifecycle.done", component: "play-file" });
-    process.exit(0);
-  });
-});
-
-process.on("SIGTERM", () => {
-  finalize().then(() => process.exit(0));
-});