Incorporate CLI that supports all transloadify commands

.github/workflows/integration.yml → .github/workflows/e2e.yml

@@ -1,4 +1,4 @@
-name: Integration tests
+name: e2e tests
 
 on:
   workflow_dispatch:
@@ -12,7 +12,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
-      # Integration tests are not yet ready to run in parallel
+      # e2e tests are not yet ready to run in parallel
       max-parallel: 1
       matrix:
         node:
@@ -33,7 +33,7 @@ jobs:
       #      - name: Setup tmate session
       #        uses: mxschmitt/action-tmate@v3
 
-      - run: corepack yarn test:all
+      - run: corepack yarn test
         env:
           TRANSLOADIT_KEY: ${{ secrets.TRANSLOADIT_KEY }}
           TRANSLOADIT_SECRET: ${{ secrets.TRANSLOADIT_SECRET }}

CONTRIBUTING.md

@@ -50,9 +50,9 @@ yarn test:unit
 
 This will also generate a coverage report in the `coverage` directory.
 
-### Integration tests
+### e2e tests
 
-Integration tests are in the [`test/integration`](test/integration) folder. They require some extra setup.
+e2e tests are in the [`test/e2e`](test/e2e) folder. They require some extra setup.
 
 Firstly, these tests require the Cloudflare executable. You can download this with:
 
@@ -63,10 +63,10 @@ chmod +x cloudflared-linux-amd64
 
 They also require a Transloadit key and secret, which you can get from https://transloadit.com/c/credentials.
 
-You can run the integration tests with:
+You can run the e2e tests with:
 
 ```sh
-TRANSLOADIT_KEY='YOUR_TRANSLOADIT_KEY' TRANSLOADIT_SECRET='YOUR_TRANSLOADIT_SECRET' CLOUDFLARED_PATH='./cloudflared-linux-amd64' yarn test:integration
+TRANSLOADIT_KEY='YOUR_TRANSLOADIT_KEY' TRANSLOADIT_SECRET='YOUR_TRANSLOADIT_SECRET' CLOUDFLARED_PATH='./cloudflared-linux-amd64' yarn test:e2e
 ```
 
 ### Code Coverage

MIGRATION.md

@@ -19,11 +19,11 @@ Version 4 focuses on type-safety, clearer errors, and modern Node support. Most
 ```js
 // CommonJS import example
 async function getClient() {
-  const { Transloadit } = await import("transloadit");
+  const { Transloadit } = await import('transloadit')
   return new Transloadit({
-    authKey: process.env.TRANSLOADIT_KEY ?? "",
-    authSecret: process.env.TRANSLOADIT_SECRET ?? "",
-  });
+    authKey: process.env.TRANSLOADIT_KEY ?? '',
+    authSecret: process.env.TRANSLOADIT_SECRET ?? '',
+  })
 }
 ```
 
@@ -48,16 +48,16 @@ The package also exports `AssemblyInstructionsInput`, `AssemblyIndexItem`, `Asse
 const params: AssemblyInstructionsInput = {
   steps: {
     resize: {
-      use: ":original",
-      robot: "/image/resize",
+      use: ':original',
+      robot: '/image/resize',
       width: 320,
       height: 240,
       result: true,
     },
   },
-};
+}
 
-await transloadit.createAssembly({ params, waitForCompletion: true });
+await transloadit.createAssembly({ params, waitForCompletion: true })
 ```
 
 ## 3. Adjust API result handling
@@ -82,15 +82,15 @@ const createdAssembly = await transloadit.createAssembly(...);
 
 ```ts
 try {
-  await transloadit.createAssembly({ params });
+  await transloadit.createAssembly({ params })
 } catch (error) {
   if (error instanceof ApiError && error.response.assembly_id) {
     console.error(
-      "Troubleshoot at https://transloadit.com/c/assemblies/" +
+      'Troubleshoot at https://transloadit.com/c/assemblies/' +
         error.response.assembly_id
-    );
+    )
   }
-  throw error;
+  throw error
 }
 ```
 
@@ -103,18 +103,18 @@ try {
     authKey,
     authSecret,
     validateResponses: true,
-  });
+  })
   ```
 
 - `getSignedSmartCDNUrl` generates Smart CDN URLs with signatures that match the server-side implementation:
 
   ```ts
   const signedUrl = transloadit.getSignedSmartCDNUrl({
-    workspace: "my-team",
-    template: "hero-image",
-    input: "landing.jpg",
-    urlParams: { format: "webp" },
-  });
+    workspace: 'my-team',
+    template: 'hero-image',
+    input: 'landing.jpg',
+    urlParams: { format: 'webp' },
+  })
   ```
 
 ## 6. Removed `createAssembly` callback support
@@ -135,7 +135,7 @@ As a consequence of upgrading `got` to v14, the `gotRetry` option no longer acce
 
 ## Testing & troubleshooting
 
-- Run your existing integration tests on Node 20+. If you relied on CommonJS `require`, convert those modules or wrap calls in `import()` shims as shown above.
+- Run your existing e2e tests on Node 20+. If you relied on CommonJS `require`, convert those modules or wrap calls in `import()` shims as shown above.
 - If TypeScript raises errors about unfamiliar properties, import the respective types from `transloadit` instead of redefining them.
 - Schemas intentionally mirror the current public API. Some properties remain permissive while we tighten validation in the API itself; report gaps if the SDK raises or misses invalid data.
 

package.json

@@ -20,27 +20,33 @@
     "@aws-sdk/client-s3": "^3.891.0",
     "@aws-sdk/s3-request-presigner": "^3.891.0",
     "@transloadit/sev-logger": "^0.0.15",
+    "clipanion": "^4.0.0-rc.4",
     "debug": "^4.4.3",
     "form-data": "^4.0.4",
     "got": "14.4.9",
     "into-stream": "^9.0.0",
     "is-stream": "^4.0.1",
+    "node-watch": "^0.7.4",
     "p-map": "^7.0.3",
+    "recursive-readdir": "^2.2.3",
     "tus-js-client": "^4.3.1",
     "type-fest": "^4.41.0",
     "zod": "3.25.76"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.2.4",
     "@types/debug": "^4.1.12",
+    "@types/recursive-readdir": "^2.2.4",
     "@types/temp": "^0.9.4",
     "@vitest/coverage-v8": "^3.2.4",
     "badge-maker": "^5.0.2",
-    "dotenv": "^17.2.2",
+    "dotenv": "^17.2.3",
     "execa": "9.6.0",
+    "image-size": "^2.0.2",
     "nock": "^14.0.10",
     "npm-run-all": "^4.1.5",
     "p-retry": "^7.0.0",
+    "rimraf": "^6.1.2",
     "temp": "^0.9.4",
     "tsx": "4.20.5",
     "typescript": "5.9.2",
@@ -61,12 +67,10 @@
     "lint:js": "biome check .",
     "lint": "npm-run-all --parallel 'lint:js'",
     "fix": "npm-run-all --serial 'fix:js'",
-    "next:update": "next-update --keep true --tldr",
     "prepack": "rm -f tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo && tsc --build tsconfig.build.json",
     "test:unit": "vitest run --coverage ./test/unit",
-    "test:integration": "vitest run ./test/integration",
-    "test:all": "vitest run --coverage",
-    "test": "yarn test:unit"
+    "test:e2e": "vitest run ./test/e2e",
+    "test": "vitest run --coverage"
   },
   "license": "MIT",
   "main": "./dist/Transloadit.js",