@wild-framework/cache-auto 0.2.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,30 @@
+# @wild-framework/cache-auto
+
+Env-driven cache provider for [Wild Framework](https://github.com/KhandaSoftware/wild-framework).
+
+## Install
+
+```bash
+pnpm add @wild-framework/cache-auto
+```
+
+## Usage
+
+Register `CacheProvider` and set `REDIS_URL` to swap backends without touching app code:
+
+```ts
+import { CacheProvider } from "@wild-framework/cache-auto";
+
+CacheProvider.keyPrefix = "app:"; // optional (Redis only)
+
+app.register(CacheProvider);
+```
+
+| `REDIS_URL`          | Backend             |
+| -------------------- | ------------------- |
+| `redis://…` / `rediss://…` | Redis (node-redis) |
+| unset / anything else | In-memory (dev)    |
+
+## License
+
+MIT

package/dist/classify.d.ts

@@ -0,0 +1,10 @@
+/** Which concrete cache backend an env var maps to. */
+export type CacheBackend = "redis" | "memory";
+/**
+ * Classify a cache connection URL.
+ *
+ *   redis://… / rediss://…  → "redis"
+ *   anything else/undefined → "memory"
+ */
+export declare function classifyCacheUrl(url: string | undefined): CacheBackend;
+//# sourceMappingURL=classify.d.ts.map

package/dist/classify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classify.d.ts","sourceRoot":"","sources":["../src/classify.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE9C;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,CAItE"}

package/dist/classify.js

@@ -0,0 +1,14 @@
+/**
+ * Classify a cache connection URL.
+ *
+ *   redis://… / rediss://…  → "redis"
+ *   anything else/undefined → "memory"
+ */
+export function classifyCacheUrl(url) {
+    if (!url)
+        return "memory";
+    if (url.startsWith("redis://") || url.startsWith("rediss://"))
+        return "redis";
+    return "memory";
+}
+//# sourceMappingURL=classify.js.map

package/dist/classify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"classify.js","sourceRoot":"","sources":["../src/classify.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAuB;IACpD,IAAI,CAAC,GAAG;QAAE,OAAO,QAAQ,CAAC;IAC1B,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC;QAAE,OAAO,OAAO,CAAC;IAC9E,OAAO,QAAQ,CAAC;AACpB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { CacheProvider } from "./provider.js";
+export { classifyCacheUrl } from "./classify.js";
+export type { CacheBackend } from "./classify.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,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { CacheProvider } from "./provider.js";
+export { classifyCacheUrl } from "./classify.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,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}

package/dist/provider.d.ts

@@ -0,0 +1,32 @@
+import type { Provider, Application } from "@wild-framework/core";
+/**
+ * Unified, env-driven cache provider.
+ *
+ * Selects a concrete driver from `REDIS_URL` and binds a `Cache` into the
+ * container. This is the "one provider to rule them all" — register it and
+ * set `REDIS_URL` to swap backends without touching app code:
+ *
+ *   REDIS_URL=redis://…   → RedisCacheDriver
+ *   (unset)               → InMemoryCacheDriver
+ *
+ * Static configuration (no-arg constructor requirement):
+ *
+ * ```ts
+ * CacheProvider.keyPrefix = "app:"; // optional (Redis only)
+ * ```
+ *
+ * The explicit providers (`CacheProvider` from `@wild-framework/cache` and
+ * `RedisCacheProvider` from `@wild-framework/cache-redis`) remain available
+ * when you want to be explicit.
+ */
+export declare class CacheProvider implements Provider {
+    /** Redis connection string. Overrides `process.env.REDIS_URL` when set. */
+    static url: string | undefined;
+    /** Optional prefix prepended to every key (Redis only). */
+    static keyPrefix: string | undefined;
+    private driver;
+    register(app: Application): void;
+    boot(): Promise<void>;
+    shutdown(): Promise<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;AAMlE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,aAAc,YAAW,QAAQ;IAC1C,2EAA2E;IAC3E,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,2DAA2D;IAC3D,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC,OAAO,CAAC,MAAM,CAA+B;IAE7C,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAa1B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAGlC"}

package/dist/provider.js

@@ -0,0 +1,50 @@
+import { Container } from "@wild-framework/container";
+import { Cache, InMemoryCacheDriver } from "@wild-framework/cache";
+import { RedisCacheDriver } from "@wild-framework/cache-redis";
+import { classifyCacheUrl } from "./classify.js";
+/**
+ * Unified, env-driven cache provider.
+ *
+ * Selects a concrete driver from `REDIS_URL` and binds a `Cache` into the
+ * container. This is the "one provider to rule them all" — register it and
+ * set `REDIS_URL` to swap backends without touching app code:
+ *
+ *   REDIS_URL=redis://…   → RedisCacheDriver
+ *   (unset)               → InMemoryCacheDriver
+ *
+ * Static configuration (no-arg constructor requirement):
+ *
+ * ```ts
+ * CacheProvider.keyPrefix = "app:"; // optional (Redis only)
+ * ```
+ *
+ * The explicit providers (`CacheProvider` from `@wild-framework/cache` and
+ * `RedisCacheProvider` from `@wild-framework/cache-redis`) remain available
+ * when you want to be explicit.
+ */
+export class CacheProvider {
+    /** Redis connection string. Overrides `process.env.REDIS_URL` when set. */
+    static url;
+    /** Optional prefix prepended to every key (Redis only). */
+    static keyPrefix;
+    driver;
+    register(app) {
+        const container = app.resolve(Container);
+        const url = CacheProvider.url ?? process.env.REDIS_URL;
+        if (classifyCacheUrl(url) === "redis") {
+            const driver = new RedisCacheDriver({ url, keyPrefix: CacheProvider.keyPrefix });
+            this.driver = driver;
+            container.singleton(Cache, () => new Cache(driver));
+        }
+        else {
+            container.singleton(Cache, () => new Cache(new InMemoryCacheDriver()));
+        }
+    }
+    async boot() {
+        await this.driver?.connect();
+    }
+    async shutdown() {
+        await this.driver?.close();
+    }
+}
+//# 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,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,aAAa;IACtB,2EAA2E;IAC3E,MAAM,CAAC,GAAG,CAAqB;IAC/B,2DAA2D;IAC3D,MAAM,CAAC,SAAS,CAAqB;IAE7B,MAAM,CAA+B;IAE7C,QAAQ,CAAC,GAAgB;QACrB,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;QAEvD,IAAI,gBAAgB,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,SAAS,EAAE,CAAC,CAAC;YACjF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACJ,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAC,CAAC;QAC3E,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI;QACN,MAAM,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,MAAM,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;IAC/B,CAAC;CACJ"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@wild-framework/cache-auto",
+  "version": "0.2.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": "Env-driven cache provider — auto-selects Redis or in-memory from REDIS_URL.",
+  "keywords": [
+    "wild",
+    "framework",
+    "cache",
+    "redis",
+    "ttl",
+    "auto"
+  ],
+  "dependencies": {
+    "@wild-framework/container": "0.2.0",
+    "@wild-framework/core": "0.2.0",
+    "@wild-framework/cache-redis": "0.2.0",
+    "@wild-framework/cache": "0.2.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "vitest run"
+  }
+}