feat: tsup, pnpm and new build system by productdevbook · Pull Request #565 · supertokens/supertokens-node

productdevbook · 2023-05-13T02:59:14Z

close #413
close #459

dynamic build -> export dist
pnpm support
esm, cjs support

rishabhpoddar · 2023-05-13T08:04:08Z

@@ -138,7 +138,7 @@ export async function assertThatBodyParserHasBeenUsedForExpressLikeRequest(
            let err = await new Promise((resolve) => {
                let resolvedCalled = false;
                if (request.readable) {
-                    jsonParser(request, new ServerResponse(request), (e) => {
+                    jsonParser(request, new ServerResponse(request), (e: any) => {


can we not use any type?

you can use, i did any as i don't know what types are

rishabhpoddar · 2023-05-13T08:04:29Z

@@ -71,7 +71,10 @@ function defaultCreateAndSendCustomSms(_: NormalisedAppinfo) {
                         * if the error is thrown from API, the response object
                         * will be of type `{err: string}`
                         */
+                        // TODO: check if this is the correct way to check for error
+                        // @ts-ignore


can we not add @ts-ignore to so many files?

there were ts errors in a few places only during the build, I closed them temporarily with this. We can do this better in the next pr.

rishabhpoddar · 2023-05-13T08:06:25Z

hey @productdevbook could you also tell if this a breaking change for the user? For example, will the import statements for the user change in any way for any recipe / function etc?

productdevbook · 2023-05-13T08:08:27Z

It should not affect it in any way, because I took the same paths. I can even create a playground for testing purposes.

productdevbook · 2023-05-13T08:44:19Z

rishabhpoddar · 2023-05-14T16:53:49Z

Okay. Im going to try and remove all the newly added @ts-ignore annotations before merging this PR.

Also, i see the you have removed the build folder and instead using dist, but dist itself is not part of the git repo (which is fine). This would affect the npm publish process right? Also, if someone is using the github repo directly in the npm command (like npm i git+https://github.com:supertokens/supertokens-node#14.0), how would they go about generating the required dist folder (for the package to work)

rishabhpoddar · 2023-05-14T17:00:07Z

-        "build-check": "cd lib && npx tsc -p tsconfig.json --noEmit && cd ../test/with-typescript && npx tsc -p tsconfig.json --noEmit",
-        "build": "cd lib && rm -rf build && npx tsc -p tsconfig.json && cd ../test/with-typescript && npx tsc -p tsconfig.json --noEmit && cd ../.. && npm run post-build",
+        "build-check": "npx tsc -p tsconfig.json --noEmit && cd ../test/with-typescript && npx tsc -p tsconfig.json --noEmit",
+        "build": "tsup",


the build command earlier used to also check the compilation of ../test/with-typescript - this was done as a way to make sure that the interface exposed to the user doesn't break unintentionally.

you don't need them, tsup sets them all in dist. There is no need for that test, since that user will no longer have ts errors.

productdevbook · 2023-05-14T17:10:02Z

Okay. Im going to try and remove all the newly added @ts-ignore annotations before merging this PR.

Also, i see the you have removed the build folder and instead using dist, but dist itself is not part of the git repo (which is fine). This would affect the npm publish process right? Also, if someone is using the github repo directly in the npm command (like npm i git+https://github.com:supertokens/supertokens-node#14.0), how would they go about generating the required dist folder (for the package to work)

yes, used dist. example npm publish first build working and after send. package.json in

  "files": [
        "dist",
        "LICENSE",
        "README.md"
    ],

only send data.

productdevbook · 2023-05-14T17:13:05Z

npm i git+https://github.com:supertokens/supertokens-node#14.0

I do not know about this. normally it should not be kept on dist vs github in any way.

rishabhpoddar · 2023-05-15T17:17:03Z

I do not know about this. normally it should not be kept on dist vs github in any way.

Right, we do have requirements that we need the sdk to work even with directly using the git repo. Therefore, we would need the dist folder to be a part of the github repo as well (which is why earlier we had the build folder as well).

If you can think of a better solution to this, it would be great.

productdevbook · 2023-05-15T18:06:52Z

I can't find a solution to this, people who will use it will pr and create and export their github dist using their own url. This should not be in the main library. The solution is actually that simple. We already do the same thing in many libraries.

fork and build and push. and me github url copy and paste.

rishabhpoddar · 2023-05-16T14:11:19Z

I'm afraid that won't work for us. Maybe we can add a post npm install hook to do the TS compilation for such users. But we do require some solution that universally works even when pulling the GH repo directly. This is a hard requirement for us i'm afraid.

productdevbook · 2023-05-16T15:01:26Z

Since it will be an npm package and it is a suitable external build, people will use it according to the package versions anyway. In addition, users who want to use github url, which is a very special situation, should do as I said. It's a must. There is a postinstall structure in npm, but it is very inefficient in this structure.

productdevbook added 8 commits May 13, 2023 05:57

pnpm

9ba676c

Create tsup.config.ts

5b3d5c1

fix lib same ts error

a2cf5d0

delete lib/build

d7f3574

fix: test path

4fdd7de

feat: add framework packagejson add

f8f3607

fix: tsconfig

455b3fa

Update tsup.config.ts

f57850b

rishabhpoddar suggested changes May 13, 2023

View reviewed changes

productdevbook added 3 commits May 13, 2023 11:09

delete: package-lock.json

e04b431

add playground

bf628f8

fix: playground ts error

9073946

productdevbook added 2 commits May 13, 2023 11:46

Update CONTRIBUTING.md

6ad8f26

update ts min node 16

2857c9c

rishabhpoddar suggested changes May 14, 2023

View reviewed changes

ITenthusiasm mentioned this pull request Jan 15, 2024

Feat: Support Convenient Directory Imports for Developers Using ESM #783

Open

Uh oh!

Conversation

productdevbook commented May 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rishabhpoddar May 13, 2023

Choose a reason for hiding this comment

Uh oh!

productdevbook May 13, 2023

Choose a reason for hiding this comment

Uh oh!

rishabhpoddar May 13, 2023

Choose a reason for hiding this comment

Uh oh!

productdevbook May 13, 2023

Choose a reason for hiding this comment

Uh oh!

rishabhpoddar commented May 13, 2023

Uh oh!

productdevbook commented May 13, 2023

Uh oh!

productdevbook commented May 13, 2023

Uh oh!

rishabhpoddar commented May 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rishabhpoddar May 14, 2023

Choose a reason for hiding this comment

Uh oh!

productdevbook May 14, 2023

Choose a reason for hiding this comment

Uh oh!

productdevbook commented May 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

productdevbook commented May 14, 2023

Uh oh!

rishabhpoddar commented May 15, 2023

Uh oh!

productdevbook commented May 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rishabhpoddar commented May 16, 2023

Uh oh!

productdevbook commented May 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

productdevbook commented May 13, 2023 •

edited

Loading

rishabhpoddar commented May 14, 2023 •

edited

Loading

productdevbook commented May 14, 2023 •

edited

Loading

productdevbook commented May 15, 2023 •

edited

Loading