feat(ts): support module augmentation #1681

balazsorban44 · 2021-04-09T21:14:17Z

What:

Support Module Augmentation. Also adds a documentation section explaining how to do it.

Why:

This way, certain interfaces like JWT or Session can be defined in a single location and will be shared across the entire app.

For example useSession and the callbacks.session will share the same type!

How:

It only required some cleanup in the CallbacksOptions interface

Checklist:

Documentation
Tests
Ready to be merged

vercel · 2021-04-09T21:14:19Z

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/3tSiwgdapznXX2dfqNryUUpYd6F5
✅ Preview: https://next-auth-git-feat-module-augmentation-nextauthjs.vercel.app

ubbe-xyz

Very neat 💯, much easier to read the CallbacksOptions type now 💚

I leave 3 small nitpicks 💬 ; none of them prevents merging this 😊

ubbe-xyz · 2021-04-10T10:42:28Z

types/index.d.ts

+export interface Profile extends Record<string, unknown> {}
+
+export interface CallbacksOptions<
+  P extends Record<string, unknown> = Profile,


Given Profile is just Record<string, unknown>, maybe we can simplify this line to 💭

export interface CallbacksOptions< P = Record<string, unknown>, A extends Record<string, unknown> = Account

It is because it's kind of unfinished, as we may want to make it extensible as the other interfaces. We could either try to somehow infer it from providers, or add it as a generic to NextAuth (same goes for Account, they are not necessarily used anywhere else than NextAuth, so generic could work just fine. Or we could go all in on Module Augmentation. Haven't decided yet. 🤔) In any case, I think that could be a subsequent PR

ubbe-xyz · 2021-04-10T10:46:31Z

types/index.d.ts

+> {
+  signIn?(user: User, account: A, profile: P): Awaitable<string | boolean>
+  redirect?(url: string, baseUrl: string): Awaitable<string>
+  session?(session: Session, userOrToken: JWT | User): Awaitable<Session>


This type will force the session callback to always take 2 parameters session, userOrToken. Are we coolio with that? I 👀 the default callback for the session is just using one, maybe we should change it to:

session?:(session: Session, userOrToken?: JWT | User): Awaitable<Session>

Yes, so the defulat session callback actually is just an identity function and does nothing than return the first param. In any other case, when the user defines/overrides this, they will use the second param to extend session in some way. So I think it's good. 🙂

ubbe-xyz · 2021-04-10T10:49:22Z

www/docs/getting-started/typescript.md

 ---

-Currently, NextAuth.js relies on the community to provide TypeScript types. You can download it from [DefinitelyTyped](https://www.npmjs.com/package/@types/next-auth).
+TypeScript comes with its own types, so you can safely use it in your TypeScript projects. Even if you don't use TypeScript, IDEs like VSCode will pick this up, to provide you with a better developer experience. While you are typing, you will get suggestions of what certain objects are, and sometimes also links to documentation, and examples.


Should we change:

TypeScript comes with its own types, so you can safely use it in your TypeScript projects.

to:

NextAuth comes with its own types, so you can safely use it in your TypeScript projects.

🤦‍♂️

github-actions · 2021-04-10T21:49:56Z

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

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2021-04-19T15:42:03Z

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

The release is available on:

Your semantic-release bot 📦🚀

* 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 <info@balazsorban.com> * 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 <hi@llu.lu> Co-authored-by: Nico Domino <yo@ndo.dev>

* 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 <info@balazsorban.com> * 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 <hi@llu.lu> Co-authored-by: Nico Domino <yo@ndo.dev>

balazsorban44 added 3 commits April 9, 2021 23:01

chore(ts): remove unused imports

e4558e8

refactor(ts): clean up CallbackOptions

f0fc4da

docs(ts): explain Module Augmentation

10b2987

balazsorban44 requested a review from ubbe-xyz April 9, 2021 21:14

balazsorban44 added docs Relates to documentation TypeScript Issues relating to TypeScript labels Apr 9, 2021

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

8e604c6

vercel bot temporarily deployed to Preview April 9, 2021 21:35 Inactive

test(ts): make jwt params optional

06de62d

vercel bot temporarily deployed to Preview April 9, 2021 21:39 Inactive

ubbe-xyz approved these changes Apr 10, 2021

View reviewed changes

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

ad89db2

vercel bot temporarily deployed to Preview April 10, 2021 21:39 Inactive

balazsorban44 merged commit a1e3050 into beta Apr 10, 2021

balazsorban44 deleted the feat/module-augmentation branch April 10, 2021 21:48

github-actions bot added the released on @beta label Apr 10, 2021

ubbe-xyz mentioned this pull request Apr 11, 2021

Update callbacks.md #1689

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ts): support module augmentation #1681

feat(ts): support module augmentation #1681

balazsorban44 commented Apr 9, 2021 •

edited

Loading

vercel bot commented Apr 9, 2021 •

edited

Loading

ubbe-xyz left a comment

ubbe-xyz Apr 10, 2021

balazsorban44 Apr 10, 2021

ubbe-xyz Apr 10, 2021

balazsorban44 Apr 10, 2021 •

edited

Loading

ubbe-xyz Apr 10, 2021

balazsorban44 Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 19, 2021

feat(ts): support module augmentation #1681

feat(ts): support module augmentation #1681

Conversation

balazsorban44 commented Apr 9, 2021 • edited Loading

vercel bot commented Apr 9, 2021 • edited Loading

ubbe-xyz left a comment

Choose a reason for hiding this comment

ubbe-xyz Apr 10, 2021

Choose a reason for hiding this comment

balazsorban44 Apr 10, 2021

Choose a reason for hiding this comment

ubbe-xyz Apr 10, 2021

Choose a reason for hiding this comment

balazsorban44 Apr 10, 2021 • edited Loading

Choose a reason for hiding this comment

ubbe-xyz Apr 10, 2021

Choose a reason for hiding this comment

balazsorban44 Apr 10, 2021

Choose a reason for hiding this comment

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 19, 2021

balazsorban44 commented Apr 9, 2021 •

edited

Loading

vercel bot commented Apr 9, 2021 •

edited

Loading

balazsorban44 Apr 10, 2021 •

edited

Loading