hume 0.3.2 → 0.4.0

package/Client.js

@@ -94,7 +94,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -143,7 +143,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -195,7 +195,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -243,7 +243,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 responseType: "streaming",
@@ -287,7 +287,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/README.md

@@ -62,23 +62,35 @@ const client = new HumeStreamingClient({
     apiKey: "YOUR_API_KEY",
 });
 
-const stream = await client.connect({
+const stream = client.connect({
     configs: {
         language: {},
     },
-    onMessage: (response) => {
-        if (response.language != null) {
-            console.log(response.language.predictions);
-        }
-    },
-    onError: (err) => {
-      console.log(err);
-    }
+    onMessage: (response) => { console.log("Socket opened") },
+    onWarning: (warning) => { console.log(warning)},
+    onError: (error) => { console.log(error)},
+    onClose: () => { console.log("Socket closed")},
 });
 
-stream.sendText({
+const response = await stream.sendText({
     text: "Mary had a little lamb,"
 });
+console.log(response);
+```
+
+### Sending Files
+You can use the `sendFile` method to upload files. 
+
+```typescript
+const response = await socket.sendFile({
+    file: fs.createReadStream(path.join(__dirname, "obama.png")),
+    config: {
+        face: {
+            identifyFaces: true,
+        },
+    },
+});
+console.log(response);
 ```
 
 ## Errors
@@ -124,3 +136,17 @@ await hume.submitJob(..., {
     timeoutInSeconds: 10, // timeout after 10 seconds
 });
 ```
+
+## Beta Status
+This SDK is in beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.
+
+## Contributing
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a
+proof of concept, but know that we will not be able to merge it as-is. We suggest opening an 
+issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/dist/Client.js

@@ -94,7 +94,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -143,7 +143,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -195,7 +195,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -243,7 +243,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 responseType: "streaming",
@@ -287,7 +287,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.2",
+                    "X-Fern-SDK-Version": "0.4.0",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/wrapper/HumeStreamingClient.d.ts

@@ -1,23 +1,28 @@
 import * as Hume from "../api";
-import * as core from "../core";
 import { StreamSocket } from "./StreamSocket";
+import WebSocket from "ws";
 export declare namespace HumeStreamingClient {
     interface Options {
-        apiKey: core.Supplier<string>;
+        apiKey: string;
         openTimeoutInSeconds?: number;
     }
     interface ConnectArgs {
         config: Hume.ModelConfig;
         streamWindowMs?: number;
-        onOpen?: () => void;
+        onOpen?: (event: WebSocket.Event) => void;
         onMessage?: (message: Hume.ModelResponse) => void;
         onWarning?: (error: Hume.ModelsWarning) => void;
         onError?: (error: Hume.ModelsError) => void;
-        onClose?: () => void;
+        onClose?: (event: WebSocket.Event) => void;
     }
 }
 export declare class HumeStreamingClient {
     protected readonly _options: HumeStreamingClient.Options;
     constructor(_options: HumeStreamingClient.Options);
-    connect(args: HumeStreamingClient.ConnectArgs): Promise<StreamSocket>;
+    connect(args: HumeStreamingClient.ConnectArgs): StreamSocket;
 }
+export declare function parse(data: WebSocket.Data, args?: {
+    onMessage?: (message: Hume.ModelResponse) => void;
+    onWarning?: (error: Hume.ModelsWarning) => void;
+    onError?: (error: Hume.ModelsError) => void;
+}): Promise<Hume.ModelResponse | Hume.ModelsWarning | Hume.ModelsError | undefined>;

package/dist/wrapper/HumeStreamingClient.js

@@ -35,8 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HumeStreamingClient = void 0;
-const core = __importStar(require("../core"));
+exports.parse = exports.HumeStreamingClient = void 0;
 const serializers = __importStar(require("../serialization"));
 const StreamSocket_1 = require("./StreamSocket");
 const ws_1 = __importDefault(require("ws"));
@@ -45,81 +44,76 @@ class HumeStreamingClient {
         this._options = _options;
     }
     connect(args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const websocket = new ws_1.default(`wss://api.hume.ai/v0/stream/models`, {
-                headers: {
-                    "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
-                },
-                timeout: this._options.openTimeoutInSeconds,
-            });
-            websocket.addEventListener("open", () => {
-                var _a;
-                (_a = args.onOpen) === null || _a === void 0 ? void 0 : _a.call(args);
-            });
-            websocket.addEventListener("error", (e) => {
-                var _a;
-                (_a = args.onError) === null || _a === void 0 ? void 0 : _a.call(args, {
-                    code: e.type,
-                    error: e.message,
-                });
-            });
-            websocket.addEventListener("message", ({ data }) => __awaiter(this, void 0, void 0, function* () {
-                var _a, _b, _c;
-                const body = JSON.parse(data);
-                const parsedResponse = yield serializers.ModelResponse.parse(body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-                if (parsedResponse.ok) {
-                    (_a = args.onMessage) === null || _a === void 0 ? void 0 : _a.call(args, parsedResponse.value);
-                    return;
-                }
-                const parsedWarning = yield serializers.ModelsWarning.parse(body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-                if (parsedWarning.ok) {
-                    (_b = args.onWarning) === null || _b === void 0 ? void 0 : _b.call(args, parsedWarning.value);
-                    return;
-                }
-                const parsedError = yield serializers.ModelsError.parse(body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-                if (parsedError.ok) {
-                    (_c = args.onError) === null || _c === void 0 ? void 0 : _c.call(args, parsedError.value);
-                    return;
-                }
-            }));
-            websocket.addEventListener("close", () => {
-                var _a;
-                (_a = args.onClose) === null || _a === void 0 ? void 0 : _a.call(args);
+        const websocket = new ws_1.default(`wss://api.hume.ai/v0/stream/models`, {
+            headers: {
+                "X-Hume-Api-Key": this._options.apiKey,
+            },
+            timeout: this._options.openTimeoutInSeconds,
+        });
+        websocket.addEventListener("open", (event) => {
+            var _a;
+            (_a = args.onOpen) === null || _a === void 0 ? void 0 : _a.call(args, event);
+        });
+        websocket.addEventListener("error", (e) => {
+            var _a;
+            (_a = args.onError) === null || _a === void 0 ? void 0 : _a.call(args, {
+                code: e.type,
+                error: e.message,
             });
-            return new Promise((resolve) => {
-                if (websocket && websocket.readyState !== websocket.OPEN) {
-                    websocket.addEventListener("open", () => {
-                        resolve(new StreamSocket_1.StreamSocket({
-                            websocket,
-                            streamWindowMs: args.streamWindowMs,
-                            config: args.config,
-                        }));
-                    });
-                }
-                else {
-                    resolve(new StreamSocket_1.StreamSocket({
-                        websocket,
-                        streamWindowMs: args.streamWindowMs,
-                        config: args.config,
-                    }));
-                }
+        });
+        websocket.addEventListener("message", ({ data }) => __awaiter(this, void 0, void 0, function* () {
+            parse(data, {
+                onMessage: args.onMessage,
+                onWarning: args.onWarning,
+                onError: args.onError,
             });
+        }));
+        websocket.addEventListener("close", (event) => {
+            var _a;
+            (_a = args.onClose) === null || _a === void 0 ? void 0 : _a.call(args, event);
+        });
+        return new StreamSocket_1.StreamSocket({
+            websocket,
+            streamWindowMs: args.streamWindowMs,
+            config: args.config,
         });
     }
 }
 exports.HumeStreamingClient = HumeStreamingClient;
+function parse(data, args = {}) {
+    var _a, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        const message = JSON.parse(data);
+        const parsedResponse = yield serializers.ModelResponse.parse(message, {
+            unrecognizedObjectKeys: "passthrough",
+            allowUnrecognizedUnionMembers: true,
+            allowUnrecognizedEnumValues: true,
+            breadcrumbsPrefix: ["response"],
+        });
+        if (parsedResponse.ok) {
+            (_a = args.onMessage) === null || _a === void 0 ? void 0 : _a.call(args, parsedResponse.value);
+            return parsedResponse.value;
+        }
+        const parsedWarning = yield serializers.ModelsWarning.parse(message, {
+            unrecognizedObjectKeys: "passthrough",
+            allowUnrecognizedUnionMembers: true,
+            allowUnrecognizedEnumValues: true,
+            breadcrumbsPrefix: ["response"],
+        });
+        if (parsedWarning.ok) {
+            (_b = args.onWarning) === null || _b === void 0 ? void 0 : _b.call(args, parsedWarning.value);
+            return parsedWarning.value;
+        }
+        const parsedError = yield serializers.ModelsError.parse(message, {
+            unrecognizedObjectKeys: "passthrough",
+            allowUnrecognizedUnionMembers: true,
+            allowUnrecognizedEnumValues: true,
+            breadcrumbsPrefix: ["response"],
+        });
+        if (parsedError.ok) {
+            (_c = args.onError) === null || _c === void 0 ? void 0 : _c.call(args, parsedError.value);
+            return parsedError.value;
+        }
+    });
+}
+exports.parse = parse;

package/dist/wrapper/StreamSocket.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import WebSocket from "ws";
 import * as Hume from "../api";
+import * as fs from "fs";
 export declare namespace StreamSocket {
     interface Args {
         websocket: WebSocket;
@@ -14,29 +15,16 @@ export declare class StreamSocket {
     private config;
     constructor({ websocket, config, streamWindowMs }: StreamSocket.Args);
     /**
-     * Send a file on the `StreamSocket`
+     * Send 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`
+     * @param file A fs.ReadStream | File | Blob
+     * @param config This method is intended for use with a `LanguageConfig`.
+     * When the socket is configured for other modalities this method will fail.
      */
-    sendBuffer({ buffer, config, }: {
-        buffer: Buffer;
+    sendFile({ file, config, }: {
+        file: fs.ReadStream | Blob;
         config?: Hume.ModelConfig;
-    }): void;
+    }): Promise<Hume.ModelResponse>;
     /**
      * Send text on the `StreamSocket`
      *
@@ -44,10 +32,10 @@ export declare class StreamSocket {
      * @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, }: {
+    sendText({ text, config }: {
         text: string;
         config?: Hume.ModelConfig;
-    }): void;
+    }): Promise<Hume.ModelResponse>;
     /**
      * Send facemesh landmarks on the `StreamSocket`
      *
@@ -61,7 +49,7 @@ export declare class StreamSocket {
     sendFacemesh({ landmarks, config, }: {
         landmarks: number[][][];
         config?: Hume.ModelConfig;
-    }): void;
+    }): Promise<Hume.ModelResponse>;
     /**
      *
      * Reset the streaming sliding window.
@@ -69,15 +57,17 @@ export declare class StreamSocket {
      * 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;
+    reset(): Promise<void>;
     /**
      *
      * Get details associated with the current streaming connection.
      *
      */
-    getJobDetails(): void;
+    getJobDetails(): Promise<void>;
     /**
      * Closes the underlying socket.
      */
     close(): void;
+    private send;
+    private tillSocketOpen;
 }