feat: add generate function to ai voice generator (#125)

Author: davidhu2000

.sdk.json

@@ -1,5 +1,5 @@
 {
-  "id": "31df0519-cea5-43da-929f-50f1bfbc429b",
+  "id": "b4a720d1-545c-494f-a7a5-df7d60093894",
   "tracked_paths": [
     {
       "editable": true,

README.md

@@ -260,6 +260,7 @@ Valid values are: `none`, `error`, `warn`, `info`, `debug` (case insensitive). I
 ### [v1.aiVoiceGenerator](src/resources/v1/ai-voice-generator/README.md)
 
 * [create](src/resources/v1/ai-voice-generator/README.md#create) - AI Voice Generator
+* [generate](src/resources/v1/ai-voice-generator/README.md#generate) - AI Voice Generator Generate Workflow
 
 ### [v1.animation](src/resources/v1/animation/README.md)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "magic-hour",
-  "version": "0.41.0",
+  "version": "0.42.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {

src/resources/v1/ai-voice-generator/README.md

@@ -2,6 +2,49 @@
 
 ## Module Functions
 
+<!-- CUSTOM DOCS START -->
+### AI Voice Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In addition to the parameters listed in the `create` section below, `generate` introduces 3 new parameters:
+
+- `waitForCompletion` (boolean, default true): Whether to wait for the project to complete.
+- `downloadOutputs` (boolean, default true): Whether to download the generated files
+- `downloadDirectory` (string, optional): Directory to save downloaded files (defaults to current directory)
+
+#### Example Snippet
+
+```typescript
+import Client from "magic-hour";
+
+const client = new Client({ token: process.env["API_TOKEN"]!! });
+const res = await client.v1.aiVoiceGenerator.generate(
+  {
+    name: "Voice Generator audio",
+    style: { prompt: "Hello, how are you?", voiceName: "Elon Musk" },
+  },
+  {
+    waitForCompletion: true,
+    downloadOutputs: true,
+    downloadDirectory: "outputs",
+  },
+);
+
+```
+
+<!-- CUSTOM DOCS END -->
+
 ### AI Voice Generator <a name="create"></a>
 
 Generate speech from text. Each character costs 0.05 credits. The cost is rounded up to the nearest whole number.

src/resources/v1/ai-voice-generator/resource-client.ts

@@ -6,16 +6,82 @@ import {
   ResourceClientOptions,
 } from "make-api-request-js";
 
+import {
+  GenerateOptions,
+  GenerateRequestType,
+} from "magic-hour/helpers/generate-type";
+import { getLogger } from "magic-hour/logger";
 import * as requests from "magic-hour/resources/v1/ai-voice-generator/request-types";
+import { ImageProjectsClient } from "magic-hour/resources/v1/image-projects";
 import * as types from "magic-hour/types";
 import { Schemas$V1AiVoiceGeneratorCreateBody } from "magic-hour/types/v1-ai-voice-generator-create-body";
 import { Schemas$V1AiVoiceGeneratorCreateResponse } from "magic-hour/types/v1-ai-voice-generator-create-response";
 
+type GenerateRequest = GenerateRequestType<requests.CreateRequest, {}>;
+
 export class AiVoiceGeneratorClient extends CoreResourceClient {
   constructor(coreClient: CoreClient, opts: ResourceClientOptions) {
     super(coreClient, opts);
   }
 
+  /**
+   * AI Voice Generator
+   *
+   * Generate speech from text
+   *
+   * This method provides a convenient way to create a request and automatically wait for completion and download outputs.
+   *
+   * @example
+   * ```typescript
+   * import Client from "magic-hour";
+   *
+   * const client = new Client({ token: process.env["API_TOKEN"]!! });
+   * const res = await client.v1.aiVoiceGenerator.generate(
+   *   {
+   *     name: "Voice Generator audio",
+   *     style: { prompt: "Hello, how are you?", voiceName: "Elon Musk" },
+   *   },
+   *   {
+   *     waitForCompletion: true,
+   *     downloadOutputs: true,
+   *     downloadDirectory: "outputs",
+   *   },
+   * );
+   * ```
+   */
+  async generate(request: GenerateRequest, opts: GenerateOptions = {}) {
+    const {
+      waitForCompletion = true,
+      downloadOutputs = true,
+      downloadDirectory = undefined,
+      ...createOpts
+    } = opts;
+
+    const createResponse = await this.create(request, createOpts);
+
+    getLogger().info(
+      `Created AiVoiceGeneratorClient project ${createResponse.id}`,
+    );
+
+    const projectsClient = new ImageProjectsClient(this._client, this._opts);
+
+    getLogger().debug(
+      `Checking result for AiVoiceGeneratorClient project ${createResponse.id}`,
+    );
+
+    const result = await projectsClient.checkResult(
+      { id: createResponse.id },
+      {
+        waitForCompletion,
+        downloadOutputs,
+        downloadDirectory,
+        ...createOpts,
+      },
+    );
+
+    return result;
+  }
+
   /**
    * AI Voice Generator
    *

src/resources/v1/animation/README.md

@@ -4,6 +4,7 @@
 
 
 
+
 <!-- CUSTOM DOCS START -->
 ### Animation Generate Workflow <a name="generate"></a>
 

src/resources/v1/audio-projects/README.md

@@ -3,6 +3,7 @@
 ## Module Functions
 
 
+
 <!-- CUSTOM DOCS START -->
 
 ### Check results <a name="check-result"></a>
@@ -60,7 +61,7 @@ const res = await client.v1.audioProjects.delete({ id: "cuid-example" });
 
 ### Get audio details <a name="get"></a>
 
-Get the details of an audio project. The `downloads` field will be empty unless the audio was successfully rendered.
+Get the details of a audio project. The `downloads` field will be empty unless the audio was successfully rendered.
 
 The audio can be one of the following status
 - `draft` - not currently used

src/resources/v1/audio-projects/resource-client.ts

@@ -142,7 +142,7 @@ export class AudioProjectsClient extends CoreResourceClient {
   /**
    * Get audio details
    *
-   * Get the details of an audio project. The `downloads` field will be empty unless the audio was successfully rendered.
+   * Get the details of a audio project. The `downloads` field will be empty unless the audio was successfully rendered.
    *
    * The audio can be one of the following status
    * - `draft` - not currently used