keyv - feat: (breaking) removing opts from KeyvStorageAdapter (#1906)

* keyv - feat: (breaking) removing opts from KeyvStorageAdapter

* removing opts fixes

Author: jaredwray

core/keyv/README.md

@@ -538,7 +538,7 @@ The storage adapter instance to be used by Keyv.
 Type: `String`
 Default: `'keyv'`
 
-This is the namespace for the current instance. When you set it it will set it also on the storage adapter. This is the preferred way to set the namespace over `.opts.namespace`.
+This is the namespace for the current instance. When you set it it will set it also on the storage adapter.
 
 ## options
 
@@ -630,8 +630,10 @@ await keyv.setRaw('foo', { value: 'bar' });
 
 // Round-trip: get raw, modify, set raw
 const raw = await keyv.getRaw('foo');
-raw.value = 'updated';
-await keyv.setRaw('foo', raw);
+if (raw) {
+  raw.value = 'updated';
+  await keyv.setRaw('foo', raw);
+}
 ```
 
 ## .setManyRaw(entries)

core/keyv/src/generic-store.ts

@@ -93,7 +93,6 @@ export type KeyPrefixData = {
  * ```
  */
 export class KeyvGenericStore extends Hookified implements KeyvStorageAdapter {
-	private readonly _options?: KeyvGenericStoreOptions;
 	private _store: KeyvMapType;
 	private _namespace?: string | (() => string);
 	private _keySeparator = "::";
@@ -106,7 +105,6 @@ export class KeyvGenericStore extends Hookified implements KeyvStorageAdapter {
 	constructor(store: KeyvMapType, options?: KeyvGenericStoreOptions) {
 		super();
 		this._store = store;
-		this._options = options;
 
 		if (options?.keySeparator) {
 			this._keySeparator = options.keySeparator;
@@ -145,13 +143,6 @@ export class KeyvGenericStore extends Hookified implements KeyvStorageAdapter {
 		this._keySeparator = separator;
 	}
 
-	/**
-	 * Gets the options passed to the constructor.
-	 */
-	public get opts() {
-		return this._options;
-	}
-
 	/**
 	 * Gets the current namespace value (resolved if it's a function).
 	 */

core/keyv/src/types.ts

@@ -95,8 +95,6 @@ export type StoredDataRaw<Value> = DeserializedData<Value> | undefined;
 export type StoredData<Value> = StoredDataNoRaw<Value> | StoredDataRaw<Value>;
 
 export type KeyvStorageAdapter = {
-	// biome-ignore lint/suspicious/noExplicitAny: type format
-	opts: any;
 	namespace?: string | undefined;
 	get<Value>(key: string): Promise<StoredData<Value> | undefined>;
 	// biome-ignore lint/suspicious/noExplicitAny: type format

core/keyv/test/generic-store-integration.test.ts

@@ -39,9 +39,12 @@ describe("KeyvGenericStore with QuickLRU - Store Options", () => {
 
 	test("should be able to get the options", () => {
 		const lru = new QuickLRU<string, unknown>({ maxSize: 100 });
-		const options = { namespace: "test", keySeparator: ":" };
-		const keyv = new KeyvGenericStore(lru, options);
-		expect(keyv.opts).toEqual(options);
+		const keyv = new KeyvGenericStore(lru, {
+			namespace: "test",
+			keySeparator: ":",
+		});
+		expect(keyv.namespace).toBe("test");
+		expect(keyv.keySeparator).toBe(":");
 	});
 });
 
@@ -689,9 +692,12 @@ describe("KeyvGenericStore with lru.min - Store Options", () => {
 
 	test("should be able to get the options", () => {
 		const lru = createLRU<string, unknown>({ max: 100 });
-		const options = { namespace: "test", keySeparator: ":" };
-		const keyv = new KeyvGenericStore(lru, options);
-		expect(keyv.opts).toEqual(options);
+		const keyv = new KeyvGenericStore(lru, {
+			namespace: "test",
+			keySeparator: ":",
+		});
+		expect(keyv.namespace).toBe("test");
+		expect(keyv.keySeparator).toBe(":");
 	});
 });
 
@@ -1128,9 +1134,12 @@ describe("KeyvGenericStore with Map - Store Options", () => {
 
 	test("should be able to get the options", () => {
 		const map = new Map<string, unknown>();
-		const options = { namespace: "test", keySeparator: ":" };
-		const keyv = new KeyvGenericStore(map, options);
-		expect(keyv.opts).toEqual(options);
+		const keyv = new KeyvGenericStore(map, {
+			namespace: "test",
+			keySeparator: ":",
+		});
+		expect(keyv.namespace).toBe("test");
+		expect(keyv.keySeparator).toBe(":");
 	});
 });
 

core/keyv/test/generic-store.test.ts

@@ -30,11 +30,10 @@ describe("Keyv Generic Store Options", () => {
 		expect(keyv.keySeparator).toBe("new");
 	});
 
-	test("should be able to get the options", () => {
+	test("should be able to get the namespace from options", () => {
 		const store = new Map();
-		const options = { namespace: "test" };
-		const keyv = new KeyvGenericStore(store, options);
-		expect(keyv.opts).toEqual(options);
+		const keyv = new KeyvGenericStore(store, { namespace: "test" });
+		expect(keyv.namespace).toBe("test");
 	});
 });
 

core/test-suite/test/unit.ts

@@ -7,18 +7,9 @@ import keyvTestSuite, {
 } from "../src/index.js";
 
 const storeExtended = () => {
-	class MapExtend extends Map {
-		// biome-ignore lint/correctness/noUnusedPrivateClassMembers: allowed
-		private readonly opts: { timeout: number };
-		// biome-ignore lint/suspicious/noExplicitAny: type format for Map
-		constructor(map: Map<any, any>, options: { timeout: number }) {
-			// @ts-expect-error - super don't accept arguments
-			super(map);
-			this.opts = options;
-		}
-	}
+	class MapExtend extends Map {}
 
-	return new MapExtend(new Map(), { timeout: 1000 });
+	return new MapExtend();
 };
 
 keyvTestSuite(test, Keyv, storeExtended);

package.json

@@ -14,9 +14,9 @@
   "scripts": {
     "build:keyv": "pnpm recursive --filter=keyv run build",
     "build": "pnpm build:keyv && pnpm recursive --filter '!keyv' run build",
-    "build:sequential": "pnpm build:keyv && pnpm --filter '!keyv' --workspace-concurrency 1 -r build",
+    "build:list": "pnpm build:keyv && pnpm --filter '!keyv' --workspace-concurrency 1 -r build",
     "test": "pnpm -r test",
-    "test:sequential": "pnpm -r --workspace-concurrency 1 test",
+    "test:list": "pnpm -r --workspace-concurrency 1 test",
     "test:ci": "pnpm -r test:ci",
     "test:services:start": "chmod +x ./scripts/test-services-start.sh && ./scripts/test-services-start.sh",
     "test:services:stop": "chmod +x ./scripts/test-services-stop.sh && ./scripts/test-services-stop.sh",

storage/dynamo/README.md

@@ -32,7 +32,6 @@
   - [.namespace](#namespace)
   - [.keyPrefixSeparator](#keyprefixseparator)
   - [.sixHoursInMilliseconds](#sixhoursinmilliseconds)
-  - [.opts](#opts)
 - [Methods](#methods)
   - [constructor(options?)](#constructoroptions)
   - [.get(key)](#getkey)
@@ -208,7 +207,6 @@ Options extend [`DynamoDBClientConfig`](https://docs.aws.amazon.com/AWSJavaScrip
 |---|---|---|---|
 | `tableName` | `string` | `'keyv'` | The DynamoDB table name. Created automatically if it doesn't exist. |
 | `namespace` | `string` | `undefined` | Key prefix for namespace isolation |
-| `dialect` | `string` | `'dynamo'` | Storage dialect identifier (read-only) |
 | `endpoint` | `string` | — | The DynamoDB endpoint URL (e.g., `'http://localhost:8000'` for local development) |
 | `region` | `string` | — | The AWS region (e.g., `'us-east-1'`) |
 
@@ -256,27 +254,13 @@ The default TTL fallback in milliseconds. Used when no TTL is specified in a `se
 |---|---|
 | `number` | `21600000` (6 hours) |
 
-### .opts
-
-Read-only object containing the current configuration options.
-
-| Type |
-|---|
-| `KeyvDynamoOptions` |
-
-```js
-const store = new KeyvDynamo({ endpoint: 'http://localhost:8000', tableName: 'cacheTable' });
-console.log(store.opts);
-// { tableName: 'cacheTable', dialect: 'dynamo', endpoint: 'http://localhost:8000' }
-```
-
 ## Methods
 
 ### constructor(options?)
 
 Creates a new `KeyvDynamo` instance. Automatically creates the DynamoDB table if it doesn't exist.
 
-- `options` — A `KeyvDynamoOptions` object or an endpoint string. Defaults to `{ tableName: 'keyv', dialect: 'dynamo' }`.
+- `options` — A `KeyvDynamoOptions` object or an endpoint string. Defaults to `{ tableName: 'keyv' }`.
 
 ```js
 import KeyvDynamo from '@keyv/dynamo';

storage/dynamo/src/index.ts

@@ -42,10 +42,13 @@ export class KeyvDynamo extends Hookified implements KeyvStorageAdapter {
 
 		this._opts = {
 			tableName: "keyv",
-			dialect: "dynamo",
 			...options,
 		};
 
+		if (this._opts.namespace) {
+			this._namespace = this._opts.namespace;
+		}
+
 		this._client = DynamoDBDocument.from(new DynamoDB(this._opts));
 
 		this._tableReady = this.ensureTable(this._opts.tableName).catch(
@@ -83,15 +86,6 @@ export class KeyvDynamo extends Hookified implements KeyvStorageAdapter {
 		this._namespace = value;
 	}
 
-	/**
-	 * Gets the merged configuration options. Read-only.
-	 */
-	public get opts(): Omit<KeyvDynamoOptions, "tableName"> & {
-		tableName: string;
-	} {
-		return this._opts;
-	}
-
 	/**
 	 * Gets the underlying DynamoDB Document client instance.
 	 */
@@ -106,6 +100,20 @@ export class KeyvDynamo extends Hookified implements KeyvStorageAdapter {
 		this._client = value;
 	}
 
+	/**
+	 * Gets the DynamoDB table name.
+	 */
+	public get tableName(): string {
+		return this._opts.tableName;
+	}
+
+	/**
+	 * Gets the DynamoDB endpoint URL, if configured.
+	 */
+	public get endpoint(): string | undefined {
+		return this._opts.endpoint as string | undefined;
+	}
+
 	/**
 	 * Gets the separator between the namespace and key.
 	 * @default ':'
@@ -621,7 +629,6 @@ export class KeyvDynamo extends Hookified implements KeyvStorageAdapter {
 export default KeyvDynamo;
 export type KeyvDynamoOptions = {
 	namespace?: string;
-	dialect?: string;
 	tableName?: string;
 } & DynamoDBClientConfig;
 

storage/dynamo/test/test.ts

@@ -37,15 +37,13 @@ test.it("should ensure table creation", async (t) => {
 
 test.it("should be able to create a keyv instance", (t) => {
 	const keyv = new Keyv<string>({ store: keyvDynamodb });
-	t.expect(keyv.store.opts.endpoint).toEqual(dynamoURL);
+	t.expect((keyv.store as KeyvDynamo).endpoint).toEqual(dynamoURL);
 });
 
 test.it("should be able to create a keyv instance with namespace", (t) => {
-	const keyv = new Keyv<string>({
-		store: new KeyvDynamo({ endpoint: dynamoURL, namespace: "test" }),
-	});
-	t.expect(keyv.store.opts.endpoint).toEqual(dynamoURL);
-	t.expect(keyv.store.opts.namespace).toEqual("test");
+	const store = new KeyvDynamo({ endpoint: dynamoURL, namespace: "test" });
+	t.expect(store.endpoint).toEqual(dynamoURL);
+	t.expect(store.namespace).toEqual("test");
 });
 
 test.it(".clear() entire cache store with default namespace", async (t) => {
@@ -351,7 +349,7 @@ test.it("has returns false for expired key", async (t) => {
 	await store.set(key, "value", 0);
 	// Manually overwrite with an already-expired expiresAt
 	await store.client.put({
-		TableName: store.opts.tableName,
+		TableName: store.tableName,
 		Item: {
 			id: store.formatKey(key),
 			value: "value",
@@ -369,7 +367,7 @@ test.it("hasMany returns false for expired keys", async (t) => {
 	await store.set(key2, "value2");
 	// Overwrite key1 with an expired expiresAt
 	await store.client.put({
-		TableName: store.opts.tableName,
+		TableName: store.tableName,
 		Item: {
 			id: store.formatKey(key1),
 			value: "value1",
@@ -396,7 +394,7 @@ test.describe("createKeyv", () => {
 		t.expect(keyv.namespace).toBeUndefined();
 		t.expect((keyv.store as KeyvDynamo).namespace).toBeUndefined();
 
-		t.expect((keyv.store as KeyvDynamo).opts.endpoint).toBe(dynamoURL);
+		t.expect((keyv.store as KeyvDynamo).endpoint).toBe(dynamoURL);
 	});
 
 	test.it("should create Keyv instance with custom namespace", (t) => {
@@ -407,7 +405,7 @@ test.describe("createKeyv", () => {
 		t.expect(keyv.namespace).toBe(namespace);
 		t.expect((keyv.store as KeyvDynamo).namespace).toBe(namespace);
 
-		t.expect((keyv.store as KeyvDynamo).opts.endpoint).toBe(dynamoURL);
+		t.expect((keyv.store as KeyvDynamo).endpoint).toBe(dynamoURL);
 	});
 
 	test.it("should create Keyv instance with custom table name", (t) => {
@@ -418,7 +416,7 @@ test.describe("createKeyv", () => {
 		t.expect(keyv.namespace).toBeUndefined();
 		t.expect((keyv.store as KeyvDynamo).namespace).toBeUndefined();
 
-		t.expect((keyv.store as KeyvDynamo).opts.tableName).toBe(tableName);
+		t.expect((keyv.store as KeyvDynamo).tableName).toBe(tableName);
 	});
 
 	test.it(
@@ -432,7 +430,7 @@ test.describe("createKeyv", () => {
 			t.expect(keyv.namespace).toBe(namespace);
 			t.expect((keyv.store as KeyvDynamo).namespace).toBe(namespace);
 
-			t.expect((keyv.store as KeyvDynamo).opts.tableName).toBe(tableName);
+			t.expect((keyv.store as KeyvDynamo).tableName).toBe(tableName);
 		},
 	);