@transcodely/sdk 0.3.1 → 0.3.3

package/dist/index.mjs

@@ -5880,12 +5880,12 @@ var SubtitleTrack = class _SubtitleTrack extends Message {
   /**
    * Generate an AI chapters track from the transcript this track produces.
    *
-   * Only meaningful together with the (upcoming) `generate` subtitle operation:
-   * when enabled, an AI pass over the generated transcript produces a chapters
+   * Only meaningful together with the `generate` subtitle operation: when
+   * enabled, an AI pass over the generated transcript produces a chapters
    * track delivered as WebVTT plus JSON. Free — no pricing impact. The
    * transcript text is processed via the Anthropic API (an external
-   * subprocessor). Until the `generate` operation ships, setting this is
-   * rejected at job creation.
+   * subprocessor). Caption generation is available; the auto-chapters pass is
+   * not yet, so setting this is still rejected at job creation.
    *
    * @generated from field: optional bool generate_chapters = 12;
    */
@@ -6133,6 +6133,30 @@ var SubtitleResult = class _SubtitleResult extends Message {
    * @generated from field: string transcript_url = 10;
    */
   transcriptUrl = "";
+  /**
+   * Ready-to-fetch HTTPS URL for the caption file, signed and time-limited.
+   *
+   * Points at the same object as url, but as a CDN URL a browser or player can
+   * load — url is a raw storage URI ("s3://…") that no client can fetch.
+   * Present only for jobs writing to Transcodely-managed storage (an
+   * output_origin with provider "transcodely"); jobs writing to your own bucket
+   * get nothing here and should sign url with their own credentials.
+   *
+   * Emitted on single-job reads (Get, Watch) and never on List, and expires —
+   * 6 hours by default — so re-read the job for a fresh one rather than
+   * storing it.
+   *
+   * @generated from field: optional string signed_url = 11;
+   */
+  signedUrl;
+  /**
+   * Ready-to-fetch HTTPS URL for the segment transcript, signed and
+   * time-limited. Same rules and lifetime as signed_url; set only for generate
+   * tracks, which are the only ones carrying a transcript.
+   *
+   * @generated from field: optional string transcript_signed_url = 12;
+   */
+  transcriptSignedUrl;
   constructor(data) {
     super();
     proto3.util.initPartial(data, this);
@@ -6197,7 +6221,9 @@ var SubtitleResult = class _SubtitleResult extends Message {
       kind: "scalar",
       T: 9
       /* ScalarType.STRING */
-    }
+    },
+    { no: 11, name: "signed_url", kind: "scalar", T: 9, opt: true },
+    { no: 12, name: "transcript_signed_url", kind: "scalar", T: 9, opt: true }
   ]);
   static fromBinary(bytes, options) {
     return new _SubtitleResult().fromBinary(bytes, options);
@@ -6240,35 +6266,41 @@ var BYOKConfig = class _BYOKConfig extends Message {
   /**
    * Key identifier (32 hex characters).
    *
+   * The one BYOK field returned on reads. It names which key encrypted an
+   * output — the way an API key's prefix and last-4 name the key — so the
+   * key in use can be confirmed without keeping separate records.
+   *
    * @generated from field: string key_id = 1;
    */
   keyId = "";
   /**
    * Content encryption key (32 hex characters).
    *
+   * Write-only: encrypted at rest and never returned on any read.
+   *
    * @generated from field: string key = 2;
    */
   key = "";
   /**
-   * Widevine PSSH box (base64-encoded, optional).
+   * Widevine PSSH box (base64-encoded, optional). Write-only.
    *
    * @generated from field: optional string pssh_widevine = 3;
    */
   psshWidevine;
   /**
-   * PlayReady PSSH XML (optional).
+   * PlayReady PSSH XML (optional). Write-only.
    *
    * @generated from field: optional string pssh_playready = 4;
    */
   psshPlayready;
   /**
-   * FairPlay initialization vector (32 hex characters).
+   * FairPlay initialization vector (32 hex characters). Write-only.
    *
    * @generated from field: optional string fairplay_iv = 5;
    */
   fairplayIv;
   /**
-   * FairPlay key server URI (skd:// scheme).
+   * FairPlay key server URI (skd:// scheme). Write-only.
    *
    * @generated from field: optional string fairplay_uri = 6;
    */
@@ -6322,6 +6354,9 @@ var KeyServerConfig = class _KeyServerConfig extends Message {
   /**
    * Authentication token for the key server.
    *
+   * Write-only: encrypted at rest and never returned on any read. The other
+   * two fields of this message are echoed back normally.
+   *
    * @generated from field: optional string auth_token = 2;
    */
   authToken;
@@ -6377,6 +6412,9 @@ var DRMConfig = class _DRMConfig extends Message {
   /**
    * BYOK configuration (mutually exclusive with key_server).
    *
+   * On reads this is a partial reveal: present with only key_id populated,
+   * or absent entirely for outputs predating the key id column.
+   *
    * @generated from field: optional transcodely.v1.BYOKConfig byok = 3;
    */
   byok;
@@ -8656,13 +8694,15 @@ var ThumbnailFormat = /* @__PURE__ */ ((ThumbnailFormat2) => {
   ThumbnailFormat2[ThumbnailFormat2["JPEG"] = 1] = "JPEG";
   ThumbnailFormat2[ThumbnailFormat2["PNG"] = 2] = "PNG";
   ThumbnailFormat2[ThumbnailFormat2["WEBP"] = 3] = "WEBP";
+  ThumbnailFormat2[ThumbnailFormat2["MP4"] = 4] = "MP4";
   return ThumbnailFormat2;
 })(ThumbnailFormat || {});
 proto3.util.setEnumType(ThumbnailFormat, "transcodely.v1.ThumbnailFormat", [
   { no: 0, name: "THUMBNAIL_FORMAT_UNSPECIFIED" },
   { no: 1, name: "THUMBNAIL_FORMAT_JPEG" },
   { no: 2, name: "THUMBNAIL_FORMAT_PNG" },
-  { no: 3, name: "THUMBNAIL_FORMAT_WEBP" }
+  { no: 3, name: "THUMBNAIL_FORMAT_WEBP" },
+  { no: 4, name: "THUMBNAIL_FORMAT_MP4" }
 ]);
 var ThumbnailSpec = class _ThumbnailSpec extends Message {
   /**
@@ -8764,7 +8804,7 @@ var ThumbnailSpec = class _ThumbnailSpec extends Message {
   durationSeconds;
   /**
    * Frames per second of the animated preview (animated mode only).
-   * Range: 8-15. Default (unset): 12, applied worker-side. Only valid for
+   * Range: 8-30. Default (unset): 12, applied worker-side. Only valid for
    * animated mode.
    *
    * @generated from field: optional int32 fps = 12;
@@ -8862,6 +8902,24 @@ var ThumbnailResult = class _ThumbnailResult extends Message {
    * @generated from field: int32 index = 7;
    */
   index = 0;
+  /**
+   * Ready-to-fetch HTTPS URL for this thumbnail file, signed and time-limited.
+   *
+   * Points at the same object as url, but as a CDN URL a browser can load —
+   * url is a raw storage URI ("s3://…") that no client can fetch. Present only
+   * for jobs writing to Transcodely-managed storage (an output_origin with
+   * provider "transcodely"); jobs writing to your own bucket get nothing here
+   * and should sign url with their own credentials.
+   *
+   * Emitted on single-job reads (Get, Watch) and never on List, and expires —
+   * 6 hours by default — so re-read the job for a fresh one rather than storing
+   * it. The sprite mode's WebVTT sidecar (format "vtt") is signed so that the
+   * sprite image its cues reference relatively inherits the same
+   * authorization.
+   *
+   * @generated from field: optional string signed_url = 8;
+   */
+  signedUrl;
   constructor(data) {
     super();
     proto3.util.initPartial(data, this);
@@ -8917,7 +8975,8 @@ var ThumbnailResult = class _ThumbnailResult extends Message {
       kind: "scalar",
       T: 5
       /* ScalarType.INT32 */
-    }
+    },
+    { no: 8, name: "signed_url", kind: "scalar", T: 9, opt: true }
   ]);
   static fromBinary(bytes, options) {
     return new _ThumbnailResult().fromBinary(bytes, options);
@@ -9916,7 +9975,14 @@ var JobOutput = class _JobOutput extends Message {
    */
   errorCode;
   /**
-   * Error message if failed.
+   * Human-readable summary of why this output failed, in one or two sentences.
+   *
+   * Derived from error_code, not from the transcoder: this field never carries
+   * raw tool output, command lines, stack traces, or file paths. Where a short
+   * safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
+   *
+   * Match on error_code, not on this text. The wording is documentation, not
+   * API surface, and may be reworded in any release.
    *
    * @generated from field: optional string error_message = 13;
    */
@@ -9995,6 +10061,28 @@ var JobOutput = class _JobOutput extends Message {
    * @generated from field: repeated transcodely.v1.OutputVariantResult variant_results = 25;
    */
   variantResults = [];
+  /**
+   * Ready-to-fetch HTTPS URL for this output, signed and time-limited.
+   *
+   * Points at the same object as output_url — the media file for a progressive
+   * output, the master playlist or MPD for HLS/DASH — but as a CDN URL a
+   * browser or player can load, where output_url is a raw storage URI
+   * ("s3://…") that no client can fetch.
+   *
+   * Present only when the job writes to Transcodely-managed storage (an
+   * output_origin with provider "transcodely") and the output has completed.
+   * Jobs writing to your own bucket get nothing here: we hold no delivery
+   * domain for it, so read output_url and sign it with your own credentials.
+   *
+   * Emitted on single-job reads (Get, Watch) and never on List. The URL expires
+   * — 6 hours by default — so treat it as a fetch handle, not a durable link:
+   * re-read the job for a fresh one rather than storing it. For HLS and DASH it
+   * is signed so that variant playlists and segments referenced by the manifest
+   * inherit the same authorization.
+   *
+   * @generated from field: optional string signed_url = 26;
+   */
+  signedUrl;
   constructor(data) {
     super();
     proto3.util.initPartial(data, this);
@@ -10042,7 +10130,8 @@ var JobOutput = class _JobOutput extends Message {
     { no: 22, name: "width", kind: "scalar", T: 5, opt: true },
     { no: 23, name: "height", kind: "scalar", T: 5, opt: true },
     { no: 24, name: "average_bitrate_kbps", kind: "scalar", T: 5, opt: true },
-    { no: 25, name: "variant_results", kind: "message", T: OutputVariantResult, repeated: true }
+    { no: 25, name: "variant_results", kind: "message", T: OutputVariantResult, repeated: true },
+    { no: 26, name: "signed_url", kind: "scalar", T: 9, opt: true }
   ]);
   static fromBinary(bytes, options) {
     return new _JobOutput().fromBinary(bytes, options);
@@ -10395,7 +10484,9 @@ var Job = class _Job extends Message {
    */
   inputMetadata;
   /**
-   * Output renditions.
+   * Output renditions, in the same order as the create request's `outputs`.
+   * The order is stable across every read of the job, so indexing into this
+   * array to find the rendition you asked for is safe.
    *
    * @generated from field: repeated transcodely.v1.JobOutput outputs = 7;
    */
@@ -10433,7 +10524,15 @@ var Job = class _Job extends Message {
    */
   errorCode;
   /**
-   * Error message if status is FAILED.
+   * Human-readable summary of why the job failed, in one or two sentences.
+   *
+   * Derived from error_code, not from the transcoder: this field never carries
+   * raw tool output, command lines, stack traces, or file paths. Where a short
+   * safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
+   * The same text reaches you on the job.failed webhook payload.
+   *
+   * Match on error_code, not on this text. The wording is documentation, not
+   * API surface, and may be reworded in any release.
    *
    * @generated from field: optional string error_message = 11;
    */
@@ -10602,8 +10701,8 @@ var Job = class _Job extends Message {
   inputVideoId = "";
   /**
    * Auto-generated chapter tracks, one per output whose generated caption track
-   * had chapters enabled (SubtitleTrack.generate_chapters). Not yet populated:
-   * the auto-chapters feature is rolling out together with generated captions.
+   * had chapters enabled (SubtitleTrack.generate_chapters). Populated once the
+   * auto-chapters pass ships; empty until then.
    *
    * @generated from field: repeated transcodely.v1.ChapterResult chapter_results = 35;
    */
@@ -14649,7 +14748,7 @@ function backoff(attempt) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.3.1";
+var SDK_VERSION = "0.3.3";
 var API_VERSION = "2026-05-03";
 var DEFAULT_BASE_URL = "https://api.transcodely.com";