@wild-framework/cache 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wild Framework contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+# @wild-framework/cache
+
+Cache abstraction for [Wild Framework](https://github.com/your-org/wild-framework).
+
+## Install
+
+```bash
+pnpm add @wild-framework/cache
+```
+
+## Usage
+
+```ts
+import { Cache } from "@wild-framework/cache";
+
+await cache.set("user:1", user, 60_000); // TTL in ms
+const cached = await cache.get("user:1");
+await cache.has("user:1");
+await cache.delete("user:1");
+await cache.flush();
+```
+
+Ships with an in-memory driver with TTL support. Implement `CacheDriver` for Redis.
+
+## License
+
+MIT

package/dist/cache.d.ts

@@ -0,0 +1,22 @@
+import type { CacheDriver } from "./driver.js";
+/**
+ * Cache facade.
+ *
+ * Wraps a `CacheDriver` and exposes a consistent API.
+ * Resolved from the container: `app.resolve(Cache)`.
+ */
+export declare class Cache {
+    private driver;
+    constructor(driver: CacheDriver);
+    /** Get a value. Returns `undefined` if missing or expired. */
+    get<T>(key: string): Promise<T | undefined>;
+    /** Set a value with an optional TTL in milliseconds. */
+    set<T>(key: string, value: T, ttlMs?: number): Promise<void>;
+    /** Delete a key. */
+    delete(key: string): Promise<void>;
+    /** Check whether a key exists and is not expired. */
+    has(key: string): Promise<boolean>;
+    /** Remove all keys. */
+    flush(): Promise<void>;
+}
+//# sourceMappingURL=cache.d.ts.map

package/dist/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C;;;;;GAKG;AACH,qBAAa,KAAK;IACF,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEvC,8DAA8D;IAC9D,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAI3C,wDAAwD;IACxD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5D,oBAAoB;IACpB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,qDAAqD;IACrD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlC,uBAAuB;IACvB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGzB"}

package/dist/cache.js

@@ -0,0 +1,33 @@
+/**
+ * Cache facade.
+ *
+ * Wraps a `CacheDriver` and exposes a consistent API.
+ * Resolved from the container: `app.resolve(Cache)`.
+ */
+export class Cache {
+    driver;
+    constructor(driver) {
+        this.driver = driver;
+    }
+    /** Get a value. Returns `undefined` if missing or expired. */
+    get(key) {
+        return this.driver.get(key);
+    }
+    /** Set a value with an optional TTL in milliseconds. */
+    set(key, value, ttlMs) {
+        return this.driver.set(key, value, ttlMs);
+    }
+    /** Delete a key. */
+    delete(key) {
+        return this.driver.delete(key);
+    }
+    /** Check whether a key exists and is not expired. */
+    has(key) {
+        return this.driver.has(key);
+    }
+    /** Remove all keys. */
+    flush() {
+        return this.driver.flush();
+    }
+}
+//# sourceMappingURL=cache.js.map

package/dist/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,OAAO,KAAK;IACM;IAApB,YAAoB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE3C,8DAA8D;IAC9D,GAAG,CAAI,GAAW;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAI,GAAG,CAAC,CAAC;IACnC,CAAC;IAED,wDAAwD;IACxD,GAAG,CAAI,GAAW,EAAE,KAAQ,EAAE,KAAc;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED,oBAAoB;IACpB,MAAM,CAAC,GAAW;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAED,qDAAqD;IACrD,GAAG,CAAC,GAAW;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,uBAAuB;IACvB,KAAK;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;CACJ"}

package/dist/driver.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Cache driver contract.
+ *
+ * Implement this for Redis, Memcached, or any backend.
+ * App code depends on `Cache`, never on a driver directly.
+ */
+export interface CacheDriver {
+    /** Get a value. Returns `undefined` if missing or expired. */
+    get<T>(key: string): Promise<T | undefined>;
+    /** Set a value with an optional TTL in milliseconds. */
+    set<T>(key: string, value: T, ttlMs?: number): Promise<void>;
+    /** Delete a key. */
+    delete(key: string): Promise<void>;
+    /** Check whether a key exists and is not expired. */
+    has(key: string): Promise<boolean>;
+    /** Remove all keys. */
+    flush(): Promise<void>;
+}
+//# sourceMappingURL=driver.d.ts.map

package/dist/driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../src/driver.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IACxB,8DAA8D;IAC9D,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAC5C,wDAAwD;IACxD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,oBAAoB;IACpB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,qDAAqD;IACrD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACnC,uBAAuB;IACvB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B"}

package/dist/driver.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=driver.js.map

package/dist/driver.js.map

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

package/dist/in-memory-driver.d.ts

@@ -0,0 +1,16 @@
+import type { CacheDriver } from "./driver.js";
+/**
+ * In-memory cache driver.
+ *
+ * Map-backed with TTL expiry. Intended for development and testing.
+ */
+export declare class InMemoryCacheDriver implements CacheDriver {
+    private store;
+    get<T>(key: string): Promise<T | undefined>;
+    set<T>(key: string, value: T, ttlMs?: number): Promise<void>;
+    delete(key: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    flush(): Promise<void>;
+    private isExpired;
+}
+//# sourceMappingURL=in-memory-driver.d.ts.map

package/dist/in-memory-driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"in-memory-driver.d.ts","sourceRoot":"","sources":["../src/in-memory-driver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAQ/C;;;;GAIG;AACH,qBAAa,mBAAoB,YAAW,WAAW;IACnD,OAAO,CAAC,KAAK,CAA4B;IAEnC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAa3C,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5D,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAalC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,OAAO,CAAC,SAAS;CAGpB"}

package/dist/in-memory-driver.js

@@ -0,0 +1,44 @@
+/**
+ * In-memory cache driver.
+ *
+ * Map-backed with TTL expiry. Intended for development and testing.
+ */
+export class InMemoryCacheDriver {
+    store = new Map();
+    async get(key) {
+        const entry = this.store.get(key);
+        if (!entry)
+            return undefined;
+        if (this.isExpired(entry)) {
+            this.store.delete(key);
+            return undefined;
+        }
+        return entry.value;
+    }
+    async set(key, value, ttlMs) {
+        this.store.set(key, {
+            value,
+            expiresAt: ttlMs !== undefined ? Date.now() + ttlMs : undefined,
+        });
+    }
+    async delete(key) {
+        this.store.delete(key);
+    }
+    async has(key) {
+        const entry = this.store.get(key);
+        if (!entry)
+            return false;
+        if (this.isExpired(entry)) {
+            this.store.delete(key);
+            return false;
+        }
+        return true;
+    }
+    async flush() {
+        this.store.clear();
+    }
+    isExpired(entry) {
+        return entry.expiresAt !== undefined && Date.now() > entry.expiresAt;
+    }
+}
+//# sourceMappingURL=in-memory-driver.js.map

package/dist/in-memory-driver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"in-memory-driver.js","sourceRoot":"","sources":["../src/in-memory-driver.ts"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IACpB,KAAK,GAAG,IAAI,GAAG,EAAiB,CAAC;IAEzC,KAAK,CAAC,GAAG,CAAI,GAAW;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAE7B,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,OAAO,KAAK,CAAC,KAAU,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAQ,EAAE,KAAc;QAC9C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YAChB,KAAK;YACL,SAAS,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS;SAClE,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACpB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACjB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QAEzB,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAEO,SAAS,CAAC,KAAY;QAC1B,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC;IACzE,CAAC;CACJ"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { Cache } from "./cache.js";
+export { CacheProvider } from "./provider.js";
+export { InMemoryCacheDriver } from "./in-memory-driver.js";
+export type { CacheDriver } from "./driver.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { Cache } from "./cache.js";
+export { CacheProvider } from "./provider.js";
+export { InMemoryCacheDriver } from "./in-memory-driver.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/provider.d.ts

@@ -0,0 +1,11 @@
+import type { Provider, Application } from "@wild-framework/core";
+/**
+ * Registers the cache with the application.
+ *
+ * Binds a `Cache` backed by the in-memory driver. Swap drivers by
+ * implementing `CacheDriver` and binding a new `Cache`.
+ */
+export declare class CacheProvider implements Provider {
+    register(app: Application): void;
+}
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAKlE;;;;;GAKG;AACH,qBAAa,aAAc,YAAW,QAAQ;IAC1C,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;CAKnC"}

package/dist/provider.js

@@ -0,0 +1,17 @@
+import { Container } from "@wild-framework/container";
+import { Cache } from "./cache.js";
+import { InMemoryCacheDriver } from "./in-memory-driver.js";
+/**
+ * Registers the cache with the application.
+ *
+ * Binds a `Cache` backed by the in-memory driver. Swap drivers by
+ * implementing `CacheDriver` and binding a new `Cache`.
+ */
+export class CacheProvider {
+    register(app) {
+        const container = app.resolve(Container);
+        const cache = new Cache(new InMemoryCacheDriver());
+        container.singleton(Cache, () => cache);
+    }
+}
+//# sourceMappingURL=provider.js.map

package/dist/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IACtB,QAAQ,CAAC,GAAgB;QACrB,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAC;QACnD,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;CACJ"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@wild-framework/cache",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "author": "Sphah",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KhandaSoftware/wild-framework.git"
+  },
+  "description": "Cache abstraction for Wild Framework.",
+  "keywords": [
+    "wild",
+    "framework",
+    "cache",
+    "redis",
+    "ttl"
+  ],
+  "dependencies": {
+    "@wild-framework/core": "0.1.0",
+    "@wild-framework/container": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "vitest run"
+  }
+}