🌿 Fern Regeneration -- March 4, 2024

.github/workflows/ci.yml

@@ -16,8 +16,21 @@ jobs:
       - name: Compile
         run: yarn && yarn build
 
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Set up node
+        uses: actions/setup-node@v3
+
+      - name: Compile
+        run: yarn && yarn test
+
   publish:
-    needs: [ compile ]
+    needs: [ compile, test ]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
 

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    preset: "ts-jest",
+    testEnvironment: "node",
+};

package.json

@@ -1,14 +1,15 @@
 {
     "name": "hume",
-    "version": "0.4.1",
+    "version": "0.4.2",
     "private": false,
     "repository": "https://github.com/HumeAI/hume-typescript-sdk",
     "main": "./index.js",
     "types": "./index.d.ts",
     "scripts": {
         "format": "prettier --write 'src/**/*.ts'",
         "build": "tsc",
-        "prepack": "cp -rv dist/. ."
+        "prepack": "cp -rv dist/. .",
+        "test": "jest"
     },
     "dependencies": {
         "url-join": "4.0.1",
@@ -24,6 +25,9 @@
         "@types/url-join": "4.0.1",
         "@types/qs": "6.9.8",
         "@types/node-fetch": "2.6.9",
+        "jest": "^29.7.0",
+        "@types/jest": "^29.5.5",
+        "ts-jest": "^29.1.1",
         "@types/node": "17.0.33",
         "prettier": "2.7.1",
         "typescript": "4.6.4"

src/Client.ts

@@ -29,19 +29,14 @@ export class HumeClient {
      * Sort and filter jobs.
      *
      * @example
-     *     await hume.listJobs({
-     *         status: Hume.Status.Queued,
-     *         when: Hume.When.CreatedBefore,
-     *         sortBy: Hume.SortBy.Created,
-     *         direction: Hume.Direction.Asc
-     *     })
+     *     await hume.listJobs()
      */
     public async listJobs(
         request: Hume.ListJobsRequest = {},
         requestOptions?: HumeClient.RequestOptions
     ): Promise<Hume.JobRequest[]> {
         const { limit, status, when, timestampMs, sortBy, direction } = request;
-        const _queryParams: Record<string, string | string[]> = {};
+        const _queryParams: Record<string, string | string[] | object | object[]> = {};
         if (limit != null) {
             _queryParams["limit"] = limit.toString();
         }
@@ -80,7 +75,9 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "hume",
-                "X-Fern-SDK-Version": "0.4.1",
+                "X-Fern-SDK-Version": "0.4.2",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             queryParameters: _queryParams,
@@ -120,6 +117,9 @@ export class HumeClient {
 
     /**
      * Start a new batch job.
+     *
+     * @example
+     *     await hume.submitJob()
      */
     public async submitJob(
         request: Hume.BaseRequest = {},
@@ -135,7 +135,9 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "hume",
-                "X-Fern-SDK-Version": "0.4.1",
+                "X-Fern-SDK-Version": "0.4.2",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             body: await serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -193,7 +195,9 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "hume",
-                "X-Fern-SDK-Version": "0.4.1",
+                "X-Fern-SDK-Version": "0.4.2",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -244,7 +248,9 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "hume",
-                "X-Fern-SDK-Version": "0.4.1",
+                "X-Fern-SDK-Version": "0.4.2",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             responseType: "streaming",
@@ -291,7 +297,9 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "hume",
-                "X-Fern-SDK-Version": "0.4.1",
+                "X-Fern-SDK-Version": "0.4.2",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

src/api/client/requests/BaseRequest.ts

@@ -4,6 +4,10 @@
 
 import * as Hume from "../..";
 
+/**
+ * @example
+ *     {}
+ */
 export interface BaseRequest {
     models?: Hume.Models;
     transcription?: Hume.Transcription;

src/api/client/requests/ListJobsRequest.ts

@@ -6,12 +6,7 @@ import * as Hume from "../..";
 
 /**
  * @example
- *     {
- *         status: Hume.Status.Queued,
- *         when: Hume.When.CreatedBefore,
- *         sortBy: Hume.SortBy.Created,
- *         direction: Hume.Direction.Asc
- *     }
+ *     {}
  */
 export interface ListJobsRequest {
     /**

src/api/index.ts

@@ -1,2 +1,3 @@
+export * from "./resources";
 export * from "./types";
 export * from "./client";

src/api/resources/index.ts

@@ -0,0 +1,2 @@
+export * as websocket from "./websocket";
+export * from "./websocket/types";

src/api/resources/websocket/index.ts

@@ -0,0 +1 @@
+export * from "./types";

src/api/types/BurstResponse.ts → src/api/resources/websocket/types/BurstResponse.ts

@@ -2,11 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
 /**
  * Response for the vocal burst emotion model.
  */
 export interface BurstResponse {
-    predictions?: Hume.ModelsSuccessBurstPredictionsItem[];
+    predictions?: Hume.WebsocketBurstBurstPredictionsItem[];
 }

src/api/types/FaceResponse.ts → src/api/resources/websocket/types/FaceResponse.ts

@@ -2,11 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
 /**
  * Response for the facial expression emotion model.
  */
 export interface FaceResponse {
-    predictions?: Hume.ModelsSuccessFacePredictionsItem[];
+    predictions?: Hume.WebsocketBurstFacePredictionsItem[];
 }

src/api/types/FacemeshResponse.ts → src/api/resources/websocket/types/FacemeshResponse.ts

@@ -2,11 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
 /**
  * Response for the facemesh emotion model.
  */
 export interface FacemeshResponse {
-    predictions?: Hume.ModelsSuccessFacemeshPredictionsItem[];
+    predictions?: Hume.WebsocketBurstFacemeshPredictionsItem[];
 }

src/api/types/LanguageResponse.ts → src/api/resources/websocket/types/LanguageResponse.ts

@@ -2,11 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
 /**
  * Response for the language emotion model.
  */
 export interface LanguageResponse {
-    predictions?: Hume.ModelsSuccessLanguagePredictionsItem[];
+    predictions?: Hume.WebsocketBurstLanguagePredictionsItem[];
 }

src/api/types/ModelResponse.ts → src/api/resources/websocket/types/ModelResponse.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
 export interface ModelResponse {
     /** Response for the vocal burst emotion model. */

src/api/types/ProsodyResponse.ts → src/api/resources/websocket/types/ProsodyResponse.ts

@@ -2,11 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
 /**
  * Response for the speech prosody emotion model.
  */
 export interface ProsodyResponse {
-    predictions?: Hume.ModelsSuccessProsodyPredictionsItem[];
+    predictions?: Hume.WebsocketBurstProsodyPredictionsItem[];
 }

src/api/resources/websocket/types/SubscribeEvent.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Hume from "../../..";
+
+export type SubscribeEvent = Hume.ModelResponse | Hume.WebsocketError | Hume.WebsocketWarning;

src/api/types/ModelsSuccessProsodyPredictionsItem.ts → src/api/resources/websocket/types/WebsocketBurstBurstPredictionsItem.ts

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
-export interface ModelsSuccessProsodyPredictionsItem {
+export interface WebsocketBurstBurstPredictionsItem {
     time?: Hume.TimeRange;
     emotions?: Hume.EmotionEmbedding;
 }

src/api/types/ModelsSuccessFacePredictionsItem.ts → src/api/resources/websocket/types/WebsocketBurstFacePredictionsItem.ts

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
-export interface ModelsSuccessFacePredictionsItem {
+export interface WebsocketBurstFacePredictionsItem {
     /** Frame number */
     frame?: number;
     /** Time in seconds when face detection occurred. */

src/api/types/ModelsSuccessFacemeshPredictionsItem.ts → src/api/resources/websocket/types/WebsocketBurstFacemeshPredictionsItem.ts

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
-export interface ModelsSuccessFacemeshPredictionsItem {
+export interface WebsocketBurstFacemeshPredictionsItem {
     emotions?: Hume.EmotionEmbedding;
 }

src/api/types/ModelsSuccessLanguagePredictionsItem.ts → src/api/resources/websocket/types/WebsocketBurstLanguagePredictionsItem.ts

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
-export interface ModelsSuccessLanguagePredictionsItem {
+export interface WebsocketBurstLanguagePredictionsItem {
     /** A segment of text (like a word or a sentence). */
     text?: string;
     position?: Hume.TextPosition;

src/api/types/ModelsSuccessBurstPredictionsItem.ts → src/api/resources/websocket/types/WebsocketBurstProsodyPredictionsItem.ts

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Hume from "..";
+import * as Hume from "../../..";
 
-export interface ModelsSuccessBurstPredictionsItem {
+export interface WebsocketBurstProsodyPredictionsItem {
     time?: Hume.TimeRange;
     emotions?: Hume.EmotionEmbedding;
 }

src/api/types/ModelsError.ts → src/api/resources/websocket/types/WebsocketError.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export interface ModelsError {
+export interface WebsocketError {
     /** Error message text. */
     error?: string;
     /** Unique identifier for the error. */

src/api/types/ModelsWarning.ts → src/api/resources/websocket/types/WebsocketWarning.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export interface ModelsWarning {
+export interface WebsocketWarning {
     /** Warning message text. */
     warning?: string;
     /** Unique identifier for the error. */

src/api/resources/websocket/types/index.ts

@@ -0,0 +1,14 @@
+export * from "./WebsocketBurstBurstPredictionsItem";
+export * from "./BurstResponse";
+export * from "./WebsocketBurstFacePredictionsItem";
+export * from "./FaceResponse";
+export * from "./WebsocketBurstFacemeshPredictionsItem";
+export * from "./FacemeshResponse";
+export * from "./WebsocketBurstLanguagePredictionsItem";
+export * from "./LanguageResponse";
+export * from "./WebsocketBurstProsodyPredictionsItem";
+export * from "./ProsodyResponse";
+export * from "./ModelResponse";
+export * from "./WebsocketError";
+export * from "./WebsocketWarning";
+export * from "./SubscribeEvent";