@transcodely/sdk 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.mjs CHANGED
@@ -5880,12 +5880,12 @@ var SubtitleTrack = class _SubtitleTrack extends Message {
5880
5880
  /**
5881
5881
  * Generate an AI chapters track from the transcript this track produces.
5882
5882
  *
5883
- * Only meaningful together with the (upcoming) `generate` subtitle operation:
5884
- * when enabled, an AI pass over the generated transcript produces a chapters
5883
+ * Only meaningful together with the `generate` subtitle operation: when
5884
+ * enabled, an AI pass over the generated transcript produces a chapters
5885
5885
  * track delivered as WebVTT plus JSON. Free — no pricing impact. The
5886
5886
  * transcript text is processed via the Anthropic API (an external
5887
- * subprocessor). Until the `generate` operation ships, setting this is
5888
- * rejected at job creation.
5887
+ * subprocessor). Caption generation is available; the auto-chapters pass is
5888
+ * not yet, so setting this is still rejected at job creation.
5889
5889
  *
5890
5890
  * @generated from field: optional bool generate_chapters = 12;
5891
5891
  */
@@ -6133,6 +6133,30 @@ var SubtitleResult = class _SubtitleResult extends Message {
6133
6133
  * @generated from field: string transcript_url = 10;
6134
6134
  */
6135
6135
  transcriptUrl = "";
6136
+ /**
6137
+ * Ready-to-fetch HTTPS URL for the caption file, signed and time-limited.
6138
+ *
6139
+ * Points at the same object as url, but as a CDN URL a browser or player can
6140
+ * load — url is a raw storage URI ("s3://…") that no client can fetch.
6141
+ * Present only for jobs writing to Transcodely-managed storage (an
6142
+ * output_origin with provider "transcodely"); jobs writing to your own bucket
6143
+ * get nothing here and should sign url with their own credentials.
6144
+ *
6145
+ * Emitted on single-job reads (Get, Watch) and never on List, and expires —
6146
+ * 6 hours by default — so re-read the job for a fresh one rather than
6147
+ * storing it.
6148
+ *
6149
+ * @generated from field: optional string signed_url = 11;
6150
+ */
6151
+ signedUrl;
6152
+ /**
6153
+ * Ready-to-fetch HTTPS URL for the segment transcript, signed and
6154
+ * time-limited. Same rules and lifetime as signed_url; set only for generate
6155
+ * tracks, which are the only ones carrying a transcript.
6156
+ *
6157
+ * @generated from field: optional string transcript_signed_url = 12;
6158
+ */
6159
+ transcriptSignedUrl;
6136
6160
  constructor(data) {
6137
6161
  super();
6138
6162
  proto3.util.initPartial(data, this);
@@ -6197,7 +6221,9 @@ var SubtitleResult = class _SubtitleResult extends Message {
6197
6221
  kind: "scalar",
6198
6222
  T: 9
6199
6223
  /* ScalarType.STRING */
6200
- }
6224
+ },
6225
+ { no: 11, name: "signed_url", kind: "scalar", T: 9, opt: true },
6226
+ { no: 12, name: "transcript_signed_url", kind: "scalar", T: 9, opt: true }
6201
6227
  ]);
6202
6228
  static fromBinary(bytes, options) {
6203
6229
  return new _SubtitleResult().fromBinary(bytes, options);
@@ -6240,35 +6266,41 @@ var BYOKConfig = class _BYOKConfig extends Message {
6240
6266
  /**
6241
6267
  * Key identifier (32 hex characters).
6242
6268
  *
6269
+ * The one BYOK field returned on reads. It names which key encrypted an
6270
+ * output — the way an API key's prefix and last-4 name the key — so the
6271
+ * key in use can be confirmed without keeping separate records.
6272
+ *
6243
6273
  * @generated from field: string key_id = 1;
6244
6274
  */
6245
6275
  keyId = "";
6246
6276
  /**
6247
6277
  * Content encryption key (32 hex characters).
6248
6278
  *
6279
+ * Write-only: encrypted at rest and never returned on any read.
6280
+ *
6249
6281
  * @generated from field: string key = 2;
6250
6282
  */
6251
6283
  key = "";
6252
6284
  /**
6253
- * Widevine PSSH box (base64-encoded, optional).
6285
+ * Widevine PSSH box (base64-encoded, optional). Write-only.
6254
6286
  *
6255
6287
  * @generated from field: optional string pssh_widevine = 3;
6256
6288
  */
6257
6289
  psshWidevine;
6258
6290
  /**
6259
- * PlayReady PSSH XML (optional).
6291
+ * PlayReady PSSH XML (optional). Write-only.
6260
6292
  *
6261
6293
  * @generated from field: optional string pssh_playready = 4;
6262
6294
  */
6263
6295
  psshPlayready;
6264
6296
  /**
6265
- * FairPlay initialization vector (32 hex characters).
6297
+ * FairPlay initialization vector (32 hex characters). Write-only.
6266
6298
  *
6267
6299
  * @generated from field: optional string fairplay_iv = 5;
6268
6300
  */
6269
6301
  fairplayIv;
6270
6302
  /**
6271
- * FairPlay key server URI (skd:// scheme).
6303
+ * FairPlay key server URI (skd:// scheme). Write-only.
6272
6304
  *
6273
6305
  * @generated from field: optional string fairplay_uri = 6;
6274
6306
  */
@@ -6322,6 +6354,9 @@ var KeyServerConfig = class _KeyServerConfig extends Message {
6322
6354
  /**
6323
6355
  * Authentication token for the key server.
6324
6356
  *
6357
+ * Write-only: encrypted at rest and never returned on any read. The other
6358
+ * two fields of this message are echoed back normally.
6359
+ *
6325
6360
  * @generated from field: optional string auth_token = 2;
6326
6361
  */
6327
6362
  authToken;
@@ -6377,6 +6412,9 @@ var DRMConfig = class _DRMConfig extends Message {
6377
6412
  /**
6378
6413
  * BYOK configuration (mutually exclusive with key_server).
6379
6414
  *
6415
+ * On reads this is a partial reveal: present with only key_id populated,
6416
+ * or absent entirely for outputs predating the key id column.
6417
+ *
6380
6418
  * @generated from field: optional transcodely.v1.BYOKConfig byok = 3;
6381
6419
  */
6382
6420
  byok;
@@ -8862,6 +8900,24 @@ var ThumbnailResult = class _ThumbnailResult extends Message {
8862
8900
  * @generated from field: int32 index = 7;
8863
8901
  */
8864
8902
  index = 0;
8903
+ /**
8904
+ * Ready-to-fetch HTTPS URL for this thumbnail file, signed and time-limited.
8905
+ *
8906
+ * Points at the same object as url, but as a CDN URL a browser can load —
8907
+ * url is a raw storage URI ("s3://…") that no client can fetch. Present only
8908
+ * for jobs writing to Transcodely-managed storage (an output_origin with
8909
+ * provider "transcodely"); jobs writing to your own bucket get nothing here
8910
+ * and should sign url with their own credentials.
8911
+ *
8912
+ * Emitted on single-job reads (Get, Watch) and never on List, and expires —
8913
+ * 6 hours by default — so re-read the job for a fresh one rather than storing
8914
+ * it. The sprite mode's WebVTT sidecar (format "vtt") is signed so that the
8915
+ * sprite image its cues reference relatively inherits the same
8916
+ * authorization.
8917
+ *
8918
+ * @generated from field: optional string signed_url = 8;
8919
+ */
8920
+ signedUrl;
8865
8921
  constructor(data) {
8866
8922
  super();
8867
8923
  proto3.util.initPartial(data, this);
@@ -8917,7 +8973,8 @@ var ThumbnailResult = class _ThumbnailResult extends Message {
8917
8973
  kind: "scalar",
8918
8974
  T: 5
8919
8975
  /* ScalarType.INT32 */
8920
- }
8976
+ },
8977
+ { no: 8, name: "signed_url", kind: "scalar", T: 9, opt: true }
8921
8978
  ]);
8922
8979
  static fromBinary(bytes, options) {
8923
8980
  return new _ThumbnailResult().fromBinary(bytes, options);
@@ -9916,7 +9973,14 @@ var JobOutput = class _JobOutput extends Message {
9916
9973
  */
9917
9974
  errorCode;
9918
9975
  /**
9919
- * Error message if failed.
9976
+ * Human-readable summary of why this output failed, in one or two sentences.
9977
+ *
9978
+ * Derived from error_code, not from the transcoder: this field never carries
9979
+ * raw tool output, command lines, stack traces, or file paths. Where a short
9980
+ * safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
9981
+ *
9982
+ * Match on error_code, not on this text. The wording is documentation, not
9983
+ * API surface, and may be reworded in any release.
9920
9984
  *
9921
9985
  * @generated from field: optional string error_message = 13;
9922
9986
  */
@@ -9995,6 +10059,28 @@ var JobOutput = class _JobOutput extends Message {
9995
10059
  * @generated from field: repeated transcodely.v1.OutputVariantResult variant_results = 25;
9996
10060
  */
9997
10061
  variantResults = [];
10062
+ /**
10063
+ * Ready-to-fetch HTTPS URL for this output, signed and time-limited.
10064
+ *
10065
+ * Points at the same object as output_url — the media file for a progressive
10066
+ * output, the master playlist or MPD for HLS/DASH — but as a CDN URL a
10067
+ * browser or player can load, where output_url is a raw storage URI
10068
+ * ("s3://…") that no client can fetch.
10069
+ *
10070
+ * Present only when the job writes to Transcodely-managed storage (an
10071
+ * output_origin with provider "transcodely") and the output has completed.
10072
+ * Jobs writing to your own bucket get nothing here: we hold no delivery
10073
+ * domain for it, so read output_url and sign it with your own credentials.
10074
+ *
10075
+ * Emitted on single-job reads (Get, Watch) and never on List. The URL expires
10076
+ * — 6 hours by default — so treat it as a fetch handle, not a durable link:
10077
+ * re-read the job for a fresh one rather than storing it. For HLS and DASH it
10078
+ * is signed so that variant playlists and segments referenced by the manifest
10079
+ * inherit the same authorization.
10080
+ *
10081
+ * @generated from field: optional string signed_url = 26;
10082
+ */
10083
+ signedUrl;
9998
10084
  constructor(data) {
9999
10085
  super();
10000
10086
  proto3.util.initPartial(data, this);
@@ -10042,7 +10128,8 @@ var JobOutput = class _JobOutput extends Message {
10042
10128
  { no: 22, name: "width", kind: "scalar", T: 5, opt: true },
10043
10129
  { no: 23, name: "height", kind: "scalar", T: 5, opt: true },
10044
10130
  { no: 24, name: "average_bitrate_kbps", kind: "scalar", T: 5, opt: true },
10045
- { no: 25, name: "variant_results", kind: "message", T: OutputVariantResult, repeated: true }
10131
+ { no: 25, name: "variant_results", kind: "message", T: OutputVariantResult, repeated: true },
10132
+ { no: 26, name: "signed_url", kind: "scalar", T: 9, opt: true }
10046
10133
  ]);
10047
10134
  static fromBinary(bytes, options) {
10048
10135
  return new _JobOutput().fromBinary(bytes, options);
@@ -10395,7 +10482,9 @@ var Job = class _Job extends Message {
10395
10482
  */
10396
10483
  inputMetadata;
10397
10484
  /**
10398
- * Output renditions.
10485
+ * Output renditions, in the same order as the create request's `outputs`.
10486
+ * The order is stable across every read of the job, so indexing into this
10487
+ * array to find the rendition you asked for is safe.
10399
10488
  *
10400
10489
  * @generated from field: repeated transcodely.v1.JobOutput outputs = 7;
10401
10490
  */
@@ -10433,7 +10522,15 @@ var Job = class _Job extends Message {
10433
10522
  */
10434
10523
  errorCode;
10435
10524
  /**
10436
- * Error message if status is FAILED.
10525
+ * Human-readable summary of why the job failed, in one or two sentences.
10526
+ *
10527
+ * Derived from error_code, not from the transcoder: this field never carries
10528
+ * raw tool output, command lines, stack traces, or file paths. Where a short
10529
+ * safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
10530
+ * The same text reaches you on the job.failed webhook payload.
10531
+ *
10532
+ * Match on error_code, not on this text. The wording is documentation, not
10533
+ * API surface, and may be reworded in any release.
10437
10534
  *
10438
10535
  * @generated from field: optional string error_message = 11;
10439
10536
  */
@@ -10602,8 +10699,8 @@ var Job = class _Job extends Message {
10602
10699
  inputVideoId = "";
10603
10700
  /**
10604
10701
  * Auto-generated chapter tracks, one per output whose generated caption track
10605
- * had chapters enabled (SubtitleTrack.generate_chapters). Not yet populated:
10606
- * the auto-chapters feature is rolling out together with generated captions.
10702
+ * had chapters enabled (SubtitleTrack.generate_chapters). Populated once the
10703
+ * auto-chapters pass ships; empty until then.
10607
10704
  *
10608
10705
  * @generated from field: repeated transcodely.v1.ChapterResult chapter_results = 35;
10609
10706
  */
@@ -14649,7 +14746,7 @@ function backoff(attempt) {
14649
14746
  }
14650
14747
 
14651
14748
  // src/version.ts
14652
- var SDK_VERSION = "0.3.1";
14749
+ var SDK_VERSION = "0.3.2";
14653
14750
  var API_VERSION = "2026-05-03";
14654
14751
  var DEFAULT_BASE_URL = "https://api.transcodely.com";
14655
14752