@authhero/aws-adapter 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 authhero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,126 @@
+# @authhero/aws-adapter
+
+AWS DynamoDB adapter for AuthHero. This adapter implements the AuthHero data adapters using Amazon DynamoDB as the storage backend.
+
+## Features
+
+- Single-table design for efficient DynamoDB usage
+- Works with AWS Lambda and Cloudflare Workers
+- Type-safe with full TypeScript support
+
+## Installation
+
+```bash
+npm install @authhero/aws-adapter
+# or
+pnpm add @authhero/aws-adapter
+```
+
+## Usage
+
+### With AWS Lambda
+
+```typescript
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
+import createAdapters from "@authhero/aws-adapter";
+
+const client = new DynamoDBClient({});
+const docClient = DynamoDBDocumentClient.from(client);
+
+const adapters = createAdapters(docClient, {
+  tableName: "authhero",
+});
+```
+
+### With Cloudflare Workers
+
+```typescript
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
+import createAdapters from "@authhero/aws-adapter";
+
+// In Cloudflare Workers, you need to provide credentials explicitly
+const client = new DynamoDBClient({
+  region: env.AWS_REGION,
+  credentials: {
+    accessKeyId: env.AWS_ACCESS_KEY_ID,
+    secretAccessKey: env.AWS_SECRET_ACCESS_KEY,
+  },
+});
+const docClient = DynamoDBDocumentClient.from(client);
+
+const adapters = createAdapters(docClient, {
+  tableName: "authhero",
+});
+```
+
+## Table Design
+
+This adapter uses a single-table design with the following key structure:
+
+| Entity     | PK                                  | SK                           |
+| ---------- | ----------------------------------- | ---------------------------- |
+| Tenant     | `TENANT#{tenant_id}`                | `TENANT`                     |
+| User       | `TENANT#{tenant_id}`                | `USER#{user_id}`             |
+| Session    | `TENANT#{tenant_id}`                | `SESSION#{session_id}`       |
+| Client     | `TENANT#{tenant_id}`                | `CLIENT#{client_id}`         |
+| Connection | `TENANT#{tenant_id}`                | `CONNECTION#{connection_id}` |
+| Code       | `TENANT#{tenant_id}`                | `CODE#{code_id}`             |
+| Password   | `TENANT#{tenant_id}#USER#{user_id}` | `PASSWORD#{password_id}`     |
+| ...        | ...                                 | ...                          |
+
+### Global Secondary Indexes
+
+- **GSI1**: For querying by email across users
+  - GSI1PK: `TENANT#{tenant_id}#EMAIL#{email}`
+  - GSI1SK: `USER`
+
+- **GSI2**: For querying custom domains
+  - GSI2PK: `DOMAIN#{domain}`
+  - GSI2SK: `CUSTOM_DOMAIN`
+
+## DynamoDB Table Setup
+
+Create a DynamoDB table with the following configuration:
+
+```json
+{
+  "TableName": "authhero",
+  "KeySchema": [
+    { "AttributeName": "PK", "KeyType": "HASH" },
+    { "AttributeName": "SK", "KeyType": "RANGE" }
+  ],
+  "AttributeDefinitions": [
+    { "AttributeName": "PK", "AttributeType": "S" },
+    { "AttributeName": "SK", "AttributeType": "S" },
+    { "AttributeName": "GSI1PK", "AttributeType": "S" },
+    { "AttributeName": "GSI1SK", "AttributeType": "S" },
+    { "AttributeName": "GSI2PK", "AttributeType": "S" },
+    { "AttributeName": "GSI2SK", "AttributeType": "S" }
+  ],
+  "GlobalSecondaryIndexes": [
+    {
+      "IndexName": "GSI1",
+      "KeySchema": [
+        { "AttributeName": "GSI1PK", "KeyType": "HASH" },
+        { "AttributeName": "GSI1SK", "KeyType": "RANGE" }
+      ],
+      "Projection": { "ProjectionType": "ALL" }
+    },
+    {
+      "IndexName": "GSI2",
+      "KeySchema": [
+        { "AttributeName": "GSI2PK", "KeyType": "HASH" },
+        { "AttributeName": "GSI2SK", "KeyType": "RANGE" }
+      ],
+      "Projection": { "ProjectionType": "ALL" }
+    }
+  ],
+  "BillingMode": "PAY_PER_REQUEST"
+}
+```
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@authhero/aws-adapter",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "tag": "latest"
+  },
+  "homepage": "https://authhero.net",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/markusahlstrand/authhero"
+  },
+  "version": "0.2.0",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/aws-adapter.cjs",
+  "module": "dist/aws-adapter.mjs",
+  "types": "dist/aws-adapter.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/aws-adapter.d.ts",
+      "require": "./dist/aws-adapter.cjs",
+      "import": "./dist/aws-adapter.mjs"
+    }
+  },
+  "devDependencies": {
+    "@hono/zod-openapi": "^0.19.10",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@types/node": "^24.10.0",
+    "dts-bundle-generator": "^9.5.1",
+    "dynalite": "^3.2.2",
+    "hono": "^4.10.4",
+    "typescript": "^5.9.3",
+    "vite": "^7.2.2",
+    "vitest": "^4.0.7"
+  },
+  "peerDependencies": {
+    "@hono/zod-openapi": "^0.19.10",
+    "hono": "^4.6.8"
+  },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "^3.700.0",
+    "@aws-sdk/lib-dynamodb": "^3.700.0",
+    "nanoid": "^5.1.6",
+    "@authhero/adapter-interfaces": "^0.108.0"
+  },
+  "scripts": {
+    "build": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}