@keyv/dynamo 1.0.1 → 1.2.0

package/README.md

@@ -35,6 +35,32 @@ e.g:
 const keyv = new KeyvDynamo({ tableName: 'cacheTable' });
 ```
 
+### Using the `createKeyv` helper function
+
+The `createKeyv` function is a convenience method that creates a new Keyv instance with the DynamoDB adapter. It automatically sets `useKeyPrefix` to `false` to allow the adapter to handle key prefixing:
+
+```js
+import { createKeyv } from '@keyv/dynamo';
+
+const keyv = createKeyv({
+  endpoint: 'http://localhost:8000',
+  tableName: 'cacheTable',
+  namespace: 'my-app'
+});
+```
+
+### Accessing the DynamoDB Client
+
+The DynamoDB client is exposed as a property for advanced use cases:
+
+```js
+const store = new KeyvDynamo();
+const dynamoClient = store.client; // DynamoDBDocument instance
+
+// You can use the client directly for custom operations
+await dynamoClient.get({ TableName: 'keyv', Key: { id: 'myKey' } });
+```
+
 ## Usage with NestJS
 
 Since DynamoDB has a 400KB limit per item, compressing data can help in some cases.

package/dist/index.cjs

@@ -30,14 +30,18 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  Keyv: () => import_keyv2.Keyv,
   KeyvDynamo: () => KeyvDynamo,
+  createKeyv: () => createKeyv,
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
-var import_events = __toESM(require("events"), 1);
+var import_node_events = __toESM(require("events"), 1);
 var import_client_dynamodb = require("@aws-sdk/client-dynamodb");
 var import_lib_dynamodb = require("@aws-sdk/lib-dynamodb");
-var KeyvDynamo = class extends import_events.default {
+var import_keyv = require("keyv");
+var import_keyv2 = require("keyv");
+var KeyvDynamo = class extends import_node_events.default {
   ttlSupport = true;
   sixHoursInMilliseconds = 6 * 60 * 60 * 1e3;
   namespace;
@@ -56,13 +60,17 @@ var KeyvDynamo = class extends import_events.default {
       ...options
     };
     this.client = import_lib_dynamodb.DynamoDBDocument.from(new import_client_dynamodb.DynamoDB(this.opts));
-    this.tableReady = this.ensureTable(this.opts.tableName).catch((error) => {
-      this.emit("error", error);
-    });
+    this.tableReady = this.ensureTable(this.opts.tableName).catch(
+      (error) => {
+        this.emit("error", error);
+      }
+    );
   }
   async set(key, value, ttl) {
     await this.tableReady;
-    const sixHoursFromNowEpoch = Math.floor((Date.now() + this.sixHoursInMilliseconds) / 1e3);
+    const sixHoursFromNowEpoch = Math.floor(
+      (Date.now() + this.sixHoursInMilliseconds) / 1e3
+    );
     const expiresAt = typeof ttl === "number" ? Math.floor((Date.now() + (ttl + 1e3)) / 1e3) : sixHoursFromNowEpoch;
     const putInput = {
       TableName: this.opts.tableName,
@@ -109,7 +117,9 @@ var KeyvDynamo = class extends import_events.default {
       }
     };
     const { Responses: { [this.opts.tableName]: items = [] } = {} } = await this.client.batchGet(batchGetInput);
-    return keys.map((key) => items.find((item) => item?.id === key)?.value);
+    return keys.map(
+      (key) => items.find((item) => item?.id === key)?.value
+    );
   }
   async deleteMany(keys) {
     await this.tableReady;
@@ -148,7 +158,9 @@ var KeyvDynamo = class extends import_events.default {
   }
   async ensureTable(tableName) {
     try {
-      await this.client.send(new import_client_dynamodb.DescribeTableCommand({ TableName: tableName }));
+      await this.client.send(
+        new import_client_dynamodb.DescribeTableCommand({ TableName: tableName })
+      );
     } catch (error) {
       if (error instanceof import_client_dynamodb.ResourceNotFoundException) {
         await this.createTable(tableName);
@@ -159,23 +171,27 @@ var KeyvDynamo = class extends import_events.default {
   }
   async createTable(tableName) {
     try {
-      await this.client.send(new import_client_dynamodb.CreateTableCommand({
-        TableName: tableName,
-        KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
-        AttributeDefinitions: [{ AttributeName: "id", AttributeType: "S" }],
-        BillingMode: "PAY_PER_REQUEST"
-      }));
+      await this.client.send(
+        new import_client_dynamodb.CreateTableCommand({
+          TableName: tableName,
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+          AttributeDefinitions: [{ AttributeName: "id", AttributeType: "S" }],
+          BillingMode: "PAY_PER_REQUEST"
+        })
+      );
       await (0, import_client_dynamodb.waitUntilTableExists)(
         { client: this.client, maxWaitTime: 60 },
         { TableName: tableName }
       );
-      await this.client.send(new import_client_dynamodb.UpdateTimeToLiveCommand({
-        TableName: tableName,
-        TimeToLiveSpecification: {
-          AttributeName: "expiresAt",
-          Enabled: true
-        }
-      }));
+      await this.client.send(
+        new import_client_dynamodb.UpdateTimeToLiveCommand({
+          TableName: tableName,
+          TimeToLiveSpecification: {
+            AttributeName: "expiresAt",
+            Enabled: true
+          }
+        })
+      );
     } catch (error) {
       if (error instanceof import_client_dynamodb.ResourceInUseException) {
         await (0, import_client_dynamodb.waitUntilTableExists)(
@@ -189,7 +205,23 @@ var KeyvDynamo = class extends import_events.default {
   }
 };
 var index_default = KeyvDynamo;
+function createKeyv(options) {
+  const adapter = new KeyvDynamo(options ?? {});
+  if (typeof options === "object" && options?.namespace) {
+    adapter.namespace = options.namespace;
+    const keyv2 = new import_keyv.Keyv(adapter, {
+      namespace: options.namespace,
+      useKeyPrefix: false
+    });
+    return keyv2;
+  }
+  const keyv = new import_keyv.Keyv(adapter, { useKeyPrefix: false });
+  keyv.namespace = void 0;
+  return keyv;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  KeyvDynamo
+  Keyv,
+  KeyvDynamo,
+  createKeyv
 });

package/dist/index.d.cts

@@ -1,15 +1,17 @@
-import EventEmitter from 'events';
+import EventEmitter from 'node:events';
 import { DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
-import { KeyvStoreAdapter, StoredData } from 'keyv';
+import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
+import { KeyvStoreAdapter, StoredData, Keyv } from 'keyv';
+export { Keyv } from 'keyv';
 
 declare class KeyvDynamo extends EventEmitter implements KeyvStoreAdapter {
     ttlSupport: boolean;
     sixHoursInMilliseconds: number;
     namespace?: string;
-    opts: Omit<KeyvDynamoOptions, 'tableName'> & {
+    opts: Omit<KeyvDynamoOptions, "tableName"> & {
         tableName: string;
     };
-    private readonly client;
+    readonly client: DynamoDBDocument;
     private readonly tableReady;
     constructor(options: KeyvDynamoOptions | string);
     set(key: string, value: unknown, ttl?: number): Promise<void>;
@@ -28,5 +30,11 @@ type KeyvDynamoOptions = {
     dialect?: string;
     tableName?: string;
 } & DynamoDBClientConfig;
+/**
+ * Will create a Keyv instance with the DynamoDB adapter. This will also set the namespace and useKeyPrefix to false.
+ * @param options - Options for the adapter including DynamoDB client configuration and table settings.
+ * @returns {Keyv} - Keyv instance with the DynamoDB adapter
+ */
+declare function createKeyv(options?: KeyvDynamoOptions | string): Keyv;
 
-export { KeyvDynamo, type KeyvDynamoOptions, KeyvDynamo as default };
+export { KeyvDynamo, type KeyvDynamoOptions, createKeyv, KeyvDynamo as default };

package/dist/index.d.ts

@@ -1,15 +1,17 @@
-import EventEmitter from 'events';
+import EventEmitter from 'node:events';
 import { DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
-import { KeyvStoreAdapter, StoredData } from 'keyv';
+import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
+import { KeyvStoreAdapter, StoredData, Keyv } from 'keyv';
+export { Keyv } from 'keyv';
 
 declare class KeyvDynamo extends EventEmitter implements KeyvStoreAdapter {
     ttlSupport: boolean;
     sixHoursInMilliseconds: number;
     namespace?: string;
-    opts: Omit<KeyvDynamoOptions, 'tableName'> & {
+    opts: Omit<KeyvDynamoOptions, "tableName"> & {
         tableName: string;
     };
-    private readonly client;
+    readonly client: DynamoDBDocument;
     private readonly tableReady;
     constructor(options: KeyvDynamoOptions | string);
     set(key: string, value: unknown, ttl?: number): Promise<void>;
@@ -28,5 +30,11 @@ type KeyvDynamoOptions = {
     dialect?: string;
     tableName?: string;
 } & DynamoDBClientConfig;
+/**
+ * Will create a Keyv instance with the DynamoDB adapter. This will also set the namespace and useKeyPrefix to false.
+ * @param options - Options for the adapter including DynamoDB client configuration and table settings.
+ * @returns {Keyv} - Keyv instance with the DynamoDB adapter
+ */
+declare function createKeyv(options?: KeyvDynamoOptions | string): Keyv;
 
-export { KeyvDynamo, type KeyvDynamoOptions, KeyvDynamo as default };
+export { KeyvDynamo, type KeyvDynamoOptions, createKeyv, KeyvDynamo as default };

package/dist/index.js

@@ -4,14 +4,16 @@ import {
   CreateTableCommand,
   DescribeTableCommand,
   DynamoDB,
-  ResourceNotFoundException,
   ResourceInUseException,
+  ResourceNotFoundException,
   UpdateTimeToLiveCommand,
   waitUntilTableExists
 } from "@aws-sdk/client-dynamodb";
 import {
   DynamoDBDocument
 } from "@aws-sdk/lib-dynamodb";
+import { Keyv } from "keyv";
+import { Keyv as Keyv2 } from "keyv";
 var KeyvDynamo = class extends EventEmitter {
   ttlSupport = true;
   sixHoursInMilliseconds = 6 * 60 * 60 * 1e3;
@@ -31,13 +33,17 @@ var KeyvDynamo = class extends EventEmitter {
       ...options
     };
     this.client = DynamoDBDocument.from(new DynamoDB(this.opts));
-    this.tableReady = this.ensureTable(this.opts.tableName).catch((error) => {
-      this.emit("error", error);
-    });
+    this.tableReady = this.ensureTable(this.opts.tableName).catch(
+      (error) => {
+        this.emit("error", error);
+      }
+    );
   }
   async set(key, value, ttl) {
     await this.tableReady;
-    const sixHoursFromNowEpoch = Math.floor((Date.now() + this.sixHoursInMilliseconds) / 1e3);
+    const sixHoursFromNowEpoch = Math.floor(
+      (Date.now() + this.sixHoursInMilliseconds) / 1e3
+    );
     const expiresAt = typeof ttl === "number" ? Math.floor((Date.now() + (ttl + 1e3)) / 1e3) : sixHoursFromNowEpoch;
     const putInput = {
       TableName: this.opts.tableName,
@@ -84,7 +90,9 @@ var KeyvDynamo = class extends EventEmitter {
       }
     };
     const { Responses: { [this.opts.tableName]: items = [] } = {} } = await this.client.batchGet(batchGetInput);
-    return keys.map((key) => items.find((item) => item?.id === key)?.value);
+    return keys.map(
+      (key) => items.find((item) => item?.id === key)?.value
+    );
   }
   async deleteMany(keys) {
     await this.tableReady;
@@ -123,7 +131,9 @@ var KeyvDynamo = class extends EventEmitter {
   }
   async ensureTable(tableName) {
     try {
-      await this.client.send(new DescribeTableCommand({ TableName: tableName }));
+      await this.client.send(
+        new DescribeTableCommand({ TableName: tableName })
+      );
     } catch (error) {
       if (error instanceof ResourceNotFoundException) {
         await this.createTable(tableName);
@@ -134,23 +144,27 @@ var KeyvDynamo = class extends EventEmitter {
   }
   async createTable(tableName) {
     try {
-      await this.client.send(new CreateTableCommand({
-        TableName: tableName,
-        KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
-        AttributeDefinitions: [{ AttributeName: "id", AttributeType: "S" }],
-        BillingMode: "PAY_PER_REQUEST"
-      }));
+      await this.client.send(
+        new CreateTableCommand({
+          TableName: tableName,
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+          AttributeDefinitions: [{ AttributeName: "id", AttributeType: "S" }],
+          BillingMode: "PAY_PER_REQUEST"
+        })
+      );
       await waitUntilTableExists(
         { client: this.client, maxWaitTime: 60 },
         { TableName: tableName }
       );
-      await this.client.send(new UpdateTimeToLiveCommand({
-        TableName: tableName,
-        TimeToLiveSpecification: {
-          AttributeName: "expiresAt",
-          Enabled: true
-        }
-      }));
+      await this.client.send(
+        new UpdateTimeToLiveCommand({
+          TableName: tableName,
+          TimeToLiveSpecification: {
+            AttributeName: "expiresAt",
+            Enabled: true
+          }
+        })
+      );
     } catch (error) {
       if (error instanceof ResourceInUseException) {
         await waitUntilTableExists(
@@ -164,7 +178,23 @@ var KeyvDynamo = class extends EventEmitter {
   }
 };
 var index_default = KeyvDynamo;
+function createKeyv(options) {
+  const adapter = new KeyvDynamo(options ?? {});
+  if (typeof options === "object" && options?.namespace) {
+    adapter.namespace = options.namespace;
+    const keyv2 = new Keyv(adapter, {
+      namespace: options.namespace,
+      useKeyPrefix: false
+    });
+    return keyv2;
+  }
+  const keyv = new Keyv(adapter, { useKeyPrefix: false });
+  keyv.namespace = void 0;
+  return keyv;
+}
 export {
+  Keyv2 as Keyv,
   KeyvDynamo,
+  createKeyv,
   index_default as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/dynamo",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "DynamoDB storage adapter for Keyv",
   "type": "module",
   "main": "dist/index.cjs",
@@ -12,29 +12,6 @@
       "import": "./dist/index.js"
     }
   },
-  "xo": {
-    "space": true,
-    "rules": {
-      "import/no-named-as-default": "off",
-      "unicorn/prefer-module": "off",
-      "unicorn/prefer-event-target": "off",
-      "unicorn/no-array-reduce": "off",
-      "unicorn/prefer-object-from-entries": "off",
-      "unicorn/prefer-node-protocol": "off",
-      "@typescript-eslint/no-unsafe-assignment": "off",
-      "@typescript-eslint/no-unsafe-call": "off",
-      "@typescript-eslint/no-unsafe-return": "off",
-      "@typescript-eslint/no-unsafe-argument": "off",
-      "import/extensions": "off",
-      "@typescript-eslint/consistent-type-imports": "off",
-      "@typescript-eslint/naming-convention": "off",
-      "@typescript-eslint/no-floating-promises": "off",
-      "import/no-extraneous-dependencies": "off",
-      "@typescript-eslint/no-confusing-void-expression": "off",
-      "@typescript-eslint/no-empty-function": "off",
-      "promise/prefer-await-to-then": "off"
-    }
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jaredwray/keyv.git"
@@ -58,13 +35,16 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.859.0",
-    "@aws-sdk/lib-dynamodb": "^3.859.0"
+    "@aws-sdk/client-dynamodb": "^3.896.0",
+    "@aws-sdk/lib-dynamodb": "^3.896.0"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.2.4",
     "vitest": "^3.2.4",
-    "@keyv/test-suite": "^2.1.1",
-    "keyv": "^5.5.0"
+    "@keyv/test-suite": "^2.1.1"
+  },
+  "peerDependencies": {
+    "keyv": "^5.5.3"
   },
   "tsd": {
     "directory": "test"
@@ -75,8 +55,10 @@
   ],
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
-    "test": "xo --fix && vitest run --coverage",
-    "test:ci": "xo && vitest --run --sequence.setupFiles=list --coverage",
+    "lint": "biome check --write --error-on-warnings",
+    "lint:ci": "biome check --error-on-warnings",
+    "test": "pnpm lint && vitest run --coverage",
+    "test:ci": "pnpm lint:ci && vitest --run --sequence.setupFiles=list --coverage",
     "clean": "rimraf ./node_modules ./coverage ./dist"
   }
 }