companion: port to TypeScript by kvz · Pull Request #6179 · transloadit/uppy

kvz · 2026-02-11T07:20:51Z

Supersedes #6178.

This branch keeps the exact same final content as #6178, but splits history for reviewability:

chore(companion): rename source and test files from .js to .ts (pure git mv, no content changes)
feat(companion): port Companion to TypeScript (actual content/type/schema/build updates)

Validation note:

Final tree is byte-for-byte identical to ts-companion (7b5b16a298690b0492de4cc4fab744f998b45570).

changeset-bot · 2026-02-11T07:20:56Z

⚠️ No Changeset found

Latest commit: 2603299

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

kvz · 2026-02-11T07:22:50Z

packages/@uppy/companion/bin/companion

@@ -1,3 +0,0 @@
-#!/usr/bin/env node


the new bin points to dist/

kvz · 2026-02-11T07:23:15Z

.github/workflows/ci.yml

        run:
          corepack yarn install
      - run: corepack yarn run typecheck
+      - run: corepack yarn workspace @uppy/companion lint:ts


Extra strict typescript options, but just for linting, as to remain compatible with status quo outputs for now

Murderlon · 2026-02-11T14:32:55Z

I ran it through Devin Review, it has some comments: https://app.devin.ai/review/transloadit/uppy/pull/6179

socket-security · 2026-02-11T19:29:59Z

No dependency changes detected. Learn more about Socket for GitHub.

👍 No dependency changes detected in pull request

kvz · 2026-02-11T19:39:01Z

I ran it through Devin Review, it has some comments: https://app.devin.ai/review/transloadit/uppy/pull/6179

That was helpful! Added the patches to address. Also kicked another review and added patches for the findings then. Each time covered by added regression tests.

This workflow outputs the differences between two versions of the code in the 'lib' folders after a push or pull request event.

github-actions · 2026-03-02T04:57:44Z

Diff output files

No diff

mifi · 2026-03-02T09:32:04Z

I cannot believe that the dist js output diff is empty 🤔

- improve types - simplify, undo some unnecessary complications - use tsconfig.lint.json by default when developing (merge it into tsconfig.json) - fix some subtle bugs

we don't need to test AWS internal code

else it's very confusing when developing, because we will get errors when running yarn build, but not in vscode

and use zod to validate config

mifi · 2026-03-10T15:26:39Z

Ok I now consider this PR finished and the typescript support is complete. Do you want to have a look @Murderlon or shall we merge it?

I would probably release this a major as a safe guard because the refactor is quite extensive and in case we accidentally broke something people will be prepared, as opposed to a minor/patch.

If we release it as a major, we should probably also include other things like #6175

mifi · 2026-03-07T07:26:24Z

packages/@uppy/companion/src/server/provider/zoom/adapter.ts


-const adaptData = (userResponse, results) => {
-  if (!results) {
+function isZoomRecordingFile(value: unknown): value is ZoomRecordingFile {


a bit crazy refactor here but i trust it's correct.

mifi · 2026-03-11T08:33:45Z

@kvz what do you think? release it as a major or minor?

kvz · 2026-03-16T13:46:15Z

I'm thinking a Major, and indeed including all the things from our major wishlist

packages/@uppy/companion/src/config/grant.ts

packages/@uppy/companion/src/scripts/rewrite-dts-extensions.ts

packages/@uppy/companion/src/server/controllers/index.ts

packages/@uppy/companion/src/server/emitter/index.ts

packages/@uppy/companion/tsconfig.shared.json

from companion and remove script rewrite-dts-extensions.js

mifi · 2026-03-29T11:49:25Z

I have resolved the feedback and I think this is ready to merge as soon as we want to go major release of companion. we should consider whether we should merge/release #6248 first

kvz added 2 commits February 11, 2026 08:19

chore(companion): rename source and test files from .js to .ts

80ca1cd

feat(companion): port Companion to TypeScript

893b9de

kvz self-assigned this Feb 11, 2026

kvz requested review from Murderlon and mifi February 11, 2026 07:21

kvz mentioned this pull request Feb 11, 2026

companion: port to TypeScript #6178

Closed

kvz commented Feb 11, 2026

View reviewed changes

packages/@uppy/companion/bin/companion

@@ -1,3 +0,0 @@

#!/usr/bin/env node

Copy link
Copy Markdown

Member Author

kvz Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the new bin points to dist/

kvz commented Feb 11, 2026

View reviewed changes

fix(docker): run companion from dist CLI entrypoint

dab0f74

kvz added 2 commits February 11, 2026 20:03

companion: fix tus stream source and s3 region fallback regressions

1cb50d2

companion: address council review findings

45f32fe

Add GitHub Actions workflow for diff output

ee21d7d

This workflow outputs the differences between two versions of the code in the 'lib' folders after a push or pull request event.

mifi closed this Mar 2, 2026

mifi reopened this Mar 2, 2026

mifi mentioned this pull request Mar 2, 2026

Add empty line in diff.yml before 'on' section #6204

Closed

mifi added 2 commits March 2, 2026 12:55

Merge branch 'main' into ts-companion-renames

f62c0d1

Delete .github/workflows/diff.yml

5cb213b

mifi added 7 commits March 10, 2026 00:59

improvements

260310c

- improve types - simplify, undo some unnecessary complications - use tsconfig.lint.json by default when developing (merge it into tsconfig.json) - fix some subtle bugs

remove unneeded test

260310c

we don't need to test AWS internal code

move most tsconfig into shared

260310b

else it's very confusing when developing, because we will get errors when running yarn build, but not in vscode

add provider return types

2603100

type grant provider config

2603108

type credentials fetch response

2603105

fix bug where facebook wasn't using credentials fetcher

2603109

mifi added 7 commits March 10, 2026 14:40

fix import

2603102

improve types

2603101

and use zod to validate config

fix bug with dynamic credentials

2603106

add logging

2603102

improve types

260310a

lint

2603109

Merge branch 'main' into ts-companion-renames

4d7440d

mifi approved these changes Mar 10, 2026

View reviewed changes

Murderlon reviewed Mar 17, 2026

View reviewed changes

add health check endpoint (#6220)

6935fdd

This was referenced Mar 26, 2026

@uppy: upgrade biome and more improvements #6244

Open

[Feat] Add optional SSE-KMS support for S3 uploads in Companion #6239

Open

mifi added 5 commits March 29, 2026 18:19

Merge branch 'main' into ts-companion-renames

c33fc30

remove allowImportingTsExtensions and rewriteRelativeImportExtensions

2603291

from companion and remove script rewrite-dts-extensions.js

use interface instead of type

2603292

change ts imports to js

2603295

reuse types from grant

2603299

Conversation

kvz commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

kvz Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

kvz Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Murderlon commented Feb 11, 2026

Uh oh!

socket-security bot commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kvz commented Feb 11, 2026

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

mifi commented Mar 2, 2026

Uh oh!

mifi commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mifi Mar 7, 2026

Choose a reason for hiding this comment

Uh oh!

mifi commented Mar 11, 2026

Uh oh!

kvz commented Mar 16, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mifi commented Mar 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kvz commented Feb 11, 2026 •

edited

Loading

changeset-bot bot commented Feb 11, 2026 •

edited

Loading

kvz Feb 11, 2026 •

edited

Loading

socket-security bot commented Feb 11, 2026 •

edited

Loading

mifi commented Mar 10, 2026 •

edited

Loading