rewrite to esm and upgrade packages (#223)

* rewrite to esm and upgrade `got`

* fix lint

* upgrade the rest of packages

closes #155

* update doc

* export more

* fix ts deprecated syntax

* fix proxy

* fix lint

* fix test

* yarn dedupe

* remove try catch in exacmples

* fix exports

* remove redundant moduleResolution

* add test for `error` field in GET assembly

* use tsconfig.build.json for prepack

because type errors in examples, test etc shouldn't block publish
those are handled in `lint:ts`

* refactor examples and script to ts

* require node 20

and upgrade got

* lint

* use yarn exec

instead of tsx
#223 (comment)

* Update test/generate-coverage-badge.ts

Co-authored-by: Remco Haszing <[email protected]>

* use experimental-strip-types

---------

Co-authored-by: Remco Haszing <[email protected]>

Author: mifi

.eslintrc.js .eslintrc.cjs.eslintrc.js renamed to .eslintrc.cjs

@@ -19,6 +19,7 @@ module.exports = {
     },
   },
   rules: {
+    'import/no-unresolved': 'off',
     'import/extensions': 'off',
     'no-unused-vars': 'off',
     '@typescript-eslint/no-unused-vars': ['error'],
@@ -39,5 +40,13 @@ module.exports = {
         'no-console': 'off',
       },
     },
+    {
+      files: 'examples/**',
+      rules: {
+        'no-console': 0,
+        'import/no-extraneous-dependencies': 0,
+        'import/no-unresolved': 0,
+      },
+    },
   ],
 }

.github/workflows/ci.yml

@@ -58,7 +58,6 @@ jobs:
     strategy:
       matrix:
         node:
-          - 18
           - 20
           - 22
     steps:

.github/workflows/integration.yml

@@ -16,7 +16,6 @@ jobs:
       max-parallel: 1
       matrix:
         node:
-          - 18
           - 20.15.1
           - 22.3.0
     steps:
@@ -43,7 +42,7 @@ jobs:
           DEBUG: 'transloadit:*'
 
       - name: Generate the badge from the json-summary
-        run: node test/generate-coverage-badge.js coverage/coverage-summary.json
+        run: node --experimental-strip-types test/generate-coverage-badge.ts coverage/coverage-summary.json
       - name: Move HTML report and badge to the correct location
         run: |
           mv coverage/lcov-report static-build

README.md

@@ -24,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 18 or newer
+- [Node.js](https://nodejs.org/en/) version 20 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`)
 
@@ -47,7 +47,7 @@ npm install --save transloadit
 The following code will upload an image and resize it to a thumbnail:
 
 ```javascript
-const { Transloadit } = require('transloadit')
+import { Transloadit } from 'transloadit'
 
 const transloadit = new Transloadit({
   authKey: 'YOUR_TRANSLOADIT_KEY',
@@ -451,7 +451,7 @@ There are three kinds of retries:
 
 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`)
+#### GOT HTTP retries (`gotRetry`, default `{ limit: 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).
 

examples/.eslintrc.js

@@ -0,0 +1,35 @@
+// Run this file as:
+//
+//   env TRANSLOADIT_KEY=xxx TRANSLOADIT_SECRET=yyy node examples/convert_to_webp.js ./examples/fixtures/berkley.jpg
+//
+// You may need to build the project first using:
+//
+//   yarn prepack
+//
+import { Transloadit } from 'transloadit'
+
+const transloadit = new Transloadit({
+  authKey: process.env.TRANSLOADIT_KEY!,
+  authSecret: process.env.TRANSLOADIT_SECRET!,
+})
+
+const filePath = process.argv[2]
+
+const status = await transloadit.createAssembly({
+  files: {
+    file1: filePath,
+  },
+  params: {
+    steps: {
+      webp: {
+        use: ':original',
+        robot: '/image/resize',
+        result: true,
+        imagemagick_stack: 'v2.0.7',
+        format: 'webp',
+      },
+    },
+  },
+  waitForCompletion: true,
+})
+console.log('Your WebP file:', status.results.webp[0].url)

examples/convert_to_webp.js

@@ -0,0 +1,76 @@
+/* eslint-disable max-len */
+// Run this file as:
+//
+//   env TRANSLOADIT_KEY=xxx TRANSLOADIT_SECRET=yyy node template_api.js
+//
+// You may need to build the project first using:
+//
+//   yarn prepack
+//
+import { CreateTemplateCredentialParams, Transloadit } from 'transloadit'
+
+const transloadit = new Transloadit({
+  authKey: process.env.TRANSLOADIT_KEY!,
+  authSecret: process.env.TRANSLOADIT_SECRET!,
+})
+
+const firstName = 'myProductionS3'
+const secondName = 'myStagingS3'
+
+const credentialParams: CreateTemplateCredentialParams = {
+  name: firstName,
+  type: 's3',
+  content: {
+    key: 'xyxy',
+    secret: 'xyxyxyxy',
+    bucket: 'mybucket.example.com',
+    bucket_region: 'us-east-1',
+  },
+}
+
+console.log(`==> listTemplateCredentials`)
+const { credentials } = await transloadit.listTemplateCredentials({
+  sort: 'created',
+  order: 'asc',
+})
+console.log('Successfully fetched', credentials.length, 'credential(s)')
+
+// ^-- with   Templates, there is `items` and `count`.
+//     with Credentials, there is `ok`, `message`, `credentials`
+
+for (const credential of credentials) {
+  if ([firstName, secondName].includes(credential.name)) {
+    console.log(`==> deleteTemplateCredential: ${credential.id} (${credential.name})`)
+    const delResult = await transloadit.deleteTemplateCredential(credential.id)
+    console.log('Successfully deleted credential', delResult)
+    // ^-- identical structure between `Templates` and `Credentials`
+  }
+}
+
+console.log(`==> createTemplateCredential`)
+const createTemplateCredentialResult = await transloadit.createTemplateCredential(credentialParams)
+console.log('TemplateCredential created successfully:', createTemplateCredentialResult)
+// ^-- with   Templates, there is `ok`, `message`, `id`, `content`, `name`, `require_signature_auth`. Same is true for: created, updated, fetched
+//     with Credentials, there is `ok`, `message`, `credentials` <-- and a single object nested directly under it, which is unexpected with that plural imho. Same is true for created, updated, fetched
+
+console.log(
+  `==> editTemplateCredential: ${createTemplateCredentialResult.credential.id} (${createTemplateCredentialResult.credential.name})`
+)
+const editResult = await transloadit.editTemplateCredential(
+  createTemplateCredentialResult.credential.id,
+  {
+    ...credentialParams,
+    name: secondName,
+  }
+)
+console.log('Successfully edited credential', editResult)
+// ^-- see create
+
+console.log(
+  `==> getTemplateCredential: ${createTemplateCredentialResult.credential.id} (${createTemplateCredentialResult.credential.name})`
+)
+const getTemplateCredentialResult = await transloadit.getTemplateCredential(
+  createTemplateCredentialResult.credential.id
+)
+console.log('Successfully fetched credential', getTemplateCredentialResult)
+// ^-- not working at al, getting a 404. looking at the API, this is not implemented yet