@datar-platform/better-auth-dynamodb 0.1.0-alpha.0

package/dist/types.d.ts

@@ -0,0 +1,97 @@
+import type { DBAdapterDebugLogOption } from "@better-auth/core/db/adapter";
+import type { IndexMap } from "./index-map.js";
+/** A single record as stored/returned. Better Auth handles field-level typing. */
+export type StoreItem = Record<string, any>;
+/** One page of a paginated query. `cursor` is opaque and store-defined. */
+export interface QueryPage {
+    items: StoreItem[];
+    cursor?: unknown;
+}
+/**
+ * The storage seam. A `DynamoStore` knows how to persist and query records for
+ * a given model; it owns all physical key encoding. The generic adapter core
+ * drives it purely through logical index names + field values, so any store —
+ * the built-in single-table store or a custom one — plugs in the same way.
+ *
+ * Implementations should return the full item (including generated fields) from
+ * `put`/`update` so the adapter can hand it back to Better Auth.
+ */
+export interface DynamoStore {
+    /** Persist a new record and return it (with any store-generated fields). */
+    put(model: string, item: StoreItem): Promise<StoreItem>;
+    /** Fetch a single record by its primary `id`, or `null` if absent. */
+    getById(model: string, id: string): Promise<StoreItem | null>;
+    /** Patch the named fields on the record with the given `id` and return the new item. */
+    update(model: string, id: string, patch: StoreItem): Promise<StoreItem | null>;
+    /** Delete the record with the given `id`. No-op if it does not exist. */
+    deleteById(model: string, id: string): Promise<void>;
+    /**
+     * Query a logical index. `key` holds the partition-key field values plus any
+     * leading sort-key field values the caller resolved. Returns one page; the
+     * core drains pages via `cursor` until exhausted.
+     */
+    queryIndex(req: {
+        model: string;
+        index: string;
+        key: StoreItem;
+        limit?: number;
+        cursor?: unknown;
+    }): Promise<QueryPage>;
+    /**
+     * List every record of a model (the substitute for a full table scan when no
+     * index matches a query). Returns one page; the core drains via `cursor`.
+     */
+    listByType(req: {
+        model: string;
+        limit?: number;
+        cursor?: unknown;
+    }): Promise<QueryPage>;
+    /**
+     * Optional fast count. Only used by the core when the query has no residual
+     * (in-memory) predicates. Return `null` to signal "no fast path, fall back to
+     * draining + counting".
+     */
+    count?(req: {
+        model: string;
+        index?: string;
+        key?: StoreItem;
+    }): Promise<number | null>;
+    /**
+     * Optional schema generator, wired to the Better Auth CLI `generate` command.
+     * The built-in store emits a portable CloudFormation template; a custom store
+     * may emit whatever provisioning artifact fits its physical layout.
+     */
+    createSchema?(opts: {
+        file?: string;
+        tables: unknown;
+    }): Promise<{
+        code: string;
+        path: string;
+        overwrite?: boolean;
+    }>;
+}
+/**
+ * Public configuration for {@link dynamoAdapter}.
+ *
+ * Omit `store` to use the built-in single-table store (needs `tableName`).
+ * Omit `indexMap` to auto-derive access patterns from the Better Auth schema
+ * (`unique` fields -> lookup indexes, `references` fields -> by-parent indexes).
+ */
+export interface DynamoAdapterConfig {
+    /** Storage backend. Defaults to the built-in single-table store. */
+    store?: DynamoStore;
+    /** Access-pattern map. Defaults to schema-derived patterns. */
+    indexMap?: IndexMap;
+    /** DynamoDB table name (used only by the built-in store). */
+    tableName?: string;
+    /** AWS region (used only by the built-in store). */
+    region?: string;
+    /**
+     * Override the DynamoDB endpoint (used only by the built-in store). Point this
+     * at DynamoDB Local or LocalStack, e.g. `http://localhost:4566`.
+     */
+    endpoint?: string;
+    /** Better Auth debug logging, forwarded to the adapter factory. */
+    debugLogs?: DBAdapterDebugLogOption;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAE5E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C,kFAAkF;AAClF,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE5C,2EAA2E;AAC3E,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,4EAA4E;IAC5E,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAExD,sEAAsE;IACtE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAE9D,wFAAwF;IACxF,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,SAAS,GACf,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAE7B,yEAAyE;IACzE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,SAAS,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,GAAG,EAAE;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAEvB;;;;OAIG;IACH,KAAK,CAAC,CAAC,GAAG,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,SAAS,CAAC;KACjB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE3B;;;;OAIG;IACH,YAAY,CAAC,CAAC,IAAI,EAAE;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,OAAO,CAAC;KACjB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CAClE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,oEAAoE;IACpE,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mEAAmE;IACnE,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC"}

package/dist/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@datar-platform/better-auth-dynamodb",
+  "version": "0.1.0-alpha.0",
+  "private": false,
+  "description": "A generic DynamoDB adapter for Better Auth. Bring your own store or use the built-in single-table store.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "keywords": [
+    "better-auth",
+    "better-auth-adapter",
+    "dynamodb",
+    "aws",
+    "auth"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/joesome-Web-Services/datar-turbo.git",
+    "directory": "packages/better-auth-dynamodb"
+  },
+  "homepage": "https://datar.co.za",
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "^3.687.0",
+    "@aws-sdk/lib-dynamodb": "^3.687.0"
+  },
+  "peerDependencies": {
+    "better-auth": ">=1.5.0"
+  },
+  "devDependencies": {
+    "better-auth": "1.5.4",
+    "eslint": "^9.38.0",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3",
+    "vitest": "^2.1.8",
+    "@joesome-web-services/eslint-config-internal": "0.2.11",
+    "@joesome-web-services/prettier-config": "0.2.11",
+    "@joesome-web-services/vitest-config": "0.2.11",
+    "@joesome-web-services/tsconfig": "0.2.11"
+  },
+  "prettier": "@joesome-web-services/prettier-config",
+  "scripts": {
+    "build": "echo 'source (JIT) package — consumed via bundler transpilePackages, no build step. Run build:publish to emit dist for npm publish.'",
+    "build:publish": "tsc -p tsconfig.build.json",
+    "clean": "git clean -xdf .cache .turbo dist node_modules",
+    "format": "prettier --check . --ignore-path ../../.gitignore",
+    "lint": "eslint --flag unstable_native_nodejs_ts_config",
+    "typecheck": "tsgo --noEmit",
+    "test": "vitest run",
+    "test:e2e": "DYNAMO_E2E=1 vitest run test/localstack.test.ts",
+    "test:watch": "vitest"
+  }
+}