@rendobar/sdk 5.1.0 → 5.2.0

package/dist/index.d.mts

@@ -2163,13 +2163,13 @@ declare const jobStepSchema: ZodObject<{
  * treating the file as opaque ("other"). Adding a value here is non-breaking.
  */
 declare const fileTypeSchema: ZodEnum<{
-  video: "video";
-  image: "image";
   audio: "audio";
   captions: "captions";
-  playlist: "playlist";
   data: "data";
+  image: "image";
   other: "other";
+  playlist: "playlist";
+  video: "video";
 }>;
 /**
  * A single produced file. `url` is a ready-to-fetch, time-limited URL (signed
@@ -2181,13 +2181,13 @@ declare const fileSchema: ZodObject<{
   url: ZodString;
   path: ZodString;
   type: ZodEnum<{
-    video: "video";
-    image: "image";
     audio: "audio";
     captions: "captions";
-    playlist: "playlist";
     data: "data";
+    image: "image";
     other: "other";
+    playlist: "playlist";
+    video: "video";
   }>;
   size: ZodNumber;
   meta: ZodOptional<ZodObject<{
@@ -2195,6 +2195,7 @@ declare const fileSchema: ZodObject<{
     width: ZodOptional<ZodNumber>;
     height: ZodOptional<ZodNumber>;
     durationMs: ZodOptional<ZodNumber>;
+    seed: ZodOptional<ZodNumber>;
   }, $strip>>;
 }, $strip>;
 declare const jobOutputSchema: ZodObject<{
@@ -2203,13 +2204,13 @@ declare const jobOutputSchema: ZodObject<{
     url: ZodString;
     path: ZodString;
     type: ZodEnum<{
-      video: "video";
-      image: "image";
       audio: "audio";
       captions: "captions";
-      playlist: "playlist";
       data: "data";
+      image: "image";
       other: "other";
+      playlist: "playlist";
+      video: "video";
     }>;
     size: ZodNumber;
     meta: ZodOptional<ZodObject<{
@@ -2217,19 +2218,20 @@ declare const jobOutputSchema: ZodObject<{
       width: ZodOptional<ZodNumber>;
       height: ZodOptional<ZodNumber>;
       durationMs: ZodOptional<ZodNumber>;
+      seed: ZodOptional<ZodNumber>;
     }, $strip>>;
   }, $strip>>;
   files: ZodArray<ZodObject<{
     url: ZodString;
     path: ZodString;
     type: ZodEnum<{
-      video: "video";
-      image: "image";
       audio: "audio";
       captions: "captions";
-      playlist: "playlist";
       data: "data";
+      image: "image";
       other: "other";
+      playlist: "playlist";
+      video: "video";
     }>;
     size: ZodNumber;
     meta: ZodOptional<ZodObject<{
@@ -2237,6 +2239,7 @@ declare const jobOutputSchema: ZodObject<{
       width: ZodOptional<ZodNumber>;
       height: ZodOptional<ZodNumber>;
       durationMs: ZodOptional<ZodNumber>;
+      seed: ZodOptional<ZodNumber>;
     }, $strip>>;
   }, $strip>>;
   expiresAt: ZodNullable<ZodNumber>;
@@ -2247,9 +2250,9 @@ declare const jobErrorSchema: ZodObject<{
   detail: ZodNullable<ZodString>;
   retryable: ZodBoolean;
   failedPhase: ZodOptional<ZodEnum<{
+    finalizing: "finalizing";
     preparing: "preparing";
     processing: "processing";
-    finalizing: "finalizing";
   }>>;
 }, $strip>;
 declare const jobCostSchema: ZodObject<{
@@ -2274,12 +2277,12 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
     formatted: ZodString;
   }, $strip>>;
   outputCategory: ZodEnum<{
-    video: "video";
-    image: "image";
     audio: "audio";
     captions: "captions";
+    image: "image";
     json: "json";
     raw: "raw";
+    video: "video";
   }>;
   steps: ZodArray<ZodObject<{
     id: ZodString;
@@ -2301,11 +2304,13 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
   completedAt: ZodNullable<ZodNumber>;
   settledAt: ZodNullable<ZodNumber>;
   retentionExpiresAt: ZodNullable<ZodNumber>;
+  webUrl: ZodString;
+  model: ZodNullable<ZodString>;
   callback: ZodOptional<ZodNullable<ZodObject<{
     status: ZodEnum<{
-      pending: "pending";
       delivered: "delivered";
       failed: "failed";
+      pending: "pending";
     }>;
   }, $strip>>>;
   status: ZodLiteral<"waiting">;
@@ -2326,12 +2331,12 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
     formatted: ZodString;
   }, $strip>>;
   outputCategory: ZodEnum<{
-    video: "video";
-    image: "image";
     audio: "audio";
     captions: "captions";
+    image: "image";
     json: "json";
     raw: "raw";
+    video: "video";
   }>;
   steps: ZodArray<ZodObject<{
     id: ZodString;
@@ -2353,11 +2358,13 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
   completedAt: ZodNullable<ZodNumber>;
   settledAt: ZodNullable<ZodNumber>;
   retentionExpiresAt: ZodNullable<ZodNumber>;
+  webUrl: ZodString;
+  model: ZodNullable<ZodString>;
   callback: ZodOptional<ZodNullable<ZodObject<{
     status: ZodEnum<{
-      pending: "pending";
       delivered: "delivered";
       failed: "failed";
+      pending: "pending";
     }>;
   }, $strip>>>;
   status: ZodLiteral<"dispatched">;
@@ -2380,12 +2387,12 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
     formatted: ZodString;
   }, $strip>>;
   outputCategory: ZodEnum<{
-    video: "video";
-    image: "image";
     audio: "audio";
     captions: "captions";
+    image: "image";
     json: "json";
     raw: "raw";
+    video: "video";
   }>;
   steps: ZodArray<ZodObject<{
     id: ZodString;
@@ -2407,11 +2414,13 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
   completedAt: ZodNullable<ZodNumber>;
   settledAt: ZodNullable<ZodNumber>;
   retentionExpiresAt: ZodNullable<ZodNumber>;
+  webUrl: ZodString;
+  model: ZodNullable<ZodString>;
   callback: ZodOptional<ZodNullable<ZodObject<{
     status: ZodEnum<{
-      pending: "pending";
       delivered: "delivered";
       failed: "failed";
+      pending: "pending";
     }>;
   }, $strip>>>;
   status: ZodLiteral<"running">;
@@ -2434,12 +2443,12 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
     formatted: ZodString;
   }, $strip>>;
   outputCategory: ZodEnum<{
-    video: "video";
-    image: "image";
     audio: "audio";
     captions: "captions";
+    image: "image";
     json: "json";
     raw: "raw";
+    video: "video";
   }>;
   steps: ZodArray<ZodObject<{
     id: ZodString;
@@ -2461,11 +2470,13 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
   completedAt: ZodNullable<ZodNumber>;
   settledAt: ZodNullable<ZodNumber>;
   retentionExpiresAt: ZodNullable<ZodNumber>;
+  webUrl: ZodString;
+  model: ZodNullable<ZodString>;
   callback: ZodOptional<ZodNullable<ZodObject<{
     status: ZodEnum<{
-      pending: "pending";
       delivered: "delivered";
       failed: "failed";
+      pending: "pending";
     }>;
   }, $strip>>>;
   status: ZodLiteral<"complete">;
@@ -2475,13 +2486,13 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
       url: ZodString;
       path: ZodString;
       type: ZodEnum<{
-        video: "video";
-        image: "image";
         audio: "audio";
         captions: "captions";
-        playlist: "playlist";
         data: "data";
+        image: "image";
         other: "other";
+        playlist: "playlist";
+        video: "video";
       }>;
       size: ZodNumber;
       meta: ZodOptional<ZodObject<{
@@ -2489,19 +2500,20 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
         width: ZodOptional<ZodNumber>;
         height: ZodOptional<ZodNumber>;
         durationMs: ZodOptional<ZodNumber>;
+        seed: ZodOptional<ZodNumber>;
       }, $strip>>;
     }, $strip>>;
     files: ZodArray<ZodObject<{
       url: ZodString;
       path: ZodString;
       type: ZodEnum<{
-        video: "video";
-        image: "image";
         audio: "audio";
         captions: "captions";
-        playlist: "playlist";
         data: "data";
+        image: "image";
         other: "other";
+        playlist: "playlist";
+        video: "video";
       }>;
       size: ZodNumber;
       meta: ZodOptional<ZodObject<{
@@ -2509,6 +2521,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
         width: ZodOptional<ZodNumber>;
         height: ZodOptional<ZodNumber>;
         durationMs: ZodOptional<ZodNumber>;
+        seed: ZodOptional<ZodNumber>;
       }, $strip>>;
     }, $strip>>;
     expiresAt: ZodNullable<ZodNumber>;
@@ -2530,12 +2543,12 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
     formatted: ZodString;
   }, $strip>>;
   outputCategory: ZodEnum<{
-    video: "video";
-    image: "image";
     audio: "audio";
     captions: "captions";
+    image: "image";
     json: "json";
     raw: "raw";
+    video: "video";
   }>;
   steps: ZodArray<ZodObject<{
     id: ZodString;
@@ -2557,11 +2570,13 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
   completedAt: ZodNullable<ZodNumber>;
   settledAt: ZodNullable<ZodNumber>;
   retentionExpiresAt: ZodNullable<ZodNumber>;
+  webUrl: ZodString;
+  model: ZodNullable<ZodString>;
   callback: ZodOptional<ZodNullable<ZodObject<{
     status: ZodEnum<{
-      pending: "pending";
       delivered: "delivered";
       failed: "failed";
+      pending: "pending";
     }>;
   }, $strip>>>;
   status: ZodLiteral<"failed">;
@@ -2571,9 +2586,9 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
     detail: ZodNullable<ZodString>;
     retryable: ZodBoolean;
     failedPhase: ZodOptional<ZodEnum<{
+      finalizing: "finalizing";
       preparing: "preparing";
       processing: "processing";
-      finalizing: "finalizing";
     }>>;
   }, $strip>;
 }, $strip>, ZodObject<{
@@ -2593,12 +2608,12 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
     formatted: ZodString;
   }, $strip>>;
   outputCategory: ZodEnum<{
-    video: "video";
-    image: "image";
     audio: "audio";
     captions: "captions";
+    image: "image";
     json: "json";
     raw: "raw";
+    video: "video";
   }>;
   steps: ZodArray<ZodObject<{
     id: ZodString;
@@ -2620,11 +2635,13 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
   completedAt: ZodNullable<ZodNumber>;
   settledAt: ZodNullable<ZodNumber>;
   retentionExpiresAt: ZodNullable<ZodNumber>;
+  webUrl: ZodString;
+  model: ZodNullable<ZodString>;
   callback: ZodOptional<ZodNullable<ZodObject<{
     status: ZodEnum<{
-      pending: "pending";
       delivered: "delivered";
       failed: "failed";
+      pending: "pending";
     }>;
   }, $strip>>>;
   status: ZodLiteral<"cancelled">;
@@ -2764,10 +2781,10 @@ declare const webhookDeliverySchema: ZodObject<{
   event: ZodString;
   payload: ZodString;
   status: ZodEnum<{
-    pending: "pending";
+    cancelled: "cancelled";
     delivered: "delivered";
     failed: "failed";
-    cancelled: "cancelled";
+    pending: "pending";
   }>;
   statusCode: ZodNullable<ZodNumber>;
   responseBody: ZodNullable<ZodString>;
@@ -3024,9 +3041,9 @@ declare const orgEventSchema: ZodDiscriminatedUnion<[ZodObject<{
   timestamp: ZodNumber;
   progress: ZodNullable<ZodNumber>;
   phase: ZodOptional<ZodEnum<{
+    finalizing: "finalizing";
     preparing: "preparing";
     processing: "processing";
-    finalizing: "finalizing";
   }>>;
   step: ZodString;
   stepProgress: ZodOptional<ZodNumber>;
@@ -3083,10 +3100,10 @@ declare const orgEventSchema: ZodDiscriminatedUnion<[ZodObject<{
   jobId: ZodString;
   timestamp: ZodOptional<ZodNumber>;
   level: ZodEnum<{
+    debug: "debug";
     error: "error";
     info: "info";
     warn: "warn";
-    debug: "debug";
   }>;
   message: ZodString;
   step: ZodOptional<ZodString>;
@@ -3332,6 +3349,7 @@ declare function createClient(config?: ClientConfig): {
     }) => Promise<JobListPage>;
     listAll: (params?: Omit<ListJobsParams, "offset">) => AsyncGenerator<JobResponse>;
     wait: (id: string, options?: WaitOptions) => Promise<JobResponse>;
+    run: (params: CreateJobParams, options?: WaitOptions) => Promise<JobResponse>;
     cancel: (id: string, options?: {
       signal?: AbortSignal;
     }) => Promise<JobResponse>;
@@ -3500,7 +3518,7 @@ declare function createClient(config?: ClientConfig): {
       signal?: AbortSignal;
     }): Promise<void>;
     getSettings(options?: {
-      signal? /** Custom fetch function for testing or special runtimes. */ : AbortSignal;
+      signal?: AbortSignal;
     }): Promise<OrgSettings>;
     updateSettings(body: Partial<Pick<OrgSettings, "billingEmailsEnabled" | "defaultRegion" | "regionPinned">>, options?: {
       signal?: AbortSignal;
@@ -3678,6 +3696,61 @@ interface FfmpegParams {
   compute?: "auto" | "cpu" | "gpu";
 }
 //#endregion
+//#region src/jobs/image.d.ts
+/**
+ * Public params types for the `image.generate` and `image.edit` jobs.
+ *
+ * Declared as plain interfaces here (rather than re-exported from
+ * `@rendobar/shared`) for the same reason as `FfmpegParams` in `./ffmpeg.js`:
+ * the SDK's dts bundler must not follow the shared package's job-registry
+ * type graph — that graph pulls the full generation model catalog into the
+ * .d.ts output and causes tsdown to OOM.
+ *
+ * The canonical runtime shape is the discriminated Zod unions in
+ * `packages/shared/src/jobs/definitions/image-generate.job.ts` and
+ * `image-edit.job.ts` (built from `GEN_BASE_PARAMS` in
+ * `packages/shared/src/jobs/gen-registry.ts`) — keep these interfaces in
+ * sync with them. Both jobs share the same base field set. The per-model
+ * extras (`negativePrompt`, `guidance`, `steps`) are offered here as
+ * optional on every model rather than reproduced as the catalog's per-model
+ * discriminated union, so the SDK doesn't have to track which model
+ * supports which knob — the API validates against the real per-model schema
+ * and rejects a field the resolved model doesn't support.
+ */
+/**
+ * Tier alias for a generation model. `"economy"` is the default when `model`
+ * is omitted. Pin an exact model id (e.g. `"qwen-image-2512"`) instead of a
+ * tier to reach that model's own controls.
+ */
+type GenModelTier = "economy" | "standard" | "premium";
+interface ImageGenBaseParams {
+  /** Tier alias or exact model id. Defaults to the "economy" tier when omitted. */
+  model?: GenModelTier | string;
+  /** What you want. For image.edit, describe the change to make. Plain language, no special syntax. */
+  prompt: string;
+  /** Requested output width in pixels. Snapped to what the model can render. */
+  width?: number;
+  /** Requested output height in pixels. Snapped to what the model can render. */
+  height?: number;
+  /** Fixed seed for a reproducible result. The seed used is echoed back. */
+  seed?: number;
+  /** What to keep out of the image. Only some models support this. */
+  negativePrompt?: string;
+  /** How strictly to follow the prompt. Higher is stricter. Only some models support this. */
+  guidance?: number;
+  /** Denoise steps. More steps means more detail and more time. Range depends on the resolved model. */
+  steps?: number;
+  /** Rewrite the prompt for the model before generating. Defaults per model; omit to keep the model's default. */
+  enhancePrompt?: boolean;
+}
+/** Public params type for the `image.generate` job. */
+interface ImageGenerateParams extends ImageGenBaseParams {}
+/**
+ * Public params type for the `image.edit` job. Reference images (1-4) are
+ * passed as job `inputs.images`, not here — see `CreateJobParams.inputs`.
+ */
+interface ImageEditParams extends ImageGenBaseParams {}
+//#endregion
 //#region src/resources/jobs.d.ts
 type CreateJobParams = {
   type: string;
@@ -3852,4 +3925,4 @@ type AssetListPage = {
   meta: AssetListMeta;
 };
 //#endregion
-export { ApiError, type ApiKey, type AssetResponse as Asset, type AssetDownloadResponse, type AssetInitResponse, type AssetListMeta, type AssetListPage, type BalanceDepletedData, type BalanceLowData, type BillingInvoice, type BillingState, type ClientConfig, type Cost, type CreateJobParams, type CreateUploadOptions, type CreateWebhookParams, type FfmpegParams, type FileType, type JobResponse as Job, type JobCancelledData, type JobCompletedData, type JobCreatedData, type JobCreatedResponse, type JobError, type JobFailedData, JobFailedError, type JobListPage, type JobStartedData, type JobStats, type JobStep, type JobSubscribeOptions, type JobSubscription, type JobTimings, type JobType, type ListAssetsParams, type ListDeliveriesParams, type ListJobsParams, type LogEntryData, type OrgCurrentResponse, type OrgEvent, type OrgSettings, type Organization, type Output, type OutputFile, type PaginationMeta, type PaymentMethod, type RealtimeConnectOptions, type RealtimeConnection, type RendobarClient, type RetryDeliveryResult, type StatsParams, type TestEventData, type Transaction, type TransactionListParams, type UpdateWebhookParams, type UploadProgress, type UsageParams, type UsageSummary, type WaitOptions, WaitTimeoutError, type WebhookDelivery, type WebhookEndpoint, type WebhookEventDataMap, type WebhookPayload, createClient, isApiError, jobData, outputUrl };
+export { ApiError, type ApiKey, type AssetResponse as Asset, type AssetDownloadResponse, type AssetInitResponse, type AssetListMeta, type AssetListPage, type BalanceDepletedData, type BalanceLowData, type BillingInvoice, type BillingState, type ClientConfig, type Cost, type CreateJobParams, type CreateUploadOptions, type CreateWebhookParams, type FfmpegParams, type FileType, type GenModelTier, type ImageEditParams, type ImageGenerateParams, type JobResponse as Job, type JobCancelledData, type JobCompletedData, type JobCreatedData, type JobCreatedResponse, type JobError, type JobFailedData, JobFailedError, type JobListPage, type JobStartedData, type JobStats, type JobStep, type JobSubscribeOptions, type JobSubscription, type JobTimings, type JobType, type ListAssetsParams, type ListDeliveriesParams, type ListJobsParams, type LogEntryData, type OrgCurrentResponse, type OrgEvent, type OrgSettings, type Organization, type Output, type OutputFile, type PaginationMeta, type PaymentMethod, type RealtimeConnectOptions, type RealtimeConnection, type RendobarClient, type RetryDeliveryResult, type StatsParams, type TestEventData, type Transaction, type TransactionListParams, type UpdateWebhookParams, type UploadProgress, type UsageParams, type UsageSummary, type WaitOptions, WaitTimeoutError, type WebhookDelivery, type WebhookEndpoint, type WebhookEventDataMap, type WebhookPayload, createClient, isApiError, jobData, outputUrl };

package/dist/index.mjs

@@ -208,6 +208,25 @@ function createJobsResource(request) {
 			signal: options?.signal
 		});
 	}
+	/**
+	* Create a job and wait for it to reach a terminal state, returning the
+	* finished job. A convenience wrapper over `create()` + `wait()` for
+	* callers who just want the result without juggling two calls — works for
+	* any job type, not just a specific product.
+	*
+	* Unlike `wait()` (which defaults `throwOnFailure` to `false` to preserve
+	* its existing behavior), `run()` defaults `throwOnFailure` to `true`: a
+	* job that ends "failed" or "cancelled" throws `JobFailedError` unless the
+	* caller explicitly opts out with `throwOnFailure: false`.
+	*/
+	async function run(params, options = {}) {
+		const { signal, throwOnFailure = true, ...waitOptions } = options;
+		return wait((await create(params, { signal })).id, {
+			...waitOptions,
+			signal,
+			throwOnFailure
+		});
+	}
 	async function get(id, options) {
 		return request(`/jobs/${id}`, { signal: options?.signal });
 	}
@@ -264,6 +283,7 @@ function createJobsResource(request) {
 		list,
 		listAll,
 		wait,
+		run,
 		cancel,
 		download,
 		logs,

package/package.json

@@ -1,8 +1,29 @@
 {
   "name": "@rendobar/sdk",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "type": "module",
   "description": "TypeScript client for the Rendobar media processing API",
+  "license": "MIT",
+  "homepage": "https://rendobar.com/docs/sdk",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rendobar/rendobar.git",
+    "directory": "packages/sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/rendobar/rendobar/issues"
+  },
+  "author": "Rendobar",
+  "keywords": [
+    "rendobar",
+    "ffmpeg",
+    "video",
+    "media-processing",
+    "transcode",
+    "api-client",
+    "sdk",
+    "typescript"
+  ],
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",
@@ -41,9 +62,10 @@
     "partysocket": "^1.1.16"
   },
   "devDependencies": {
+    "@types/node": "^25",
     "@rendobar/shared": "workspace:*",
     "tsdown": "^0.22.0",
-    "typescript": "^5.9.3",
+    "typescript": "^7.0.2",
     "vitest": "^4.0.18"
   }
 }