fix: harden zod scripts and tooling

Author: kvz

CONTRIBUTING.md

@@ -81,7 +81,7 @@ View the coverage report locally by opening `coverage/index.html` in your browse
 
 ## Packaging the legacy `transloadit` package
 
-The `packages/transloadit` folder is a generated legacy wrapper. The `src` directory and top-level `README.md`, `CHANGELOG.md`, and `LICENSE` are produced during packing by `scripts/prepare-transloadit.js` and are not tracked in git. If you need to validate the legacy package contents, run:
+The `packages/transloadit` folder is a generated legacy wrapper. The `src` directory and top-level `README.md`, `CHANGELOG.md`, and `LICENSE` are produced during packing by `scripts/prepare-transloadit.ts` and are not tracked in git. If you need to validate the legacy package contents, run:
 
 ```sh
 yarn pack

docs/todo.md

@@ -10,13 +10,13 @@
 - [x] Assert byte-for-byte identity
 
 ## Fingerprint script
-- [x] Add `scripts/fingerprint-pack.js`
+- [x] Add `scripts/fingerprint-pack.ts`
 - [x] Use `npm pack --json` to get tarball name
 - [x] Hash the tarball SHA256
 - [x] Hash each file via `tar -tf` + `tar -xOf`
 - [x] Output JSON artifact for comparison
-- [x] Support `node scripts/fingerprint-pack.js .`
-- [x] Support `node scripts/fingerprint-pack.js packages/transloadit`
+- [x] Support `node --experimental-strip-types scripts/fingerprint-pack.ts .`
+- [x] Support `node --experimental-strip-types scripts/fingerprint-pack.ts packages/transloadit`
 
 ## Versioning and releases
 - [x] Add Changesets at workspace root

packages/node/src/InconsistentResponseError.ts

@@ -1,3 +1,3 @@
-export default class InconsistentResponseError extends Error {
+export class InconsistentResponseError extends Error {
   override name = 'InconsistentResponseError'
 }

packages/node/src/Transloadit.ts

@@ -42,7 +42,7 @@ import type {
   TemplateCredentialsResponse,
   TemplateResponse,
 } from './apiTypes.ts'
-import InconsistentResponseError from './InconsistentResponseError.ts'
+import { InconsistentResponseError } from './InconsistentResponseError.ts'
 import PaginationStream from './PaginationStream.ts'
 import PollingTimeoutError from './PollingTimeoutError.ts'
 import type { Stream } from './tus.ts'

packages/transloadit/package.json

@@ -69,7 +69,7 @@
     "lint:deps": "knip --dependencies --no-progress",
     "fix:deps": "knip --dependencies --no-progress --fix",
     "knip": "knip --no-config-hints --no-progress",
-    "prepack": "node ../../scripts/prepare-transloadit.js",
+    "prepack": "node --experimental-strip-types ../../scripts/prepare-transloadit.ts",
     "test:unit": "vitest run --coverage ./test/unit",
     "test:e2e": "vitest run ./test/e2e",
     "test": "vitest run --coverage"

packages/zod/package.json

@@ -28,13 +28,13 @@
     }
   },
   "scripts": {
-    "sync:v3": "node scripts/sync-v3.ts",
-    "sync:v4": "node scripts/sync-v4.ts",
+    "sync:v3": "node --experimental-strip-types scripts/sync-v3.ts",
+    "sync:v4": "node --experimental-strip-types scripts/sync-v4.ts",
     "sync": "yarn sync:v3 && yarn sync:v4",
     "lint:ts": "yarn sync && tsc --build tsconfig.build.json",
-    "test:unit": "node test/exports-sync.test.ts && node test/runtime-parity.test.ts",
+    "test:unit": "node --experimental-strip-types test/scripts-config.test.ts && node --experimental-strip-types test/exports-sync.test.ts && node --experimental-strip-types test/runtime-parity.test.ts",
     "build": "yarn sync && tsc --build tsconfig.build.json",
-    "check": "yarn sync && tsc --build tsconfig.build.json && tsc --noEmit --project tsconfig.test.json && node test/exports-sync.test.ts && node test/runtime-parity.test.ts"
+    "check": "yarn sync && tsc --build tsconfig.build.json && tsc --noEmit --project tsconfig.test.json && yarn test:unit"
   },
   "dependencies": {
     "zod": "^4.0.0"

packages/zod/scripts/sync-v3.ts

@@ -24,7 +24,7 @@ const indexContents = [
   '',
 ].join('\n')
 
-const collectFiles = async (dir, acc = []) => {
+const collectFiles = async (dir: string, acc: string[] = []): Promise<string[]> => {
   const entries = await readdir(dir, { withFileTypes: true })
   for (const entry of entries) {
     const full = resolve(dir, entry.name)

packages/zod/test/scripts-config.test.ts

@@ -0,0 +1,26 @@
+import assert from 'node:assert/strict'
+import { readFile } from 'node:fs/promises'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const filePath = fileURLToPath(import.meta.url)
+const zodRoot = resolve(dirname(filePath), '..')
+const packageJsonPath = resolve(zodRoot, 'package.json')
+const packageJson = JSON.parse(await readFile(packageJsonPath, 'utf8')) as {
+  scripts?: Record<string, string>
+}
+
+const scripts = packageJson.scripts ?? {}
+const requiredFlag = '--experimental-strip-types'
+const requiredScripts = ['sync:v3', 'sync:v4', 'test:unit']
+
+for (const scriptName of requiredScripts) {
+  const script = scripts[scriptName]
+  assert.ok(script, `Missing ${scriptName} script in package.json`)
+  assert.ok(
+    script.includes(requiredFlag),
+    `${scriptName} should include ${requiredFlag} so Node can run TypeScript`,
+  )
+}
+
+console.log('zod scripts config: ok')

scripts/fingerprint-pack.js scripts/fingerprint-pack.tsscripts/fingerprint-pack.js renamed to scripts/fingerprint-pack.ts

@@ -7,8 +7,8 @@ import { promisify } from 'node:util'
 
 const execFileAsync = promisify(execFile)
 
-const usage = () => {
-  console.log(`Usage: node scripts/fingerprint-pack.js [path] [options]
+const usage = (): void => {
+  console.log(`Usage: node --experimental-strip-types scripts/fingerprint-pack.ts [path] [options]
 
 Options:
   -o, --out <file>   Write JSON output to a file
@@ -18,7 +18,14 @@ Options:
 `)
 }
 
-const parseArgs = () => {
+interface ParsedArgs {
+  target: string
+  out: string | null
+  keep: boolean
+  ignoreScripts: boolean
+}
+
+const parseArgs = (): ParsedArgs => {
   const args = process.argv.slice(2)
   let target = '.'
   let out = null
@@ -53,7 +60,7 @@ const parseArgs = () => {
   return { target, out, keep, ignoreScripts }
 }
 
-const hashFile = async (filePath) =>
+const hashFile = async (filePath: string): Promise<string> =>
   new Promise((resolvePromise, reject) => {
     const hash = createHash('sha256')
     const stream = createReadStream(filePath)
@@ -62,7 +69,10 @@ const hashFile = async (filePath) =>
     stream.on('end', () => resolvePromise(hash.digest('hex')))
   })
 
-const hashTarEntry = async (tarballPath, entry) =>
+const hashTarEntry = async (
+  tarballPath: string,
+  entry: string,
+): Promise<{ sha256: string; sizeBytes: number }> =>
   new Promise((resolvePromise, reject) => {
     const hash = createHash('sha256')
     let sizeBytes = 0
@@ -87,20 +97,22 @@ const hashTarEntry = async (tarballPath, entry) =>
     })
   })
 
-const readTarEntry = async (tarballPath, entry) => {
-  const { stdout } = await execFileAsync('tar', ['-xOf', tarballPath, entry])
+const readTarEntry = async (tarballPath: string, entry: string): Promise<string> => {
+  const { stdout } = await execFileAsync('tar', ['-xOf', tarballPath, entry], {
+    encoding: 'utf8',
+  })
   return stdout
 }
 
-const main = async () => {
+const main = async (): Promise<void> => {
   const { target, out, keep, ignoreScripts } = parseArgs()
   const cwd = resolve(process.cwd(), target)
 
   const packArgs = ['pack', '--json']
   if (ignoreScripts) {
     packArgs.push('--ignore-scripts')
   }
-  const { stdout } = await execFileAsync('npm', packArgs, { cwd })
+  const { stdout } = await execFileAsync('npm', packArgs, { cwd, encoding: 'utf8' })
   const packed = JSON.parse(stdout.trim())
   const info = Array.isArray(packed) ? packed[0] : packed
   if (!info?.filename) {

scripts/pack-transloadit.ts

@@ -11,9 +11,13 @@ const repoRoot = resolve(dirname(filePath), '..')
 const legacyPackage = resolve(repoRoot, 'packages/transloadit')
 
 const runPack = async () => {
-  await execFileAsync('node', [resolve(repoRoot, 'scripts/prepare-transloadit.js')], {
-    cwd: repoRoot,
-  })
+  await execFileAsync(
+    'node',
+    ['--experimental-strip-types', resolve(repoRoot, 'scripts/prepare-transloadit.ts')],
+    {
+      cwd: repoRoot,
+    },
+  )
 
   await execFileAsync('npm', ['pack', '--ignore-scripts'], {
     cwd: legacyPackage,