@ai-sdk/hume 3.0.0-beta.3 → 3.0.0-beta.31

package/CHANGELOG.md

@@ -1,5 +1,243 @@
 # @ai-sdk/hume
 
+## 3.0.0-beta.31
+
+### Major Changes
+
+- 04e9009: chore: make provider implementations code patterns more consistent, including renaming certain exported symbols
+
+  For all externally exported symbols that were renamed, the old names continue to work via deprecated aliases.
+
+### Patch Changes
+
+- Updated dependencies [08d2129]
+  - @ai-sdk/provider-utils@5.0.0-beta.30
+
+## 3.0.0-beta.30
+
+### Patch Changes
+
+- 258c093: chore: ensure consistent import handling and avoid import duplicates or cycles
+- Updated dependencies [9bd6512]
+- Updated dependencies [258c093]
+- Updated dependencies [b6783da]
+  - @ai-sdk/provider-utils@5.0.0-beta.29
+  - @ai-sdk/provider@4.0.0-beta.14
+
+## 3.0.0-beta.29
+
+### Patch Changes
+
+- 9f0e36c: trigger release for all packages after provenance setup
+- Updated dependencies [9f0e36c]
+  - @ai-sdk/provider@4.0.0-beta.13
+  - @ai-sdk/provider-utils@5.0.0-beta.28
+
+## 3.0.0-beta.28
+
+### Patch Changes
+
+- Updated dependencies [785fe16]
+- Updated dependencies [67df0a0]
+- Updated dependencies [befb78c]
+- Updated dependencies [0458559]
+- Updated dependencies [5852c0a]
+- Updated dependencies [fc92055]
+  - @ai-sdk/provider-utils@5.0.0-beta.27
+
+## 3.0.0-beta.27
+
+### Patch Changes
+
+- Updated dependencies [2e98477]
+  - @ai-sdk/provider-utils@5.0.0-beta.26
+
+## 3.0.0-beta.26
+
+### Patch Changes
+
+- Updated dependencies [eea8d98]
+  - @ai-sdk/provider-utils@5.0.0-beta.25
+
+## 3.0.0-beta.25
+
+### Patch Changes
+
+- Updated dependencies [f807e45]
+  - @ai-sdk/provider-utils@5.0.0-beta.24
+
+## 3.0.0-beta.24
+
+### Patch Changes
+
+- Updated dependencies [350ea38]
+  - @ai-sdk/provider-utils@5.0.0-beta.23
+
+## 3.0.0-beta.23
+
+### Patch Changes
+
+- Updated dependencies [083947b]
+  - @ai-sdk/provider-utils@5.0.0-beta.22
+
+## 3.0.0-beta.22
+
+### Patch Changes
+
+- Updated dependencies [add1126]
+  - @ai-sdk/provider-utils@5.0.0-beta.21
+
+## 3.0.0-beta.21
+
+### Patch Changes
+
+- b3976a2: Add workflow serialization support to all provider models.
+
+  **`@ai-sdk/provider-utils`:** New `serializeModel()` helper that extracts only serializable properties from a model instance, filtering out functions and objects containing functions. Third-party provider authors can use this to add workflow support to their own models.
+
+  **All providers:** `headers` is now optional in provider config types. This is non-breaking — existing code that passes `headers` continues to work. Custom provider implementations that construct model configs manually can now omit `headers`, which is useful when models are deserialized from a workflow step boundary where auth is provided separately.
+
+  All provider model classes now include `WORKFLOW_SERIALIZE` and `WORKFLOW_DESERIALIZE` static methods, enabling them to cross workflow step boundaries without serialization errors.
+
+- Updated dependencies [b3976a2]
+- Updated dependencies [ff5eba1]
+  - @ai-sdk/provider-utils@5.0.0-beta.20
+  - @ai-sdk/provider@4.0.0-beta.12
+
+## 3.0.0-beta.20
+
+### Major Changes
+
+- ef992f8: Remove CommonJS exports from all packages. All packages are now ESM-only (`"type": "module"`). Consumers using `require()` must switch to ESM `import` syntax.
+
+### Patch Changes
+
+- Updated dependencies [ef992f8]
+  - @ai-sdk/provider@4.0.0-beta.11
+  - @ai-sdk/provider-utils@5.0.0-beta.19
+
+## 3.0.0-beta.19
+
+### Patch Changes
+
+- Updated dependencies [90e2d8a]
+  - @ai-sdk/provider-utils@5.0.0-beta.18
+
+## 3.0.0-beta.18
+
+### Patch Changes
+
+- Updated dependencies [3ae1786]
+  - @ai-sdk/provider-utils@5.0.0-beta.17
+
+## 3.0.0-beta.17
+
+### Patch Changes
+
+- Updated dependencies [176466a]
+  - @ai-sdk/provider@4.0.0-beta.10
+  - @ai-sdk/provider-utils@5.0.0-beta.16
+
+## 3.0.0-beta.16
+
+### Patch Changes
+
+- Updated dependencies [e311194]
+  - @ai-sdk/provider@4.0.0-beta.9
+  - @ai-sdk/provider-utils@5.0.0-beta.15
+
+## 3.0.0-beta.15
+
+### Patch Changes
+
+- Updated dependencies [34bd95d]
+- Updated dependencies [008271d]
+  - @ai-sdk/provider@4.0.0-beta.8
+  - @ai-sdk/provider-utils@5.0.0-beta.14
+
+## 3.0.0-beta.14
+
+### Patch Changes
+
+- Updated dependencies [b0c2869]
+- Updated dependencies [7e26e81]
+  - @ai-sdk/provider-utils@5.0.0-beta.13
+
+## 3.0.0-beta.13
+
+### Patch Changes
+
+- Updated dependencies [46d1149]
+  - @ai-sdk/provider-utils@5.0.0-beta.12
+
+## 3.0.0-beta.12
+
+### Patch Changes
+
+- Updated dependencies [6fd51c0]
+  - @ai-sdk/provider-utils@5.0.0-beta.11
+  - @ai-sdk/provider@4.0.0-beta.7
+
+## 3.0.0-beta.11
+
+### Patch Changes
+
+- Updated dependencies [c29a26f]
+  - @ai-sdk/provider-utils@5.0.0-beta.10
+  - @ai-sdk/provider@4.0.0-beta.6
+
+## 3.0.0-beta.10
+
+### Patch Changes
+
+- 38fc777: Add AI Gateway hint to provider READMEs
+
+## 3.0.0-beta.9
+
+### Patch Changes
+
+- Updated dependencies [2e17091]
+  - @ai-sdk/provider-utils@5.0.0-beta.9
+
+## 3.0.0-beta.8
+
+### Patch Changes
+
+- Updated dependencies [986c6fd]
+- Updated dependencies [493295c]
+  - @ai-sdk/provider-utils@5.0.0-beta.8
+
+## 3.0.0-beta.7
+
+### Patch Changes
+
+- Updated dependencies [1f509d4]
+  - @ai-sdk/provider-utils@5.0.0-beta.7
+  - @ai-sdk/provider@4.0.0-beta.5
+
+## 3.0.0-beta.6
+
+### Patch Changes
+
+- Updated dependencies [3887c70]
+  - @ai-sdk/provider-utils@5.0.0-beta.6
+  - @ai-sdk/provider@4.0.0-beta.4
+
+## 3.0.0-beta.5
+
+### Patch Changes
+
+- Updated dependencies [776b617]
+  - @ai-sdk/provider-utils@5.0.0-beta.5
+  - @ai-sdk/provider@4.0.0-beta.3
+
+## 3.0.0-beta.4
+
+### Patch Changes
+
+- Updated dependencies [61753c3]
+  - @ai-sdk/provider-utils@5.0.0-beta.4
+
 ## 3.0.0-beta.3
 
 ### Patch Changes

package/README.md

@@ -3,6 +3,8 @@
 The **[Hume provider](https://ai-sdk.dev/providers/ai-sdk-providers/hume)** for the [AI SDK](https://ai-sdk.dev/docs)
 contains support for the Hume API.
 
+> **Deploying to Vercel?** With Vercel's AI Gateway you can access Hume (and hundreds of models from other providers) — no additional packages, API keys, or extra cost. [Get started with AI Gateway](https://vercel.com/ai-gateway).
+
 ## Setup
 
 The Hume provider is available in the `@ai-sdk/hume` module. You can install it with

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { SpeechModelV3, ProviderV3 } from '@ai-sdk/provider';
-import { FetchFunction } from '@ai-sdk/provider-utils';
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { SpeechModelV4, ProviderV4 } from '@ai-sdk/provider';
+import { FetchFunction, WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
 type HumeConfig = {
@@ -8,60 +9,42 @@ type HumeConfig = {
         modelId: string;
         path: string;
     }) => string;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     fetch?: FetchFunction;
     generateId?: () => string;
 };
 
-declare const humeSpeechModelOptionsSchema: z.ZodObject<{
-    context: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodObject<{
-        generationId: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        utterances: z.ZodArray<z.ZodObject<{
-            text: z.ZodString;
-            description: z.ZodOptional<z.ZodString>;
-            speed: z.ZodOptional<z.ZodNumber>;
-            trailingSilence: z.ZodOptional<z.ZodNumber>;
-            voice: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
-                id: z.ZodString;
-                provider: z.ZodOptional<z.ZodEnum<{
-                    HUME_AI: "HUME_AI";
-                    CUSTOM_VOICE: "CUSTOM_VOICE";
-                }>>;
-            }, z.core.$strip>, z.ZodObject<{
-                name: z.ZodString;
-                provider: z.ZodOptional<z.ZodEnum<{
-                    HUME_AI: "HUME_AI";
-                    CUSTOM_VOICE: "CUSTOM_VOICE";
-                }>>;
-            }, z.core.$strip>]>>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>]>>>;
-}, z.core.$strip>;
-type HumeSpeechModelOptions = z.infer<typeof humeSpeechModelOptionsSchema>;
 interface HumeSpeechModelConfig extends HumeConfig {
     _internal?: {
         currentDate?: () => Date;
     };
 }
-declare class HumeSpeechModel implements SpeechModelV3 {
+declare class HumeSpeechModel implements SpeechModelV4 {
     readonly modelId: '';
     private readonly config;
-    readonly specificationVersion = "v3";
+    readonly specificationVersion = "v4";
     get provider(): string;
+    static [WORKFLOW_SERIALIZE](model: HumeSpeechModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: '';
+        config: HumeSpeechModelConfig;
+    }): HumeSpeechModel;
     constructor(modelId: '', config: HumeSpeechModelConfig);
     private getArgs;
-    doGenerate(options: Parameters<SpeechModelV3['doGenerate']>[0]): Promise<Awaited<ReturnType<SpeechModelV3['doGenerate']>>>;
+    doGenerate(options: Parameters<SpeechModelV4['doGenerate']>[0]): Promise<Awaited<ReturnType<SpeechModelV4['doGenerate']>>>;
 }
 
-interface HumeProvider extends Pick<ProviderV3, 'speechModel'> {
+interface HumeProvider extends ProviderV4 {
     (settings?: {}): {
         speech: HumeSpeechModel;
     };
     /**
      * Creates a model for speech synthesis.
      */
-    speech(): SpeechModelV3;
+    speech(): SpeechModelV4;
 }
 interface HumeProviderSettings {
     /**
@@ -87,6 +70,33 @@ declare function createHume(options?: HumeProviderSettings): HumeProvider;
  */
 declare const hume: HumeProvider;
 
+declare const humeSpeechModelOptionsSchema: z.ZodObject<{
+    context: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodObject<{
+        generationId: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        utterances: z.ZodArray<z.ZodObject<{
+            text: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            speed: z.ZodOptional<z.ZodNumber>;
+            trailingSilence: z.ZodOptional<z.ZodNumber>;
+            voice: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+                id: z.ZodString;
+                provider: z.ZodOptional<z.ZodEnum<{
+                    HUME_AI: "HUME_AI";
+                    CUSTOM_VOICE: "CUSTOM_VOICE";
+                }>>;
+            }, z.core.$strip>, z.ZodObject<{
+                name: z.ZodString;
+                provider: z.ZodOptional<z.ZodEnum<{
+                    HUME_AI: "HUME_AI";
+                    CUSTOM_VOICE: "CUSTOM_VOICE";
+                }>>;
+            }, z.core.$strip>]>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>]>>>;
+}, z.core.$strip>;
+type HumeSpeechModelOptions = z.infer<typeof humeSpeechModelOptionsSchema>;
+
 declare const VERSION: string;
 
 export { type HumeProvider, type HumeProviderSettings, type HumeSpeechModelOptions, VERSION, createHume, hume };

package/dist/index.js

@@ -1,110 +1,96 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  VERSION: () => VERSION,
-  createHume: () => createHume,
-  hume: () => hume
-});
-module.exports = __toCommonJS(index_exports);
-
 // src/hume-provider.ts
-var import_provider_utils3 = require("@ai-sdk/provider-utils");
+import {
+  NoSuchModelError
+} from "@ai-sdk/provider";
+import {
+  loadApiKey,
+  withUserAgentSuffix
+} from "@ai-sdk/provider-utils";
 
 // src/hume-speech-model.ts
-var import_provider_utils2 = require("@ai-sdk/provider-utils");
-var import_v42 = require("zod/v4");
+import {
+  combineHeaders,
+  createBinaryResponseHandler,
+  parseProviderOptions,
+  postJsonToApi,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE
+} from "@ai-sdk/provider-utils";
 
 // src/hume-error.ts
-var import_v4 = require("zod/v4");
-var import_provider_utils = require("@ai-sdk/provider-utils");
-var humeErrorDataSchema = import_v4.z.object({
-  error: import_v4.z.object({
-    message: import_v4.z.string(),
-    code: import_v4.z.number()
+import { z } from "zod/v4";
+import { createJsonErrorResponseHandler } from "@ai-sdk/provider-utils";
+var humeErrorDataSchema = z.object({
+  error: z.object({
+    message: z.string(),
+    code: z.number()
   })
 });
-var humeFailedResponseHandler = (0, import_provider_utils.createJsonErrorResponseHandler)({
+var humeFailedResponseHandler = createJsonErrorResponseHandler({
   errorSchema: humeErrorDataSchema,
   errorToMessage: (data) => data.error.message
 });
 
-// src/hume-speech-model.ts
-var humeSpeechModelOptionsSchema = import_v42.z.object({
+// src/hume-speech-model-options.ts
+import { z as z2 } from "zod/v4";
+var humeSpeechModelOptionsSchema = z2.object({
   /**
    * Context for the speech synthesis request.
    * Can be either a generationId for retrieving a previous generation,
    * or a list of utterances to synthesize.
    */
-  context: import_v42.z.object({
+  context: z2.object({
     /**
      * ID of a previously generated speech synthesis to retrieve.
      */
-    generationId: import_v42.z.string()
+    generationId: z2.string()
   }).or(
-    import_v42.z.object({
+    z2.object({
       /**
        * List of utterances to synthesize into speech.
        */
-      utterances: import_v42.z.array(
-        import_v42.z.object({
+      utterances: z2.array(
+        z2.object({
           /**
            * The text content to convert to speech.
            */
-          text: import_v42.z.string(),
+          text: z2.string(),
           /**
            * Optional description or instructions for how the text should be spoken.
            */
-          description: import_v42.z.string().optional(),
+          description: z2.string().optional(),
           /**
            * Optional speech rate multiplier.
            */
-          speed: import_v42.z.number().optional(),
+          speed: z2.number().optional(),
           /**
            * Optional duration of silence to add after the utterance in seconds.
            */
-          trailingSilence: import_v42.z.number().optional(),
+          trailingSilence: z2.number().optional(),
           /**
            * Voice configuration for the utterance.
            * Can be specified by ID or name.
            */
-          voice: import_v42.z.object({
+          voice: z2.object({
             /**
              * ID of the voice to use.
              */
-            id: import_v42.z.string(),
+            id: z2.string(),
             /**
              * Provider of the voice, either Hume's built-in voices or a custom voice.
              */
-            provider: import_v42.z.enum(["HUME_AI", "CUSTOM_VOICE"]).optional()
+            provider: z2.enum(["HUME_AI", "CUSTOM_VOICE"]).optional()
           }).or(
-            import_v42.z.object({
+            z2.object({
               /**
                * Name of the voice to use.
                */
-              name: import_v42.z.string(),
+              name: z2.string(),
               /**
                * Provider of the voice, either Hume's built-in voices or a custom voice.
                */
-              provider: import_v42.z.enum(["HUME_AI", "CUSTOM_VOICE"]).optional()
+              provider: z2.enum(["HUME_AI", "CUSTOM_VOICE"]).optional()
             })
           ).optional()
         })
@@ -112,15 +98,26 @@ var humeSpeechModelOptionsSchema = import_v42.z.object({
     })
   ).nullish()
 });
-var HumeSpeechModel = class {
+
+// src/hume-speech-model.ts
+var HumeSpeechModel = class _HumeSpeechModel {
   constructor(modelId, config) {
     this.modelId = modelId;
     this.config = config;
-    this.specificationVersion = "v3";
+    this.specificationVersion = "v4";
   }
   get provider() {
     return this.config.provider;
   }
+  static [WORKFLOW_SERIALIZE](model) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config
+    });
+  }
+  static [WORKFLOW_DESERIALIZE](options) {
+    return new _HumeSpeechModel(options.modelId, options.config);
+  }
   async getArgs({
     text,
     voice = "d8ab67c6-953d-4bd8-9370-8fa53a0f1453",
@@ -131,7 +128,7 @@ var HumeSpeechModel = class {
     providerOptions
   }) {
     const warnings = [];
-    const humeOptions = await (0, import_provider_utils2.parseProviderOptions)({
+    const humeOptions = await parseProviderOptions({
       provider: "hume",
       providerOptions,
       schema: humeSpeechModelOptionsSchema
@@ -200,22 +197,22 @@ var HumeSpeechModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e;
     const currentDate = (_c = (_b = (_a = this.config._internal) == null ? void 0 : _a.currentDate) == null ? void 0 : _b.call(_a)) != null ? _c : /* @__PURE__ */ new Date();
     const { requestBody, warnings } = await this.getArgs(options);
     const {
       value: audio,
       responseHeaders,
       rawValue: rawResponse
-    } = await (0, import_provider_utils2.postJsonToApi)({
+    } = await postJsonToApi({
       url: this.config.url({
         path: "/v0/tts/file",
         modelId: this.modelId
       }),
-      headers: (0, import_provider_utils2.combineHeaders)(this.config.headers(), options.headers),
+      headers: combineHeaders((_e = (_d = this.config).headers) == null ? void 0 : _e.call(_d), options.headers),
       body: requestBody,
       failedResponseHandler: humeFailedResponseHandler,
-      successfulResponseHandler: (0, import_provider_utils2.createBinaryResponseHandler)(),
+      successfulResponseHandler: createBinaryResponseHandler(),
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
     });
@@ -236,13 +233,13 @@ var HumeSpeechModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.0-beta.3" : "0.0.0-test";
+var VERSION = true ? "3.0.0-beta.31" : "0.0.0-test";
 
 // src/hume-provider.ts
 function createHume(options = {}) {
-  const getHeaders = () => (0, import_provider_utils3.withUserAgentSuffix)(
+  const getHeaders = () => withUserAgentSuffix(
     {
-      "X-Hume-Api-Key": (0, import_provider_utils3.loadApiKey)({
+      "X-Hume-Api-Key": loadApiKey({
         apiKey: options.apiKey,
         environmentVariableName: "HUME_API_KEY",
         description: "Hume"
@@ -262,15 +259,36 @@ function createHume(options = {}) {
       speech: createSpeechModel()
     };
   };
+  provider.specificationVersion = "v4";
   provider.speech = createSpeechModel;
   provider.speechModel = createSpeechModel;
+  provider.languageModel = (modelId) => {
+    throw new NoSuchModelError({
+      modelId,
+      modelType: "languageModel",
+      message: "Hume does not provide language models"
+    });
+  };
+  provider.embeddingModel = (modelId) => {
+    throw new NoSuchModelError({
+      modelId,
+      modelType: "embeddingModel",
+      message: "Hume does not provide embedding models"
+    });
+  };
+  provider.imageModel = (modelId) => {
+    throw new NoSuchModelError({
+      modelId,
+      modelType: "imageModel",
+      message: "Hume does not provide image models"
+    });
+  };
   return provider;
 }
 var hume = createHume();
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   VERSION,
   createHume,
   hume
-});
+};
 //# sourceMappingURL=index.js.map