Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(ts): de-duplicate types #1690

Merged
merged 28 commits into from
Apr 19, 2021
Merged

refactor(ts): de-duplicate types #1690

merged 28 commits into from
Apr 19, 2021

Conversation

balazsorban44
Copy link
Member

@balazsorban44 balazsorban44 commented Apr 11, 2021

What:
Removed all .d.ts type declarations from the src folder

Why:

We now have a dedicated folder for all types (types) and so we don't need them in the source folder. This will keep it easier for folks less familiar with TS to contribute to the core, and give TS folks to contribute to better typings much easier!

How:

Rather than simply deleting the previously used types, I tried to merge them with the ones in types, and refactored some parts where I felt they were too strict (like the OAuth providers typings)

Checklist:

  • src/client/index.d.ts should be merged with types/client.d.ts

@vercel
Copy link

vercel bot commented Apr 11, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/nextauthjs/next-auth/6DaiJEjGFYtDFuxnQMSvwHGDKise
✅ Preview: https://next-auth-git-feat-deduplicate-types-nextauthjs.vercel.app

@github-actions github-actions bot added core Refers to `@auth/core` pages providers labels Apr 11, 2021
@balazsorban44 balazsorban44 changed the title Feat/deduplicate types refactor(ts): de-duplicate types Apr 11, 2021
@vercel vercel bot temporarily deployed to Preview April 11, 2021 17:38 Inactive
@balazsorban44 balazsorban44 added the TypeScript Issues relating to TypeScript label Apr 11, 2021
Copy link
Collaborator

@ubbe-xyz ubbe-xyz left a comment

Choose a reason for hiding this comment

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

Amazing 💯 🤩 , just the client types left to pair-review 💪🏽

types/index.d.ts Outdated Show resolved Hide resolved
types/providers.d.ts Outdated Show resolved Hide resolved
types/providers.d.ts Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview April 16, 2021 18:17 Inactive
@github-actions github-actions bot added the client Client related code label Apr 16, 2021
@vercel vercel bot temporarily deployed to Preview April 16, 2021 18:21 Inactive
@vercel vercel bot temporarily deployed to Preview April 16, 2021 18:22 Inactive
@vercel vercel bot temporarily deployed to Preview April 17, 2021 09:22 Inactive
@vercel vercel bot temporarily deployed to Preview April 17, 2021 09:24 Inactive
@vercel vercel bot temporarily deployed to Preview April 17, 2021 20:43 Inactive
@vercel vercel bot temporarily deployed to Preview April 17, 2021 21:01 Inactive
config/build.js Show resolved Hide resolved
src/client/index.js Show resolved Hide resolved
types/client.d.ts Show resolved Hide resolved
types/client.d.ts Show resolved Hide resolved
types/index.d.ts Outdated Show resolved Hide resolved
types/jwt.d.ts Show resolved Hide resolved
types/tests/client.test.ts Show resolved Hide resolved
Copy link
Collaborator

@ubbe-xyz ubbe-xyz left a comment

Choose a reason for hiding this comment

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

Impressive refactor 😍 , types read much much better now 💪🏽 🍵

I leave few very small suggestions 💭, but nothing blocking for this to be merged!

@vercel vercel bot temporarily deployed to Preview April 19, 2021 11:51 Inactive
@github-actions github-actions bot added the docs Relates to documentation label Apr 19, 2021
@vercel vercel bot temporarily deployed to Preview April 19, 2021 12:10 Inactive
@vercel vercel bot temporarily deployed to Preview April 19, 2021 12:11 Inactive
@vercel vercel bot temporarily deployed to Preview April 19, 2021 12:19 Inactive
@vercel vercel bot temporarily deployed to Preview April 19, 2021 14:50 Inactive
@balazsorban44 balazsorban44 merged commit 97c77ff into beta Apr 19, 2021
@balazsorban44 balazsorban44 deleted the feat/deduplicate-types branch April 19, 2021 14:54
@github-actions
Copy link

🎉 This PR is included in version 3.14.0-beta.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version 3.15.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

balazsorban44 added a commit that referenced this pull request Apr 20, 2021
* chore: add beta to release flow/GH actions

* feat(ts): expose types from the package (#1665)

* chore(types): move existing types to the repo
* feat(ts): expose types from the main package
* chore(deps): bring back `react-dom` version range
* chore(ts): cleanup deps and comments
* chore(ci): run types tests on a separate workflow

* chore(ci): fix typo on types workflow

* fix(ts): correctly export sub-module types (#1677)

* chore(types): build types script

Adds a script that moves the declaration files we have in `./types` to `./dist` relative to the files they intend to type.

This is the first step, we still need to change what we declare in `package.json`, add the script to the CI pipeline if we're happy with it and figure out how to type `next-auth/jwt`.

* refactor(lint): fix build-types script

* fix(ts): add .d.ts sub-module files to package.json

#1677 seemed to miss this

* fix(built): typo in package.json

* fix(build): fix release

* feat(ts): support module augmentation (#1681)

* chore(ts): remove unused imports

* refactor(ts): clean up CallbackOptions

* docs(ts): explain Module Augmentation

* docs(ts): don't use @ in folder name "types"

* test(ts): make jwt params optional

* docs(ts): fix typo (TypeScript -> NextAuth.js)

* style: replace ts-standard with eslint/prettier (#1724)

* style: move from ts-standard to eslint/prettier

* fix: install remaining eslint-config-standard peer deps

* fix: add remaining missing dependencies/config

Co-authored-by: Balázs Orbán <[email protected]>

* docs(lint): update contributing.md (#1760)

Regarding ESLint / Prettier use and link to their VSCode extensions

* refactor(ts): de-duplicate types (#1690)

* refactor(ts): deduplicate internal types

* refactor(ts): ease up providers typings

* test(ts): fix failing TS tests

* test(ts): rename TS property to fix test

* docs(ts): mention TS docs in README.md

* feat(ts): move/update client types

* refactor(TS): rename some types

* test(ts): fix client tests

* docs(ts): move function descriptions to .d.ts

* chore: fix lint error

* refactor(ts): separate internal types

* chore: simplify build-types script

* chore: update type import paths in src

* chore(build): create root files at build

* chore: remove unnecessary .npmignore

* chore: run prettier on types

* fix(ts): clean up jwt types

* fix(ts): make getToken return type depend on raw param

* docs(page): explain page errors, add theming note

* docs(ts): add JSDoc to NextAuthOptions props

* chore(ts): remove unused import

* docs(ts): change JSDOC docs notation

* refactor(build): extract module entries into enum

* chore(ts): move ClientSafeProvider

* chore(ts): simplify GetTokenParams generic

* style(lint): fix linting errors

* chore: re-add generic extension to GetTokenParams

* fix(ts): extract EmailConfigServerOptions to interface

* fix(ts): use relative imports

* Merge branch 'main' into beta

* Merge main into beta

* fix(ts): fix typos, add more links to documentation

* test(ts): update JWT getToken test

* fix(build): fix tsconfig.json formatting

* test(ts): use absolute imports in test files

* fix(ts): add missing callbacks JSDoc

* docs: mention TS in FAQ, fix typos

* docs: fix some typos in the docs

Co-authored-by: Lluis Agusti <[email protected]>
Co-authored-by: Nico Domino <[email protected]>
mnphpexpert added a commit to mnphpexpert/next-auth that referenced this pull request Sep 2, 2024
* chore: add beta to release flow/GH actions

* feat(ts): expose types from the package (nextauthjs#1665)

* chore(types): move existing types to the repo
* feat(ts): expose types from the main package
* chore(deps): bring back `react-dom` version range
* chore(ts): cleanup deps and comments
* chore(ci): run types tests on a separate workflow

* chore(ci): fix typo on types workflow

* fix(ts): correctly export sub-module types (nextauthjs#1677)

* chore(types): build types script

Adds a script that moves the declaration files we have in `./types` to `./dist` relative to the files they intend to type.

This is the first step, we still need to change what we declare in `package.json`, add the script to the CI pipeline if we're happy with it and figure out how to type `next-auth/jwt`.

* refactor(lint): fix build-types script

* fix(ts): add .d.ts sub-module files to package.json

nextauthjs#1677 seemed to miss this

* fix(built): typo in package.json

* fix(build): fix release

* feat(ts): support module augmentation (nextauthjs#1681)

* chore(ts): remove unused imports

* refactor(ts): clean up CallbackOptions

* docs(ts): explain Module Augmentation

* docs(ts): don't use @ in folder name "types"

* test(ts): make jwt params optional

* docs(ts): fix typo (TypeScript -> NextAuth.js)

* style: replace ts-standard with eslint/prettier (nextauthjs#1724)

* style: move from ts-standard to eslint/prettier

* fix: install remaining eslint-config-standard peer deps

* fix: add remaining missing dependencies/config

Co-authored-by: Balázs Orbán <[email protected]>

* docs(lint): update contributing.md (nextauthjs#1760)

Regarding ESLint / Prettier use and link to their VSCode extensions

* refactor(ts): de-duplicate types (nextauthjs#1690)

* refactor(ts): deduplicate internal types

* refactor(ts): ease up providers typings

* test(ts): fix failing TS tests

* test(ts): rename TS property to fix test

* docs(ts): mention TS docs in README.md

* feat(ts): move/update client types

* refactor(TS): rename some types

* test(ts): fix client tests

* docs(ts): move function descriptions to .d.ts

* chore: fix lint error

* refactor(ts): separate internal types

* chore: simplify build-types script

* chore: update type import paths in src

* chore(build): create root files at build

* chore: remove unnecessary .npmignore

* chore: run prettier on types

* fix(ts): clean up jwt types

* fix(ts): make getToken return type depend on raw param

* docs(page): explain page errors, add theming note

* docs(ts): add JSDoc to NextAuthOptions props

* chore(ts): remove unused import

* docs(ts): change JSDOC docs notation

* refactor(build): extract module entries into enum

* chore(ts): move ClientSafeProvider

* chore(ts): simplify GetTokenParams generic

* style(lint): fix linting errors

* chore: re-add generic extension to GetTokenParams

* fix(ts): extract EmailConfigServerOptions to interface

* fix(ts): use relative imports

* Merge branch 'main' into beta

* Merge main into beta

* fix(ts): fix typos, add more links to documentation

* test(ts): update JWT getToken test

* fix(build): fix tsconfig.json formatting

* test(ts): use absolute imports in test files

* fix(ts): add missing callbacks JSDoc

* docs: mention TS in FAQ, fix typos

* docs: fix some typos in the docs

Co-authored-by: Lluis Agusti <[email protected]>
Co-authored-by: Nico Domino <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Client related code core Refers to `@auth/core` docs Relates to documentation pages providers TypeScript Issues relating to TypeScript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants