hume 0.1.0 → 0.2.4

package/wrapper/Job.js

@@ -0,0 +1,87 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Job = void 0;
+const errors = __importStar(require("../errors"));
+class Job {
+    constructor(jobId, client) {
+        this.jobId = jobId;
+        this.client = client;
+    }
+    awaitCompletion(timeoutInSeconds = 300) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const poller = new JobCompletionPoller(this.jobId, this.client);
+                poller.start(resolve);
+                setTimeout(() => {
+                    poller.stop();
+                    reject(new errors.HumeTimeoutError());
+                }, timeoutInSeconds * 1000);
+            });
+        });
+    }
+}
+exports.Job = Job;
+class JobCompletionPoller {
+    constructor(jobId, client) {
+        this.jobId = jobId;
+        this.client = client;
+        this.isPolling = true;
+    }
+    start(onTerminal) {
+        this.isPolling = true;
+        this.poll(onTerminal);
+    }
+    stop() {
+        this.isPolling = false;
+    }
+    poll(onTerminal) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const jobDetails = yield this.client.getJobDetails(this.jobId);
+                if (jobDetails.state.status === "COMPLETED" ||
+                    jobDetails.state.status === "FAILED") {
+                    onTerminal();
+                    this.stop();
+                }
+            }
+            catch (_a) {
+                // swallow errors while polling
+            }
+            if (this.isPolling) {
+                setTimeout(() => this.poll(onTerminal), 1000);
+            }
+        });
+    }
+}

package/wrapper/StreamSocket.d.ts

@@ -0,0 +1,83 @@
+/// <reference types="node" />
+import WebSocket from "ws";
+import * as Hume from "../api";
+export declare namespace StreamSocket {
+    interface Args {
+        websocket: WebSocket;
+        config: Hume.ModelConfig;
+        streamWindowMs?: number;
+    }
+}
+export declare class StreamSocket {
+    readonly websocket: WebSocket;
+    private readonly streamWindowMs?;
+    private config;
+    constructor({ websocket, config, streamWindowMs }: StreamSocket.Args);
+    /**
+     * Send a file on the `StreamSocket`
+     *
+     * @param filepath Path to media file to send on socket connection
+     * @param config List of model configurations.
+     * If set these configurations will overwrite any configurations
+     * set when initializing the `StreamSocket`
+     */
+    sendFile({ filepath, config, }: {
+        filepath: string;
+        config?: Hume.ModelConfig;
+    }): Promise<void>;
+    /**
+     * Send raw bytes on the `StreamSocket`
+     *
+     * @param buffer Raw bytes of media to send on socket connection
+     * @param config List of model configurations.
+     * If set these configurations will overwrite any configurations
+     * set when initializing the `StreamSocket`
+     */
+    sendBuffer({ buffer, config, }: {
+        buffer: Buffer;
+        config?: Hume.ModelConfig;
+    }): void;
+    /**
+     * Send text on the `StreamSocket`
+     *
+     * @param text Text to send to the language model.
+     * @param config This method is intended for use with a `LanguageConfig`.
+     * When the socket is configured for other modalities this method will fail.
+     */
+    sendText({ text, config, }: {
+        text: string;
+        config?: Hume.ModelConfig;
+    }): void;
+    /**
+     * Send facemesh landmarks on the `StreamSocket`
+     *
+     * @param landmarks List of landmark points for multiple faces.
+     * The shape of this 3-dimensional list should be (n, 478, 3) where n is the number
+     * of faces to be processed, 478 is the number of MediaPipe landmarks per face and 3
+     * represents the (x, y, z) coordinates of each landmark.
+     * @param config List of model configurations.
+     * If set these configurations will overwrite existing configurations
+     */
+    sendFacemesh({ landmarks, config, }: {
+        landmarks: number[][][];
+        config?: Hume.ModelConfig;
+    }): void;
+    /**
+     *
+     * Reset the streaming sliding window.
+     *
+     * Call this method when some media has been fully processed and you want to continue using the same
+     * streaming connection without leaking context across media samples.
+     */
+    reset(): void;
+    /**
+     *
+     * Get details associated with the current streaming connection.
+     *
+     */
+    getJobDetails(): void;
+    /**
+     * Closes the underlying socket.
+     */
+    close(): void;
+}

package/wrapper/StreamSocket.js

@@ -0,0 +1,114 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamSocket = void 0;
+const promises_1 = require("fs/promises");
+class StreamSocket {
+    constructor({ websocket, config, streamWindowMs }) {
+        this.websocket = websocket;
+        this.config = config;
+        this.streamWindowMs = streamWindowMs;
+    }
+    /**
+     * Send a file on the `StreamSocket`
+     *
+     * @param filepath Path to media file to send on socket connection
+     * @param config List of model configurations.
+     * If set these configurations will overwrite any configurations
+     * set when initializing the `StreamSocket`
+     */
+    sendFile({ filepath, config, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.sendBuffer({
+                buffer: yield (0, promises_1.readFile)(filepath),
+                config,
+            });
+        });
+    }
+    /**
+     * Send raw bytes on the `StreamSocket`
+     *
+     * @param buffer Raw bytes of media to send on socket connection
+     * @param config List of model configurations.
+     * If set these configurations will overwrite any configurations
+     * set when initializing the `StreamSocket`
+     */
+    sendBuffer({ buffer, config, }) {
+        this.sendText({
+            text: buffer.toString("base64"),
+            config,
+        });
+    }
+    /**
+     * Send text on the `StreamSocket`
+     *
+     * @param text Text to send to the language model.
+     * @param config This method is intended for use with a `LanguageConfig`.
+     * When the socket is configured for other modalities this method will fail.
+     */
+    sendText({ text, config, }) {
+        if (config != null) {
+            this.config = config;
+        }
+        this.websocket.send(JSON.stringify({
+            data: text,
+            raw_text: true,
+            models: this.config,
+            stream_window_ms: this.streamWindowMs,
+        }));
+    }
+    /**
+     * Send facemesh landmarks on the `StreamSocket`
+     *
+     * @param landmarks List of landmark points for multiple faces.
+     * The shape of this 3-dimensional list should be (n, 478, 3) where n is the number
+     * of faces to be processed, 478 is the number of MediaPipe landmarks per face and 3
+     * represents the (x, y, z) coordinates of each landmark.
+     * @param config List of model configurations.
+     * If set these configurations will overwrite existing configurations
+     */
+    sendFacemesh({ landmarks, config, }) {
+        const stringifiedLandmarks = JSON.stringify(landmarks);
+        this.sendText({
+            text: Buffer.from(stringifiedLandmarks).toString("base64"),
+            config,
+        });
+    }
+    /**
+     *
+     * Reset the streaming sliding window.
+     *
+     * Call this method when some media has been fully processed and you want to continue using the same
+     * streaming connection without leaking context across media samples.
+     */
+    reset() {
+        this.websocket.send(JSON.stringify({
+            reset_stream: true,
+        }));
+    }
+    /**
+     *
+     * Get details associated with the current streaming connection.
+     *
+     */
+    getJobDetails() {
+        this.websocket.send(JSON.stringify({
+            job_details: true,
+        }));
+    }
+    /**
+     * Closes the underlying socket.
+     */
+    close() {
+        this.websocket.close();
+    }
+}
+exports.StreamSocket = StreamSocket;

package/postcss.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  content: ["./src/**/*.{js,jsx,ts,tsx}"],
-  theme: {
-    extend: {},
-  },
-  plugins: [],
-};

package/src/components/HumeWidget.tsx

@@ -1,37 +0,0 @@
-import { useEffect, useRef } from "react";
-
-interface HumeWidgetProps {
-  width: number;
-  height: number;
-}
-
-export default function HumeWidget(props: HumeWidgetProps) {
-  const canvasRef = useRef<HTMLCanvasElement>(null);
-
-  useEffect(() => {
-    const canvas = canvasRef.current;
-    const context = canvas?.getContext("2d");
-    if (!canvas || !context) {
-      console.log("Missing canvas or canvas context");
-      return;
-    }
-
-    canvas.width = props.width;
-    canvas.height = props.height;
-
-    const radius = 6;
-    const location = { x: canvas.width / 2, y: canvas.height / 2 };
-    context.clearRect(0, 0, canvas.width, canvas.height);
-    context.beginPath();
-    context.arc(location.x, location.y, radius, 0, 2 * Math.PI);
-    context.fillStyle = "#3498db";
-    context.fill();
-  }, []);
-
-  return (
-    <div className="gb-neutral-400">
-      <canvas ref={canvasRef}></canvas>
-      <span>TEST</span>
-    </div>
-  );
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-import HumeWidget from "./components/HumeWidget";
-
-export { HumeWidget };

package/tailwind.config.js

@@ -1,8 +0,0 @@
-/** @type {import('tailwindcss').Config} */
-module.exports = {
-  content: [],
-  theme: {
-    extend: {},
-  },
-  plugins: [],
-}

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-    "allowJs": false,
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "incremental": true,
-    "isolatedModules": false,
-    "jsx": "react-jsx",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmit": false,
-    "noFallthroughCasesInSwitch": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "strictNullChecks": true,
-    "target": "es6"
-  },
-  "include": ["**/*.ts", "**/*.tsx"],
-  "exclude": ["node_modules"]
-}