diffio 0.1.78 → 0.1.80

package/README.md

@@ -77,7 +77,11 @@ retrying after an uncertain response.
 
 `waitForGeneration` and `generations.waitForComplete` wait for the overall `status` to become
 `complete`. Individual stages reaching 100% or `complete` do not end polling while video publication
-or usage settlement is still pending.
+or usage settlement is still pending. For Diffio 2.0, `complete` means restored media is ready;
+transcription can still be `pending`, become `available` later, or finish as `unavailable`.
+Read `progress.transcription?.status` independently. Older responses omit `transcription`;
+absence does not establish availability. Unavailable transcription does not fail completed
+Diffio 2.0 media. Diffio 3.5 requires its transcript before restoration can complete.
 
 ## Audio isolation helper
 
@@ -136,6 +140,7 @@ const progress = await client.generations.getProgress({
 });
 
 console.log(progress.status);
+console.log(progress.transcription?.status ?? "not reported");
 ```
 
 ## Generation download
@@ -153,16 +158,43 @@ const download = await client.generations.getDownload({
 console.log(download.downloadUrl);
 ```
 
-Set `downloadType` to `"transcript"` to fetch the transcript JSON artifact when the generation has one.
+Set `downloadType` to `"transcript"` to fetch the transcript JSON artifact when available.
+Pending transcripts raise `DiffioApiError` with `statusCode === 409` and error code
+`TRANSCRIPT_PENDING`. Unavailable transcripts return `404` with `TRANSCRIPT_UNAVAILABLE`.
+The `responseBody` also includes `transcription.status`. Check the error code to distinguish
+these from other 409 or 404 errors.
 
 ```ts
-const transcript = await client.generations.getDownload({
-  generationId: "gen_123",
-  apiProjectId: "proj_123",
-  downloadType: "transcript"
-});
+import { DiffioApiError } from "diffio";
+
+try {
+  const transcript = await client.generations.getDownload({
+    generationId: "gen_123",
+    apiProjectId: "proj_123",
+    downloadType: "transcript"
+  });
+  console.log(transcript.downloadUrl);
+} catch (error) {
+  if (!(error instanceof DiffioApiError)) throw error;
+  const body = error.responseBody;
+  const code = body && typeof body === "object" && "code" in body ? body.code : undefined;
+  if (error.statusCode === 409 && code === "TRANSCRIPT_PENDING") {
+    console.log("Transcript pending; check progress and retry later.");
+  } else if (error.statusCode === 404 && code === "TRANSCRIPT_UNAVAILABLE") {
+    console.log("Transcript unavailable; restored media remains available.");
+  } else {
+    throw error;
+  }
+}
 ```
 
+`restoreAudio` with `downloadType: "transcript"` also attempts a transcript download after
+media completion. It does not wait for pending transcription. With the default `raiseOnError: false`,
+it returns `[null, info]` and preserves `info.statusCode` and `info.responseBody`; `info.status`
+can still be `complete` because media restoration succeeded. With `raiseOnError: true`, it throws
+`DiffioApiError` and attaches metadata as `error.restoreInfo`. Poll progress and retry the download
+explicitly for the same generation. Audio and video downloads proceed independently of transcription.
+
 ## Account, keys, usage, and webhook configuration
 
 Agent keys can manage account settings, scoped keys, usage, and webhook endpoints.
@@ -227,6 +259,11 @@ console.log(event.svixMessageId);
 
 Use the raw request body (not parsed JSON) plus the `svix-*` headers and your webhook signing secret.
 
+Verified events expose the same optional `event.transcription` object as generation progress.
+A Diffio 2.0 `generation.completed` event can report `pending` or `unavailable` transcription.
+Later transcript publication does not emit another completion event; poll progress when you need
+to follow a pending transcript. Older events can omit `transcription`.
+
 ```ts
 import express from "express";
 import { DiffioClient } from "diffio";

package/dist/Client.d.ts

@@ -47,7 +47,7 @@ export declare class DiffioClient {
         apiProjectId?: string;
         requestOptions?: DiffioClient.RequestOptions;
     }): Promise<GenerationProgressResponse>;
-    /** Waits for the authoritative overall status, including artifact publication and settlement. */
+    /** Waits for media completion and settlement. Diffio 2.0 transcription may still be pending or unavailable. */
     waitForGeneration(options: {
         generationId: string;
         apiProjectId?: string;

package/dist/Client.js

@@ -182,7 +182,7 @@ class DiffioClient {
         const response = await this._requestJson("POST", "get_generation_progress", payload, requestOptions);
         return (0, serialization_1.parseGenerationProgressResponse)(response);
     }
-    /** Waits for the authoritative overall status, including artifact publication and settlement. */
+    /** Waits for media completion and settlement. Diffio 2.0 transcription may still be pending or unavailable. */
     async waitForGeneration(options) {
         const { generationId, apiProjectId, pollInterval = 2, timeout, timeoutInSeconds, onProgress, showProgress, requestOptions } = options;
         const timeoutSeconds = timeoutInSeconds ?? timeout ?? DEFAULT_TIMEOUT_SECONDS;
@@ -739,6 +739,10 @@ function setRestoreError(metadata, error) {
     metadata.error = message;
     metadata.exceptionType = error instanceof Error ? error.name : typeof error;
     metadata.exceptionMessage = message;
+    if (error instanceof errors_1.DiffioApiError) {
+        metadata.statusCode = error.statusCode;
+        metadata.responseBody = error.responseBody;
+    }
 }
 function attachRestoreMetadata(error, metadata) {
     if (error && typeof error === "object") {

package/dist/api/resources/audioIsolation/client/Client.d.ts

@@ -1,5 +1,5 @@
 import type { DiffioClient } from "../../../../Client";
-import type { AudioIsolationResult, ModelKey, RestoreMetadata } from "../../../types";
+import type { AudioIsolationResult, GenerationProgressResponse, ModelKey, RestoreMetadata } from "../../../types";
 export interface AudioIsolationRestoreOptions {
     filePath: string;
     contentType?: string;
@@ -14,7 +14,7 @@ export interface AudioIsolationRestoreOptions {
     pollInterval?: number;
     timeout?: number;
     timeoutInSeconds?: number;
-    onProgress?: (progress: unknown) => void | Promise<void>;
+    onProgress?: (progress: GenerationProgressResponse) => void | Promise<void>;
     showProgress?: boolean;
     requestOptions?: DiffioClient.RequestOptions;
     progressRequestOptions?: DiffioClient.RequestOptions;

package/dist/api/serialization.js

@@ -85,6 +85,7 @@ function parseGenerationProgressStage(data) {
 }
 function parseGenerationProgressResponse(data) {
     const restoredVideo = data?.restoredVideo;
+    const transcription = parseGenerationTranscription(data?.transcription);
     return {
         generationId: data.generationId,
         apiProjectId: data.apiProjectId,
@@ -93,6 +94,7 @@ function parseGenerationProgressResponse(data) {
         preProcessing: parseGenerationProgressStage(data.preProcessing),
         inference: parseGenerationProgressStage(data.inference),
         restoredVideo: restoredVideo ? parseGenerationProgressStage(restoredVideo) : null,
+        ...(transcription ? { transcription } : {}),
         error: data.error ?? null,
         errorDetails: data.errorDetails ?? null
     };
@@ -157,6 +159,7 @@ function parseWebhookConfigureResponse(data) {
     };
 }
 function parseGenerationWebhookEvent(data) {
+    const transcription = parseGenerationTranscription(data?.transcription);
     return {
         eventType: data.eventType,
         eventId: data.eventId,
@@ -167,10 +170,21 @@ function parseGenerationWebhookEvent(data) {
         status: data.status,
         hasVideo: data.hasVideo ?? null,
         modelKey: data.modelKey ?? null,
+        ...(transcription ? { transcription } : {}),
         error: data.error ?? null,
         errorDetails: data.errorDetails ?? null
     };
 }
+function parseGenerationTranscription(data) {
+    if (data == null || typeof data !== "object" || !("status" in data)) {
+        return undefined;
+    }
+    const { status } = data;
+    if (status === "pending" || status === "available" || status === "unavailable") {
+        return { status };
+    }
+    return undefined;
+}
 function createAudioIsolationResult(project, generation) {
     return { project, generation };
 }

package/dist/api/types.d.ts

@@ -3,6 +3,10 @@ export type DownloadType = "audio" | "video" | "transcript";
 export type WebhookMode = "test" | "live";
 export type WebhookEventType = "generation.queued" | "generation.processing" | "generation.failed" | "generation.completed";
 export type GenerationWebhookStatus = "queued" | "processing" | "error" | "complete";
+export type TranscriptionStatus = "pending" | "available" | "unavailable";
+export interface GenerationTranscription {
+    status: TranscriptionStatus;
+}
 export interface CreateProjectResponse {
     apiProjectId: string;
     uploadUrl: string;
@@ -60,6 +64,8 @@ export interface GenerationProgressResponse {
     preProcessing: GenerationProgressStage;
     inference: GenerationProgressStage;
     restoredVideo?: GenerationProgressStage | null;
+    /** Independent of media completion; omitted by older API versions. */
+    transcription?: GenerationTranscription;
     error?: string | null;
     errorDetails?: string | null;
 }
@@ -123,6 +129,8 @@ export interface GenerationWebhookEvent {
     status: GenerationWebhookStatus | string;
     hasVideo?: boolean | null;
     modelKey?: ModelKey | string | null;
+    /** A completed Diffio 2.0 generation may still have a pending or unavailable transcript. */
+    transcription?: GenerationTranscription;
     error?: string | null;
     errorDetails?: string | null;
 }
@@ -144,4 +152,7 @@ export interface RestoreMetadata {
     errorDetails: string | null;
     exceptionType: string | null;
     exceptionMessage: string | null;
+    /** HTTP error details retained when a restore helper returns instead of throwing. */
+    statusCode?: number;
+    responseBody?: unknown;
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const DIFFIO_SDK_VERSION = "0.1.78";
+export declare const DIFFIO_SDK_VERSION = "0.1.80";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DIFFIO_SDK_VERSION = void 0;
-exports.DIFFIO_SDK_VERSION = "0.1.78";
+exports.DIFFIO_SDK_VERSION = "0.1.80";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "diffio",
-  "version": "0.1.78",
+  "version": "0.1.80",
   "description": "Diffio API client for Node.js",
   "repository": {
     "type": "git",