@dqnamo/voicecontrol 0.0.1

package/README.md

@@ -0,0 +1,20 @@
+# @dqnamo/voicecontrol
+
+Composable primitives for building voice-controlled web interfaces.
+
+This is the first experimental release. The React provider, action component,
+transcription transport, and Jev decision adapter are under active development.
+
+```js
+import { defineVoiceAction, voiceControlAttributes } from "@dqnamo/voicecontrol";
+
+const action = defineVoiceAction({
+  id: "todo.complete",
+  description: "Complete the selected task",
+  execute: ({ transcript }) => {
+    console.log("Run from voice command:", transcript);
+  },
+});
+
+const attributes = voiceControlAttributes(action);
+```

package/index.d.ts

@@ -0,0 +1,35 @@
+export type VoiceActionContext = {
+  probability: number;
+  signal: AbortSignal;
+  transcript: string;
+  turnId: number;
+};
+
+export type VoiceActionDefinition = {
+  confirmation?: boolean;
+  description: string;
+  enabled?: boolean;
+  execute: (context: VoiceActionContext) => void | Promise<void>;
+  id: string;
+  kind?: "action" | "navigation";
+};
+
+export type VoiceControlAttributes = {
+  "data-voice-control-confirm": "true" | undefined;
+  "data-voice-control-desc": string;
+  "data-voice-control-id": string;
+};
+
+export declare const voiceControlAttributeNames: Readonly<{
+  confirmation: "data-voice-control-confirm";
+  description: "data-voice-control-desc";
+  id: "data-voice-control-id";
+}>;
+
+export declare function defineVoiceAction<
+  const Action extends VoiceActionDefinition,
+>(action: Action): Readonly<Action>;
+
+export declare function voiceControlAttributes(
+  action: Pick<VoiceActionDefinition, "confirmation" | "description" | "id">,
+): VoiceControlAttributes;

package/index.js

@@ -0,0 +1,38 @@
+const idAttribute = "data-voice-control-id";
+const descriptionAttribute = "data-voice-control-desc";
+const confirmationAttribute = "data-voice-control-confirm";
+
+export const voiceControlAttributeNames = Object.freeze({
+  confirmation: confirmationAttribute,
+  description: descriptionAttribute,
+  id: idAttribute,
+});
+
+export function defineVoiceAction(action) {
+  if (!action || typeof action !== "object") {
+    throw new TypeError("A voice action definition is required.");
+  }
+  if (typeof action.id !== "string" || !action.id.trim()) {
+    throw new TypeError("A voice action needs a non-empty id.");
+  }
+  if (typeof action.description !== "string" || !action.description.trim()) {
+    throw new TypeError("A voice action needs a non-empty description.");
+  }
+  if (typeof action.execute !== "function") {
+    throw new TypeError("A voice action needs an execute function.");
+  }
+
+  return Object.freeze({
+    ...action,
+    description: action.description.trim(),
+    id: action.id.trim(),
+  });
+}
+
+export function voiceControlAttributes(action) {
+  return {
+    [confirmationAttribute]: action.confirmation ? "true" : undefined,
+    [descriptionAttribute]: action.description,
+    [idAttribute]: action.id,
+  };
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@dqnamo/voicecontrol",
+  "version": "0.0.1",
+  "description": "Composable primitives for building voice-controlled web interfaces.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "voice-control",
+    "speech",
+    "react",
+    "accessibility",
+    "jev"
+  ],
+  "author": "dqnamo"
+}