@auth/dynamodb-adapter 1.6.0 → 2.1.0

package/README.md

@@ -1,7 +1,7 @@
 <p align="center">
   <br/>
   <a href="https://authjs.dev" target="_blank">
-    <img height="64px" src="https://authjs.dev/img/logo/logo-sm.png" />
+    <img height="64px" src="https://authjs.dev/img/logo-sm.png" />
   </a>
   <a href="https://aws.amazon.com/dynamodb" target="_blank">
     <img height="64px" src="https://authjs.dev/img/adapters/dynamodb.svg"/>
@@ -18,7 +18,7 @@
       <img src="https://img.shields.io/npm/dm/@auth/dynamodb-adapter?label=%20downloads&style=flat-square" alt="Downloads" />
     </a>
     <a href="https://github.com/nextauthjs/next-auth/stargazers">
-      <img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="Github Stars" />
+      <img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="GitHub Stars" />
     </a>
   </p>
 </p>

package/index.d.ts

@@ -1,6 +1,6 @@
 /**
- * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: 16}}>
- *  <p style={{fontWeight: "normal"}}>Official <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html">DynamoDB</a> adapter for Auth.js / NextAuth.js.</p>
+ * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: "16px"}}>
+ *  <p>Official <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html">DynamoDB</a> adapter for Auth.js / NextAuth.js.</p>
  *  <a href="https://docs.aws.amazon.com/dynamodb/index.html">
  *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/dynamodb.png" width="48"/>
  *  </a>
@@ -24,186 +24,9 @@ export interface DynamoDBAdapterOptions {
     indexPartitionKey?: string;
     indexSortKey?: string;
 }
-/**
- * ## Setup
- *
- * By default, the adapter expects a table with a partition key `pk` and a sort key `sk`, as well as a global secondary index named `GSI1` with `GSI1PK` as partition key and `GSI1SK` as sorting key. To automatically delete sessions and verification requests after they expire using [dynamodb TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) you should [enable the TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-how-to.html) with attribute name 'expires'. You can set whatever you want as the table name and the billing method.
- * You can find the full schema in the table structure section below.
- *
- * ### Configuring Auth.js
- *
- * You need to pass `DynamoDBDocument` client from the modular [`aws-sdk`](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/dynamodb-example-dynamodb-utilities.html) v3 to the adapter.
- * The default table name is `next-auth`, but you can customise that by passing `{ tableName: 'your-table-name' }` as the second parameter in the adapter.
- *
- * ```javascript title="pages/api/auth/[...nextauth].js"
- * import { DynamoDB, DynamoDBClientConfig } from "@aws-sdk/client-dynamodb"
- * import { DynamoDBDocument } from "@aws-sdk/lib-dynamodb"
- * import NextAuth from "next-auth";
- * import Providers from "next-auth/providers";
- * import { DynamoDBAdapter } from "@auth/dynamodb-adapter"
- *
- * const config: DynamoDBClientConfig = {
- *   credentials: {
- *     accessKeyId: process.env.NEXT_AUTH_AWS_ACCESS_KEY,
- *     secretAccessKey: process.env.NEXT_AUTH_AWS_SECRET_KEY,
- *   },
- *   region: process.env.NEXT_AUTH_AWS_REGION,
- * };
- *
- * const client = DynamoDBDocument.from(new DynamoDB(config), {
- *   marshallOptions: {
- *     convertEmptyValues: true,
- *     removeUndefinedValues: true,
- *     convertClassInstanceToMap: true,
- *   },
- * })
- *
- * export default NextAuth({
- *   // Configure one or more authentication providers
- *   providers: [
- *     Providers.GitHub({
- *       clientId: process.env.GITHUB_ID,
- *       clientSecret: process.env.GITHUB_SECRET,
- *     }),
- *     Providers.Email({
- *       server: process.env.EMAIL_SERVER,
- *       from: process.env.EMAIL_FROM,
- *     }),
- *     // ...add more providers here
- *   ],
- *   adapter: DynamoDBAdapter(
- *     client
- *   ),
- *   ...
- * });
- * ```
- *
- * (AWS secrets start with `NEXT_AUTH_` in order to not conflict with [Vercel's reserved environment variables](https://vercel.com/docs/environment-variables#reserved-environment-variables).)
- *
- * ## AWS Credentials
- *
- * :::note
- *   Always follow the **principle of least privilege** when giving access to AWS
- *   services/resources -> identities should only be permitted to perform the
- *   smallest set of actions necessary to fulfill a specific task.
- * :::
- *
- * 1. Open the [AWS console](https://console.aws.amazon.com/) and go to "IAM", then "Users".
- * 2. Create a new user. The purpose of this user is to give programmatic access to DynamoDB.
- * 3. Create an Access Key and then copy Key ID and Secret to your `.env`/`.env.local` file.
- * 4. Select "Add Permission" and "Create Inline Policy".
- * 5. Copy the JSON below into the JSON input and replace `region`, `account_id` and `table_name` with your values.
- *
- * ```json
- * {
- *   "Version": "2012-10-17",
- *   "Statement": [
- *     {
- *       "Sid": "DynamoDBAccess",
- *       "Effect": "Allow",
- *       "Action": [
- *         "dynamodb:BatchGetItem",
- *         "dynamodb:BatchWriteItem",
- *         "dynamodb:Describe*",
- *         "dynamodb:List*",
- *         "dynamodb:PutItem",
- *         "dynamodb:DeleteItem",
- *         "dynamodb:GetItem",
- *         "dynamodb:Scan",
- *         "dynamodb:Query",
- *         "dynamodb:UpdateItem"
- *       ],
- *       "Resource": [
- *         "arn:aws:dynamodb:{region}:{account_id}:table/{table_name}",
- *         "arn:aws:dynamodb:{region}:{account_id}:table/{table_name}/index/GSI1"
- *       ]
- *     }
- *   ]
- * }
- * ```
- *
- * ## Advanced usage
- *
- * ### Default schema
- *
- * The table respects the single table design pattern. This has many advantages:
- *
- * - Only one table to manage, monitor and provision.
- * - Querying relations is faster than with multi-table schemas (for eg. retrieving all sessions for a user).
- * - Only one table needs to be replicated if you want to go multi-region.
- *
- * > This schema is adapted for use in DynamoDB and based upon our main [schema](https://authjs.dev/reference/core/adapters#models)
- *
- * ![DynamoDB Table](https://i.imgur.com/hGZtWDq.png)
- *
- * You can create this table with infrastructure as code using [`aws-cdk`](https://github.com/aws/aws-cdk) with the following table definition:
- *
- * ```javascript title=stack.ts
- * new dynamodb.Table(this, `NextAuthTable`, {
- *   tableName: "next-auth",
- *   partitionKey: { name: "pk", type: dynamodb.AttributeType.STRING },
- *   sortKey: { name: "sk", type: dynamodb.AttributeType.STRING },
- *   timeToLiveAttribute: "expires",
- * }).addGlobalSecondaryIndex({
- *   indexName: "GSI1",
- *   partitionKey: { name: "GSI1PK", type: dynamodb.AttributeType.STRING },
- *   sortKey: { name: "GSI1SK", type: dynamodb.AttributeType.STRING },
- * })
- * ```
- *
- * Alternatively, you can use this cloudformation template:
- *
- * ```yaml title=cloudformation.yaml
- * NextAuthTable:
- *   Type: "AWS::DynamoDB::Table"
- *   Properties:
- *     TableName: next-auth
- *     AttributeDefinitions:
- *       - AttributeName: pk
- *         AttributeType: S
- *       - AttributeName: sk
- *         AttributeType: S
- *       - AttributeName: GSI1PK
- *         AttributeType: S
- *       - AttributeName: GSI1SK
- *         AttributeType: S
- *     KeySchema:
- *       - AttributeName: pk
- *         KeyType: HASH
- *       - AttributeName: sk
- *         KeyType: RANGE
- *     GlobalSecondaryIndexes:
- *       - IndexName: GSI1
- *         Projection:
- *           ProjectionType: ALL
- *         KeySchema:
- *           - AttributeName: GSI1PK
- *             KeyType: HASH
- *           - AttributeName: GSI1SK
- *             KeyType: RANGE
- *     TimeToLiveSpecification:
- *       AttributeName: expires
- *       Enabled: true
- * ```
- *
- * ### Using a custom schema
- *
- * You can configure your custom table schema by passing the `options` key to the adapter constructor:
- *
- * ```javascript
- * const adapter = DynamoDBAdapter(client, {
- *   tableName: "custom-table-name",
- *   partitionKey: "custom-pk",
- *   sortKey: "custom-sk",
- *   indexName: "custom-index-name",
- *   indexPartitionKey: "custom-index-pk",
- *   indexSortKey: "custom-index-sk",
- * })
- * ```
- **/
 export declare function DynamoDBAdapter(client: DynamoDBDocument, options?: DynamoDBAdapterOptions): Adapter;
 declare const format: {
-    /** Takes a plain old JavaScript object and turns it into a Dynamodb object */
+    /** Takes a plain old JavaScript object and turns it into a DynamoDB object */
     to(object: Record<string, any>): Record<string, unknown>;
     /** Takes a Dynamo object and returns a plain old JavaScript object */
     from<T = Record<string, unknown>>(object?: Record<string, any>): T | null;

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAEV,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EACV,OAAO,EAKR,MAAM,qBAAqB,CAAA;AAE5B,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAgLI;AACJ,wBAAgB,eAAe,CAC7B,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CA+ST;AASD,QAAA,MAAM,MAAM;IACV,8EAA8E;eACnE,OAAO,MAAM,EAAE,GAAG,CAAC;IAY9B,sEAAsE;+CAC3B,OAAO,MAAM,EAAE,GAAG,CAAC;CAsB/D,CAAA;AAED,iBAAS,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC9D,gBAAgB,EAAE,MAAM,CAAA;IACxB,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChD,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnD,CAgBA;AAED,OAAO,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAEV,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EACV,OAAO,EAKR,MAAM,qBAAqB,CAAA;AAE5B,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,wBAAgB,eAAe,CAC7B,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CA+ST;AASD,QAAA,MAAM,MAAM;IACV,8EAA8E;eACnE,OAAO,MAAM,EAAE,GAAG,CAAC;IAY9B,sEAAsE;+CAC3B,OAAO,MAAM,EAAE,GAAG,CAAC;CAsB/D,CAAA;AAED,iBAAS,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC9D,gBAAgB,EAAE,MAAM,CAAA;IACxB,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChD,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnD,CAgBA;AAED,OAAO,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAA"}

package/index.js

@@ -1,6 +1,6 @@
 /**
- * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: 16}}>
- *  <p style={{fontWeight: "normal"}}>Official <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html">DynamoDB</a> adapter for Auth.js / NextAuth.js.</p>
+ * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: "16px"}}>
+ *  <p>Official <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html">DynamoDB</a> adapter for Auth.js / NextAuth.js.</p>
  *  <a href="https://docs.aws.amazon.com/dynamodb/index.html">
  *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/dynamodb.png" width="48"/>
  *  </a>
@@ -14,183 +14,6 @@
  *
  * @module @auth/dynamodb-adapter
  */
-/**
- * ## Setup
- *
- * By default, the adapter expects a table with a partition key `pk` and a sort key `sk`, as well as a global secondary index named `GSI1` with `GSI1PK` as partition key and `GSI1SK` as sorting key. To automatically delete sessions and verification requests after they expire using [dynamodb TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) you should [enable the TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-how-to.html) with attribute name 'expires'. You can set whatever you want as the table name and the billing method.
- * You can find the full schema in the table structure section below.
- *
- * ### Configuring Auth.js
- *
- * You need to pass `DynamoDBDocument` client from the modular [`aws-sdk`](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/dynamodb-example-dynamodb-utilities.html) v3 to the adapter.
- * The default table name is `next-auth`, but you can customise that by passing `{ tableName: 'your-table-name' }` as the second parameter in the adapter.
- *
- * ```javascript title="pages/api/auth/[...nextauth].js"
- * import { DynamoDB, DynamoDBClientConfig } from "@aws-sdk/client-dynamodb"
- * import { DynamoDBDocument } from "@aws-sdk/lib-dynamodb"
- * import NextAuth from "next-auth";
- * import Providers from "next-auth/providers";
- * import { DynamoDBAdapter } from "@auth/dynamodb-adapter"
- *
- * const config: DynamoDBClientConfig = {
- *   credentials: {
- *     accessKeyId: process.env.NEXT_AUTH_AWS_ACCESS_KEY,
- *     secretAccessKey: process.env.NEXT_AUTH_AWS_SECRET_KEY,
- *   },
- *   region: process.env.NEXT_AUTH_AWS_REGION,
- * };
- *
- * const client = DynamoDBDocument.from(new DynamoDB(config), {
- *   marshallOptions: {
- *     convertEmptyValues: true,
- *     removeUndefinedValues: true,
- *     convertClassInstanceToMap: true,
- *   },
- * })
- *
- * export default NextAuth({
- *   // Configure one or more authentication providers
- *   providers: [
- *     Providers.GitHub({
- *       clientId: process.env.GITHUB_ID,
- *       clientSecret: process.env.GITHUB_SECRET,
- *     }),
- *     Providers.Email({
- *       server: process.env.EMAIL_SERVER,
- *       from: process.env.EMAIL_FROM,
- *     }),
- *     // ...add more providers here
- *   ],
- *   adapter: DynamoDBAdapter(
- *     client
- *   ),
- *   ...
- * });
- * ```
- *
- * (AWS secrets start with `NEXT_AUTH_` in order to not conflict with [Vercel's reserved environment variables](https://vercel.com/docs/environment-variables#reserved-environment-variables).)
- *
- * ## AWS Credentials
- *
- * :::note
- *   Always follow the **principle of least privilege** when giving access to AWS
- *   services/resources -> identities should only be permitted to perform the
- *   smallest set of actions necessary to fulfill a specific task.
- * :::
- *
- * 1. Open the [AWS console](https://console.aws.amazon.com/) and go to "IAM", then "Users".
- * 2. Create a new user. The purpose of this user is to give programmatic access to DynamoDB.
- * 3. Create an Access Key and then copy Key ID and Secret to your `.env`/`.env.local` file.
- * 4. Select "Add Permission" and "Create Inline Policy".
- * 5. Copy the JSON below into the JSON input and replace `region`, `account_id` and `table_name` with your values.
- *
- * ```json
- * {
- *   "Version": "2012-10-17",
- *   "Statement": [
- *     {
- *       "Sid": "DynamoDBAccess",
- *       "Effect": "Allow",
- *       "Action": [
- *         "dynamodb:BatchGetItem",
- *         "dynamodb:BatchWriteItem",
- *         "dynamodb:Describe*",
- *         "dynamodb:List*",
- *         "dynamodb:PutItem",
- *         "dynamodb:DeleteItem",
- *         "dynamodb:GetItem",
- *         "dynamodb:Scan",
- *         "dynamodb:Query",
- *         "dynamodb:UpdateItem"
- *       ],
- *       "Resource": [
- *         "arn:aws:dynamodb:{region}:{account_id}:table/{table_name}",
- *         "arn:aws:dynamodb:{region}:{account_id}:table/{table_name}/index/GSI1"
- *       ]
- *     }
- *   ]
- * }
- * ```
- *
- * ## Advanced usage
- *
- * ### Default schema
- *
- * The table respects the single table design pattern. This has many advantages:
- *
- * - Only one table to manage, monitor and provision.
- * - Querying relations is faster than with multi-table schemas (for eg. retrieving all sessions for a user).
- * - Only one table needs to be replicated if you want to go multi-region.
- *
- * > This schema is adapted for use in DynamoDB and based upon our main [schema](https://authjs.dev/reference/core/adapters#models)
- *
- * ![DynamoDB Table](https://i.imgur.com/hGZtWDq.png)
- *
- * You can create this table with infrastructure as code using [`aws-cdk`](https://github.com/aws/aws-cdk) with the following table definition:
- *
- * ```javascript title=stack.ts
- * new dynamodb.Table(this, `NextAuthTable`, {
- *   tableName: "next-auth",
- *   partitionKey: { name: "pk", type: dynamodb.AttributeType.STRING },
- *   sortKey: { name: "sk", type: dynamodb.AttributeType.STRING },
- *   timeToLiveAttribute: "expires",
- * }).addGlobalSecondaryIndex({
- *   indexName: "GSI1",
- *   partitionKey: { name: "GSI1PK", type: dynamodb.AttributeType.STRING },
- *   sortKey: { name: "GSI1SK", type: dynamodb.AttributeType.STRING },
- * })
- * ```
- *
- * Alternatively, you can use this cloudformation template:
- *
- * ```yaml title=cloudformation.yaml
- * NextAuthTable:
- *   Type: "AWS::DynamoDB::Table"
- *   Properties:
- *     TableName: next-auth
- *     AttributeDefinitions:
- *       - AttributeName: pk
- *         AttributeType: S
- *       - AttributeName: sk
- *         AttributeType: S
- *       - AttributeName: GSI1PK
- *         AttributeType: S
- *       - AttributeName: GSI1SK
- *         AttributeType: S
- *     KeySchema:
- *       - AttributeName: pk
- *         KeyType: HASH
- *       - AttributeName: sk
- *         KeyType: RANGE
- *     GlobalSecondaryIndexes:
- *       - IndexName: GSI1
- *         Projection:
- *           ProjectionType: ALL
- *         KeySchema:
- *           - AttributeName: GSI1PK
- *             KeyType: HASH
- *           - AttributeName: GSI1SK
- *             KeyType: RANGE
- *     TimeToLiveSpecification:
- *       AttributeName: expires
- *       Enabled: true
- * ```
- *
- * ### Using a custom schema
- *
- * You can configure your custom table schema by passing the `options` key to the adapter constructor:
- *
- * ```javascript
- * const adapter = DynamoDBAdapter(client, {
- *   tableName: "custom-table-name",
- *   partitionKey: "custom-pk",
- *   sortKey: "custom-sk",
- *   indexName: "custom-index-name",
- *   indexPartitionKey: "custom-index-pk",
- *   indexSortKey: "custom-index-sk",
- * })
- * ```
- **/
 export function DynamoDBAdapter(client, options) {
     const TableName = options?.tableName ?? "next-auth";
     const pk = options?.partitionKey ?? "pk";
@@ -492,7 +315,7 @@ function isDate(value) {
     return value && isoDateRE.test(value) && !isNaN(Date.parse(value));
 }
 const format = {
-    /** Takes a plain old JavaScript object and turns it into a Dynamodb object */
+    /** Takes a plain old JavaScript object and turns it into a DynamoDB object */
     to(object) {
         const newObject = {};
         for (const key in object) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@auth/dynamodb-adapter",
   "repository": "https://github.com/nextauthjs/next-auth",
-  "version": "1.6.0",
+  "version": "2.1.0",
   "description": "AWS DynamoDB adapter for next-auth.",
   "keywords": [
     "next-auth",
@@ -44,7 +44,7 @@
     "@aws-sdk/lib-dynamodb": "^3.36.1"
   },
   "dependencies": {
-    "@auth/core": "0.29.0"
+    "@auth/core": "0.31.0"
   },
   "scripts": {
     "test:default": "vitest -c ../utils/vitest.config.ts",

package/src/index.ts

@@ -1,6 +1,6 @@
 /**
- * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: 16}}>
- *  <p style={{fontWeight: "normal"}}>Official <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html">DynamoDB</a> adapter for Auth.js / NextAuth.js.</p>
+ * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: "16px"}}>
+ *  <p>Official <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html">DynamoDB</a> adapter for Auth.js / NextAuth.js.</p>
  *  <a href="https://docs.aws.amazon.com/dynamodb/index.html">
  *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/dynamodb.png" width="48"/>
  *  </a>
@@ -36,183 +36,6 @@ export interface DynamoDBAdapterOptions {
   indexSortKey?: string
 }
 
-/**
- * ## Setup
- *
- * By default, the adapter expects a table with a partition key `pk` and a sort key `sk`, as well as a global secondary index named `GSI1` with `GSI1PK` as partition key and `GSI1SK` as sorting key. To automatically delete sessions and verification requests after they expire using [dynamodb TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) you should [enable the TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-how-to.html) with attribute name 'expires'. You can set whatever you want as the table name and the billing method.
- * You can find the full schema in the table structure section below.
- *
- * ### Configuring Auth.js
- *
- * You need to pass `DynamoDBDocument` client from the modular [`aws-sdk`](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/dynamodb-example-dynamodb-utilities.html) v3 to the adapter.
- * The default table name is `next-auth`, but you can customise that by passing `{ tableName: 'your-table-name' }` as the second parameter in the adapter.
- *
- * ```javascript title="pages/api/auth/[...nextauth].js"
- * import { DynamoDB, DynamoDBClientConfig } from "@aws-sdk/client-dynamodb"
- * import { DynamoDBDocument } from "@aws-sdk/lib-dynamodb"
- * import NextAuth from "next-auth";
- * import Providers from "next-auth/providers";
- * import { DynamoDBAdapter } from "@auth/dynamodb-adapter"
- *
- * const config: DynamoDBClientConfig = {
- *   credentials: {
- *     accessKeyId: process.env.NEXT_AUTH_AWS_ACCESS_KEY,
- *     secretAccessKey: process.env.NEXT_AUTH_AWS_SECRET_KEY,
- *   },
- *   region: process.env.NEXT_AUTH_AWS_REGION,
- * };
- *
- * const client = DynamoDBDocument.from(new DynamoDB(config), {
- *   marshallOptions: {
- *     convertEmptyValues: true,
- *     removeUndefinedValues: true,
- *     convertClassInstanceToMap: true,
- *   },
- * })
- *
- * export default NextAuth({
- *   // Configure one or more authentication providers
- *   providers: [
- *     Providers.GitHub({
- *       clientId: process.env.GITHUB_ID,
- *       clientSecret: process.env.GITHUB_SECRET,
- *     }),
- *     Providers.Email({
- *       server: process.env.EMAIL_SERVER,
- *       from: process.env.EMAIL_FROM,
- *     }),
- *     // ...add more providers here
- *   ],
- *   adapter: DynamoDBAdapter(
- *     client
- *   ),
- *   ...
- * });
- * ```
- *
- * (AWS secrets start with `NEXT_AUTH_` in order to not conflict with [Vercel's reserved environment variables](https://vercel.com/docs/environment-variables#reserved-environment-variables).)
- *
- * ## AWS Credentials
- *
- * :::note
- *   Always follow the **principle of least privilege** when giving access to AWS
- *   services/resources -> identities should only be permitted to perform the
- *   smallest set of actions necessary to fulfill a specific task.
- * :::
- *
- * 1. Open the [AWS console](https://console.aws.amazon.com/) and go to "IAM", then "Users".
- * 2. Create a new user. The purpose of this user is to give programmatic access to DynamoDB.
- * 3. Create an Access Key and then copy Key ID and Secret to your `.env`/`.env.local` file.
- * 4. Select "Add Permission" and "Create Inline Policy".
- * 5. Copy the JSON below into the JSON input and replace `region`, `account_id` and `table_name` with your values.
- *
- * ```json
- * {
- *   "Version": "2012-10-17",
- *   "Statement": [
- *     {
- *       "Sid": "DynamoDBAccess",
- *       "Effect": "Allow",
- *       "Action": [
- *         "dynamodb:BatchGetItem",
- *         "dynamodb:BatchWriteItem",
- *         "dynamodb:Describe*",
- *         "dynamodb:List*",
- *         "dynamodb:PutItem",
- *         "dynamodb:DeleteItem",
- *         "dynamodb:GetItem",
- *         "dynamodb:Scan",
- *         "dynamodb:Query",
- *         "dynamodb:UpdateItem"
- *       ],
- *       "Resource": [
- *         "arn:aws:dynamodb:{region}:{account_id}:table/{table_name}",
- *         "arn:aws:dynamodb:{region}:{account_id}:table/{table_name}/index/GSI1"
- *       ]
- *     }
- *   ]
- * }
- * ```
- *
- * ## Advanced usage
- *
- * ### Default schema
- *
- * The table respects the single table design pattern. This has many advantages:
- *
- * - Only one table to manage, monitor and provision.
- * - Querying relations is faster than with multi-table schemas (for eg. retrieving all sessions for a user).
- * - Only one table needs to be replicated if you want to go multi-region.
- *
- * > This schema is adapted for use in DynamoDB and based upon our main [schema](https://authjs.dev/reference/core/adapters#models)
- *
- * ![DynamoDB Table](https://i.imgur.com/hGZtWDq.png)
- *
- * You can create this table with infrastructure as code using [`aws-cdk`](https://github.com/aws/aws-cdk) with the following table definition:
- *
- * ```javascript title=stack.ts
- * new dynamodb.Table(this, `NextAuthTable`, {
- *   tableName: "next-auth",
- *   partitionKey: { name: "pk", type: dynamodb.AttributeType.STRING },
- *   sortKey: { name: "sk", type: dynamodb.AttributeType.STRING },
- *   timeToLiveAttribute: "expires",
- * }).addGlobalSecondaryIndex({
- *   indexName: "GSI1",
- *   partitionKey: { name: "GSI1PK", type: dynamodb.AttributeType.STRING },
- *   sortKey: { name: "GSI1SK", type: dynamodb.AttributeType.STRING },
- * })
- * ```
- *
- * Alternatively, you can use this cloudformation template:
- *
- * ```yaml title=cloudformation.yaml
- * NextAuthTable:
- *   Type: "AWS::DynamoDB::Table"
- *   Properties:
- *     TableName: next-auth
- *     AttributeDefinitions:
- *       - AttributeName: pk
- *         AttributeType: S
- *       - AttributeName: sk
- *         AttributeType: S
- *       - AttributeName: GSI1PK
- *         AttributeType: S
- *       - AttributeName: GSI1SK
- *         AttributeType: S
- *     KeySchema:
- *       - AttributeName: pk
- *         KeyType: HASH
- *       - AttributeName: sk
- *         KeyType: RANGE
- *     GlobalSecondaryIndexes:
- *       - IndexName: GSI1
- *         Projection:
- *           ProjectionType: ALL
- *         KeySchema:
- *           - AttributeName: GSI1PK
- *             KeyType: HASH
- *           - AttributeName: GSI1SK
- *             KeyType: RANGE
- *     TimeToLiveSpecification:
- *       AttributeName: expires
- *       Enabled: true
- * ```
- *
- * ### Using a custom schema
- *
- * You can configure your custom table schema by passing the `options` key to the adapter constructor:
- *
- * ```javascript
- * const adapter = DynamoDBAdapter(client, {
- *   tableName: "custom-table-name",
- *   partitionKey: "custom-pk",
- *   sortKey: "custom-sk",
- *   indexName: "custom-index-name",
- *   indexPartitionKey: "custom-index-pk",
- *   indexSortKey: "custom-index-sk",
- * })
- * ```
- **/
 export function DynamoDBAdapter(
   client: DynamoDBDocument,
   options?: DynamoDBAdapterOptions
@@ -529,7 +352,7 @@ function isDate(value: any) {
 }
 
 const format = {
-  /** Takes a plain old JavaScript object and turns it into a Dynamodb object */
+  /** Takes a plain old JavaScript object and turns it into a DynamoDB object */
   to(object: Record<string, any>) {
     const newObject: Record<string, unknown> = {}
     for (const key in object) {