@voqalize/avatar 0.2.2 → 0.4.0

package/dist/useAvatar.js

@@ -0,0 +1,35 @@
+/**
+ * useAvatar — mount an avatar into a ref'd element for as long as there is a
+ * client to embody, and tear it down after.
+ *
+ * Internal; `<Avatar>` is the only thing the React entry exports. The whole
+ * hook is one effect, because the factory takes the client at construction:
+ * there is no separate attach step to keep in its own lifecycle any more.
+ */
+import { useEffect, useRef } from "react";
+import { createAvatar as createSvgAvatar, } from "./createAvatar.js";
+export function useAvatar({ client, create, options } = {}) {
+    const containerRef = useRef(null);
+    // Latest-options ref, so the mount effect reads the live values without
+    // remounting the face every time a caller passes a fresh object literal.
+    const optionsRef = useRef(options);
+    optionsRef.current = options;
+    useEffect(() => {
+        const mount = containerRef.current;
+        if (!mount || !client)
+            return;
+        const factory = (create ?? createSvgAvatar);
+        // The cast is the seam between "O minus the two we supply" and O. It is
+        // sound by construction and TypeScript cannot see through the spread of a
+        // generic; the two halves are typed at the boundary the caller touches.
+        const instance = factory({ mount, client, ...optionsRef.current });
+        return () => instance.destroy();
+        // A new client identity is a new thing to embody, so the avatar is rebuilt
+        // rather than re-pointed. Hosts keep one `PipecatClient` across
+        // connect/disconnect cycles, so this does not fire on an ordinary
+        // reconnect; if yours constructs a fresh client per session, expect the
+        // face to remount with it.
+    }, [client, create]);
+    return { containerRef };
+}
+//# sourceMappingURL=useAvatar.js.map

package/dist/useAvatar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAvatar.js","sourceRoot":"","sources":["../client/useAvatar.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EACL,YAAY,IAAI,eAAe,GAIhC,MAAM,mBAAmB,CAAC;AA8B3B,MAAM,UAAU,SAAS,CACvB,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,KAA0B,EAAE;IAErD,MAAM,YAAY,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAC;IAElD,wEAAwE;IACxE,yEAAyE;IACzE,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACnC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7B,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YAAE,OAAO;QAC9B,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,eAAe,CAAqB,CAAC;QAChE,wEAAwE;QACxE,0EAA0E;QAC1E,wEAAwE;QACxE,MAAM,QAAQ,GAAG,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,OAAO,EAAkB,CAAC,CAAC;QACnF,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAChC,2EAA2E;QAC3E,gEAAgE;QAChE,kEAAkE;QAClE,wEAAwE;QACxE,2BAA2B;IAC7B,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAErB,OAAO,EAAE,YAAY,EAAE,CAAC;AAC1B,CAAC"}

package/dist/vikram.d.ts

@@ -0,0 +1,7 @@
+/** Polished professional male avatar, authored to read at call-tile size. */
+import type { CanvasAvatarOptions } from './createCanvasAvatar.js';
+import type { AvatarInstance } from './createAvatar.js';
+export type { CanvasAvatarOptions };
+export { supports } from './supports.js';
+export declare function createAvatar(options: CanvasAvatarOptions): AvatarInstance;
+//# sourceMappingURL=vikram.d.ts.map

package/dist/vikram.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vikram.d.ts","sourceRoot":"","sources":["../client/vikram.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAG7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAUxD,YAAY,EAAE,mBAAmB,EAAE,CAAC;AAEpC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,cAAc,CAOzE"}

package/dist/vikram.js

@@ -0,0 +1,20 @@
+/** Polished professional male avatar, authored to read at call-tile size. */
+import { createCanvasAvatar } from './createCanvasAvatar.js';
+const RIG_URL = new URL('../src/canvas/data/professional-male-a.rig.json', import.meta.url);
+const IMAGES = {
+    'professional-male-a-top-body.webp': new URL('../src/canvas/data/img/professional-male-a-top-body.webp', import.meta.url),
+    'professional-male-a-hair-back.webp': new URL('../src/canvas/data/img/professional-male-a-hair-back.webp', import.meta.url),
+    'professional-male-a-hair-front.webp': new URL('../src/canvas/data/img/professional-male-a-hair-front.webp', import.meta.url),
+};
+const FACE = () => import('../src/canvas/avatars/round/face.mjs');
+// Same mixer, same clip library, so the same declaration (`supports.ts`).
+export { supports } from './supports.js';
+export function createAvatar(options) {
+    return createCanvasAvatar(options, {
+        rigUrl: RIG_URL,
+        images: IMAGES,
+        face: FACE,
+        label: 'Vikram — polished professional male avatar',
+    });
+}
+//# sourceMappingURL=vikram.js.map

package/dist/vikram.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vikram.js","sourceRoot":"","sources":["../client/vikram.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAE7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAI7D,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,iDAAiD,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC5F,MAAM,MAAM,GAAG;IACb,mCAAmC,EAAE,IAAI,GAAG,CAAC,0DAA0D,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;IACzH,oCAAoC,EAAE,IAAI,GAAG,CAAC,2DAA2D,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;IAC3H,qCAAqC,EAAE,IAAI,GAAG,CAAC,4DAA4D,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;CACrH,CAAC;AACX,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,sCAAsC,CAAC,CAAC;AAGlE,0EAA0E;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,UAAU,YAAY,CAAC,OAA4B;IACvD,OAAO,kBAAkB,CAAC,OAAO,EAAE;QACjC,MAAM,EAAE,OAAO;QACf,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,4CAA4C;KACpD,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@voqalize/avatar",
-  "version": "0.2.2",
-  "description": "A JavaScript-programmable 2-D talking head for AI voice calls: server-synced lipsync, state through motion, zero dependencies.",
-  "license": "AGPL-3.0-only",
+  "version": "0.4.0",
+  "description": "A JavaScript-programmable talking head for AI voice calls: line-art or 2.5-D faces, server-synced lipsync, state through motion, no runtime dependencies.",
+  "license": "MIT AND CC-BY-4.0",
   "author": "Voqalize",
   "homepage": "https://github.com/voqalize/avatar#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/voqalize/avatar.git"
+    "url": "git+https://github.com/voqalize/avatar.git",
+    "directory": "packages/avatar"
   },
   "bugs": {
     "url": "https://github.com/voqalize/avatar/issues"
@@ -21,7 +22,9 @@
     "pipecat",
     "voice-agent",
     "svg",
-    "animation"
+    "animation",
+    "3d",
+    "threejs"
   ],
   "engines": {
     "node": ">=20"
@@ -31,31 +34,116 @@
   },
   "type": "module",
   "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./client/dist/index.d.ts",
-      "default": "./client/dist/index.js"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "default": "./dist/react.js"
+    },
+    "./internal": {
+      "types": "./dist/internal.d.ts",
+      "default": "./dist/internal.js"
+    },
+    "./internal/three": {
+      "types": "./dist/three/internal.d.ts",
+      "default": "./dist/three/internal.js"
+    },
+    "./faces/peep": {
+      "types": "./src/face-peep.d.ts",
+      "default": "./src/face-peep.js"
+    },
+    "./faces/wren": {
+      "types": "./src/face-wren.d.ts",
+      "default": "./src/face-wren.js"
+    },
+    "./faces/myna": {
+      "types": "./src/face-myna.d.ts",
+      "default": "./src/face-myna.js"
+    },
+    "./avatars/tara": {
+      "types": "./dist/three/tara.d.ts",
+      "default": "./dist/three/tara.js"
+    },
+    "./avatars/tushar": {
+      "types": "./dist/three/tushar.d.ts",
+      "default": "./dist/three/tushar.js"
+    },
+    "./avatars/tanya": {
+      "types": "./dist/three/tanya.d.ts",
+      "default": "./dist/three/tanya.js"
+    },
+    "./avatars/arjun": {
+      "types": "./dist/arjun.d.ts",
+      "default": "./dist/arjun.js"
+    },
+    "./avatars/meera": {
+      "types": "./dist/meera.d.ts",
+      "default": "./dist/meera.js"
+    },
+    "./avatars/vikram": {
+      "types": "./dist/vikram.d.ts",
+      "default": "./dist/vikram.js"
+    },
+    "./avatars/ishita": {
+      "types": "./dist/ishita.d.ts",
+      "default": "./dist/ishita.js"
+    },
+    "./avatars/kabir": {
+      "types": "./dist/kabir.d.ts",
+      "default": "./dist/kabir.js"
+    },
+    "./avatars/naina": {
+      "types": "./dist/naina.d.ts",
+      "default": "./dist/naina.js"
+    },
+    "./avatars/interviewer-male": {
+      "types": "./dist/interviewer-male.d.ts",
+      "default": "./dist/interviewer-male.js"
+    },
+    "./avatars/interviewer-female": {
+      "types": "./dist/interviewer-female.d.ts",
+      "default": "./dist/interviewer-female.js"
+    },
+    "./avatars/professional-male-a": {
+      "types": "./dist/professional-male-a.d.ts",
+      "default": "./dist/professional-male-a.js"
+    },
+    "./avatars/professional-female-a": {
+      "types": "./dist/professional-female-a.d.ts",
+      "default": "./dist/professional-female-a.js"
+    },
+    "./avatars/professional-male-b": {
+      "types": "./dist/professional-male-b.d.ts",
+      "default": "./dist/professional-male-b.js"
+    },
+    "./avatars/professional-female-b": {
+      "types": "./dist/professional-female-b.d.ts",
+      "default": "./dist/professional-female-b.js"
     },
     "./package.json": "./package.json"
   },
   "files": [
     "src",
-    "client/dist",
-    "client/src",
-    "docs/contract-protocol.md",
-    "docs/contract-avatar.md",
-    "README.md"
+    "client",
+    "dist",
+    "assets",
+    "LICENSE-CC-BY-4.0"
   ],
   "scripts": {
-    "build": "tsc -p client/tsconfig.json",
-    "typecheck": "tsc -p client/tsconfig.json --noEmit",
-    "test": "vitest run",
-    "prepare": "tsc -p client/tsconfig.json"
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "prepare": "tsc -p tsconfig.json"
   },
   "peerDependencies": {
     "@pipecat-ai/client-js": ">=1.4 <2",
     "react": ">=18",
-    "react-dom": ">=18"
+    "react-dom": ">=18",
+    "three": ">=0.180 <0.187"
   },
   "peerDependenciesMeta": {
     "@pipecat-ai/client-js": {
@@ -66,16 +154,13 @@
     },
     "react-dom": {
       "optional": true
+    },
+    "three": {
+      "optional": true
     }
   },
   "devDependencies": {
-    "@pipecat-ai/client-js": "1.7.0",
-    "@types/react": "^18.3.3",
-    "@types/react-dom": "^18.3.0",
-    "jsdom": "^25.0.1",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "typescript": "^5.7.3",
-    "vitest": "^3.2.7"
+    "@types/three": "^0.185.4",
+    "three": "^0.180.0"
   }
 }