@keyv/dynamo 1.1.0 → 1.2.1

package/README.md

@@ -35,6 +35,20 @@ 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:

package/dist/index.cjs

@@ -30,13 +30,17 @@ 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_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 import_keyv = require("keyv");
+var import_keyv2 = require("keyv");
 var KeyvDynamo = class extends import_node_events.default {
   ttlSupport = true;
   sixHoursInMilliseconds = 6 * 60 * 60 * 1e3;
@@ -201,7 +205,24 @@ var KeyvDynamo = class extends import_node_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
 });
+/* c8 ignore next -- @preserve */

package/dist/index.d.cts

@@ -1,7 +1,8 @@
 import EventEmitter from 'node:events';
 import { DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
-import { KeyvStoreAdapter, StoredData } from 'keyv';
+import { KeyvStoreAdapter, StoredData, Keyv } from 'keyv';
+export { Keyv } from 'keyv';
 
 declare class KeyvDynamo extends EventEmitter implements KeyvStoreAdapter {
     ttlSupport: boolean;
@@ -29,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,7 +1,8 @@
 import EventEmitter from 'node:events';
 import { DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
-import { KeyvStoreAdapter, StoredData } from 'keyv';
+import { KeyvStoreAdapter, StoredData, Keyv } from 'keyv';
+export { Keyv } from 'keyv';
 
 declare class KeyvDynamo extends EventEmitter implements KeyvStoreAdapter {
     ttlSupport: boolean;
@@ -29,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

@@ -12,6 +12,8 @@ import {
 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;
@@ -176,7 +178,24 @@ 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
 };
+/* c8 ignore next -- @preserve */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/dynamo",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "DynamoDB storage adapter for Keyv",
   "type": "module",
   "main": "dist/index.cjs",
@@ -35,14 +35,17 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.883.0",
-    "@aws-sdk/lib-dynamodb": "^3.883.0"
+    "@aws-sdk/client-dynamodb": "^3.917.0",
+    "@aws-sdk/lib-dynamodb": "^3.917.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.2.3",
-    "vitest": "^3.2.4",
-    "@keyv/test-suite": "^2.1.1",
-    "keyv": "^5.5.1"
+    "@biomejs/biome": "^2.3.0",
+    "@vitest/coverage-v8": "^4.0.3",
+    "vitest": "^4.0.3",
+    "@keyv/test-suite": "^2.1.1"
+  },
+  "peerDependencies": {
+    "keyv": "^5.5.3"
   },
   "tsd": {
     "directory": "test"
@@ -53,8 +56,10 @@
   ],
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
-    "test": "biome check --write && vitest run --coverage",
-    "test:ci": "biome check && 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"
   }
 }