@uppy/utils: refactor to TS #4699

aduh95 · 2023-09-25T14:54:36Z

Blocked on:

meta: add support for TypeScript plugins #4640

upgrade svelte-processes

upgrade tsd and fix ci

Co-authored-by: Antoine du Hamel <antoine@transloadit.com>

Convert isDomElement to TS

nickrttn · 2023-09-27T07:40:48Z

packages/@uppy/utils/src/dataURItoBlob.ts

@@ -1,28 +1,30 @@
 const DATA_URL_PATTERN = /^data:([^/]+\/[^,;]+(?:[^,]*?))(;base64)?,([\s\S]*)$/

-export default function dataURItoBlob (dataURI, opts, toFile) {
+export default function dataURItoBlob (dataURI: string, opts: { mimeType: string, name: string }, toFile: boolean) {


For a library I would consider it a best practice to use explicit return types, not inferred return types. There's a typescript-eslint rule to enforce that. WDYT?

not sure if dataURItoBlob is a public API though? we don't document it as part of the uppy api

I don't see why it would change anything that we're a library, tsc will still produce the appropriate return type when we ask it to emit the .d.ts file. Or is it to avoid having unintentional semver-minor change slip through?

I don't think you should make the distinction between public vs. private in this API but just make a choice between inferred and explicit and stick with it throughout the codebase. Explicit return types throughout will lead to better generated .d.ts files in the end.

my two cents: simple functions without conditional return types are fine to infer. Otherwise type it. If that's too inconsistent or forgetful we could add the eslint rule yes.

Maybe we just don’t force anything using rules, just allow people to do what they prefer?

Explicit return types throughout will lead to better generated .d.ts files in the end.

Shouldn't we expect TS to generate better return type than us humans? 🤔

Why would an inferred type be better than you describing exactly what you want/need a function to return?

Maybe we just don’t force anything using rules, just allow people to do what they prefer?

That's going to lead to messy and inconsistent type definitions.

Explicit return types throughout will lead to better generated .d.ts files in the end.

Shouldn't we expect TS to generate better return type than us humans? 🤔

Why would an inferred type be better than you describing exactly what you want/need a function to return?

Because it would describe what the function actually returns instead of what I think it does

Which might not be what you want it to return. If you specify the return type you'll get TS errors if you do not return exactly that.

Murderlon

✨

packages/@uppy/utils/src/UppyFile.ts

Murderlon · 2023-10-19T08:48:28Z

packages/@uppy/utils/tsconfig.json

+    "emitDeclarationOnly": false,
+    "noEmit": true
+  },
+  "include": ["./package.json", "./types/*.ts"],


For utils now that we are refactoring everything it once, yes. But this comment started about the include and I still think that's incorrect.

* main: meta: fix js2ts check

* main: More image editor improvements (#4676) @uppy/react: add useUppyState (#4711) Release: uppy@3.18.1 (#4760) Bump jsonwebtoken from 8.5.1 to 9.0.0 in /packages/@uppy/companion (#4751) Bump react-devtools-core from 4.25.0 to 4.28.4 (#4756) Bump webpack from 5.74.0 to 5.88.2 (#4740) Bump @babel/traverse from 7.22.5 to 7.23.2 (#4739) @uppy/core: fix `sideEffects` declaration (#4759) Release: uppy@3.18.0 (#4754) @uppy/aws-s3-multipart: fix `TypeError` (#4748) Bump tough-cookie from 4.1.2 to 4.1.3 (#4750) example: simplify code by using built-in `throwIfAborted` (#4749) @uppy/aws-s3-multipart: pass `signal` as separate arg for backward compat (#4746) meta: fix TS integration (#4741)

* main: Companion+client stability fixes, error handling and retry (#4734) add getBucket metadata argument (#4770) @uppy/core: simplify types with class generic (#4761)

Murderlon

I don't know why this is still failing:

packages/@uppy/core/types/index.d.ts:1:28 - error TS2307: Cannot find module '@uppy/utils' or its corresponding type declarations.

1 import * as UppyUtils from '@uppy/utils'
                             ~~~~~~~~~~~~~

packages/@uppy/utils/src/Translator.ts

packages/@uppy/utils/src/FileProgress.ts

packages/@uppy/utils/src/Translator.ts

Murderlon · 2023-11-03T13:58:08Z

packages/@uppy/utils/src/mimeTypes.ts

+  gz: 'application/gzip' as const,
+  dmg: 'application/x-apple-diskimage' as const,
+}


I think we can get rid of all these as const's with this

Suggested change

gz: 'application/gzip' as const,

dmg: 'application/x-apple-diskimage' as const,

}

gz: 'application/gzip' as const,

dmg: 'application/x-apple-diskimage' as const,

} as Readonly<Record<string, string>>

That doesn't do the same thing at all, as const is not there to indicate the value is read-only

why is it there then?

Here's the first search result for as const typescript: https://stackoverflow.com/a/66993654

If you leave it off, the compiler will use its default type inference behavior, which will possibly result in a wider or more general type.

Here's a video from Matt Pocock describing as const:

https://www.youtube.com/watch?v=6M9aZzm-kEc&pp=ygUUbWF0dCBwb2NvY2sgYXMgY29uc3Q%3D

…o utils-to-ts * 'utils-to-ts' of https://github.com/transloadit/uppy: fix types

packages/@uppy/utils/src/Translator.ts

| Package | Version | Package | Version | | ---------------------- | ------- | ---------------------- | ------- | | @uppy/aws-s3 | 3.5.0 | @uppy/provider-views | 3.7.0 | | @uppy/aws-s3-multipart | 3.9.0 | @uppy/react | 3.2.0 | | @uppy/companion | 4.11.0 | @uppy/transloadit | 3.4.0 | | @uppy/companion-client | 3.6.0 | @uppy/tus | 3.4.0 | | @uppy/core | 3.7.0 | @uppy/url | 3.4.0 | | @uppy/dashboard | 3.7.0 | @uppy/utils | 5.6.0 | | @uppy/image-editor | 2.3.0 | @uppy/xhr-upload | 3.5.0 | | @uppy/locales | 3.4.0 | uppy | 3.19.0 | - @uppy/dashboard: Remove uppy-Dashboard-isFixed when uppy.close() is invoked (Artur Paikin / #4775) - @uppy/core,@uppy/dashboard: don't cancel all files when clicking "done" (Mikael Finstad / #4771) - @uppy/utils: refactor to TS (Antoine du Hamel / #4699) - @uppy/locales: locales: add ca_ES (ordago / #4772) - @uppy/companion: Companion+client stability fixes, error handling and retry (Mikael Finstad / #4734) - @uppy/companion: add getBucket metadata argument (Mikael Finstad / #4770) - @uppy/core: simplify types with class generic (JokcyLou / #4761) - @uppy/image-editor: More image editor improvements (Evgenia Karunus / #4676) - @uppy/react: add useUppyState (Merlijn Vos / #4711)

aduh95 and others added 28 commits August 30, 2023 18:07

meta: add support for TypeScript plugins

0124e35

fixup! meta: add support for TypeScript plugins

d8a518a

fixup! meta: add support for TypeScript plugins

4e8f732

upgrade svelte-processes

fixup! meta: add support for TypeScript plugins

f15b3e3

upgrade tsd and fix ci

fix yarn dev

3985734

resolve e2e build failure

f00dec9

fixup! resolve e2e build failure

926effa

fixup! resolve e2e build failure

ef5a87c

add js2ts script

7f8cda3

add build:ts

c1f69af

Merge branch 'main' of https://github.com/transloadit/uppy

da629a9

update tsconfig

1ccdcfa

Merge branch 'main' of https://github.com/transloadit/uppy

8ff4725

@uppy/utils: refactor to TS

5d50cbb

rename fetchWithNetworkError and getBytesRemaining to TS

676708b

Update private/js2ts/index.mjs

4980818

Co-authored-by: Antoine du Hamel <antoine@transloadit.com>

Update private/js2ts/index.mjs

57341b6

Update private/js2ts/index.mjs

f7c2e57

Merge branch 'main' of https://github.com/transloadit/uppy

2a80377

Update private/js2ts/index.mjs

6c9586e

Merge branch 'ts-packages-support' into utils-to-ts

ea1eb9e

getETA.ts

8e59ec3

@uppy/utils: convert isDomElement to TS (#4703)

5a99859

Convert isDomElement to TS

fixup! getETA.ts

6cf96de

update p-q patch

123c98d

Merge branch 'ts-packages-support' into utils-to-ts

1ee4651

convert datauritoblob to ts 🎉 (#4705)

5c5d13a

fix types

3dd995d

nickrttn reviewed Sep 27, 2023

View reviewed changes

delay.ts

8926f00

aduh95 and others added 4 commits October 15, 2023 21:07

fixup! getDroppedFile.ts

ab2368e

convert tests to TS

8befa3d

exclude test files from mandatory function return type

759ecbb

Merge branch 'ts-packages-support' into utils-to-ts

6fe32fb

Base automatically changed from ts-packages-support to main October 17, 2023 13:38

aduh95 and others added 2 commits October 17, 2023 15:40

Merge branch 'main' into utils-to-ts

cfc2ae4

fix UppyFile definition

e63a2d3

Murderlon reviewed Oct 19, 2023

View reviewed changes

Murderlon and others added 9 commits November 1, 2023 16:02

Merge branch 'main' into utils-to-ts

cbc0728

* main: meta: fix js2ts check

Update tsconfig

8a28aae

Fix format error

c9a6e29

fix Translator test

1fe5401

fu]ix ts errors

6cde95a

Fis Translator types

42cfaf5

Merge branch 'main' into utils-to-ts

4fe37f0

* main: Companion+client stability fixes, error handling and retry (#4734) add getBucket metadata argument (#4770) @uppy/core: simplify types with class generic (#4761)

Fix translator bug

b01fa13

Murderlon reviewed Nov 3, 2023

View reviewed changes

aduh95 and others added 3 commits November 3, 2023 15:00

fix types

dca3777

Fix ErrorWithCause test

6c99442

Merge branch 'utils-to-ts' of https://github.com/transloadit/uppy int…

dad85bd

…o utils-to-ts * 'utils-to-ts' of https://github.com/transloadit/uppy: fix types

Murderlon reviewed Nov 3, 2023

View reviewed changes

packages/@uppy/utils/src/Translator.ts Outdated Show resolved Hide resolved

aduh95 and others added 4 commits November 3, 2023 15:07

fix utils ref

1163689

fix fixes

6c8242b

Update packages/@uppy/utils/src/Translator.ts

282da83

Update packages/@uppy/utils/src/FileProgress.ts

6b1edc2

aduh95 merged commit 51ecc66 into main Nov 6, 2023
18 checks passed

aduh95 deleted the utils-to-ts branch November 6, 2023 14:01

github-actions bot mentioned this pull request Nov 8, 2023

Release: uppy@3.19.0 #4781

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

@uppy/utils: refactor to TS #4699

@uppy/utils: refactor to TS #4699

aduh95 commented Sep 25, 2023 •

edited

nickrttn Sep 27, 2023 •

edited

mifi Sep 27, 2023

aduh95 Sep 27, 2023

nickrttn Sep 27, 2023 •

edited

Murderlon Sep 27, 2023

mifi Sep 27, 2023

nickrttn Sep 27, 2023

nickrttn Sep 27, 2023

aduh95 Sep 27, 2023

nickrttn Sep 27, 2023

Murderlon left a comment

Murderlon Oct 19, 2023

Murderlon left a comment

Murderlon Nov 3, 2023 •

edited

aduh95 Nov 3, 2023

Murderlon Nov 6, 2023

aduh95 Nov 6, 2023

aheimlich Nov 6, 2023

@uppy/utils: refactor to TS #4699

@uppy/utils: refactor to TS #4699

Conversation

aduh95 commented Sep 25, 2023 • edited

nickrttn Sep 27, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nickrttn Sep 27, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Murderlon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Murderlon left a comment

Choose a reason for hiding this comment

Murderlon Nov 3, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aduh95 commented Sep 25, 2023 •

edited

nickrttn Sep 27, 2023 •

edited

nickrttn Sep 27, 2023 •

edited

Murderlon Nov 3, 2023 •

edited