fix(ts): make GetSessionOptions optional (#1851)

* chore(github): add CODEOWNERS

* chore(ci): remove Node 10 and add Node 16

.github/CODEOWNERS

@@ -0,0 +1 @@
+/types/ @balazsorban44 @lluia

.github/workflows/build.yml

@@ -4,22 +4,22 @@ name: Lint/Build
 
 on:
   push:
-    branches: 
-     - main
-     - beta
-     - next
+    branches:
+      - main
+      - beta
+      - next
   pull_request:
     branches:
-     - main
-     - beta
-     - next
+      - main
+      - beta
+      - next
 
 jobs:
   lint-and-build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [10, 12, 14]
+        node-version: [12, 14, 16]
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
@@ -29,4 +29,4 @@ jobs:
       - name: Install dependencies
         uses: bahmutov/npm-install@v1
       - run: npm run lint
-      - run: npm run build
+      - run: npm run build

.github/workflows/integration.yml

@@ -30,7 +30,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10, 12, 14]
+        node-version: [12, 14, 16]
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/types.yml

@@ -19,6 +19,8 @@ jobs:
       - uses: actions/checkout@v2
       - name: Use Node.js
         uses: actions/setup-node@v1
+        with:
+          node-version: 14
       - name: Install dependencies
         uses: bahmutov/npm-install@v1
       - name: Check types

.gitignore

@@ -27,18 +27,19 @@ node_modules
 .cache-loader
 www/providers.json
 src/providers/index.js
-internals
-adapters.d.ts
-adapters.js
-client.d.ts
-client.js
-index.d.ts
-index.js
-jwt.d.ts
-jwt.js
-providers.d.ts
-providers.js
-errors.js
+/internals
+/adapters.d.ts
+/adapters.js
+/client.d.ts
+/client.js
+/index.d.ts
+/index.js
+/jwt.d.ts
+/jwt.js
+/providers.d.ts
+/providers.js
+/errors.js
+/errors.d.ts
 
 # Development app
 app/next-auth

config/build.js

@@ -36,6 +36,7 @@ const TYPES_TARGETS = [
   `${MODULE_ENTRIES.ADAPTERS}.d.ts`,
   `${MODULE_ENTRIES.PROVIDERS}.d.ts`,
   `${MODULE_ENTRIES.JWT}.d.ts`,
+  `${MODULE_ENTRIES.ERRORS}.d.ts`,
   "internals",
 ]
 

package.json

@@ -66,10 +66,11 @@
     "adapters.d.ts",
     "client.js",
     "client.d.ts",
+    "errors.js",
+    "errors.d.ts",
     "jwt.js",
     "jwt.d.ts",
-    "internals",
-    "errors.js"
+    "internals"
   ],
   "license": "ISC",
   "dependencies": {
@@ -179,6 +180,18 @@
         "name": "next",
         "prerelease": true
       }
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      [
+        "@semantic-release/github",
+        {
+          "releasedLabels": false,
+          "successComment": false
+        }
+      ]
     ]
   },
   "funding": [

src/providers/mailchimp.js

@@ -0,0 +1,22 @@
+export default function Mailchimp(options) {
+  return {
+    id: 'mailchimp',
+    name: 'Mailchimp',
+    type: 'oauth',
+    version: '2.0',
+    scope: '',
+    params: { grant_type: 'authorization_code' },
+    accessTokenUrl: 'https://login.mailchimp.com/oauth2/token',
+    authorizationUrl: 'https://login.mailchimp.com/oauth2/authorize?response_type=code',
+    profileUrl: 'https://login.mailchimp.com/oauth2/metadata',
+    profile: (profile) => {
+      return {
+        id: profile.login.login_id,
+        name: profile.accountname,
+        email: profile.login.email,
+        image: null
+      }
+    },
+    ...options
+  }
+}

src/providers/wordpress.js

@@ -0,0 +1,23 @@
+export default function WordPress(options) {
+  return {
+    id: "wordpress",
+    name: "WordPress.com",
+    type: "oauth",
+    version: "2.0",
+    scope: "auth",
+    params: { grant_type: "authorization_code" },
+    accessTokenUrl: "https://public-api.wordpress.com/oauth2/token",
+    authorizationUrl:
+      "https://public-api.wordpress.com/oauth2/authorize?response_type=code",
+    profileUrl: "https://public-api.wordpress.com/rest/v1/me",
+    profile(profile) {
+      return {
+        id: profile.ID,
+        name: profile.display_name,
+        email: profile.email,
+        image: profile.avatar_URL,
+      }
+    },
+    ...options,
+  }
+}

test/.env.example

@@ -1,5 +1,6 @@
-# Rename file to .env and populate values
-# to be able to run tests
+# To be able to run tests:
+# 1. copy to the root folder and rename to .env
+# 2. Populate with values
 NEXTAUTH_URL=http://localhost:3000
 NEXTAUTH_TWITTER_ID=
 NEXTAUTH_TWITTER_SECRET=

test/docker/app.yml

@@ -2,14 +2,13 @@
 #
 # Note: Uses Docker Compose v2 as v3 doesn't currently support extends.
 # https://docs.docker.com/compose/compose-file/compose-file-v2/
-version: '2.3'
+version: "2.3"
 
 services:
-
   app:
     build:
       context: ../../
-      dockerfile: Dockerfile
+      dockerfile: ./test/Dockerfile
     environment:
       # Set env vars in your current terminal or in .env in the root directory
       - NEXTAUTH_URL=${NEXTAUTH_URL}

types/client.d.ts

@@ -32,7 +32,7 @@ export function useSession(): [Session | null, boolean]
  *
  * [Documentation](https://next-auth.js.org/getting-started/client#getsession)
  */
-export function getSession(options: GetSessionOptions): Promise<Session | null>
+export function getSession(options?: GetSessionOptions): Promise<Session | null>
 
 /**
  * Alias for `getSession`
@@ -52,7 +52,7 @@ export const session: typeof getSession
  *
  * [Documentation](https://next-auth.js.org/getting-started/client#getcsrftoken)
  */
-export function getCsrfToken(ctxOrReq: CtxOrReq): Promise<string | null>
+export function getCsrfToken(ctxOrReq?: CtxOrReq): Promise<string | null>
 
 /**
  * Alias for `getCsrfToken`

types/errors.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Same as the default `Error`, but it is JSON serializable.
+ * @source https://iaincollins.medium.com/error-handling-in-javascript-a6172ccdf9af
+ */
+export class UnknownError extends Error {}
+export class OAuthCallbackError extends UnknownError {}
+export class AccountNotLinkedError extends UnknownError {}
+export class CreateUserError extends UnknownError {}
+export class GetUserError extends UnknownError {}
+export class GetUserByEmailError extends UnknownError {}
+export class GetUserByIdError extends UnknownError {}
+export class GetUserByProviderAccountIdError extends UnknownError {}
+export class UpdateUserError extends UnknownError {}
+export class DeleteUserError extends UnknownError {}
+export class LinkAccountError extends UnknownError {}
+export class UnlinkAccountError extends UnknownError {}
+export class CreateSessionError extends UnknownError {}
+export class GetSessionError extends UnknownError {}
+export class UpdateSessionError extends UnknownError {}
+export class DeleteSessionError extends UnknownError {}
+export class CreateVerificationRequestError extends UnknownError {}
+export class GetVerificationRequestError extends UnknownError {}
+export class DeleteVerificationRequestError extends UnknownError {}

types/providers.d.ts

@@ -77,6 +77,7 @@ export type OAuthProviderType =
   | "Kakao"
   | "LINE"
   | "LinkedIn"
+  | "Mailchimp"
   | "MailRu"
   | "Medium"
   | "Netlify"
@@ -90,6 +91,7 @@ export type OAuthProviderType =
   | "Twitch"
   | "Twitter"
   | "VK"
+  | "WordPress"
   | "Yandex"
   | "Zoho"
 

www/docs/configuration/pages.md

@@ -60,7 +60,7 @@ By default, the built-in pages will follow the system theme, utilizing the [`pre
 In order to get the available authentication providers and the URLs to use for them, you can make a request to the API endpoint `/api/auth/providers`:
 
 ```jsx title="pages/auth/signin.js"
-import { providers, signIn } from 'next-auth/client'
+import { getProviders, signIn } from 'next-auth/client'
 
 export default function SignIn({ providers }) {
   return (
@@ -76,7 +76,7 @@ export default function SignIn({ providers }) {
 
 // This is the recommended way for Next.js 9.3 or newer
 export async function getServerSideProps(context){
-  const providers = await providers()
+  const providers = await getProviders()
   return {
     props: { providers }
   }
@@ -86,7 +86,7 @@ export async function getServerSideProps(context){
 // If older than Next.js 9.3
 SignIn.getInitialProps = async () => {
   return {
-    providers: await providers()
+    providers: await getProviders()
   }
 }
 */

www/docs/providers/mailchimp.md

@@ -0,0 +1,26 @@
+---
+id: mailchimp
+title: Mailchimp
+---
+
+## Documentation
+
+https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/
+
+## Configuration
+
+https://admin.mailchimp.com/account/oauth2/client/
+
+## Example
+
+```js
+import Providers from `next-auth/providers`
+...
+providers: [
+  Providers.Mailchimp({
+    clientId: process.env.MAILCHIMP_CLIENT_ID,
+    clientSecret: process.env.MAILCHIMP_CLIENT_SECRET
+  })
+]
+...
+```

www/docs/providers/wordpress.md

@@ -0,0 +1,30 @@
+---
+id: wordpress
+title: WordPress.com
+---
+
+## Documentation
+
+https://developer.wordpress.com/docs/oauth2/
+
+## Configuration
+
+https://developer.wordpress.com/apps/
+
+## Example
+
+```js
+import Providers from `next-auth/providers`
+...
+providers: [
+  Providers.WordPress({
+    clientId: process.env.WORDPRESS_CLIENT_ID,
+    clientSecret: process.env.WORDPRESS_CLIENT_SECRET
+  })
+}
+...
+```
+
+:::tip
+Register your application to obtain Client ID and Client Secret at https://developer.wordpress.com/apps/ Select Type as Web and set Redirect URL to `http://example.com/api/auth/callback/wordpress` where example.com is your site domain.
+:::