@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/CHANGELOG.md +7 -0
- package/dist/index.cjs +114 -17
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +127 -18
- package/dist/index.d.ts +127 -18
- package/dist/index.mjs +114 -17
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,13 @@ All notable changes to the Transcodely JavaScript / TypeScript SDK will be docum
|
|
|
4
4
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Breaking changes are allowed on minor bumps until 1.0.0.
|
|
6
6
|
|
|
7
|
+
## [0.3.2](https://github.com/transcodely/transcodely-js/compare/v0.3.1...v0.3.2) (2026-08-02)
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
### Features
|
|
11
|
+
|
|
12
|
+
* **client:** surface signed CDN asset URLs on job reads ([911bac9](https://github.com/transcodely/transcodely-js/commit/911bac99a5fd47bcc427291e2261e8fe219e0d02))
|
|
13
|
+
|
|
7
14
|
## [0.3.1](https://github.com/transcodely/transcodely-js/compare/v0.3.0...v0.3.1) (2026-07-29)
|
|
8
15
|
|
|
9
16
|
|
package/dist/index.cjs
CHANGED
|
@@ -5882,12 +5882,12 @@ var SubtitleTrack = class _SubtitleTrack extends protobuf.Message {
|
|
|
5882
5882
|
/**
|
|
5883
5883
|
* Generate an AI chapters track from the transcript this track produces.
|
|
5884
5884
|
*
|
|
5885
|
-
* Only meaningful together with the
|
|
5886
|
-
*
|
|
5885
|
+
* Only meaningful together with the `generate` subtitle operation: when
|
|
5886
|
+
* enabled, an AI pass over the generated transcript produces a chapters
|
|
5887
5887
|
* track delivered as WebVTT plus JSON. Free — no pricing impact. The
|
|
5888
5888
|
* transcript text is processed via the Anthropic API (an external
|
|
5889
|
-
* subprocessor).
|
|
5890
|
-
* rejected at job creation.
|
|
5889
|
+
* subprocessor). Caption generation is available; the auto-chapters pass is
|
|
5890
|
+
* not yet, so setting this is still rejected at job creation.
|
|
5891
5891
|
*
|
|
5892
5892
|
* @generated from field: optional bool generate_chapters = 12;
|
|
5893
5893
|
*/
|
|
@@ -6135,6 +6135,30 @@ var SubtitleResult = class _SubtitleResult extends protobuf.Message {
|
|
|
6135
6135
|
* @generated from field: string transcript_url = 10;
|
|
6136
6136
|
*/
|
|
6137
6137
|
transcriptUrl = "";
|
|
6138
|
+
/**
|
|
6139
|
+
* Ready-to-fetch HTTPS URL for the caption file, signed and time-limited.
|
|
6140
|
+
*
|
|
6141
|
+
* Points at the same object as url, but as a CDN URL a browser or player can
|
|
6142
|
+
* load — url is a raw storage URI ("s3://…") that no client can fetch.
|
|
6143
|
+
* Present only for jobs writing to Transcodely-managed storage (an
|
|
6144
|
+
* output_origin with provider "transcodely"); jobs writing to your own bucket
|
|
6145
|
+
* get nothing here and should sign url with their own credentials.
|
|
6146
|
+
*
|
|
6147
|
+
* Emitted on single-job reads (Get, Watch) and never on List, and expires —
|
|
6148
|
+
* 6 hours by default — so re-read the job for a fresh one rather than
|
|
6149
|
+
* storing it.
|
|
6150
|
+
*
|
|
6151
|
+
* @generated from field: optional string signed_url = 11;
|
|
6152
|
+
*/
|
|
6153
|
+
signedUrl;
|
|
6154
|
+
/**
|
|
6155
|
+
* Ready-to-fetch HTTPS URL for the segment transcript, signed and
|
|
6156
|
+
* time-limited. Same rules and lifetime as signed_url; set only for generate
|
|
6157
|
+
* tracks, which are the only ones carrying a transcript.
|
|
6158
|
+
*
|
|
6159
|
+
* @generated from field: optional string transcript_signed_url = 12;
|
|
6160
|
+
*/
|
|
6161
|
+
transcriptSignedUrl;
|
|
6138
6162
|
constructor(data) {
|
|
6139
6163
|
super();
|
|
6140
6164
|
protobuf.proto3.util.initPartial(data, this);
|
|
@@ -6199,7 +6223,9 @@ var SubtitleResult = class _SubtitleResult extends protobuf.Message {
|
|
|
6199
6223
|
kind: "scalar",
|
|
6200
6224
|
T: 9
|
|
6201
6225
|
/* ScalarType.STRING */
|
|
6202
|
-
}
|
|
6226
|
+
},
|
|
6227
|
+
{ no: 11, name: "signed_url", kind: "scalar", T: 9, opt: true },
|
|
6228
|
+
{ no: 12, name: "transcript_signed_url", kind: "scalar", T: 9, opt: true }
|
|
6203
6229
|
]);
|
|
6204
6230
|
static fromBinary(bytes, options) {
|
|
6205
6231
|
return new _SubtitleResult().fromBinary(bytes, options);
|
|
@@ -6242,35 +6268,41 @@ var BYOKConfig = class _BYOKConfig extends protobuf.Message {
|
|
|
6242
6268
|
/**
|
|
6243
6269
|
* Key identifier (32 hex characters).
|
|
6244
6270
|
*
|
|
6271
|
+
* The one BYOK field returned on reads. It names which key encrypted an
|
|
6272
|
+
* output — the way an API key's prefix and last-4 name the key — so the
|
|
6273
|
+
* key in use can be confirmed without keeping separate records.
|
|
6274
|
+
*
|
|
6245
6275
|
* @generated from field: string key_id = 1;
|
|
6246
6276
|
*/
|
|
6247
6277
|
keyId = "";
|
|
6248
6278
|
/**
|
|
6249
6279
|
* Content encryption key (32 hex characters).
|
|
6250
6280
|
*
|
|
6281
|
+
* Write-only: encrypted at rest and never returned on any read.
|
|
6282
|
+
*
|
|
6251
6283
|
* @generated from field: string key = 2;
|
|
6252
6284
|
*/
|
|
6253
6285
|
key = "";
|
|
6254
6286
|
/**
|
|
6255
|
-
* Widevine PSSH box (base64-encoded, optional).
|
|
6287
|
+
* Widevine PSSH box (base64-encoded, optional). Write-only.
|
|
6256
6288
|
*
|
|
6257
6289
|
* @generated from field: optional string pssh_widevine = 3;
|
|
6258
6290
|
*/
|
|
6259
6291
|
psshWidevine;
|
|
6260
6292
|
/**
|
|
6261
|
-
* PlayReady PSSH XML (optional).
|
|
6293
|
+
* PlayReady PSSH XML (optional). Write-only.
|
|
6262
6294
|
*
|
|
6263
6295
|
* @generated from field: optional string pssh_playready = 4;
|
|
6264
6296
|
*/
|
|
6265
6297
|
psshPlayready;
|
|
6266
6298
|
/**
|
|
6267
|
-
* FairPlay initialization vector (32 hex characters).
|
|
6299
|
+
* FairPlay initialization vector (32 hex characters). Write-only.
|
|
6268
6300
|
*
|
|
6269
6301
|
* @generated from field: optional string fairplay_iv = 5;
|
|
6270
6302
|
*/
|
|
6271
6303
|
fairplayIv;
|
|
6272
6304
|
/**
|
|
6273
|
-
* FairPlay key server URI (skd:// scheme).
|
|
6305
|
+
* FairPlay key server URI (skd:// scheme). Write-only.
|
|
6274
6306
|
*
|
|
6275
6307
|
* @generated from field: optional string fairplay_uri = 6;
|
|
6276
6308
|
*/
|
|
@@ -6324,6 +6356,9 @@ var KeyServerConfig = class _KeyServerConfig extends protobuf.Message {
|
|
|
6324
6356
|
/**
|
|
6325
6357
|
* Authentication token for the key server.
|
|
6326
6358
|
*
|
|
6359
|
+
* Write-only: encrypted at rest and never returned on any read. The other
|
|
6360
|
+
* two fields of this message are echoed back normally.
|
|
6361
|
+
*
|
|
6327
6362
|
* @generated from field: optional string auth_token = 2;
|
|
6328
6363
|
*/
|
|
6329
6364
|
authToken;
|
|
@@ -6379,6 +6414,9 @@ var DRMConfig = class _DRMConfig extends protobuf.Message {
|
|
|
6379
6414
|
/**
|
|
6380
6415
|
* BYOK configuration (mutually exclusive with key_server).
|
|
6381
6416
|
*
|
|
6417
|
+
* On reads this is a partial reveal: present with only key_id populated,
|
|
6418
|
+
* or absent entirely for outputs predating the key id column.
|
|
6419
|
+
*
|
|
6382
6420
|
* @generated from field: optional transcodely.v1.BYOKConfig byok = 3;
|
|
6383
6421
|
*/
|
|
6384
6422
|
byok;
|
|
@@ -8864,6 +8902,24 @@ var ThumbnailResult = class _ThumbnailResult extends protobuf.Message {
|
|
|
8864
8902
|
* @generated from field: int32 index = 7;
|
|
8865
8903
|
*/
|
|
8866
8904
|
index = 0;
|
|
8905
|
+
/**
|
|
8906
|
+
* Ready-to-fetch HTTPS URL for this thumbnail file, signed and time-limited.
|
|
8907
|
+
*
|
|
8908
|
+
* Points at the same object as url, but as a CDN URL a browser can load —
|
|
8909
|
+
* url is a raw storage URI ("s3://…") that no client can fetch. Present only
|
|
8910
|
+
* for jobs writing to Transcodely-managed storage (an output_origin with
|
|
8911
|
+
* provider "transcodely"); jobs writing to your own bucket get nothing here
|
|
8912
|
+
* and should sign url with their own credentials.
|
|
8913
|
+
*
|
|
8914
|
+
* Emitted on single-job reads (Get, Watch) and never on List, and expires —
|
|
8915
|
+
* 6 hours by default — so re-read the job for a fresh one rather than storing
|
|
8916
|
+
* it. The sprite mode's WebVTT sidecar (format "vtt") is signed so that the
|
|
8917
|
+
* sprite image its cues reference relatively inherits the same
|
|
8918
|
+
* authorization.
|
|
8919
|
+
*
|
|
8920
|
+
* @generated from field: optional string signed_url = 8;
|
|
8921
|
+
*/
|
|
8922
|
+
signedUrl;
|
|
8867
8923
|
constructor(data) {
|
|
8868
8924
|
super();
|
|
8869
8925
|
protobuf.proto3.util.initPartial(data, this);
|
|
@@ -8919,7 +8975,8 @@ var ThumbnailResult = class _ThumbnailResult extends protobuf.Message {
|
|
|
8919
8975
|
kind: "scalar",
|
|
8920
8976
|
T: 5
|
|
8921
8977
|
/* ScalarType.INT32 */
|
|
8922
|
-
}
|
|
8978
|
+
},
|
|
8979
|
+
{ no: 8, name: "signed_url", kind: "scalar", T: 9, opt: true }
|
|
8923
8980
|
]);
|
|
8924
8981
|
static fromBinary(bytes, options) {
|
|
8925
8982
|
return new _ThumbnailResult().fromBinary(bytes, options);
|
|
@@ -9918,7 +9975,14 @@ var JobOutput = class _JobOutput extends protobuf.Message {
|
|
|
9918
9975
|
*/
|
|
9919
9976
|
errorCode;
|
|
9920
9977
|
/**
|
|
9921
|
-
*
|
|
9978
|
+
* Human-readable summary of why this output failed, in one or two sentences.
|
|
9979
|
+
*
|
|
9980
|
+
* Derived from error_code, not from the transcoder: this field never carries
|
|
9981
|
+
* raw tool output, command lines, stack traces, or file paths. Where a short
|
|
9982
|
+
* safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
|
|
9983
|
+
*
|
|
9984
|
+
* Match on error_code, not on this text. The wording is documentation, not
|
|
9985
|
+
* API surface, and may be reworded in any release.
|
|
9922
9986
|
*
|
|
9923
9987
|
* @generated from field: optional string error_message = 13;
|
|
9924
9988
|
*/
|
|
@@ -9997,6 +10061,28 @@ var JobOutput = class _JobOutput extends protobuf.Message {
|
|
|
9997
10061
|
* @generated from field: repeated transcodely.v1.OutputVariantResult variant_results = 25;
|
|
9998
10062
|
*/
|
|
9999
10063
|
variantResults = [];
|
|
10064
|
+
/**
|
|
10065
|
+
* Ready-to-fetch HTTPS URL for this output, signed and time-limited.
|
|
10066
|
+
*
|
|
10067
|
+
* Points at the same object as output_url — the media file for a progressive
|
|
10068
|
+
* output, the master playlist or MPD for HLS/DASH — but as a CDN URL a
|
|
10069
|
+
* browser or player can load, where output_url is a raw storage URI
|
|
10070
|
+
* ("s3://…") that no client can fetch.
|
|
10071
|
+
*
|
|
10072
|
+
* Present only when the job writes to Transcodely-managed storage (an
|
|
10073
|
+
* output_origin with provider "transcodely") and the output has completed.
|
|
10074
|
+
* Jobs writing to your own bucket get nothing here: we hold no delivery
|
|
10075
|
+
* domain for it, so read output_url and sign it with your own credentials.
|
|
10076
|
+
*
|
|
10077
|
+
* Emitted on single-job reads (Get, Watch) and never on List. The URL expires
|
|
10078
|
+
* — 6 hours by default — so treat it as a fetch handle, not a durable link:
|
|
10079
|
+
* re-read the job for a fresh one rather than storing it. For HLS and DASH it
|
|
10080
|
+
* is signed so that variant playlists and segments referenced by the manifest
|
|
10081
|
+
* inherit the same authorization.
|
|
10082
|
+
*
|
|
10083
|
+
* @generated from field: optional string signed_url = 26;
|
|
10084
|
+
*/
|
|
10085
|
+
signedUrl;
|
|
10000
10086
|
constructor(data) {
|
|
10001
10087
|
super();
|
|
10002
10088
|
protobuf.proto3.util.initPartial(data, this);
|
|
@@ -10044,7 +10130,8 @@ var JobOutput = class _JobOutput extends protobuf.Message {
|
|
|
10044
10130
|
{ no: 22, name: "width", kind: "scalar", T: 5, opt: true },
|
|
10045
10131
|
{ no: 23, name: "height", kind: "scalar", T: 5, opt: true },
|
|
10046
10132
|
{ no: 24, name: "average_bitrate_kbps", kind: "scalar", T: 5, opt: true },
|
|
10047
|
-
{ no: 25, name: "variant_results", kind: "message", T: OutputVariantResult, repeated: true }
|
|
10133
|
+
{ no: 25, name: "variant_results", kind: "message", T: OutputVariantResult, repeated: true },
|
|
10134
|
+
{ no: 26, name: "signed_url", kind: "scalar", T: 9, opt: true }
|
|
10048
10135
|
]);
|
|
10049
10136
|
static fromBinary(bytes, options) {
|
|
10050
10137
|
return new _JobOutput().fromBinary(bytes, options);
|
|
@@ -10397,7 +10484,9 @@ var Job = class _Job extends protobuf.Message {
|
|
|
10397
10484
|
*/
|
|
10398
10485
|
inputMetadata;
|
|
10399
10486
|
/**
|
|
10400
|
-
* Output renditions
|
|
10487
|
+
* Output renditions, in the same order as the create request's `outputs`.
|
|
10488
|
+
* The order is stable across every read of the job, so indexing into this
|
|
10489
|
+
* array to find the rendition you asked for is safe.
|
|
10401
10490
|
*
|
|
10402
10491
|
* @generated from field: repeated transcodely.v1.JobOutput outputs = 7;
|
|
10403
10492
|
*/
|
|
@@ -10435,7 +10524,15 @@ var Job = class _Job extends protobuf.Message {
|
|
|
10435
10524
|
*/
|
|
10436
10525
|
errorCode;
|
|
10437
10526
|
/**
|
|
10438
|
-
*
|
|
10527
|
+
* Human-readable summary of why the job failed, in one or two sentences.
|
|
10528
|
+
*
|
|
10529
|
+
* Derived from error_code, not from the transcoder: this field never carries
|
|
10530
|
+
* raw tool output, command lines, stack traces, or file paths. Where a short
|
|
10531
|
+
* safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
|
|
10532
|
+
* The same text reaches you on the job.failed webhook payload.
|
|
10533
|
+
*
|
|
10534
|
+
* Match on error_code, not on this text. The wording is documentation, not
|
|
10535
|
+
* API surface, and may be reworded in any release.
|
|
10439
10536
|
*
|
|
10440
10537
|
* @generated from field: optional string error_message = 11;
|
|
10441
10538
|
*/
|
|
@@ -10604,8 +10701,8 @@ var Job = class _Job extends protobuf.Message {
|
|
|
10604
10701
|
inputVideoId = "";
|
|
10605
10702
|
/**
|
|
10606
10703
|
* Auto-generated chapter tracks, one per output whose generated caption track
|
|
10607
|
-
* had chapters enabled (SubtitleTrack.generate_chapters).
|
|
10608
|
-
*
|
|
10704
|
+
* had chapters enabled (SubtitleTrack.generate_chapters). Populated once the
|
|
10705
|
+
* auto-chapters pass ships; empty until then.
|
|
10609
10706
|
*
|
|
10610
10707
|
* @generated from field: repeated transcodely.v1.ChapterResult chapter_results = 35;
|
|
10611
10708
|
*/
|
|
@@ -14651,7 +14748,7 @@ function backoff(attempt) {
|
|
|
14651
14748
|
}
|
|
14652
14749
|
|
|
14653
14750
|
// src/version.ts
|
|
14654
|
-
var SDK_VERSION = "0.3.
|
|
14751
|
+
var SDK_VERSION = "0.3.2";
|
|
14655
14752
|
var API_VERSION = "2026-05-03";
|
|
14656
14753
|
var DEFAULT_BASE_URL = "https://api.transcodely.com";
|
|
14657
14754
|
|