@auth/dynamodb-adapter 1.0.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022-2023, Balázs Orbán
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+<p align="center">
+  <br/>
+  <a href="https://authjs.dev" target="_blank">
+    <img height="64px" src="https://authjs.dev/img/logo/logo-sm.png" />
+  </a>
+  <a href="https://aws.amazon.com/dynamodb" target="_blank">
+    <img height="64px" src="https://authjs.dev/img/adapters/dynamodb.svg"/>
+  </a>
+  <h3 align="center"><b>DynamoDB Adapter</b> - NextAuth.js / Auth.js</a></h3>
+  <p align="center" style="align: center;">
+    <a href="https://npm.im/@auth/dynamodb-adapter">
+      <img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
+    </a>
+    <a href="https://npm.im/@auth/dynamodb-adapter">
+      <img alt="npm" src="https://img.shields.io/npm/v/@auth/dynamodb-adapter?color=green&label=@auth/dynamodb-adapter&style=flat-square">
+    </a>
+    <a href="https://www.npmtrends.com/@auth/dynamodb-adapter">
+      <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" />
+    </a>
+  </p>
+</p>
+
+---
+
+Check out the documentation at [authjs.dev](https://authjs.dev/reference/adapter/dynamodb).

package/index.d.ts

@@ -0,0 +1,175 @@
+/**
+ * <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>
+ *  <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>
+ * </div>
+ *
+ * ## Installation
+ *
+ * ```bash npm2yarn2pnpm
+ * npm install next-auth @auth/dynamodb-adapter
+ * ```
+ *
+ * @module @auth/dynamodb-adapter
+ */
+import type { DynamoDBDocument } from "@aws-sdk/lib-dynamodb";
+import type { Adapter } from "@auth/core/adapters";
+export interface DynamoDBAdapterOptions {
+    tableName?: string;
+    partitionKey?: string;
+    sortKey?: string;
+    indexName?: string;
+    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 as string,
+ *     secretAccessKey: process.env.NEXT_AUTH_AWS_SECRET_KEY as string,
+ *   },
+ *   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).)
+ *
+ * ## 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/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 */
+    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;
+};
+declare function generateUpdateExpression(object: Record<string, any>): {
+    UpdateExpression: string;
+    ExpressionAttributeNames: Record<string, string>;
+    ExpressionAttributeValues: Record<string, unknown>;
+};
+export { format, generateUpdateExpression };
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAsII;AACJ,wBAAgB,eAAe,CAC7B,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CA0ST;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"}