Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 30x 30x 1x 1x 30x 39x 39x 39x 27x 27x 27x 27x 27x 3x 27x 3x 3x 27x 1x 52x 52x 52x 52x 52x 52x 52x 52x 52x 1x 1x 52x 1x 1x 52x 1x 1x 49x 49x 52x 52x 52x 52x 52x 52x 52x 1x 1x 52x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 1x 24x 23x 23x 24x 24x 24x 24x 24x 24x 24x 24x 23x 23x 6x 6x 1x 1x 6x 23x 23x 23x 23x 23x 24x 3x 3x 3x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 18x 22x 5x 5x 5x 5x 5x 5x 5x 5x 17x 13x 7x 7x 7x 7x 7x 7x 7x 22x 22x 24x 24x 24x 52x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 21x 21x 21x 19x 16x 10x 21x 12x 12x 9x 9x 21x 9x 21x 1x 1x 8x 8x 13x 52x 1x 1x 1x 1x 1x 1x 52x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 52x 1x 1x 1x 1x 1x 1x 1x 1x 1x 52x 153x 153x 153x 153x 153x 153x 153x 153x 52x 1x 1x 52x 32x 32x 32x 30x 30x 32x 52x 1x 1x 1x 1x 1x 1x 1x 1x 52x 1x 1x 1x 1x 1x 1x 1x 1x 1x 52x 1x 1x 1x 1x 1x 52x 2x 2x 2x 2x 2x 52x 1x 1x 1x 1x 1x 1x 1x 1x 52x 52x 2x 2x 2x 2x 2x 2x 52x 1x 1x 1x 1x 1x 1x 52x 1x 1x 1x 1x 1x 52x 2x 2x 2x 2x 2x 52x 1x 1x 1x 1x 1x 1x 1x 1x 52x 52x 1x 1x 1x 1x 1x 1x 52x 228x 228x 228x 228x 52x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 1x 2x 2x 3x 2x 2x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 52x 232x 232x 232x 232x 52x 33x 33x 33x 33x 33x 22x 22x 22x 22x 33x 33x 52x 194x 194x 194x 194x 52x 231x 231x 2x 2x 231x 225x 225x 231x 225x 225x 231x 225x 225x 231x 231x 52x 222x 222x 222x 222x 52x 224x 224x 224x 224x 224x 224x 224x 224x 224x 224x 224x 224x 224x 193x 193x 224x 224x 225x 225x 32x 32x 32x 225x 225x 225x 225x 225x 225x 225x 225x 225x 225x 225x 225x 225x 225x 215x 225x 10x 10x 8x 8x 8x 8x 7x 7x 7x 2x 2x 2x 2x 2x 2x 1x 8x 1x 1x 1x 1x 8x 7x 7x 7x 7x 7x 10x 2x 2x 10x 225x 224x 52x | import { createHmac, randomUUID } from 'crypto'
import got, {
RetryOptions,
Headers,
OptionsOfJSONResponseBody,
Delays,
RequestError,
HTTPError,
} from 'got'
import FormData from 'form-data'
import { constants, createReadStream } from 'fs'
import { access } from 'fs/promises'
import debug from 'debug'
import intoStream, { Input as IntoStreamInput } from 'into-stream'
import { isReadableStream, isStream } from 'is-stream'
import * as assert from 'assert'
import pMap from 'p-map'
import type { Readable } from 'stream'
import InconsistentResponseError from './InconsistentResponseError.js'
import PaginationStream from './PaginationStream.js'
import PollingTimeoutError from './PollingTimeoutError.js'
import { TransloaditErrorResponseBody, ApiError } from './ApiError.js'
import packageJson from '../package.json' with { type: 'json' }
import { sendTusRequest, Stream } from './tus.js'
import { AssemblyStatus } from './alphalib/types/assemblyStatus.js'
import type {
BaseResponse,
BillResponse,
CreateAssemblyParams,
CreateTemplateCredentialParams,
CreateTemplateParams,
EditTemplateParams,
ListAssembliesParams,
ListedAssembly,
ListedTemplate,
ListTemplateCredentialsParams,
ListTemplatesParams,
OptionalAuthParams,
PaginationListWithCount,
ReplayAssemblyNotificationParams,
ReplayAssemblyNotificationResponse,
ReplayAssemblyParams,
ReplayAssemblyResponse,
TemplateCredentialResponse,
TemplateCredentialsResponse,
TemplateResponse,
} from './apiTypes.js'
export * from './apiTypes.js'
export type { AssemblyStatus } from './alphalib/types/assemblyStatus.js'
// See https://github.com/sindresorhus/got/tree/v11.8.6?tab=readme-ov-file#errors
// Expose relevant errors
export {
RequestError,
ReadError,
ParseError,
UploadError,
HTTPError,
MaxRedirectsError,
TimeoutError,
} from 'got'
export { InconsistentResponseError, ApiError }
const log = debug('transloadit')
const logWarn = debug('transloadit:warn')
export interface UploadProgress {
uploadedBytes?: number | undefined
totalBytes?: number | undefined
}
const { version } = packageJson
export type AssemblyProgress = (assembly: AssemblyStatus) => void
export interface CreateAssemblyOptions {
params?: CreateAssemblyParams
files?: {
[name: string]: string
}
uploads?: {
[name: string]: Readable | IntoStreamInput
}
waitForCompletion?: boolean
chunkSize?: number
uploadConcurrency?: number
timeout?: number
onUploadProgress?: (uploadProgress: UploadProgress) => void
onAssemblyProgress?: AssemblyProgress
assemblyId?: string
}
export interface AwaitAssemblyCompletionOptions {
onAssemblyProgress?: AssemblyProgress
timeout?: number
interval?: number
startTimeMs?: number
}
export interface SmartCDNUrlOptions {
/**
* Workspace slug
*/
workspace: string
/**
* Template slug or template ID
*/
template: string
/**
* Input value that is provided as `${fields.input}` in the template
*/
input: string
/**
* Additional parameters for the URL query string
*/
urlParams?: Record<string, boolean | number | string | (boolean | number | string)[]>
/**
* Expiration timestamp of the signature in milliseconds since UNIX epoch.
* Defaults to 1 hour from now.
*/
expiresAt?: number
}
export type Fields = Record<string, string | number>
// A special promise that lets the user immediately get the assembly ID (synchronously before the request is sent)
interface CreateAssemblyPromise extends Promise<AssemblyStatus> {
assemblyId: string
}
// Not sure if this is still a problem with the API, but throw a special error type so the user can retry if needed
function checkAssemblyUrls(result: AssemblyStatus) {
if (result.assembly_url == null || result.assembly_ssl_url == null) {
throw new InconsistentResponseError('Server returned an incomplete assembly response (no URL)')
}
}
function getHrTimeMs(): number {
return Number(process.hrtime.bigint() / 1000000n)
}
function checkResult<T>(result: T | { error: string }): asserts result is T {
// In case server returned a successful HTTP status code, but an `error` in the JSON object
// This happens sometimes, for example when createAssembly with an invalid file (IMPORT_FILE_ERROR)
if (
typeof result === 'object' &&
result !== null &&
'error' in result &&
typeof result.error === 'string'
) {
throw new ApiError({ body: result }) // in this case there is no `cause` because we don't have an HTTPError
}
}
export interface Options {
authKey: string
authSecret: string
endpoint?: string
maxRetries?: number
timeout?: number
gotRetry?: Partial<RetryOptions>
}
export class Transloadit {
private _authKey: string
private _authSecret: string
private _endpoint: string
private _maxRetries: number
private _defaultTimeout: number
private _gotRetry: Partial<RetryOptions>
private _lastUsedAssemblyUrl = ''
constructor(opts: Options) {
if (opts?.authKey == null) {
throw new Error('Please provide an authKey')
}
if (opts.authSecret == null) {
throw new Error('Please provide an authSecret')
}
if (opts.endpoint && opts.endpoint.endsWith('/')) {
throw new Error('Trailing slash in endpoint is not allowed')
}
this._authKey = opts.authKey
this._authSecret = opts.authSecret
this._endpoint = opts.endpoint || 'https://api2.transloadit.com'
this._maxRetries = opts.maxRetries != null ? opts.maxRetries : 5
this._defaultTimeout = opts.timeout != null ? opts.timeout : 60000
// Passed on to got https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md
this._gotRetry = opts.gotRetry != null ? opts.gotRetry : { limit: 0 }
}
getLastUsedAssemblyUrl(): string {
return this._lastUsedAssemblyUrl
}
setDefaultTimeout(timeout: number): void {
this._defaultTimeout = timeout
}
/**
* Create an Assembly
*
* @param opts assembly options
*/
createAssembly(opts: CreateAssemblyOptions = {}): CreateAssemblyPromise {
const {
params = {},
waitForCompletion = false,
chunkSize: requestedChunkSize = Infinity,
uploadConcurrency = 10,
timeout = 24 * 60 * 60 * 1000, // 1 day
onUploadProgress = () => {},
onAssemblyProgress = () => {},
files = {},
uploads = {},
assemblyId,
} = opts
// Keep track of how long the request took
const startTimeMs = getHrTimeMs()
// Undocumented feature to allow specifying a custom assembly id from the client
// Not recommended for general use due to security. E.g if the user doesn't provide a cryptographically
// secure ID, then anyone could access the assembly.
let effectiveAssemblyId
if (assemblyId != null) {
effectiveAssemblyId = assemblyId
} else {
effectiveAssemblyId = randomUUID().replace(/-/g, '')
}
const urlSuffix = `/assemblies/${effectiveAssemblyId}`
// We want to be able to return the promise immediately with custom data
const promise = (async () => {
this._lastUsedAssemblyUrl = `${this._endpoint}${urlSuffix}`
await pMap(
Object.entries(files),
// eslint-disable-next-line no-bitwise
async ([, path]) => access(path, constants.F_OK | constants.R_OK),
{ concurrency: 5 }
)
// Convert uploads to streams
const streamsMap = Object.fromEntries(
Object.entries(uploads).map(([label, value]) => {
const isReadable = isReadableStream(value)
if (!isReadable && isStream(value)) {
// https://github.com/transloadit/node-sdk/issues/92
throw new Error(`Upload named "${label}" is not a Readable stream`)
}
return [label, isReadableStream(value) ? value : intoStream(value)]
})
)
// Wrap in object structure (so we can store whether it's a pathless stream or not)
const allStreamsMap = Object.fromEntries<Stream>(
Object.entries(streamsMap).map(([label, stream]) => [label, { stream }])
)
// Create streams from files too
for (const [label, path] of Object.entries(files)) {
const stream = createReadStream(path)
allStreamsMap[label] = { stream, path } // File streams have path
}
const allStreams = Object.values(allStreamsMap)
// Pause all streams
allStreams.forEach(({ stream }) => stream.pause())
// If any stream emits error, we want to handle this and exit with error
const streamErrorPromise = new Promise<AssemblyStatus>((resolve, reject) => {
allStreams.forEach(({ stream }) => stream.on('error', reject))
})
const createAssemblyAndUpload = async () => {
const result: AssemblyStatus = await this._remoteJson({
urlSuffix,
method: 'post',
timeout: { request: timeout },
params,
fields: {
tus_num_expected_upload_files: allStreams.length,
},
})
checkResult(result)
if (Object.keys(allStreamsMap).length > 0) {
await sendTusRequest({
streamsMap: allStreamsMap,
assembly: result,
onProgress: onUploadProgress,
requestedChunkSize,
uploadConcurrency,
})
}
if (!waitForCompletion) return result
if (result.assembly_id == null) {
throw new InconsistentResponseError(
'Server returned an assembly response without an assembly_id after creation'
)
}
const awaitResult = await this.awaitAssemblyCompletion(result.assembly_id, {
timeout,
onAssemblyProgress,
startTimeMs,
})
checkResult(awaitResult)
return awaitResult
}
return Promise.race([createAssemblyAndUpload(), streamErrorPromise])
})()
// This allows the user to use or log the assemblyId even before it has been created for easier debugging
return Object.assign(promise, { assemblyId: effectiveAssemblyId })
}
async awaitAssemblyCompletion(
assemblyId: string,
{
onAssemblyProgress = () => {},
timeout,
startTimeMs = getHrTimeMs(),
interval = 1000,
}: AwaitAssemblyCompletionOptions = {}
): Promise<AssemblyStatus> {
assert.ok(assemblyId)
// eslint-disable-next-line no-constant-condition
while (true) {
const result = await this.getAssembly(assemblyId)
// If 'ok' is not in result, it implies a terminal state (e.g., error, completed, canceled).
// If 'ok' is present, then we check if it's one of the non-terminal polling states.
if (
!('ok' in result) ||
(result.ok !== 'ASSEMBLY_UPLOADING' &&
result.ok !== 'ASSEMBLY_EXECUTING' &&
// ASSEMBLY_REPLAYING is not a valid 'ok' status for polling, it means it's done replaying.
// The API does not seem to have an ASSEMBLY_REPLAYING status in the typical polling loop.
// It's usually a final status from the replay endpoint.
// For polling, we only care about UPLOADING and EXECUTING.
// If a replay operation puts it into a pollable state, that state would be EXECUTING.
result.ok !== 'ASSEMBLY_REPLAYING') // This line might need review based on actual API behavior for replayed assembly polling
) {
return result // Done!
}
try {
onAssemblyProgress(result)
} catch (err) {
log('Caught onAssemblyProgress error', err)
}
const nowMs = getHrTimeMs()
if (timeout != null && nowMs - startTimeMs >= timeout) {
throw new PollingTimeoutError('Polling timed out')
}
await new Promise((resolve) => setTimeout(resolve, interval))
}
}
/**
* Cancel the assembly
*
* @param assemblyId assembly ID
* @returns after the assembly is deleted
*/
async cancelAssembly(assemblyId: string): Promise<AssemblyStatus> {
// You may wonder why do we need to call getAssembly first:
// If we use the default base URL (instead of the one returned in assembly_url_ssl),
// the delete call will hang in certain cases
// See test "should stop the assembly from reaching completion"
const { assembly_ssl_url: url } = await this.getAssembly(assemblyId)
return this._remoteJson({
url,
// urlSuffix: `/assemblies/${assemblyId}`, // Cannot simply do this, see above
method: 'delete',
})
}
/**
* Replay an Assembly
*
* @param assemblyId of the assembly to replay
* @param optional params
* @returns after the replay is started
*/
async replayAssembly(
assemblyId: string,
params: ReplayAssemblyParams = {}
): Promise<ReplayAssemblyResponse> {
const result: ReplayAssemblyResponse = await this._remoteJson({
urlSuffix: `/assemblies/${assemblyId}/replay`,
method: 'post',
...(Object.keys(params).length > 0 && { params }),
})
checkResult(result)
return result
}
/**
* Replay an Assembly notification
*
* @param assemblyId of the assembly whose notification to replay
* @param optional params
* @returns after the replay is started
*/
async replayAssemblyNotification(
assemblyId: string,
params: ReplayAssemblyNotificationParams = {}
): Promise<ReplayAssemblyNotificationResponse> {
return this._remoteJson({
urlSuffix: `/assembly_notifications/${assemblyId}/replay`,
method: 'post',
...(Object.keys(params).length > 0 && { params }),
})
}
/**
* List all assemblies
*
* @param params optional request options
* @returns list of Assemblies
*/
async listAssemblies(
params?: ListAssembliesParams
): Promise<PaginationListWithCount<ListedAssembly>> {
return this._remoteJson({
urlSuffix: '/assemblies',
method: 'get',
params: params || {},
})
}
streamAssemblies(params: ListAssembliesParams): Readable {
return new PaginationStream(async (page) => this.listAssemblies({ ...params, page }))
}
/**
* Get an Assembly
*
* @param assemblyId the Assembly Id
* @returns the retrieved Assembly
*/
async getAssembly(assemblyId: string): Promise<AssemblyStatus> {
const result: AssemblyStatus = await this._remoteJson({
urlSuffix: `/assemblies/${assemblyId}`,
})
checkAssemblyUrls(result)
return result
}
/**
* Create a Credential
*
* @param params optional request options
* @returns when the Credential is created
*/
async createTemplateCredential(
params: CreateTemplateCredentialParams
): Promise<TemplateCredentialResponse> {
return this._remoteJson({
urlSuffix: '/template_credentials',
method: 'post',
params: params || {},
})
}
/**
* Edit a Credential
*
* @param credentialId the Credential ID
* @param params optional request options
* @returns when the Credential is edited
*/
async editTemplateCredential(
credentialId: string,
params: CreateTemplateCredentialParams
): Promise<TemplateCredentialResponse> {
return this._remoteJson({
urlSuffix: `/template_credentials/${credentialId}`,
method: 'put',
params: params || {},
})
}
/**
* Delete a Credential
*
* @param credentialId the Credential ID
* @returns when the Credential is deleted
*/
async deleteTemplateCredential(credentialId: string): Promise<BaseResponse> {
return this._remoteJson({
urlSuffix: `/template_credentials/${credentialId}`,
method: 'delete',
})
}
/**
* Get a Credential
*
* @param credentialId the Credential ID
* @returns when the Credential is retrieved
*/
async getTemplateCredential(credentialId: string): Promise<TemplateCredentialResponse> {
return this._remoteJson({
urlSuffix: `/template_credentials/${credentialId}`,
method: 'get',
})
}
/**
* List all TemplateCredentials
*
* @param params optional request options
* @returns the list of templates
*/
async listTemplateCredentials(
params?: ListTemplateCredentialsParams
): Promise<TemplateCredentialsResponse> {
return this._remoteJson({
urlSuffix: '/template_credentials',
method: 'get',
params: params || {},
})
}
streamTemplateCredentials(params: ListTemplateCredentialsParams) {
return new PaginationStream(async (page) => ({
items: (await this.listTemplateCredentials({ ...params, page })).credentials,
}))
}
/**
* Create an Assembly Template
*
* @param params optional request options
* @returns when the template is created
*/
async createTemplate(params: CreateTemplateParams): Promise<TemplateResponse> {
return this._remoteJson({
urlSuffix: '/templates',
method: 'post',
params: params || {},
})
}
/**
* Edit an Assembly Template
*
* @param templateId the template ID
* @param params optional request options
* @returns when the template is edited
*/
async editTemplate(templateId: string, params: EditTemplateParams): Promise<TemplateResponse> {
return this._remoteJson({
urlSuffix: `/templates/${templateId}`,
method: 'put',
params: params || {},
})
}
/**
* Delete an Assembly Template
*
* @param templateId the template ID
* @returns when the template is deleted
*/
async deleteTemplate(templateId: string): Promise<BaseResponse> {
return this._remoteJson({
urlSuffix: `/templates/${templateId}`,
method: 'delete',
})
}
/**
* Get an Assembly Template
*
* @param templateId the template ID
* @returns when the template is retrieved
*/
async getTemplate(templateId: string): Promise<TemplateResponse> {
return this._remoteJson({
urlSuffix: `/templates/${templateId}`,
method: 'get',
})
}
/**
* List all Assembly Templates
*
* @param params optional request options
* @returns the list of templates
*/
async listTemplates(
params?: ListTemplatesParams
): Promise<PaginationListWithCount<ListedTemplate>> {
return this._remoteJson({
urlSuffix: '/templates',
method: 'get',
params: params || {},
})
}
streamTemplates(params?: ListTemplatesParams): PaginationStream<ListedTemplate> {
return new PaginationStream(async (page) => this.listTemplates({ ...params, page }))
}
/**
* Get account Billing details for a specific month
*
* @param month the date for the required billing in the format yyyy-mm
* @returns with billing data
* @see https://transloadit.com/docs/api/bill-date-get/
*/
async getBill(month: string): Promise<BillResponse> {
assert.ok(month, 'month is required')
return this._remoteJson({
urlSuffix: `/bill/${month}`,
method: 'get',
})
}
calcSignature(params: OptionalAuthParams): { signature: string; params: string } {
const jsonParams = this._prepareParams(params)
const signature = this._calcSignature(jsonParams)
return { signature, params: jsonParams }
}
/**
* Construct a signed Smart CDN URL. See https://transloadit.com/docs/topics/signature-authentication/#smart-cdn.
*/
getSignedSmartCDNUrl(opts: SmartCDNUrlOptions): string {
if (opts.workspace == null || opts.workspace === '')
throw new TypeError('workspace is required')
if (opts.template == null || opts.template === '') throw new TypeError('template is required')
if (opts.input == null) throw new TypeError('input is required') // `input` can be an empty string.
const workspaceSlug = encodeURIComponent(opts.workspace)
const templateSlug = encodeURIComponent(opts.template)
const inputField = encodeURIComponent(opts.input)
const expiresAt = opts.expiresAt || Date.now() + 60 * 60 * 1000 // 1 hour
const queryParams = new URLSearchParams()
for (const [key, value] of Object.entries(opts.urlParams || {})) {
if (Array.isArray(value)) {
for (const val of value) {
queryParams.append(key, `${val}`)
}
} else {
queryParams.append(key, `${value}`)
}
}
queryParams.set('auth_key', this._authKey)
queryParams.set('exp', `${expiresAt}`)
// The signature changes depending on the order of the query parameters. We therefore sort them on the client-
// and server-side to ensure that we do not get mismatching signatures if a proxy changes the order of query
// parameters or implementations handle query parameters ordering differently.
queryParams.sort()
const stringToSign = `${workspaceSlug}/${templateSlug}/${inputField}?${queryParams}`
const algorithm = 'sha256'
const signature = createHmac(algorithm, this._authSecret).update(stringToSign).digest('hex')
queryParams.set('sig', `sha256:${signature}`)
const signedUrl = `https://${workspaceSlug}.tlcdn.com/${templateSlug}/${inputField}?${queryParams}`
return signedUrl
}
private _calcSignature(toSign: string, algorithm = 'sha384'): string {
return `${algorithm}:${createHmac(algorithm, this._authSecret)
.update(Buffer.from(toSign, 'utf-8'))
.digest('hex')}`
}
// Sets the multipart/form-data for POST, PUT and DELETE requests, including
// the streams, the signed params, and any additional fields.
private _appendForm(form: FormData, params: OptionalAuthParams, fields?: Fields): void {
const sigData = this.calcSignature(params)
const jsonParams = sigData.params
const { signature } = sigData
form.append('params', jsonParams)
if (fields != null) {
for (const [key, val] of Object.entries(fields)) {
form.append(key, val)
}
}
form.append('signature', signature)
}
// Implements HTTP GET query params, handling the case where the url already
// has params.
private _appendParamsToUrl(url: string, params: OptionalAuthParams): string {
const { signature, params: jsonParams } = this.calcSignature(params)
const prefix = url.indexOf('?') === -1 ? '?' : '&'
return `${url}${prefix}signature=${signature}¶ms=${encodeURIComponent(jsonParams)}`
}
// Responsible for including auth parameters in all requests
private _prepareParams(paramsIn?: OptionalAuthParams): string {
let params = paramsIn
if (params == null) {
params = {}
}
if (params['auth'] == null) {
params['auth'] = {}
}
if (params['auth'].key == null) {
params['auth'].key = this._authKey
}
if (params['auth'].expires == null) {
params['auth'].expires = this._getExpiresDate()
}
return JSON.stringify(params)
}
// We want to mock this method
// eslint-disable-next-line class-methods-use-this
private _getExpiresDate(): string {
const expiresDate = new Date()
expiresDate.setDate(expiresDate.getDate() + 1)
return expiresDate.toISOString()
}
// Responsible for making API calls. Automatically sends streams with any POST,
// PUT or DELETE requests. Automatically adds signature parameters to all
// requests. Also automatically parses the JSON response.
private async _remoteJson<TRet, TParams extends OptionalAuthParams>(opts: {
urlSuffix?: string
url?: string
timeout?: Delays
method?: 'delete' | 'get' | 'post' | 'put'
params?: TParams
fields?: Fields
headers?: Headers
}): Promise<TRet> {
const {
urlSuffix,
url: urlInput,
timeout = { request: this._defaultTimeout },
method = 'get',
params = {},
fields,
headers,
} = opts
// Allow providing either a `urlSuffix` or a full `url`
if (!urlSuffix && !urlInput) throw new Error('No URL provided')
let url = urlInput || `${this._endpoint}${urlSuffix}`
if (method === 'get') {
url = this._appendParamsToUrl(url, params)
}
log('Sending request', method, url)
// todo use got.retry instead because we are no longer using FormData (which is a stream and can only be used once)
// https://github.com/sindresorhus/got/issues/1282
for (let retryCount = 0; ; retryCount++) {
let form: FormData | undefined
if (method === 'post' || method === 'put' || method === 'delete') {
form = new FormData()
this._appendForm(form, params, fields)
}
const requestOpts: OptionsOfJSONResponseBody = {
retry: this._gotRetry,
body: form,
timeout,
headers: {
'Transloadit-Client': `node-sdk:${version}`,
'User-Agent': undefined, // Remove got's user-agent
...headers,
},
responseType: 'json',
}
try {
const request = got[method]<TRet>(url, requestOpts)
const { body } = await request
// console.log(body)
return body
} catch (err) {
if (!(err instanceof RequestError)) throw err
if (err instanceof HTTPError) {
const { statusCode, body } = err.response
logWarn('HTTP error', statusCode, body)
// check whether we should retry
// https://transloadit.com/blog/2012/04/introducing-rate-limiting/
if (
typeof body === 'object' &&
body != null &&
'error' in body &&
'info' in body &&
typeof body.info === 'object' &&
body.info != null &&
'retryIn' in body.info &&
typeof body.info.retryIn === 'number' &&
Boolean(body.info.retryIn) &&
retryCount < this._maxRetries && // 413 taken from https://transloadit.com/blog/2012/04/introducing-rate-limiting/
// todo can 413 be removed?
((statusCode === 413 && body.error === 'RATE_LIMIT_REACHED') || statusCode === 429)
) {
const { retryIn: retryInSec } = body.info
logWarn(`Rate limit reached, retrying request in approximately ${retryInSec} seconds.`)
const retryInMs = 1000 * (retryInSec * (1 + 0.1 * Math.random()))
await new Promise((resolve) => setTimeout(resolve, retryInMs))
// Retry
} else {
throw new ApiError({
cause: err,
body: err.response?.body as TransloaditErrorResponseBody | undefined,
}) // todo don't assert type
}
} else {
throw err
}
}
}
}
}
|