@rendobar/sdk 1.0.0 → 2.1.0

package/README.md

@@ -99,6 +99,44 @@ const logs = await client.jobs.logs("job_abc");
 const types = await client.jobs.types();
 ```
 
+## Raw FFmpeg
+
+Run arbitrary FFmpeg commands in a sandboxed container. Commands are parsed, sanitized (protocol whitelist/blacklist flags blocked), and executed with a clean process environment.
+
+Put input URLs directly in `-i` positions — they're extracted automatically and staged via presigned R2 URLs before execution:
+
+```ts
+import { createClient } from "@rendobar/sdk";
+
+const client = createClient({ apiKey: process.env.RENDOBAR_API_KEY });
+
+const job = await client.jobs.create({
+  type: "ffmpeg",
+  params: {
+    command:
+      "ffmpeg -i https://cdn.example.com/source.mp4 " +
+      "-vf scale=1280:720 -c:v libx264 -crf 23 output.mp4",
+  },
+});
+
+const done = await client.jobs.wait(job.id);
+console.log(done.outputUrl);
+```
+
+Prefer named inputs? Pass them in the top-level `inputs` map and reference the keys in the command:
+
+```ts
+await client.jobs.create({
+  type: "ffmpeg",
+  inputs: { source: "https://cdn.example.com/source.mp4" },
+  params: { command: "ffmpeg -i source -vf scale=1280:720 output.mp4" },
+});
+```
+
+Need a typed params object? Import `FfmpegParams` — optional fields (`outputFormat`, `timeout`) have server-side defaults.
+
+See the [FFmpeg guide](https://rendobar.com/docs/guides/ffmpeg) for the full security model and supported flags.
+
 ## Billing
 
 ```typescript

package/dist/index.cjs

@@ -214,6 +214,9 @@ function createJobsResource(request) {
 		async logs(id, options) {
 			return request(`/jobs/${id}/logs`, { signal: options?.signal });
 		},
+		async getTimings(id, options) {
+			return request(`/jobs/${id}/timings`, { signal: options?.signal });
+		},
 		async types(options) {
 			return request("/jobs/types", { signal: options?.signal });
 		}
@@ -385,6 +388,13 @@ function createApiKeysResource(request) {
 				method: "DELETE",
 				signal: options?.signal
 			});
+		},
+		async update(id, params, options) {
+			return request(`/api-keys/${id}`, {
+				method: "PATCH",
+				body: params,
+				signal: options?.signal
+			});
 		}
 	};
 }

package/dist/index.d.cts

@@ -2114,11 +2114,11 @@ declare const jobResponseSchema: ZodObject<{
   orgId: ZodString;
   type: ZodString;
   status: ZodString;
-  aiPattern: ZodNullable<ZodString>;
   inputs: ZodRecord<ZodString, ZodUnknown>;
   params: ZodRecord<ZodString, ZodUnknown>;
   outputRef: ZodNullable<ZodString>;
   outputUrl: ZodNullable<ZodString>;
+  posterUrl: ZodNullable<ZodString>;
   outputMeta: ZodNullable<ZodRecord<ZodString, ZodUnknown>>;
   errorCode: ZodNullable<ZodString>;
   errorMessage: ZodNullable<ZodString>;
@@ -2147,18 +2147,7 @@ declare const jobResponseSchema: ZodObject<{
   logsAvailable: ZodBoolean;
   providerType: ZodNullable<ZodString>;
   providerRunId: ZodNullable<ZodString>;
-  apiTotalMs: ZodNullable<ZodNumber>;
-  apiPrechecksMs: ZodNullable<ZodNumber>;
-  apiValidationMs: ZodNullable<ZodNumber>;
-  apiDbInsertMs: ZodNullable<ZodNumber>;
-  apiDispatchMs: ZodNullable<ZodNumber>;
-  execDownloadMs: ZodNullable<ZodNumber>;
-  execExecuteMs: ZodNullable<ZodNumber>;
-  execUploadMs: ZodNullable<ZodNumber>;
-  queueWaitMs: ZodNullable<ZodNumber>;
-  consumerTotalMs: ZodNullable<ZodNumber>;
   settledAt: ZodNullable<ZodNumber>;
-  execTotalMs: ZodNullable<ZodNumber>;
 }, $strip>;
 declare const jobCreatedResponseSchema: ZodObject<{
   id: ZodString;
@@ -2286,6 +2275,7 @@ declare const apiKeySchema: ZodObject<{
   id: ZodString;
   name: ZodString;
   prefix: ZodString;
+  enabled: ZodBoolean;
   createdAt: ZodNumber;
   lastUsedAt: ZodNullable<ZodNumber>;
   expiresAt: ZodNullable<ZodNumber>;
@@ -2436,6 +2426,28 @@ interface LogEntryData {
   meta?: Record<string, unknown>;
 }
 //#endregion
+//#region src/types.d.ts
+/**
+ * Per-job execution timing breakdown. Returned by `client.jobs.getTimings(id)`.
+ *
+ * All values are milliseconds, or `null` if the corresponding stage did not
+ * execute (e.g. a sync-completed job has no executor or queue timings).
+ */
+interface JobTimings {
+  jobId: string;
+  apiTotalMs: number | null;
+  apiPrechecksMs: number | null;
+  apiValidationMs: number | null;
+  apiDbInsertMs: number | null;
+  apiDispatchMs: number | null;
+  execDownloadMs: number | null;
+  execExecuteMs: number | null;
+  execUploadMs: number | null;
+  execTotalMs: number | null;
+  queueWaitMs: number | null;
+  consumerTotalMs: number | null;
+}
+//#endregion
 //#region src/client.d.ts
 interface ClientConfig {
   /** API key (Bearer rb_...). Mutually exclusive with credentials. */
@@ -2479,6 +2491,9 @@ declare function createClient(config?: ClientConfig): {
     logs(id: string, options?: {
       signal?: AbortSignal;
     }): Promise<LogEntryData[]>;
+    getTimings(id: string, options?: {
+      signal?: AbortSignal;
+    }): Promise<JobTimings>;
     types(options?: {
       signal?: AbortSignal;
     }): Promise<JobType[]>;
@@ -2600,6 +2615,12 @@ declare function createClient(config?: ClientConfig): {
       id: string;
       revoked: boolean;
     }>;
+    update(id: string, params: {
+      name?: string;
+      enabled?: boolean;
+    }, options?: {
+      signal?: AbortSignal;
+    }): Promise<ApiKey>;
   };
   orgs: {
     list(options?: {
@@ -2734,6 +2755,30 @@ interface JobSubscription {
   unsubscribe: () => void;
 }
 //#endregion
+//#region src/jobs/ffmpeg.d.ts
+/**
+ * Public params type for the `ffmpeg` job.
+ *
+ * Declared as a plain interface here (rather than re-exported from
+ * `@rendobar/shared`) so the SDK's dts bundler does not have to follow
+ * the shared package's full job-registry type graph — that graph pulls
+ * pipelines, templates, and every job definition into the .d.ts output
+ * and causes tsdown to OOM.
+ *
+ * The canonical runtime shape is the Zod schema in
+ * `packages/shared/src/jobs/definitions/ffmpeg.job.ts` — keep this
+ * interface in sync with it. Optional fields match `.default(...)`
+ * semantics on the schema side.
+ */
+interface FfmpegParams {
+  /** FFmpeg command. The leading "ffmpeg" is stripped if present. */
+  command: string;
+  /** Output container/format. Inferred from the trailing filename if omitted. */
+  outputFormat?: "mp4" | "mkv" | "webm" | "mov" | "avi" | "ts" | "gif" | "png" | "jpg" | "mp3" | "wav" | "flac" | "ogg" | "aac" | "opus" | "m4a" | "srt" | "vtt";
+  /** Maximum execution time in seconds (1 - 900). Defaults to 120. */
+  timeout?: number;
+}
+//#endregion
 //#region src/resources/jobs.d.ts
 type CreateJobParams = {
   type: string;
@@ -2811,7 +2856,6 @@ type OrgCurrentResponse = {
   };
   balance: {
     balance: number;
-    rollover: number;
     balanceFormatted: string;
   };
 };
@@ -2847,5 +2891,5 @@ type Asset = {
   updatedAt: number;
 };
 //#endregion
-export { ApiError, type ApiKey, type Asset, type BatchResult, type BillingInvoice, type BillingState, type ClientConfig, type CreateJobParams, type CreateWebhookParams, type JobResponse as Job, type JobCreatedResponse, type JobListPage, type JobStep, type JobSubscribeOptions, type JobSubscription, type JobType, type ListDeliveriesParams, type ListJobsParams, type LogEntryData, type OrgCurrentResponse, type OrgEvent, type Organization, type PaginationMeta, type PaymentMethod, type RealtimeConnectOptions, type RealtimeConnection, type RendobarClient, type Transaction, type TransactionListParams, type UpdateWebhookParams, type UploadResult, type UsageParams, type UsageSummary, type WaitOptions, type WebhookDelivery, type WebhookEndpoint, createClient, isApiError };
+export { ApiError, type ApiKey, type Asset, type BatchResult, type BillingInvoice, type BillingState, type ClientConfig, type CreateJobParams, type CreateWebhookParams, type FfmpegParams, type JobResponse as Job, type JobCreatedResponse, type JobListPage, type JobStep, type JobSubscribeOptions, type JobSubscription, type JobTimings, type JobType, type ListDeliveriesParams, type ListJobsParams, type LogEntryData, type OrgCurrentResponse, type OrgEvent, type Organization, type PaginationMeta, type PaymentMethod, type RealtimeConnectOptions, type RealtimeConnection, type RendobarClient, type Transaction, type TransactionListParams, type UpdateWebhookParams, type UploadResult, type UsageParams, type UsageSummary, type WaitOptions, type WebhookDelivery, type WebhookEndpoint, createClient, isApiError };
 //# sourceMappingURL=index.d.cts.map