transloadit 4.0.3 → 4.0.4

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 You may also want to refer to [GitHub releases](https://github.com/transloadit/node-sdk/releases).
 
+## v4.0.3
+
+Released: 2025-10-16.
+
+[Diff](https://github.com/transloadit/node-sdk/compare/v4.0.2...v4.0.3).
+
+- [x] Fix `smart_sig` CLI to always override embedded credentials with the env-provided auth key while preserving other auth fields.
+- [x] Ensure the CLI entrypoint executes when invoked through npm/yarn bin shims by resolving symlinks before bootstrapping.
+- [x] Harden validation and tests around CLI invocation paths.
+
+## v4.0.2
+
+Released: 2025-10-15.
+
+[Diff](https://github.com/transloadit/node-sdk/compare/v4.0.1...v4.0.2).
+
+- [x] Add `smart_sig` CLI command (usable via `npx transloadit smart_sig`) for signing params fed through stdin.
+- [x] Document the CLI workflow and expose the binary via package metadata.
+- [x] Validate CLI input with existing zod schemas and cover the flow with unit tests.
+
 ## v4.0.1
 
 Released: 2025-09-18.

package/README.md

@@ -385,6 +385,17 @@ 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).
 
+#### CLI smart_sig
+
+Generate a signature from the command line without writing any JavaScript. The CLI reads a JSON object from stdin, injects credentials from `TRANSLOADIT_KEY`/`TRANSLOADIT_SECRET`, and prints the payload returned by `calcSignature()`.
+
+```sh
+TRANSLOADIT_KEY=... TRANSLOADIT_SECRET=... \
+  printf '{"assembly_id":"12345"}' | npx transloadit smart_sig
+```
+
+You can also use `TRANSLOADIT_AUTH_KEY`/`TRANSLOADIT_AUTH_SECRET` as aliases for the environment variables.
+
 #### 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:

package/dist/cli.d.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+export declare function readStdin(): Promise<string>;
+export declare function runSmartSig(providedInput?: string): Promise<void>;
+export declare function main(args?: string[]): Promise<void>;
+export declare function shouldRunCli(invoked?: string): boolean;
+export declare function runCliWhenExecuted(): void;
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAcA,wBAAsB,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAWjD;AAqBD,wBAAsB,WAAW,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAqDvE;AAED,wBAAsB,IAAI,CAAC,IAAI,WAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CA6BtE;AAaD,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAItD;AAED,wBAAgB,kBAAkB,IAAI,IAAI,CAMzC"}

package/dist/cli.js

@@ -0,0 +1,130 @@
+#!/usr/bin/env node
+import { realpathSync } from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+import { assemblyAuthInstructionsSchema, assemblyInstructionsSchema, } from "./alphalib/types/template.js";
+import { Transloadit } from "./Transloadit.js";
+export async function readStdin() {
+    if (process.stdin.isTTY)
+        return '';
+    process.stdin.setEncoding('utf8');
+    let data = '';
+    for await (const chunk of process.stdin) {
+        data += chunk;
+    }
+    return data;
+}
+function fail(message) {
+    console.error(message);
+    process.exitCode = 1;
+}
+const cliParamsSchema = assemblyInstructionsSchema
+    .extend({ auth: assemblyAuthInstructionsSchema.partial().optional() })
+    .partial()
+    .passthrough();
+function formatIssues(issues) {
+    return issues
+        .map((issue) => {
+        const path = issue.path.join('.') || '(root)';
+        return `${path}: ${issue.message}`;
+    })
+        .join('; ');
+}
+export async function runSmartSig(providedInput) {
+    const authKey = process.env.TRANSLOADIT_KEY || process.env.TRANSLOADIT_AUTH_KEY;
+    const authSecret = process.env.TRANSLOADIT_SECRET || process.env.TRANSLOADIT_AUTH_SECRET;
+    if (!authKey || !authSecret) {
+        fail('Missing credentials. Please set TRANSLOADIT_KEY and TRANSLOADIT_SECRET environment variables.');
+        return;
+    }
+    const rawInput = providedInput ?? (await readStdin());
+    const input = rawInput.trim();
+    let params = {};
+    if (input !== '') {
+        try {
+            const parsed = JSON.parse(input);
+            if (parsed == null || typeof parsed !== 'object' || Array.isArray(parsed)) {
+                fail('Invalid params provided via stdin. Expected a JSON object.');
+                return;
+            }
+            const parsedResult = cliParamsSchema.safeParse(parsed);
+            if (!parsedResult.success) {
+                fail(`Invalid params: ${formatIssues(parsedResult.error.issues)}`);
+                return;
+            }
+            const parsedParams = parsedResult.data;
+            const existingAuth = typeof parsedParams.auth === 'object' &&
+                parsedParams.auth != null &&
+                !Array.isArray(parsedParams.auth)
+                ? parsedParams.auth
+                : {};
+            params = {
+                ...parsedParams,
+                auth: {
+                    ...existingAuth,
+                    key: authKey,
+                },
+            };
+        }
+        catch (error) {
+            fail(`Failed to parse JSON from stdin: ${error.message}`);
+            return;
+        }
+    }
+    const client = new Transloadit({ authKey, authSecret });
+    const signature = client.calcSignature(params);
+    process.stdout.write(`${JSON.stringify(signature)}\n`);
+}
+export async function main(args = process.argv.slice(2)) {
+    const [command] = args;
+    switch (command) {
+        case 'smart_sig': {
+            await runSmartSig();
+            break;
+        }
+        case '-h':
+        case '--help':
+        case undefined: {
+            process.stdout.write([
+                'Usage:',
+                '  npx transloadit smart_sig    Read params JSON from stdin and output signed payload.',
+                '',
+                'Environment variables:',
+                '  TRANSLOADIT_KEY, TRANSLOADIT_SECRET',
+            ].join('\n'));
+            if (command === undefined)
+                process.exitCode = 1;
+            break;
+        }
+        default: {
+            fail(`Unknown command: ${command}`);
+        }
+    }
+}
+const currentFile = realpathSync(fileURLToPath(import.meta.url));
+function resolveInvokedPath(invoked) {
+    if (invoked == null)
+        return null;
+    try {
+        return realpathSync(invoked);
+    }
+    catch {
+        return path.resolve(invoked);
+    }
+}
+export function shouldRunCli(invoked) {
+    const resolved = resolveInvokedPath(invoked);
+    if (resolved == null)
+        return false;
+    return resolved === currentFile;
+}
+export function runCliWhenExecuted() {
+    if (!shouldRunCli(process.argv[1]))
+        return;
+    void main().catch((error) => {
+        fail(error.message);
+    });
+}
+runCliWhenExecuted();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,GAC3B,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,CAAC,KAAK,UAAU,SAAS;IAC7B,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK;QAAE,OAAO,EAAE,CAAA;IAElC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,IAAI,GAAG,EAAE,CAAA;IAEb,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QACxC,IAAI,IAAI,KAAK,CAAA;IACf,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,IAAI,CAAC,OAAe;IAC3B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACtB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;AACtB,CAAC;AAED,MAAM,eAAe,GAAG,0BAA0B;KAC/C,MAAM,CAAC,EAAE,IAAI,EAAE,8BAA8B,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;KACrE,OAAO,EAAE;KACT,WAAW,EAAE,CAAA;AAEhB,SAAS,YAAY,CAAC,MAAkB;IACtC,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAA;QAC7C,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAA;IACpC,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAA;AACf,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,aAAsB;IACtD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAA;IAC/E,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAA;IAExF,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;QAC5B,IAAI,CACF,+FAA+F,CAChG,CAAA;QACD,OAAM;IACR,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,IAAI,CAAC,MAAM,SAAS,EAAE,CAAC,CAAA;IACrD,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAA;IAC7B,IAAI,MAAM,GAA4B,EAAE,CAAA;IAExC,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;QACjB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAChC,IAAI,MAAM,IAAI,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1E,IAAI,CAAC,4DAA4D,CAAC,CAAA;gBAClE,OAAM;YACR,CAAC;YAED,MAAM,YAAY,GAAG,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;YACtD,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;gBAC1B,IAAI,CAAC,mBAAmB,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;gBAClE,OAAM;YACR,CAAC;YAED,MAAM,YAAY,GAAG,YAAY,CAAC,IAA+B,CAAA;YACjE,MAAM,YAAY,GAChB,OAAO,YAAY,CAAC,IAAI,KAAK,QAAQ;gBACrC,YAAY,CAAC,IAAI,IAAI,IAAI;gBACzB,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC;gBAC/B,CAAC,CAAE,YAAY,CAAC,IAAgC;gBAChD,CAAC,CAAC,EAAE,CAAA;YAER,MAAM,GAAG;gBACP,GAAG,YAAY;gBACf,IAAI,EAAE;oBACJ,GAAG,YAAY;oBACf,GAAG,EAAE,OAAO;iBACb;aACF,CAAA;QACH,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,CAAC,oCAAqC,KAAe,CAAC,OAAO,EAAE,CAAC,CAAA;YACpE,OAAM;QACR,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;IACvD,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,CAAC,MAA4B,CAAC,CAAA;IACpE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;AACxD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACrD,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;IAEtB,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,WAAW,EAAE,CAAA;YACnB,MAAK;QACP,CAAC;QAED,KAAK,IAAI,CAAC;QACV,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB;gBACE,QAAQ;gBACR,uFAAuF;gBACvF,EAAE;gBACF,wBAAwB;gBACxB,uCAAuC;aACxC,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAA;YACD,IAAI,OAAO,KAAK,SAAS;gBAAE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;YAC/C,MAAK;QACP,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,IAAI,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,WAAW,GAAG,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;AAEhE,SAAS,kBAAkB,CAAC,OAAgB;IAC1C,IAAI,OAAO,IAAI,IAAI;QAAE,OAAO,IAAI,CAAA;IAChC,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,OAAgB;IAC3C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC5C,IAAI,QAAQ,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAClC,OAAO,QAAQ,KAAK,WAAW,CAAA;AACjC,CAAC;AAED,MAAM,UAAU,kBAAkB;IAChC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAAE,OAAM;IAE1C,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,IAAI,CAAE,KAAe,CAAC,OAAO,CAAC,CAAA;IAChC,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,kBAAkB,EAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "transloadit",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Node.js SDK for Transloadit",
   "type": "module",
   "keywords": [
@@ -76,5 +76,6 @@
   "files": [
     "dist",
     "src"
-  ]
+  ],
+  "bin": "./dist/cli.js"
 }

package/src/cli.ts

@@ -0,0 +1,158 @@
+#!/usr/bin/env node
+
+import { realpathSync } from 'node:fs'
+import path from 'node:path'
+import process from 'node:process'
+import { fileURLToPath } from 'node:url'
+import type { ZodIssue } from 'zod'
+import {
+  assemblyAuthInstructionsSchema,
+  assemblyInstructionsSchema,
+} from './alphalib/types/template.ts'
+import type { OptionalAuthParams } from './apiTypes.ts'
+import { Transloadit } from './Transloadit.ts'
+
+export async function readStdin(): Promise<string> {
+  if (process.stdin.isTTY) return ''
+
+  process.stdin.setEncoding('utf8')
+  let data = ''
+
+  for await (const chunk of process.stdin) {
+    data += chunk
+  }
+
+  return data
+}
+
+function fail(message: string): void {
+  console.error(message)
+  process.exitCode = 1
+}
+
+const cliParamsSchema = assemblyInstructionsSchema
+  .extend({ auth: assemblyAuthInstructionsSchema.partial().optional() })
+  .partial()
+  .passthrough()
+
+function formatIssues(issues: ZodIssue[]): string {
+  return issues
+    .map((issue) => {
+      const path = issue.path.join('.') || '(root)'
+      return `${path}: ${issue.message}`
+    })
+    .join('; ')
+}
+
+export async function runSmartSig(providedInput?: string): Promise<void> {
+  const authKey = process.env.TRANSLOADIT_KEY || process.env.TRANSLOADIT_AUTH_KEY
+  const authSecret = process.env.TRANSLOADIT_SECRET || process.env.TRANSLOADIT_AUTH_SECRET
+
+  if (!authKey || !authSecret) {
+    fail(
+      'Missing credentials. Please set TRANSLOADIT_KEY and TRANSLOADIT_SECRET environment variables.',
+    )
+    return
+  }
+
+  const rawInput = providedInput ?? (await readStdin())
+  const input = rawInput.trim()
+  let params: Record<string, unknown> = {}
+
+  if (input !== '') {
+    try {
+      const parsed = JSON.parse(input)
+      if (parsed == null || typeof parsed !== 'object' || Array.isArray(parsed)) {
+        fail('Invalid params provided via stdin. Expected a JSON object.')
+        return
+      }
+
+      const parsedResult = cliParamsSchema.safeParse(parsed)
+      if (!parsedResult.success) {
+        fail(`Invalid params: ${formatIssues(parsedResult.error.issues)}`)
+        return
+      }
+
+      const parsedParams = parsedResult.data as Record<string, unknown>
+      const existingAuth =
+        typeof parsedParams.auth === 'object' &&
+        parsedParams.auth != null &&
+        !Array.isArray(parsedParams.auth)
+          ? (parsedParams.auth as Record<string, unknown>)
+          : {}
+
+      params = {
+        ...parsedParams,
+        auth: {
+          ...existingAuth,
+          key: authKey,
+        },
+      }
+    } catch (error: unknown) {
+      fail(`Failed to parse JSON from stdin: ${(error as Error).message}`)
+      return
+    }
+  }
+
+  const client = new Transloadit({ authKey, authSecret })
+  const signature = client.calcSignature(params as OptionalAuthParams)
+  process.stdout.write(`${JSON.stringify(signature)}\n`)
+}
+
+export async function main(args = process.argv.slice(2)): Promise<void> {
+  const [command] = args
+
+  switch (command) {
+    case 'smart_sig': {
+      await runSmartSig()
+      break
+    }
+
+    case '-h':
+    case '--help':
+    case undefined: {
+      process.stdout.write(
+        [
+          'Usage:',
+          '  npx transloadit smart_sig    Read params JSON from stdin and output signed payload.',
+          '',
+          'Environment variables:',
+          '  TRANSLOADIT_KEY, TRANSLOADIT_SECRET',
+        ].join('\n'),
+      )
+      if (command === undefined) process.exitCode = 1
+      break
+    }
+
+    default: {
+      fail(`Unknown command: ${command}`)
+    }
+  }
+}
+
+const currentFile = realpathSync(fileURLToPath(import.meta.url))
+
+function resolveInvokedPath(invoked?: string): string | null {
+  if (invoked == null) return null
+  try {
+    return realpathSync(invoked)
+  } catch {
+    return path.resolve(invoked)
+  }
+}
+
+export function shouldRunCli(invoked?: string): boolean {
+  const resolved = resolveInvokedPath(invoked)
+  if (resolved == null) return false
+  return resolved === currentFile
+}
+
+export function runCliWhenExecuted(): void {
+  if (!shouldRunCli(process.argv[1])) return
+
+  void main().catch((error) => {
+    fail((error as Error).message)
+  })
+}
+
+runCliWhenExecuted()