@warlock.js/cache 4.0.171 → 4.1.1

package/esm/drivers/mock-cache-driver.mjs

@@ -0,0 +1,226 @@
+import { BaseCacheDriver } from "./base-cache-driver.mjs";
+
+//#region ../../@warlock.js/cache/src/drivers/mock-cache-driver.ts
+/**
+* In-memory cache driver with introspection helpers, intended for use as a
+* test double in downstream packages.
+*
+* **Role.** Drop-in replacement for any real driver in test setups, with
+* extra surface that makes behavioral assertions easy: every public op gets
+* recorded into {@link MockCacheDriver.callLog}, and {@link wasCalled} /
+* {@link getStored} / {@link reset} let tests verify side effects without
+* pulling in a real Redis / Postgres / file system.
+*
+* **Responsibility.**
+* - Owns: in-memory storage backed by a `Map`, the `callLog`, TTL handling
+*   via `parseCachedData`, `onConflict` policies, and tag-index storage.
+* - Does NOT own: similarity retrieval (vectors are recorded into the
+*   `callLog` but `similar()` throws — use `MemoryCacheDriver` for tests
+*   that need real nearest-neighbor scoring), connection lifecycle
+*   (no-op `connect`/`disconnect`), or eviction (no `maxSize`).
+*
+* Register it like any other driver — sub-paths are not part of the
+* package's export convention; the same single barrel ships it next to
+* the production drivers.
+*
+* @example
+* import { cache, MockCacheDriver } from "@warlock.js/cache";
+*
+* beforeEach(async () => {
+*   cache.setCacheConfigurations({
+*     default: "mock",
+*     drivers: { mock: MockCacheDriver },
+*     options: { mock: {} },
+*   });
+*   await cache.init();
+* });
+*
+* it("invalidates the user cache after update", async () => {
+*   await userService.update(42, { name: "Jane" });
+*
+*   const driver = cache.currentDriver as MockCacheDriver;
+*   expect(driver.wasCalled("remove", "users.42")).toBe(true);
+* });
+*/
+var MockCacheDriver = class extends BaseCacheDriver {
+	constructor(..._args) {
+		super(..._args);
+		this.name = "mock";
+		this.options = {};
+		this.storage = /* @__PURE__ */ new Map();
+		this.callLog = [];
+	}
+	/**
+	* Standard driver setup. Mirrors the null driver — no connection, no
+	* resources to release.
+	*/
+	async connect() {
+		this.recordCall("connect", void 0);
+		await super.connect();
+	}
+	/**
+	* Standard driver teardown.
+	*/
+	async disconnect() {
+		this.recordCall("disconnect", void 0);
+		await super.disconnect();
+	}
+	/**
+	* Wipe everything under `namespace`. Matches `MemoryCacheDriver` semantics
+	* — the namespace itself and any key with the namespace prefix is removed.
+	*/
+	async removeNamespace(namespace) {
+		const parsed = this.parseKey(namespace);
+		this.recordCall("removeNamespace", parsed, [namespace]);
+		this.log("clearing", parsed);
+		const prefix = parsed + ".";
+		for (const key of [...this.storage.keys()]) if (key === parsed || key.startsWith(prefix)) this.storage.delete(key);
+		this.log("cleared", parsed);
+	}
+	/**
+	* Standard `set` with full `onConflict` support. Honors scope-default TTL
+	* via {@link BaseCacheDriver.resolveSetOptions}.
+	*/
+	async set(key, value, ttlOrOptions) {
+		const parsedKey = this.parseKey(key);
+		const { ttl, tags, onConflict, staleAt } = this.resolveSetOptions(ttlOrOptions);
+		this.recordCall("set", parsedKey, [value, ttlOrOptions]);
+		this.log("caching", parsedKey);
+		const existing = onConflict === "upsert" ? null : await this.get(key);
+		const exists = existing !== null;
+		if (onConflict === "create" && exists) return {
+			wasSet: false,
+			existing
+		};
+		if (onConflict === "update" && !exists) return {
+			wasSet: false,
+			existing: null
+		};
+		const data = this.prepareDataForStorage(value, ttl, staleAt);
+		this.storage.set(parsedKey, data);
+		if (tags && tags.length > 0) await this.applyTags(parsedKey, tags);
+		this.log("cached", parsedKey);
+		await this.emit("set", {
+			key: parsedKey,
+			value,
+			ttl
+		});
+		if (onConflict === "create" || onConflict === "update") return {
+			wasSet: true,
+			existing: null
+		};
+		return value;
+	}
+	/**
+	* Standard `get` with TTL handling. Emits `hit` / `miss` events to keep
+	* downstream metrics tests realistic.
+	*/
+	async get(key) {
+		const parsedKey = this.parseKey(key);
+		this.recordCall("get", parsedKey);
+		this.log("fetching", parsedKey);
+		const data = this.storage.get(parsedKey);
+		if (!data) {
+			this.log("notFound", parsedKey);
+			await this.emit("miss", { key: parsedKey });
+			return null;
+		}
+		const value = await this.parseCachedData(parsedKey, data);
+		if (value === null) {
+			this.storage.delete(parsedKey);
+			await this.emit("miss", { key: parsedKey });
+			return null;
+		}
+		await this.emit("hit", {
+			key: parsedKey,
+			value
+		});
+		return value;
+	}
+	/**
+	* Read the raw {@link CacheData} wrapper from the in-memory `Map`,
+	* including `staleAt` metadata. Returns `null` for missing or expired
+	* entries — `swr()` consumes this to branch on freshness.
+	*/
+	async getEntry(key) {
+		const parsedKey = this.parseKey(key);
+		const entry = this.storage.get(parsedKey);
+		if (!entry) return null;
+		if (entry.expiresAt !== void 0 && entry.expiresAt <= Date.now()) return null;
+		return entry;
+	}
+	/**
+	* Standard `remove` — drops the entry and emits the `removed` event.
+	*/
+	async remove(key) {
+		const parsedKey = this.parseKey(key);
+		this.recordCall("remove", parsedKey);
+		this.log("removing", parsedKey);
+		this.storage.delete(parsedKey);
+		this.log("removed", parsedKey);
+		await this.emit("removed", { key: parsedKey });
+	}
+	/**
+	* Standard `flush` — wipes the entire mock store + tag index. Does NOT
+	* touch the call log; use {@link reset} to clear that as well.
+	*/
+	async flush() {
+		this.recordCall("flush", void 0);
+		this.log("flushing");
+		this.storage.clear();
+		this.log("flushed");
+		await this.emit("flushed");
+	}
+	/**
+	* Was a given operation invoked? When `key` is provided, the match is
+	* post-`parseKey` so callers pass the same key shape they used at the
+	* call site — strings or objects, both resolve to the same parsed key.
+	*
+	* @example
+	* driver.wasCalled("set");                  // any set
+	* driver.wasCalled("set", "users.42");      // set on this specific key
+	* driver.wasCalled("set", { id: 42 });      // same — object key normalized
+	*/
+	wasCalled(operation, key) {
+		if (key === void 0) return this.callLog.some((call) => call.operation === operation);
+		const parsedKey = this.parseKey(key);
+		return this.callLog.some((call) => call.operation === operation && call.key === parsedKey);
+	}
+	/**
+	* Return the raw stored value for `key`, bypassing TTL handling and clone
+	* protection. Useful when a test wants to assert on the persisted shape
+	* (or assert that an entry expired without going through `get`).
+	*
+	* Returns `undefined` when the key isn't present.
+	*/
+	getStored(key) {
+		const parsedKey = this.parseKey(key);
+		const entry = this.storage.get(parsedKey);
+		if (!entry) return;
+		return entry.data;
+	}
+	/**
+	* Wipe everything — storage, tag index, and the call log. Pair with
+	* Vitest's `beforeEach` to get clean isolation between tests.
+	*/
+	reset() {
+		this.storage.clear();
+		this.callLog.length = 0;
+	}
+	/**
+	* Append a row to {@link callLog}. Internal helper called by every
+	* recorded op before the actual work runs.
+	*/
+	recordCall(operation, key, args = []) {
+		this.callLog.push({
+			operation,
+			key,
+			args,
+			timestamp: Date.now()
+		});
+	}
+};
+
+//#endregion
+export { MockCacheDriver };
+//# sourceMappingURL=mock-cache-driver.mjs.map

package/esm/drivers/mock-cache-driver.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-cache-driver.mjs","names":[],"sources":["../../../../../../@warlock.js/cache/src/drivers/mock-cache-driver.ts"],"sourcesContent":["import type {\n  CacheCall,\n  CacheData,\n  CacheDriver,\n  CacheKey,\n  CacheSetOptions,\n  CacheSetResult,\n  CacheTtl,\n  MockCacheOptions,\n} from \"../types\";\nimport { BaseCacheDriver } from \"./base-cache-driver\";\n\n/**\n * In-memory cache driver with introspection helpers, intended for use as a\n * test double in downstream packages.\n *\n * **Role.** Drop-in replacement for any real driver in test setups, with\n * extra surface that makes behavioral assertions easy: every public op gets\n * recorded into {@link MockCacheDriver.callLog}, and {@link wasCalled} /\n * {@link getStored} / {@link reset} let tests verify side effects without\n * pulling in a real Redis / Postgres / file system.\n *\n * **Responsibility.**\n * - Owns: in-memory storage backed by a `Map`, the `callLog`, TTL handling\n *   via `parseCachedData`, `onConflict` policies, and tag-index storage.\n * - Does NOT own: similarity retrieval (vectors are recorded into the\n *   `callLog` but `similar()` throws — use `MemoryCacheDriver` for tests\n *   that need real nearest-neighbor scoring), connection lifecycle\n *   (no-op `connect`/`disconnect`), or eviction (no `maxSize`).\n *\n * Register it like any other driver — sub-paths are not part of the\n * package's export convention; the same single barrel ships it next to\n * the production drivers.\n *\n * @example\n * import { cache, MockCacheDriver } from \"@warlock.js/cache\";\n *\n * beforeEach(async () => {\n *   cache.setCacheConfigurations({\n *     default: \"mock\",\n *     drivers: { mock: MockCacheDriver },\n *     options: { mock: {} },\n *   });\n *   await cache.init();\n * });\n *\n * it(\"invalidates the user cache after update\", async () => {\n *   await userService.update(42, { name: \"Jane\" });\n *\n *   const driver = cache.currentDriver as MockCacheDriver;\n *   expect(driver.wasCalled(\"remove\", \"users.42\")).toBe(true);\n * });\n */\nexport class MockCacheDriver\n  extends BaseCacheDriver<MockCacheDriver, MockCacheOptions>\n  implements CacheDriver<MockCacheDriver, MockCacheOptions>\n{\n  /**\n   * {@inheritdoc}\n   */\n  public name = \"mock\";\n\n  /**\n   * {@inheritdoc}\n   */\n  public options: MockCacheOptions = {};\n\n  /**\n   * Storage backing the mock — keyed by post-`parseKey` string. Public-readonly\n   * so tests can introspect raw entries when {@link getStored} isn't enough.\n   */\n  public readonly storage: Map<string, CacheData> = new Map();\n\n  /**\n   * Ordered record of every public operation routed through this driver.\n   * Pushed to before each op runs; tests assert via {@link wasCalled} or by\n   * inspecting the array directly.\n   */\n  public readonly callLog: CacheCall[] = [];\n\n  /**\n   * Standard driver setup. Mirrors the null driver — no connection, no\n   * resources to release.\n   */\n  public async connect(): Promise<void> {\n    this.recordCall(\"connect\", undefined);\n    await super.connect();\n  }\n\n  /**\n   * Standard driver teardown.\n   */\n  public async disconnect(): Promise<void> {\n    this.recordCall(\"disconnect\", undefined);\n    await super.disconnect();\n  }\n\n  /**\n   * Wipe everything under `namespace`. Matches `MemoryCacheDriver` semantics\n   * — the namespace itself and any key with the namespace prefix is removed.\n   */\n  public async removeNamespace(namespace: string): Promise<void> {\n    const parsed = this.parseKey(namespace);\n\n    this.recordCall(\"removeNamespace\", parsed, [namespace]);\n    this.log(\"clearing\", parsed);\n\n    const prefix = parsed + \".\";\n\n    for (const key of [...this.storage.keys()]) {\n      if (key === parsed || key.startsWith(prefix)) {\n        this.storage.delete(key);\n      }\n    }\n\n    this.log(\"cleared\", parsed);\n  }\n\n  /**\n   * Standard `set` with full `onConflict` support. Honors scope-default TTL\n   * via {@link BaseCacheDriver.resolveSetOptions}.\n   */\n  public async set(\n    key: CacheKey,\n    value: any,\n    ttlOrOptions?: CacheTtl | CacheSetOptions,\n  ): Promise<any> {\n    const parsedKey = this.parseKey(key);\n    const { ttl, tags, onConflict, staleAt } = this.resolveSetOptions(ttlOrOptions);\n\n    this.recordCall(\"set\", parsedKey, [value, ttlOrOptions]);\n    this.log(\"caching\", parsedKey);\n\n    const existing = onConflict === \"upsert\" ? null : await this.get(key);\n    const exists = existing !== null;\n\n    if (onConflict === \"create\" && exists) {\n      const result: CacheSetResult = { wasSet: false, existing };\n\n      return result;\n    }\n\n    if (onConflict === \"update\" && !exists) {\n      const result: CacheSetResult = { wasSet: false, existing: null };\n\n      return result;\n    }\n\n    const data = this.prepareDataForStorage(value, ttl, staleAt);\n    this.storage.set(parsedKey, data);\n\n    if (tags && tags.length > 0) {\n      await this.applyTags(parsedKey, tags);\n    }\n\n    this.log(\"cached\", parsedKey);\n    await this.emit(\"set\", { key: parsedKey, value, ttl });\n\n    if (onConflict === \"create\" || onConflict === \"update\") {\n      const result: CacheSetResult = { wasSet: true, existing: null };\n\n      return result;\n    }\n\n    return value;\n  }\n\n  /**\n   * Standard `get` with TTL handling. Emits `hit` / `miss` events to keep\n   * downstream metrics tests realistic.\n   */\n  public async get<T = any>(key: CacheKey): Promise<T | null> {\n    const parsedKey = this.parseKey(key);\n\n    this.recordCall(\"get\", parsedKey);\n    this.log(\"fetching\", parsedKey);\n\n    const data = this.storage.get(parsedKey);\n\n    if (!data) {\n      this.log(\"notFound\", parsedKey);\n      await this.emit(\"miss\", { key: parsedKey });\n\n      return null;\n    }\n\n    const value = await this.parseCachedData(parsedKey, data);\n\n    if (value === null) {\n      // expired — the parse helper already logged + queued the cleanup\n      this.storage.delete(parsedKey);\n      await this.emit(\"miss\", { key: parsedKey });\n\n      return null;\n    }\n\n    await this.emit(\"hit\", { key: parsedKey, value });\n\n    return value as T;\n  }\n\n  /**\n   * Read the raw {@link CacheData} wrapper from the in-memory `Map`,\n   * including `staleAt` metadata. Returns `null` for missing or expired\n   * entries — `swr()` consumes this to branch on freshness.\n   */\n  protected async getEntry(key: CacheKey): Promise<CacheData | null> {\n    const parsedKey = this.parseKey(key);\n    const entry = this.storage.get(parsedKey);\n\n    if (!entry) {\n      return null;\n    }\n\n    if (entry.expiresAt !== undefined && entry.expiresAt <= Date.now()) {\n      return null;\n    }\n\n    return entry;\n  }\n\n  /**\n   * Standard `remove` — drops the entry and emits the `removed` event.\n   */\n  public async remove(key: CacheKey): Promise<void> {\n    const parsedKey = this.parseKey(key);\n\n    this.recordCall(\"remove\", parsedKey);\n    this.log(\"removing\", parsedKey);\n\n    this.storage.delete(parsedKey);\n\n    this.log(\"removed\", parsedKey);\n    await this.emit(\"removed\", { key: parsedKey });\n  }\n\n  /**\n   * Standard `flush` — wipes the entire mock store + tag index. Does NOT\n   * touch the call log; use {@link reset} to clear that as well.\n   */\n  public async flush(): Promise<void> {\n    this.recordCall(\"flush\", undefined);\n    this.log(\"flushing\");\n\n    this.storage.clear();\n\n    this.log(\"flushed\");\n    await this.emit(\"flushed\");\n  }\n\n  /**\n   * Was a given operation invoked? When `key` is provided, the match is\n   * post-`parseKey` so callers pass the same key shape they used at the\n   * call site — strings or objects, both resolve to the same parsed key.\n   *\n   * @example\n   * driver.wasCalled(\"set\");                  // any set\n   * driver.wasCalled(\"set\", \"users.42\");      // set on this specific key\n   * driver.wasCalled(\"set\", { id: 42 });      // same — object key normalized\n   */\n  public wasCalled(operation: string, key?: CacheKey): boolean {\n    if (key === undefined) {\n      return this.callLog.some((call) => call.operation === operation);\n    }\n\n    const parsedKey = this.parseKey(key);\n\n    return this.callLog.some(\n      (call) => call.operation === operation && call.key === parsedKey,\n    );\n  }\n\n  /**\n   * Return the raw stored value for `key`, bypassing TTL handling and clone\n   * protection. Useful when a test wants to assert on the persisted shape\n   * (or assert that an entry expired without going through `get`).\n   *\n   * Returns `undefined` when the key isn't present.\n   */\n  public getStored<T = any>(key: CacheKey): T | undefined {\n    const parsedKey = this.parseKey(key);\n    const entry = this.storage.get(parsedKey);\n\n    if (!entry) {\n      return undefined;\n    }\n\n    return entry.data as T;\n  }\n\n  /**\n   * Wipe everything — storage, tag index, and the call log. Pair with\n   * Vitest's `beforeEach` to get clean isolation between tests.\n   */\n  public reset(): void {\n    this.storage.clear();\n    this.callLog.length = 0;\n  }\n\n  /**\n   * Append a row to {@link callLog}. Internal helper called by every\n   * recorded op before the actual work runs.\n   */\n  protected recordCall(\n    operation: string,\n    key: string | undefined,\n    args: unknown[] = [],\n  ): void {\n    this.callLog.push({\n      operation,\n      key,\n      args,\n      timestamp: Date.now(),\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqDA,IAAa,kBAAb,cACU,gBAEV;;;cAIgB;iBAKqB,CAAC;iCAMc,IAAI,IAAI;iBAOnB,CAAC;;;;;;CAMxC,MAAa,UAAyB;EACpC,KAAK,WAAW,WAAW,MAAS;EACpC,MAAM,MAAM,QAAQ;CACtB;;;;CAKA,MAAa,aAA4B;EACvC,KAAK,WAAW,cAAc,MAAS;EACvC,MAAM,MAAM,WAAW;CACzB;;;;;CAMA,MAAa,gBAAgB,WAAkC;EAC7D,MAAM,SAAS,KAAK,SAAS,SAAS;EAEtC,KAAK,WAAW,mBAAmB,QAAQ,CAAC,SAAS,CAAC;EACtD,KAAK,IAAI,YAAY,MAAM;EAE3B,MAAM,SAAS,SAAS;EAExB,KAAK,MAAM,OAAO,CAAC,GAAG,KAAK,QAAQ,KAAK,CAAC,GACvC,IAAI,QAAQ,UAAU,IAAI,WAAW,MAAM,GACzC,KAAK,QAAQ,OAAO,GAAG;EAI3B,KAAK,IAAI,WAAW,MAAM;CAC5B;;;;;CAMA,MAAa,IACX,KACA,OACA,cACc;EACd,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,EAAE,KAAK,MAAM,YAAY,YAAY,KAAK,kBAAkB,YAAY;EAE9E,KAAK,WAAW,OAAO,WAAW,CAAC,OAAO,YAAY,CAAC;EACvD,KAAK,IAAI,WAAW,SAAS;EAE7B,MAAM,WAAW,eAAe,WAAW,OAAO,MAAM,KAAK,IAAI,GAAG;EACpE,MAAM,SAAS,aAAa;EAE5B,IAAI,eAAe,YAAY,QAG7B,OAAO;GAF0B,QAAQ;GAAO;EAEpC;EAGd,IAAI,eAAe,YAAY,CAAC,QAG9B,OAAO;GAF0B,QAAQ;GAAO,UAAU;EAE9C;EAGd,MAAM,OAAO,KAAK,sBAAsB,OAAO,KAAK,OAAO;EAC3D,KAAK,QAAQ,IAAI,WAAW,IAAI;EAEhC,IAAI,QAAQ,KAAK,SAAS,GACxB,MAAM,KAAK,UAAU,WAAW,IAAI;EAGtC,KAAK,IAAI,UAAU,SAAS;EAC5B,MAAM,KAAK,KAAK,OAAO;GAAE,KAAK;GAAW;GAAO;EAAI,CAAC;EAErD,IAAI,eAAe,YAAY,eAAe,UAG5C,OAAO;GAF0B,QAAQ;GAAM,UAAU;EAE7C;EAGd,OAAO;CACT;;;;;CAMA,MAAa,IAAa,KAAkC;EAC1D,MAAM,YAAY,KAAK,SAAS,GAAG;EAEnC,KAAK,WAAW,OAAO,SAAS;EAChC,KAAK,IAAI,YAAY,SAAS;EAE9B,MAAM,OAAO,KAAK,QAAQ,IAAI,SAAS;EAEvC,IAAI,CAAC,MAAM;GACT,KAAK,IAAI,YAAY,SAAS;GAC9B,MAAM,KAAK,KAAK,QAAQ,EAAE,KAAK,UAAU,CAAC;GAE1C,OAAO;EACT;EAEA,MAAM,QAAQ,MAAM,KAAK,gBAAgB,WAAW,IAAI;EAExD,IAAI,UAAU,MAAM;GAElB,KAAK,QAAQ,OAAO,SAAS;GAC7B,MAAM,KAAK,KAAK,QAAQ,EAAE,KAAK,UAAU,CAAC;GAE1C,OAAO;EACT;EAEA,MAAM,KAAK,KAAK,OAAO;GAAE,KAAK;GAAW;EAAM,CAAC;EAEhD,OAAO;CACT;;;;;;CAOA,MAAgB,SAAS,KAA0C;EACjE,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,QAAQ,KAAK,QAAQ,IAAI,SAAS;EAExC,IAAI,CAAC,OACH,OAAO;EAGT,IAAI,MAAM,cAAc,UAAa,MAAM,aAAa,KAAK,IAAI,GAC/D,OAAO;EAGT,OAAO;CACT;;;;CAKA,MAAa,OAAO,KAA8B;EAChD,MAAM,YAAY,KAAK,SAAS,GAAG;EAEnC,KAAK,WAAW,UAAU,SAAS;EACnC,KAAK,IAAI,YAAY,SAAS;EAE9B,KAAK,QAAQ,OAAO,SAAS;EAE7B,KAAK,IAAI,WAAW,SAAS;EAC7B,MAAM,KAAK,KAAK,WAAW,EAAE,KAAK,UAAU,CAAC;CAC/C;;;;;CAMA,MAAa,QAAuB;EAClC,KAAK,WAAW,SAAS,MAAS;EAClC,KAAK,IAAI,UAAU;EAEnB,KAAK,QAAQ,MAAM;EAEnB,KAAK,IAAI,SAAS;EAClB,MAAM,KAAK,KAAK,SAAS;CAC3B;;;;;;;;;;;CAYA,AAAO,UAAU,WAAmB,KAAyB;EAC3D,IAAI,QAAQ,QACV,OAAO,KAAK,QAAQ,MAAM,SAAS,KAAK,cAAc,SAAS;EAGjE,MAAM,YAAY,KAAK,SAAS,GAAG;EAEnC,OAAO,KAAK,QAAQ,MACjB,SAAS,KAAK,cAAc,aAAa,KAAK,QAAQ,SACzD;CACF;;;;;;;;CASA,AAAO,UAAmB,KAA8B;EACtD,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,QAAQ,KAAK,QAAQ,IAAI,SAAS;EAExC,IAAI,CAAC,OACH;EAGF,OAAO,MAAM;CACf;;;;;CAMA,AAAO,QAAc;EACnB,KAAK,QAAQ,MAAM;EACnB,KAAK,QAAQ,SAAS;CACxB;;;;;CAMA,AAAU,WACR,WACA,KACA,OAAkB,CAAC,GACb;EACN,KAAK,QAAQ,KAAK;GAChB;GACA;GACA;GACA,WAAW,KAAK,IAAI;EACtB,CAAC;CACH;AACF"}

package/esm/drivers/null-cache-driver.d.mts

@@ -0,0 +1,69 @@
+import { BaseCacheDriver } from "./base-cache-driver.mjs";
+import { CacheDriver, CacheKey, CacheSetOptions, CacheTtl, NullCacheDriverOptions } from "../types.mjs";
+import { GenericObject } from "@mongez/reinforcements";
+
+//#region ../../@warlock.js/cache/src/drivers/null-cache-driver.d.ts
+declare class NullCacheDriver extends BaseCacheDriver<NullCacheDriver, NullCacheDriverOptions> implements CacheDriver<NullCacheDriver, NullCacheDriverOptions> {
+  /**
+   * Options list
+   */
+  options: GenericObject;
+  /**
+   * {@inheritdoc}
+   */
+  name: string;
+  /**
+   * Cached data
+   */
+  data: GenericObject;
+  /**
+   * {@inheritdoc}
+   */
+  get client(): this;
+  /**
+   * Constructor
+   */
+  constructor(options?: GenericObject);
+  /**
+   * {@inheritdoc}
+   */
+  setOptions(options: GenericObject): this;
+  /**
+   * {@inheritdoc}
+   */
+  parseKey(_key: CacheKey): string;
+  /**
+   * {@inheritdoc}
+   */
+  removeNamespace(namespace: string): Promise<this>;
+  /**
+   * {@inheritdoc}
+   */
+  set(key: CacheKey, _value: any, _ttlOrOptions?: CacheTtl | CacheSetOptions): Promise<any>;
+  /**
+   * {@inheritdoc}
+   */
+  get(key: CacheKey): Promise<null>;
+  /**
+   * {@inheritdoc}
+   */
+  remove(key: CacheKey): Promise<void>;
+  /**
+   * {@inheritdoc}
+   */
+  flush(): Promise<void>;
+  /**
+   * {@inheritdoc}
+   *
+   * The null driver is a black-hole — `similar()` mirrors `get()` and returns
+   * an empty result set rather than throwing.
+   */
+  similar(): Promise<any[]>;
+  /**
+   * {@inheritdoc}
+   */
+  connect(): Promise<void>;
+}
+//#endregion
+export { NullCacheDriver };
+//# sourceMappingURL=null-cache-driver.d.mts.map

package/esm/drivers/null-cache-driver.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"null-cache-driver.d.mts","names":[],"sources":["../../../../../../@warlock.js/cache/src/drivers/null-cache-driver.ts"],"mappings":";;;;;cAWa,eAAA,SACH,eAAA,CAAgB,eAAA,EAAiB,sBAAA,aAC9B,WAAA,CAAY,eAAA,EAAiB,sBAAA;;AAF1C;;EAOS,OAAA,EAAS,aAAA;EANQ;;;EAWjB,IAAA;EALS;;;EAUT,IAAA,EAAM,aAAA;EA4BS;;;EAAA,IAvBX,MAAA,CAAA;EA4CkB;;;cArCV,OAAA,GAAS,aAAA;EA4DH;;;EApDlB,UAAA,CAAW,OAAA,EAAS,aAAA;EAgFP;;;EAxEb,QAAA,CAAS,IAAA,EAAM,QAAA;EA3CA;;;EAkDT,eAAA,CAAgB,SAAA,WAAiB,OAAA;EAlDnC;;;EA6DE,GAAA,CACX,GAAA,EAAK,QAAA,EACL,MAAA,OACA,aAAA,GAAgB,QAAA,GAAW,eAAA,GAC1B,OAAA;EA5Da;;;EAuEH,GAAA,CAAI,GAAA,EAAK,QAAA,GAAQ,OAAA;EAxDnB;;;EAmEE,MAAA,CAAO,GAAA,EAAK,QAAA,GAAQ,OAAA;EApD1B;;;EA6DM,KAAA,CAAA,GAAK,OAAA;EArDI;;;;;;EAiET,OAAA,CAAA,GAAW,OAAA;EA9CtB;;;EAqDW,OAAA,CAAA,GAAO,OAAA;AAAA"}

package/esm/drivers/null-cache-driver.mjs

@@ -0,0 +1,92 @@
+import { BaseCacheDriver } from "./base-cache-driver.mjs";
+import { log } from "@warlock.js/logger";
+
+//#region ../../@warlock.js/cache/src/drivers/null-cache-driver.ts
+var NullCacheDriver = class extends BaseCacheDriver {
+	/**
+	* {@inheritdoc}
+	*/
+	get client() {
+		return this;
+	}
+	/**
+	* Constructor
+	*/
+	constructor(options = {}) {
+		super();
+		this.options = {};
+		this.name = "null";
+		this.data = {};
+		this.setOptions(options);
+	}
+	/**
+	* {@inheritdoc}
+	*/
+	setOptions(options) {
+		this.options = options;
+		return this;
+	}
+	/**
+	* {@inheritdoc}
+	*/
+	parseKey(_key) {
+		return "";
+	}
+	/**
+	* {@inheritdoc}
+	*/
+	async removeNamespace(namespace) {
+		log.info("cache", "clearing namespace", namespace);
+		log.success("cache", "namespace cleared", namespace);
+		return this;
+	}
+	/**
+	* {@inheritdoc}
+	*/
+	async set(key, _value, _ttlOrOptions) {
+		log.info("cache", "setting key", key);
+		log.success("cache", "key set", key);
+		return this;
+	}
+	/**
+	* {@inheritdoc}
+	*/
+	async get(key) {
+		log.info("cache", "fetching", key);
+		log.success("cache", "fetched", key);
+		return null;
+	}
+	/**
+	* {@inheritdoc}
+	*/
+	async remove(key) {
+		log.info("cache", "removing", key);
+		log.success("cache", "removed", key);
+	}
+	/**
+	* {@inheritdoc}
+	*/
+	async flush() {
+		log.info("cache", "flushing", "all");
+		log.success("cache", "flushed", "all");
+	}
+	/**
+	* {@inheritdoc}
+	*
+	* The null driver is a black-hole — `similar()` mirrors `get()` and returns
+	* an empty result set rather than throwing.
+	*/
+	async similar() {
+		return [];
+	}
+	/**
+	* {@inheritdoc}
+	*/
+	async connect() {
+		log.success("cache", "connected", "Connected to null cache driver");
+	}
+};
+
+//#endregion
+export { NullCacheDriver };
+//# sourceMappingURL=null-cache-driver.mjs.map

package/esm/drivers/null-cache-driver.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"null-cache-driver.mjs","names":[],"sources":["../../../../../../@warlock.js/cache/src/drivers/null-cache-driver.ts"],"sourcesContent":["import type { GenericObject } from \"@mongez/reinforcements\";\r\nimport { log } from \"@warlock.js/logger\";\r\nimport type {\r\n  CacheDriver,\r\n  CacheKey,\r\n  CacheSetOptions,\r\n  CacheTtl,\r\n  NullCacheDriverOptions,\r\n} from \"../types\";\r\nimport { BaseCacheDriver } from \"./base-cache-driver\";\r\n\r\nexport class NullCacheDriver\r\n  extends BaseCacheDriver<NullCacheDriver, NullCacheDriverOptions>\r\n  implements CacheDriver<NullCacheDriver, NullCacheDriverOptions>\r\n{\r\n  /**\r\n   * Options list\r\n   */\r\n  public options: GenericObject = {};\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public name = \"null\";\r\n\r\n  /**\r\n   * Cached data\r\n   */\r\n  public data: GenericObject = {};\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public get client() {\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Constructor\r\n   */\r\n  public constructor(options: GenericObject = {}) {\r\n    super();\r\n    this.setOptions(options);\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public setOptions(options: GenericObject) {\r\n    this.options = options;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public parseKey(_key: CacheKey) {\r\n    return \"\";\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public async removeNamespace(namespace: string) {\r\n    log.info(\"cache\", \"clearing namespace\", namespace);\r\n\r\n    log.success(\"cache\", \"namespace cleared\", namespace);\r\n\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public async set(\r\n    key: CacheKey,\r\n    _value: any,\r\n    _ttlOrOptions?: CacheTtl | CacheSetOptions,\r\n  ): Promise<any> {\r\n    log.info(\"cache\", \"setting key\", key);\r\n\r\n    log.success(\"cache\", \"key set\", key);\r\n\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public async get(key: CacheKey) {\r\n    log.info(\"cache\", \"fetching\", key);\r\n\r\n    log.success(\"cache\", \"fetched\", key);\r\n\r\n    return null;\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public async remove(key: CacheKey) {\r\n    log.info(\"cache\", \"removing\", key);\r\n\r\n    log.success(\"cache\", \"removed\", key);\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public async flush() {\r\n    log.info(\"cache\", \"flushing\", \"all\");\r\n\r\n    log.success(\"cache\", \"flushed\", \"all\");\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   *\r\n   * The null driver is a black-hole — `similar()` mirrors `get()` and returns\r\n   * an empty result set rather than throwing.\r\n   */\r\n  public async similar(): Promise<any[]> {\r\n    return [];\r\n  }\r\n\r\n  /**\r\n   * {@inheritdoc}\r\n   */\r\n  public async connect() {\r\n    log.success(\"cache\", \"connected\", \"Connected to null cache driver\");\r\n  }\r\n}\r\n"],"mappings":";;;;AAWA,IAAa,kBAAb,cACU,gBAEV;;;;CAmBE,IAAW,SAAS;EAClB,OAAO;CACT;;;;CAKA,AAAO,YAAY,UAAyB,CAAC,GAAG;EAC9C,MAAM;iBAvBwB,CAAC;cAKnB;cAKe,CAAC;EAc5B,KAAK,WAAW,OAAO;CACzB;;;;CAKA,AAAO,WAAW,SAAwB;EACxC,KAAK,UAAU;EACf,OAAO;CACT;;;;CAKA,AAAO,SAAS,MAAgB;EAC9B,OAAO;CACT;;;;CAKA,MAAa,gBAAgB,WAAmB;EAC9C,IAAI,KAAK,SAAS,sBAAsB,SAAS;EAEjD,IAAI,QAAQ,SAAS,qBAAqB,SAAS;EAEnD,OAAO;CACT;;;;CAKA,MAAa,IACX,KACA,QACA,eACc;EACd,IAAI,KAAK,SAAS,eAAe,GAAG;EAEpC,IAAI,QAAQ,SAAS,WAAW,GAAG;EAEnC,OAAO;CACT;;;;CAKA,MAAa,IAAI,KAAe;EAC9B,IAAI,KAAK,SAAS,YAAY,GAAG;EAEjC,IAAI,QAAQ,SAAS,WAAW,GAAG;EAEnC,OAAO;CACT;;;;CAKA,MAAa,OAAO,KAAe;EACjC,IAAI,KAAK,SAAS,YAAY,GAAG;EAEjC,IAAI,QAAQ,SAAS,WAAW,GAAG;CACrC;;;;CAKA,MAAa,QAAQ;EACnB,IAAI,KAAK,SAAS,YAAY,KAAK;EAEnC,IAAI,QAAQ,SAAS,WAAW,KAAK;CACvC;;;;;;;CAQA,MAAa,UAA0B;EACrC,OAAO,CAAC;CACV;;;;CAKA,MAAa,UAAU;EACrB,IAAI,QAAQ,SAAS,aAAa,gCAAgC;CACpE;AACF"}

package/esm/drivers/pg-cache-driver.d.mts

@@ -0,0 +1,148 @@
+import { BaseCacheDriver } from "./base-cache-driver.mjs";
+import { CacheData, CacheDriver, CacheKey, CacheSetOptions, CacheSimilarHit, CacheSimilarOptions, CacheTtl, PgCacheOptions, PgClientLike } from "../types.mjs";
+
+//#region ../../@warlock.js/cache/src/drivers/pg-cache-driver.d.ts
+/**
+ * Postgres cache driver with optional pgvector similarity support.
+ *
+ * Connection lifecycle is the caller's responsibility — pass an already-built
+ * `pg.Pool` or `pg.Client` via the `client` option. The driver never closes it
+ * on `cache.disconnect()`, so the same pool can serve queries elsewhere in
+ * the app.
+ *
+ * Schema is not auto-migrated. Call `driver.schema()` to get the DDL string
+ * and run it through whichever migration tool you use.
+ *
+ * @example
+ * import { Pool } from "pg";
+ * import { cache, PgCacheDriver } from "@warlock.js/cache";
+ *
+ * const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+ *
+ * cache.setCacheConfigurations({
+ *   default: "pg",
+ *   drivers: { pg: PgCacheDriver },
+ *   options: { pg: { client: pool, table: "warlock_cache", ttl: "1h" } },
+ * });
+ *
+ * await cache.init();
+ *
+ * // Run once, via your own migration tooling:
+ * // await pool.query(driver.schema());
+ */
+declare class PgCacheDriver extends BaseCacheDriver<PgClientLike, PgCacheOptions> implements CacheDriver<PgClientLike, PgCacheOptions> {
+  /**
+   * {@inheritdoc}
+   */
+  name: string;
+  /**
+   * Cached result of the pgvector extension check. Populated lazily on first
+   * vector op so the driver doesn't probe the database at construction time.
+   */
+  protected vectorReady?: boolean;
+  /**
+   * {@inheritdoc}
+   *
+   * Validates `client` presence and the table name before storing options.
+   */
+  setOptions(options: PgCacheOptions): this;
+  /**
+   * Lazy pgvector availability check. Runs once on the first vector op and
+   * caches the result — subsequent ops are zero-overhead. Throws
+   * {@link CacheConfigurationError} if the extension isn't installed; throws
+   * {@link CacheUnsupportedError} if `vector` config wasn't provided at all.
+   */
+  protected ensureVectorReady(): Promise<void>;
+  /**
+   * Format a numeric vector for pgvector ingestion. The `vector` type accepts
+   * a string literal `'[1,2,3]'` cast via `::vector` — this avoids depending
+   * on the binary protocol and works against any pg client.
+   */
+  protected formatVector(vector: number[]): string;
+  /**
+   * Resolved table name. Always defined post-`setOptions` — the validator
+   * fills in the default.
+   */
+  protected get table(): string;
+  /**
+   * The user-supplied `pg.Pool` / `pg.Client`. Use this rather than `this.client`
+   * (which has a generic fallback to `this`) for actual queries.
+   */
+  protected get pgClient(): PgClientLike;
+  /**
+   * Compute an absolute `expires_at` Date for the given relative TTL in seconds,
+   * or `null` when the entry should not expire (`Infinity` / 0 / undefined).
+   */
+  protected ttlToExpiresAt(ttl?: number): Date | null;
+  /**
+   * Return the SQL needed to provision the cache table + index. Run once via
+   * the caller's migration tooling — the driver never auto-migrates.
+   *
+   * @example
+   * await pool.query(driver.schema());
+   */
+  schema(): string;
+  /**
+   * {@inheritdoc}
+   */
+  connect(): Promise<void>;
+  /**
+   * {@inheritdoc}
+   *
+   * Does NOT close the user-supplied client — lifecycle stays with the caller.
+   */
+  disconnect(): Promise<void>;
+  /**
+   * {@inheritdoc}
+   */
+  set(key: CacheKey, value: any, ttlOrOptions?: CacheTtl | CacheSetOptions): Promise<any>;
+  /**
+   * {@inheritdoc}
+   */
+  get(key: CacheKey): Promise<any>;
+  /**
+   * Read the raw {@link CacheData} wrapper, including `staleAt` metadata.
+   * Returns `null` for missing or expired rows — `swr()` consumes this to
+   * branch on freshness without going through `get()`'s clone-and-emit path.
+   */
+  protected getEntry(key: CacheKey): Promise<CacheData | null>;
+  /**
+   * {@inheritdoc}
+   */
+  remove(key: CacheKey): Promise<void>;
+  /**
+   * {@inheritdoc}
+   *
+   * Deletes all rows whose key equals the namespace exactly or starts with
+   * `<namespace>.` — same boundary semantics as the other drivers.
+   */
+  removeNamespace(namespace: string): Promise<this>;
+  /**
+   * {@inheritdoc}
+   *
+   * Honors `globalPrefix` — when configured, scopes the flush to entries
+   * under the prefix rather than truncating the entire table (which could
+   * wipe sibling tenants sharing the same Postgres database).
+   */
+  flush(): Promise<void>;
+  /**
+   * {@inheritdoc}
+   *
+   * pgvector-backed similarity. Uses the `<=>` cosine-distance operator
+   * (lower distance = higher similarity) and converts to cosine similarity
+   * as `1 - distance` so the returned `score` matches the rest of the
+   * package (`[0, 1]`, higher is more similar).
+   *
+   * Honors `topK`, `threshold`, and an optional `tags` filter (native
+   * `tags && $tags` overlap query — much faster than the meta-key path).
+   *
+   * Throws {@link CacheUnsupportedError} when `options.vector` was not
+   * configured at driver setup; throws {@link CacheConfigurationError} when
+   * the pgvector extension is missing or the query vector's dimension count
+   * doesn't match the configured one.
+   */
+  similar<T = any>(vector: number[], options: CacheSimilarOptions): Promise<CacheSimilarHit<T>[]>;
+}
+//#endregion
+export { PgCacheDriver };
+//# sourceMappingURL=pg-cache-driver.d.mts.map

package/esm/drivers/pg-cache-driver.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pg-cache-driver.d.mts","names":[],"sources":["../../../../../../@warlock.js/cache/src/drivers/pg-cache-driver.ts"],"mappings":";;;;;;AAkDA;;;;;;;;;;;;;;;;;;;;;;;;;;cAAa,aAAA,SACH,eAAA,CAAgB,YAAA,EAAc,cAAA,aAC3B,WAAA,CAAY,YAAA,EAAc,cAAA;EA2eV;;;EAtepB,IAAA;EALI;;;;EAAA,UAWD,WAAA;EAZ4B;;;;;EAmB/B,UAAA,CAAW,OAAA,EAAS,cAAA;EAApB;;;;;;EAAA,UAsCS,iBAAA,CAAA,GAAqB,OAAA;EAqCvB;;;;;EAAA,UARJ,YAAA,CAAa,MAAA;EAuChB;;;;EAAA,cA/BO,KAAA,CAAA;EA2FD;;;;EAAA,cAnFC,QAAA,CAAA,GAAY,YAAA;EAsFE;;;;EAAA,UA9ElB,cAAA,CAAe,GAAA,YAAe,IAAA;EA6MvB;;;;;;;EA9LV,MAAA,CAAA;EAkSkB;;;EA3PZ,OAAA,CAAA,GAAO,OAAA;EA4QS;;;;;EA/PhB,UAAA,CAAA,GAAU,OAAA;EAyTrB;;;EAjTW,GAAA,CACX,GAAA,EAAK,QAAA,EACL,KAAA,OACA,YAAA,GAAe,QAAA,GAAW,eAAA,GACzB,OAAA;EA+SQ;;;EAjLE,GAAA,CAAI,GAAA,EAAK,QAAA,GAAQ,OAAA;;;;;;YAwDd,QAAA,CAAS,GAAA,EAAK,QAAA,GAAW,OAAA,CAAQ,SAAA;;;;EA4CpC,MAAA,CAAO,GAAA,EAAK,QAAA,GAAQ,OAAA;;;;;;;EAiBpB,eAAA,CAAgB,SAAA,WAAiB,OAAA;;;;;;;;EA4BjC,KAAA,CAAA,GAAK,OAAA;;;;;;;;;;;;;;;;;EA6BL,OAAA,SAAA,CACX,MAAA,YACA,OAAA,EAAS,mBAAA,GACR,OAAA,CAAQ,eAAA,CAAgB,CAAA;AAAA"}