transloadit 3.0.2 → 4.0.0-2

package/CHANGELOG.md

@@ -1,8 +1,6 @@
 # Changelog
 
-Here's is a combined todo/done list. You can see what todos are planned for the upcoming release.
-
-See [GitHub releases](https://github.com/transloadit/node-sdk/releases) for change log from this point on
+We're no longer using this file. Please refer to [GitHub releases](https://github.com/transloadit/node-sdk/releases) to see documented changes after version 2.0.10.
 
 ## v2.0.10
 
@@ -18,7 +16,7 @@ Released: 2018-12-06.
 
 [Diff](https://github.com/transloadit/node-sdk/compare/v2.0.5...v2.0.9).
 
-- [x] Add more helpful message to assembly error (#73) 
+- [x] Add more helpful message to assembly error (#73)
 - [x] Add Assembly ID to unknown errors
 - [x] Upgrade linting and fix newly found errors
 
@@ -28,7 +26,7 @@ Released: 2018-12-06.
 
 [Diff](https://github.com/transloadit/node-sdk/compare/v2.0.5...v2.0.7).
 
-- [x] Fix Transloadit-Client header test for once and all (#62) 
+- [x] Fix Transloadit-Client header test for once and all (#62)
 - [x] Fix bug causing progressCb to only be fired once
 
 ## v2.0.5
@@ -37,9 +35,9 @@ Released: 2018-12-06.
 
 [Diff](https://github.com/transloadit/node-sdk/compare/v2.0.4...v2.0.5).
 
-- [x] Make resize image example more usable irl 
+- [x] Make resize image example more usable irl
 - [x] Update Readme to include example for progressCb.
-- [x] Fix failing test due to version increase (#61) 
+- [x] Fix failing test due to version increase (#61)
 - [x] Update npm-run-all to lose event-stream dependency
 
 ## v2.0.4
@@ -48,7 +46,7 @@ Released: 2018-11-05.
 
 [Diff](https://github.com/transloadit/node-sdk/compare/v2.0.3...v2.0.4).
 
-- [x] Send transloadit-client header (#59) 
+- [x] Send transloadit-client header (#59)
 
 ## v2.0.3
 
@@ -72,7 +70,7 @@ Released: 2018-06-18.
 
 [Diff](https://github.com/transloadit/node-sdk/compare/v2.0.0...v2.0.1).
 
-- [x] Fix bug: invoke callback when waitforcompmletion is false 
+- [x] Fix bug: invoke callback when waitforcompmletion is false
 
 ## v2.0.0
 
@@ -91,7 +89,6 @@ Released: 2018-05-23.
 
 - [x] Add Assembly URL to error console logs for easier debugging. (Q: should the node sdk log to console at all? should it not just work with callbacks and the caller decides what to write to what medium?)
 
-
 ## v1.10.3
 
 Released: 2018-01-09.
@@ -127,7 +124,7 @@ Released: 2017-09-28.
 
 ## v1.9.6
 
-Released: 2017-09-26. 
+Released: 2017-09-26.
 
 [Diff](https://github.com/transloadit/node-sdk/compare/v1.9.5...v1.9.6).
 
@@ -138,7 +135,7 @@ Released: 2017-09-26.
 
 ## v1.9.5
 
-Released: 2017-09-26. 
+Released: 2017-09-26.
 
 [Diff](https://github.com/transloadit/node-sdk/compare/v0.0.22...1.9.5).
 

package/README.md

@@ -1,6 +1,13 @@
-<img src="https://assets.transloadit.com/assets/images/artwork/logos-transloadit-default.svg" width="400" />
+[![Build Status](https://github.com/transloadit/node-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/transloadit/node-sdk/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/transloadit/node-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/transloadit/node-sdk)
 
-[![](https://github.com/transloadit/node-sdk/workflows/Tests/badge.svg)](https://github.com/transloadit/node-sdk/actions?query=workflow%3ATests) [![](https://transloadit.github.io/node-sdk-coverage/coverage-badge.svg)](https://transloadit.github.io/node-sdk-coverage)
+<a href="https://transloadit.com/?utm_source=github&utm_medium=referral&utm_campaign=sdks&utm_content=node_sdk">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://assets.transloadit.com/assets/images/sponsorships/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://assets.transloadit.com/assets/images/sponsorships/logo-default.svg">
+    <img src="https://assets.transloadit.com/assets/images/sponsorships/logo-default.svg" alt="Transloadit Logo">
+  </picture>
+</a>
 
 This is the official **Node.js** SDK for [Transloadit](https://transloadit.com)'s file uploading and encoding service.
 
@@ -17,7 +24,7 @@ This is a **Node.js** SDK to make it easy to talk to the
 
 ## Requirements
 
-- [Node.js](https://nodejs.org/en/) version 10 or newer
+- [Node.js](https://nodejs.org/en/) version 18 or newer
 - [A Transloadit account](https://transloadit.com/signup/) ([free signup](https://transloadit.com/pricing/))
 - [Your API credentials](https://transloadit.com/c/template-credentials) (`authKey`, `authSecret`)
 
@@ -30,7 +37,9 @@ Inside your project, type:
 ```bash
 yarn add transloadit
 ```
+
 or
+
 ```bash
 npm install --save transloadit
 ```
@@ -40,76 +49,77 @@ npm install --save transloadit
 The following code will upload an image and resize it to a thumbnail:
 
 ```javascript
-const Transloadit = require('transloadit')
+const { Transloadit } = require('transloadit')
 
 const transloadit = new Transloadit({
-  authKey   : 'YOUR_TRANSLOADIT_KEY',
+  authKey: 'YOUR_TRANSLOADIT_KEY',
   authSecret: 'YOUR_TRANSLOADIT_SECRET',
-});
+})
 
-(async () => {
-  try {
-    const options = {
-      files: {
-        file1: '/PATH/TO/FILE.jpg',
-      },
-      params: {
-        steps: { // You can have many Steps. In this case we will just resize any inputs (:original)
-          resize: {
-            use   : ':original',
-            robot : '/image/resize',
-            result: true,
-            width : 75,
-            height: 75,
-          },
+try {
+  const options = {
+    files: {
+      file1: '/PATH/TO/FILE.jpg',
+    },
+    params: {
+      steps: {
+        // You can have many Steps. In this case we will just resize any inputs (:original)
+        resize: {
+          use: ':original',
+          robot: '/image/resize',
+          result: true,
+          width: 75,
+          height: 75,
         },
-        // OR if you already created a template, you can use it instead of "steps":
-        // template_id: 'YOUR_TEMPLATE_ID',
       },
-      waitForCompletion: true,  // Wait for the Assembly (job) to finish executing before returning
-    }
-
-    const status = await transloadit.createAssembly(options)
-
-    if (status.results.resize) {
-      console.log('✅ Success - Your resized image:', status.results.resize[0].ssl_url)
-    } else {
-      console.log("❌ The Assembly didn't produce any output. Make sure you used a valid image file")
-    }
-  } catch (err) {
-    console.error('❌ Unable to process Assembly.', err)
-    if (err.assemblyId) {
-      console.error(`💡 More info: https://transloadit.com/assemblies/${err.assemblyId}`)
-    }
+      // OR if you already created a template, you can use it instead of "steps":
+      // template_id: 'YOUR_TEMPLATE_ID',
+    },
+    waitForCompletion: true, // Wait for the Assembly (job) to finish executing before returning
   }
-})()
+
+  const status = await transloadit.createAssembly(options)
+
+  if (status.results.resize) {
+    console.log('✅ Success - Your resized image:', status.results.resize[0].ssl_url)
+  } else {
+    console.log("❌ The Assembly didn't produce any output. Make sure you used a valid image file")
+  }
+} catch (err) {
+  console.error('❌ Unable to process Assembly.', err)
+  if (err instanceof ApiError && err.assemblyId) {
+    console.error(`💡 More info: https://transloadit.com/assemblies/${err.assemblyId}`)
+  }
+}
 ```
 
 You can find [details about your executed Assemblies here](https://transloadit.com/assemblies).
 
 ## Examples
 
-- [Upload and resize image](https://github.com/transloadit/node-sdk/blob/master/examples/resize_an_image.js)
-- [Upload image and convert to WebP](https://github.com/transloadit/node-sdk/blob/master/examples/convert_to_webp.js)
-- [Crop a face out of an image and download the result](https://github.com/transloadit/node-sdk/blob/master/examples/face_detect_download.js)
-- [Retry example](https://github.com/transloadit/node-sdk/blob/master/examples/retry.js)
-- [Calculate total costs (GB usage)](https://github.com/transloadit/node-sdk/blob/master/examples/fetch_costs_of_all_assemblies_in_timeframe.js)
-- [Templates CRUD](https://github.com/transloadit/node-sdk/blob/master/examples/template_api.js)
+- [Upload and resize image](https://github.com/transloadit/node-sdk/blob/main/examples/resize_an_image.js)
+- [Upload image and convert to WebP](https://github.com/transloadit/node-sdk/blob/main/examples/convert_to_webp.js)
+- [Crop a face out of an image and download the result](https://github.com/transloadit/node-sdk/blob/main/examples/face_detect_download.js)
+- [Retry example](https://github.com/transloadit/node-sdk/blob/main/examples/retry.js)
+- [Calculate total costs (GB usage)](https://github.com/transloadit/node-sdk/blob/main/examples/fetch_costs_of_all_assemblies_in_timeframe.js)
+- [Templates CRUD](https://github.com/transloadit/node-sdk/blob/main/examples/template_api.js)
 
-For more fully working examples take a look at [`examples/`](examples/).
+For more fully working examples take a look at [`examples/`](https://github.com/transloadit/node-sdk/blob/main/examples/).
 
 For more example use cases and information about the available robots and their parameters, check out the [Transloadit website](https://transloadit.com/).
 
 ## API
 
-These are the public methods on the `Transloadit` object and their descriptions. The methods are based on the [Transloadit API](https://transloadit.com/docs/api/). See also [TypeScript definitions](types/index.d.ts).
+These are the public methods on the `Transloadit` object and their descriptions. The methods are based on the [Transloadit API](https://transloadit.com/docs/api/).
 
 Table of contents:
+
 - [Main](#main)
 - [Assemblies](#assemblies)
 - [Assembly notifications](#assembly-notifications)
 - [Templates](#templates)
 - [Errors](#errors)
+- [Rate limiting & auto retry](#rate-limiting--auto-retry)
 
 ### Main
 
@@ -118,10 +128,12 @@ Table of contents:
 Returns a new instance of the client.
 
 The `options` object can contain the following keys:
+
 - `authKey` **(required)** - see [requirements](#requirements)
 - `authSecret` **(required)** - see [requirements](#requirements)
 - `endpoint` (default `'https://api2.transloadit.com'`)
 - `maxRetries` (default `5`) - see [Rate limiting & auto retry](#rate-limiting--auto-retry)
+- `gotRetry` (default `0`) - see [Rate limiting & auto retry](#rate-limiting--auto-retry)
 - `timeout` (default `60000`: 1 minute) - the timeout (in milliseconds) for all requests (except `createAssembly`)
 
 ### Assemblies
@@ -132,25 +144,30 @@ Creates a new Assembly on Transloadit and optionally upload the specified `files
 
 You can provide the following keys inside the `options` object:
 
-- `params` **(required)** - An object containing keys defining the Assembly's behavior with the following keys: (See also [API doc](https://transloadit.com/docs/api/#assemblies-post) and [examples](#examples))
-  - `steps` - Assembly instructions - See [Transloadit docs](https://transloadit.com/docs/#assembly-instructions) and [demos](https://transloadit.com/demos/) for inspiration.
-  - `template_id` - The ID of the Template that contains your Assembly Instructions. **One of either `steps` or `template_id` is required.** If you specify both, then [any Steps will overrule the template](https://transloadit.com/docs/#overruling-templates-at-runtime).
-  - `fields` - An object of form fields to add to the request, to make use of in the Assembly instructions via [Assembly variables](https://transloadit.com/docs#assembly-variables). 
+- `params` **(required)** - An object containing keys defining the Assembly's behavior with the following keys: (See also [API doc](https://transloadit.com/docs/api/assemblies-post/) and [examples](#examples))
+  - `steps` - Assembly instructions - See [Transloadit docs](https://transloadit.com/docs/topics/assembly-instructions/) and [demos](https://transloadit.com/demos/) for inspiration.
+  - `template_id` - The ID of the Template that contains your Assembly Instructions. **One of either `steps` or `template_id` is required.** If you specify both, then [any Steps will overrule the template](https://transloadit.com/docs/topics/templates/#overruling-templates-at-runtime).
+  - `fields` - An object of form fields to add to the request, to make use of in the Assembly instructions via [Assembly variables](https://transloadit.com/docs#assembly-variables).
   - `notify_url` - Transloadit can send a Pingback to your server when the Assembly is completed. We'll send the Assembly Status in JSON encoded string inside a transloadit field in a multipart POST request to the URL supplied here.
-- `files` - An object (key-value pairs) containing one or more file paths to upload and use in your Assembly. The *key* is the *field name* and the *value* is the path to the file to be uploaded. The *field name* and the file's name may be used in the ([Assembly instructions](https://transloadit.com/docs/#assembly-instructions)) (`params`.`steps`) to refer to the particular file. See example below.
+- `files` - An object (key-value pairs) containing one or more file paths to upload and use in your Assembly. The _key_ is the _field name_ and the _value_ is the path to the file to be uploaded. The _field name_ and the file's name may be used in the ([Assembly instructions](https://transloadit.com/docs/topics/assembly-instructions/)) (`params`.`steps`) to refer to the particular file. See example below.
   - `'fieldName': '/path/to/file'`
   - more files...
-- `uploads` - An object (key-value pairs) containing one or more files to upload and use in your Assembly. The *key* is the *file name* and the *value* is the *content* of the file to be uploaded. *Value* can be one of many types:
-  - `'fieldName': (Readable | Buffer | TypedArray | ArrayBuffer | string | Iterable<Buffer | string> | AsyncIterable<Buffer | string> | Promise)`
+- `uploads` - An object (key-value pairs) containing one or more files to upload and use in your Assembly. The _key_ is the _file name_ and the _value_ is the _content_ of the file to be uploaded. _Value_ can be one of many types:
+  - `'fieldName': (Readable | Buffer | TypedArray | ArrayBuffer | string | Iterable<Buffer | string> | AsyncIterable<Buffer | string> | Promise)`.
   - more uploads...
 - `waitForCompletion` - A boolean (default is `false`) to indicate whether you want to wait for the Assembly to finish with all encoding results present before the promise is fulfilled. If `waitForCompletion` is `true`, this SDK will poll for status updates and fulfill the promise when all encoding work is done.
 - `timeout` - Number of milliseconds to wait before aborting (default `86400000`: 24 hours).
 - `onUploadProgress` - An optional function that will be periodically called with the file upload progress, which is an with an object containing:
   - `uploadedBytes` - Number of bytes uploaded so far.
   - `totalBytes` - Total number of bytes to upload or `undefined` if unknown (Streams).
-- `onAssemblyProgress` - Once the Assembly has started processing this will be periodically called with the *Assembly Execution Status* (result of `getAssembly`) **only if `waitForCompletion` is `true`**.
+- `onAssemblyProgress` - Once the Assembly has started processing this will be periodically called with the _Assembly Execution Status_ (result of `getAssembly`) **only if `waitForCompletion` is `true`**.
+- `chunkSize` - (for uploads) a number indicating the maximum size of a tus `PATCH` request body in bytes. Default to `Infinity` for file uploads and 50MB for streams of unknown length. See [tus-js-client](https://github.com/tus/tus-js-client/blob/master/docs/api.md#chunksize).
+- `uploadConcurrency` - Maximum number of concurrent tus file uploads to occur at any given time (default 10.)
+
+**NOTE**: Make sure the key in `files` and `uploads` is not one of `signature`, `params` or `max_size`.
 
 Example code showing all options:
+
 ```js
 await transloadit.createAssembly({
   files: {
@@ -169,7 +186,7 @@ await transloadit.createAssembly({
     fields: {
       field1: 'Field value',
       // ...
-    }, 
+    },
     notify_url: 'https://example.com/notify-url',
   },
   waitForCompletion: true,
@@ -180,13 +197,18 @@ await transloadit.createAssembly({
 ```
 
 Example `onUploadProgress` and `onAssemblyProgress` handlers:
+
 ```javascript
 function onUploadProgress({ uploadedBytes, totalBytes }) {
   // NOTE: totalBytes may be undefined
   console.log(`♻️ Upload progress polled: ${uploadedBytes} of ${totalBytes} bytes uploaded.`)
 }
 function onAssemblyProgress(assembly) {
-  console.log(`♻️ Assembly progress polled: ${assembly.error ? assembly.error : assembly.ok} ${assembly.assembly_id} ... `)
+  console.log(
+    `♻️ Assembly progress polled: ${assembly.error ? assembly.error : assembly.ok} ${
+      assembly.assembly_id
+    } ... `
+  )
 }
 ```
 
@@ -198,16 +220,16 @@ console.log('Creating', promise.assemblyId)
 const status = await promise
 ```
 
-
 See also:
-- [API documentation](https://transloadit.com/docs/api/#assemblies-post)
+
+- [API documentation](https://transloadit.com/docs/api/assemblies-post/)
 - Error codes and retry logic below
 
 #### async listAssemblies(params)
 
 Retrieve Assemblies according to the given `params`.
 
-Valid params can be `page`, `pagesize`, `type`, `fromdate`, `todate` and `keywords`. Please consult the [API documentation](https://transloadit.com/docs/api/#retrieve-assembly-list) for details.
+Valid params can be `page`, `pagesize`, `type`, `fromdate`, `todate` and `keywords`. Please consult the [API documentation](https://transloadit.com/docs/api/assemblies-get/) for details.
 
 The method returns an object containing these properties:
 
@@ -221,41 +243,43 @@ Creates an `objectMode` `Readable` stream that automates handling of `listAssemb
 This can be used to iterate through Assemblies:
 
 ```javascript
-const assemblyStream = transloadit.streamAssemblies({ fromdate: '2016-08-19 01:15:00 UTC' });
+const assemblyStream = transloadit.streamAssemblies({ fromdate: '2016-08-19 01:15:00 UTC' })
 
-assemblyStream.on('readable', function() {
-  const assembly = assemblyStream.read();
-  if (assembly == null) console.log('end of stream');
+assemblyStream.on('readable', function () {
+  const assembly = assemblyStream.read()
+  if (assembly == null) console.log('end of stream')
 
-  console.log(assembly.id);
-});
+  console.log(assembly.id)
+})
 ```
 
 Results can also be piped. Here's an example using
 [through2](https://github.com/rvagg/through2):
 
 ```javascript
-const assemblyStream = transloadit.streamAssemblies({ fromdate: '2016-08-19 01:15:00 UTC' });
+const assemblyStream = transloadit.streamAssemblies({ fromdate: '2016-08-19 01:15:00 UTC' })
 
 assemblyStream
-  .pipe(through.obj(function(chunk, enc, callback) {
-    this.push(chunk.id + '\n');
-    callback();
-  }))
-  .pipe(fs.createWriteStream('assemblies.txt'));
+  .pipe(
+    through.obj(function (chunk, enc, callback) {
+      this.push(chunk.id + '\n')
+      callback()
+    })
+  )
+  .pipe(fs.createWriteStream('assemblies.txt'))
 ```
 
 #### async getAssembly(assemblyId)
 
-Retrieves the JSON status of the Assembly identified by the given `assemblyId`. See [API documentation](https://transloadit.com/docs/api/#assemblies-assembly-id-get).
+Retrieves the JSON status of the Assembly identified by the given `assemblyId`. See [API documentation](https://transloadit.com/docs/api/assemblies-assembly-id-get/).
 
 #### async cancelAssembly(assemblyId)
 
-Removes the Assembly identified by the given `assemblyId` from the memory of the Transloadit machines, ultimately cancelling it. This does not delete the Assembly from the database - you can still access it on `https://transloadit.com/assemblies/{assembly_id}` in your Transloadit account. This also does not delete any files associated with the Assembly from the Transloadit servers. See [API documentation](https://transloadit.com/docs/api/#assemblies-assembly-id-delete).
+Removes the Assembly identified by the given `assemblyId` from the memory of the Transloadit machines, ultimately cancelling it. This does not delete the Assembly from the database - you can still access it on `https://transloadit.com/assemblies/{assembly_id}` in your Transloadit account. This also does not delete any files associated with the Assembly from the Transloadit servers. See [API documentation](https://transloadit.com/docs/api/assemblies-assembly-id-delete/).
 
 #### async replayAssembly(assemblyId, params)
 
-Replays the Assembly identified by the given `assemblyId` (required argument). Optionally you can also provide a `notify_url` key inside `params` if you want to change the notification target. See [API documentation](https://transloadit.com/docs/api/#assemblies-assembly-id-replay-post) for more info about `params`.
+Replays the Assembly identified by the given `assemblyId` (required argument). Optionally you can also provide a `notify_url` key inside `params` if you want to change the notification target. See [API documentation](https://transloadit.com/docs/api/assemblies-assembly-id-replay-post/) for more info about `params`.
 
 The response from the `replayAssembly` is minimal and does not contain much information about the replayed assembly. Please call `getAssembly` or `awaitAssemblyCompletion` after replay to get more information:
 
@@ -264,7 +288,9 @@ const replayAssemblyResponse = await transloadit.replayAssembly(failedAssemblyId
 
 const assembly = await transloadit.getAssembly(replayAssemblyResponse.assembly_id)
 // Or
-const completedAssembly = await transloadit.awaitAssemblyCompletion(replayAssemblyResponse.assembly_id)
+const completedAssembly = await transloadit.awaitAssemblyCompletion(
+  replayAssemblyResponse.assembly_id
+)
 ```
 
 #### async awaitAssemblyCompletion(assemblyId, opts)
@@ -272,6 +298,7 @@ const completedAssembly = await transloadit.awaitAssemblyCompletion(replayAssemb
 This function will continously poll the specified Assembly `assemblyId` and resolve when it is done uploading and executing (until `result.ok` is no longer `ASSEMBLY_UPLOADING`, `ASSEMBLY_EXECUTING` or `ASSEMBLY_REPLAYING`). It resolves with the same value as `getAssembly`.
 
 `opts` is an object with the keys:
+
 - `onAssemblyProgress` - A progress function called on each poll. See `createAssembly`
 - `timeout` - How many milliseconds until polling times out (default: no timeout)
 - `interval` - Poll interval in milliseconds (default `1000`)
@@ -284,20 +311,7 @@ Returns the internal url that was used for the last call to `createAssembly`. Th
 
 #### async replayAssemblyNotification(assemblyId, params)
 
-Replays the notification for the Assembly identified by the given `assemblyId` (required argument). Optionally you can also provide a `notify_url` key inside `params` if you want to change the notification target. See [API documentation](https://transloadit.com/docs/api/#assembly-notifications-assembly-id-replay-post) for more info about `params`.
-
-#### async listAssemblyNotifications(params)
-
-Retrieve Assembly notifications according to `params`. [See example](examples/list_assembly_notifications.js) and [API documentation](https://transloadit.com/docs/api/#assembly-notifications-get) for more info about `params`.
-
-The method returns an object containing these properties:
-
-- `items`: An `Array` of up to `pagesize` Assembly notifications
-- `count`: Total number of Assembly notifications
-
-#### streamAssemblyNotifications(params)
-
-Creates an `objectMode` `Readable` stream that automates handling of `listAssemblynotifications` pagination. Similar to `streamAssemblies`.
+Replays the notification for the Assembly identified by the given `assemblyId` (required argument). Optionally you can also provide a `notify_url` key inside `params` if you want to change the notification target. See [API documentation](https://transloadit.com/docs/api/assembly-notifications-assembly-id-replay-post/) for more info about `params`.
 
 ### Templates
 
@@ -306,21 +320,22 @@ Templates are Steps that can be reused. [See example template code](examples/tem
 #### async createTemplate(params)
 
 Creates a template the provided params. The required `params` keys are:
+
 - `name` - The template name
 - `template` - The template JSON object containing its `steps`
 
-See also [API documentation](https://transloadit.com/docs/api/#templates-post).
+See also [API documentation](https://transloadit.com/docs/api/templates-post/).
 
 ```js
 const template = {
   steps: {
     encode: {
-      use   : ':original',
-      robot : '/video/encode',
+      use: ':original',
+      robot: '/video/encode',
       preset: 'ipad-high',
     },
     thumbnail: {
-      use  : 'encode',
+      use: 'encode',
       robot: '/video/thumbnails',
     },
   },
@@ -332,19 +347,19 @@ console.log('✅ Template created with template_id', result.id)
 
 #### async editTemplate(templateId, params)
 
-Updates the template represented by the given `templateId` with the new value. The `params` works just like the one from the `createTemplate` call. See [API documentation](https://transloadit.com/docs/api/#templates-template-id-put).
+Updates the template represented by the given `templateId` with the new value. The `params` works just like the one from the `createTemplate` call. See [API documentation](https://transloadit.com/docs/api/templates-template-id-put/).
 
 #### async getTemplate(templateId)
 
-Retrieves the name and the template JSON for the template represented by the given `templateId`. See [API documentation](https://transloadit.com/docs/api/#templates-template-id-get).
+Retrieves the name and the template JSON for the template represented by the given `templateId`. See [API documentation](https://transloadit.com/docs/api/templates-template-id-get/).
 
 #### async deleteTemplate(templateId)
 
-Deletes the template represented by the given `templateId`. See [API documentation](https://transloadit.com/docs/api/#templates-template-id-delete).
+Deletes the template represented by the given `templateId`. See [API documentation](https://transloadit.com/docs/api/templates-template-id-delete/).
 
 #### async listTemplates(params)
 
-Retrieve all your templates. See [API documentation](https://transloadit.com/docs/api/#templates-get) for more info about `params`.
+Retrieve all your templates. See [API documentation](https://transloadit.com/docs/api/templates-template-id-get/) for more info about `params`.
 
 The method returns an object containing these properties:
 
@@ -363,7 +378,7 @@ Same as `constructor` `timeout` option: Set the default timeout (in milliseconds
 
 #### async getBill(date)
 
-Retrieves the billing data for a given `date` string with format `YYYY-MM`. See [API documentation](https://transloadit.com/docs/api/#bill-date-get).
+Retrieves the billing data for a given `date` string with format `YYYY-MM`. See [API documentation](https://transloadit.com/docs/api/bill-date-get/).
 
 #### calcSignature(params)
 
@@ -371,41 +386,84 @@ Calculates a signature for the given `params` JSON object. If the `params` objec
 
 This function returns an object with the key `signature` (containing the calculated signature string) and a key `params`, which contains the stringified version of the passed `params` object (including the set expires and authKey keys).
 
+#### getSignedSmartCDNUrl(params)
+
+Constructs a signed Smart CDN URL, as defined in the [API documentation](https://transloadit.com/docs/topics/signature-authentication/#smart-cdn). `params` must be an object with the following properties:
+
+- `workspace` - Workspace slug (required)
+- `template` - Template slug or template ID (required)
+- `input` - Input value that is provided as `${fields.input}` in the template (required)
+- `urlParams` - Object with additional parameters for the URL query string (optional)
+- `expiresAt` - Expiration timestamp of the signature in milliseconds since UNIX epoch. Defaults to 1 hour from now. (optional)
+
+Example:
+
+```js
+const client = new Transloadit({ authKey: 'foo_key', authSecret: 'foo_secret' })
+const url = client.getSignedSmartCDNUrl({
+  workspace: 'foo_workspace',
+  template: 'foo_template',
+  input: 'foo_input',
+  urlParams: {
+    foo: 'bar',
+  },
+})
+
+// url is:
+// https://foo_workspace.tlcdn.com/foo_template/foo_input?auth_key=foo_key&exp=1714525200000&foo=bar&sig=sha256:9548915ec70a5f0d05de9497289e792201ceec19a526fe315f4f4fd2e7e377ac
+```
+
 ### Errors
 
-Errors from Node.js will be passed on and we use [GOT](https://github.com/sindresorhus/got) for HTTP requests and errors from there will also be passed on. When the HTTP response code is not 200, the error will be a `Transloadit.HTTPError`, which is a [got.HTTPError](https://github.com/sindresorhus/got#errors)) with some additional properties:
+Any errors originating from Node.js will be passed on and we use [GOT](https://github.com/sindresorhus/got) v11 for HTTP requests. [Errors from `got`](https://github.com/sindresorhus/got/tree/v11.8.6?tab=readme-ov-file#errors) will also be passed on, _except_ the `got.HTTPError` which will be replaced with a `transloadit.ApiError`, which will have its `cause` property set to the instance of the original `got.HTTPError`. `transloadit.ApiError` has these properties:
 
-- `HTTPError.response?.body` the JSON object returned by the server along with the error response (**note**: `HTTPError.response` will be `undefined` for non-server errors)
-- `HTTPError.transloaditErrorCode` alias for `HTTPError.response.body.error` ([View all error codes](https://transloadit.com/docs/api/#error-codes))
-- `HTTPError.assemblyId` (alias for `HTTPError.response.body.assembly_id`, if the request regards an [Assembly](https://transloadit.com/docs/api/#assemblies-assembly-id-get))
+- `code` (`string`) - [The Transloadit API error code](https://transloadit.com/docs/api/response-codes/#error-codes).
+- `rawMessage` (`string`) - A textual representation of the Transloadit API error.
+- `assemblyId`: (`string`) - If the request is related to an assembly, this will be the ID of the assembly.
+- `assemblySslUrl` (`string`) - If the request is related to an assembly, this will be the SSL URL to the assembly .
 
 To identify errors you can either check its props or use `instanceof`, e.g.:
+
 ```js
-catch (err) {
-  if (err instanceof Transloadit.TimeoutError) {
+try {
+  await transloadit.createAssembly(options)
+} catch (err) {
+  if (err instanceof got.TimeoutError) {
     return console.error('The request timed out', err)
   }
   if (err.code === 'ENOENT') {
     return console.error('Cannot open file', err)
   }
-  if (err.transloaditErrorCode === 'ASSEMBLY_INVALID_STEPS') {
+  if (err instanceof ApiError && err.code === 'ASSEMBLY_INVALID_STEPS') {
     return console.error('Invalid Assembly Steps', err)
   }
 }
 ```
 
-**Note:** Assemblies that have an error status (`assembly.error`) will only result in an error thrown from `createAssembly` and `replayAssembly`. For other Assembly methods, no errors will be thrown, but any error can be found in the response's `error` property
+**Note:** Assemblies that have an error status (`assembly.error`) will only result in an error being thrown from `createAssembly` and `replayAssembly`. For other Assembly methods, no errors will be thrown, but any error can be found in the response's `error` property (also `ApiError.code`).
 
-- [More information on Transloadit errors (`transloaditErrorCode`)](https://transloadit.com/docs/api/#error-codes)
+- [More information on Transloadit errors (`ApiError.code`)](https://transloadit.com/docs/api/response-codes/#error-codes)
 - [More information on request errors](https://github.com/sindresorhus/got#errors)
 
 ### Rate limiting & auto retry
 
-All functions of the client automatically obey all rate limiting imposed by Transloadit (e.g. `RATE_LIMIT_REACHED`). It will automatically retry requests **5 times** with auto back-off (`maxRetries` option). There is no need to write your own wrapper scripts to handle rate limits.
+There are three kinds of retries:
+
+#### Retry on rate limiting (`maxRetries`, default `5`)
+
+All functions of the client automatically obey all rate limiting imposed by Transloadit (e.g. `RATE_LIMIT_REACHED`), so there is no need to write your own wrapper scripts to handle rate limits. The SDK will by default retry requests **5 times** with auto back-off (See `maxRetries` constructor option).
+
+#### GOT HTTP retries (`gotRetry`, default `0`)
+
+Because we use [got](https://github.com/sindresorhus/got) under the hood, you can pass a `gotRetry` constructor option which is passed on to `got`. This offers great flexibility for handling retries on network errors and HTTP status codes with auto back-off. See [`got` `retry` object documentation](https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md).
+
+**Note that the above `maxRetries` option does not affect the `gotRetry` logic.**
+
+#### Custom retry logic
 
 If you want to retry on other errors, please see the [retry example code](examples/retry.js).
 
-- https://transloadit.com/docs/api/#rate-limiting
+- https://transloadit.com/docs/api/rate-limiting/
 - https://transloadit.com/blog/2012/04/introducing-rate-limiting/
 
 ## Debugging
@@ -420,30 +478,18 @@ DEBUG=transloadit* node examples/template_api.js
 
 - [Mikael Finstad](https://github.com/mifi)
 
-## Contributing
+### Changelog
 
-We'd be happy to accept pull requests. If you plan on working on something big, please first drop us a line!
-
-### Testing
-
-Check your sources for linting errors via `npm run lint`, and unit tests, and run them via `npm test`
-
-### Releasing
-
-1. Install [np](https://github.com/sindresorhus/np): `npm i -g np`
-2. Wait for [tests to succeed](https://github.com/transloadit/node-sdk/actions).
-3. Run `np` and follow instructions.
-4. When successful add [release notes](https://github.com/transloadit/node-sdk/releases).
-
-### Change log
 See [Releases](https://github.com/transloadit/node-sdk/releases)
 
-### Convenience
+## Attribution
 
-If you come from a unix background and fancy faster auto-complete, you'll be delighted to know that all npm scripts are also accessible under `make`, via fakefile.
+Thanks to [Ian Hansen](https://github.com/supershabam) for donating the `transloadit` npm name. You can still access his code under [`v0.0.0`](https://www.npmjs.com/package/transloadit/v/0.0.0).
 
 ## License
 
-[MIT](LICENSE)
+[MIT](LICENSE) © [Transloadit](https://transloadit.com)
+
+## Development
 
-Thanks to [Ian Hansen](https://github.com/supershabam) for donating the `transloadit` npm name. You can still access his code under `v0.0.0`.
+See [CONTRIBUTING](./CONTRIBUTING.md).