@zeltjs/redis 0.0.1 → 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 9wick / Kohei Kido
+
+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

@@ -1,45 +1,36 @@
 # @zeltjs/redis
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+[![Documentation](https://img.shields.io/badge/docs-zeltjs.com-blue)](https://zeltjs.com)
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+Redis integration for Zelt applications.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+**[Read the Documentation](https://zeltjs.com)**
 
-## Purpose
+## Installation
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@zeltjs/redis`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+```bash
+npm install @zeltjs/redis @zeltjs/core
+```
 
-## What is OIDC Trusted Publishing?
+## Usage
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+```typescript
+import { createApp, Controller, Get, inject } from '@zeltjs/core';
+import { RedisConfig, RedisService } from '@zeltjs/redis';
 
-## Setup Instructions
+@Controller('/cache')
+class CacheController {
+  constructor(private redis = inject(RedisService)) {}
 
-To properly configure OIDC trusted publishing for this package:
+  @Get('/:key')
+  async get(key: string) {
+    const value = await this.redis.get(key);
+    return { value };
+  }
+}
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+const app = createApp({
+  http: { controllers: [CacheController] },
+  configs: [RedisConfig],
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { t as RedisConfig } from "./redis.config-r7UIae2S.js";
+import { Lifecycle, LifecycleManager } from "@zeltjs/core";
+import Redis from "ioredis";
+
+//#region src/redis.service.d.ts
+declare class RedisService implements Lifecycle {
+  private readonly _client;
+  constructor(config?: RedisConfig, lifecycle?: LifecycleManager);
+  get client(): Redis;
+  startup(): Promise<void>;
+  shutdown(): Promise<void>;
+}
+//#endregion
+export { RedisConfig, RedisService };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/redis.service.ts"],"mappings":";;;;;cAOa,YAAA,YAAwB,SAAA;EAAA,iBAClB,OAAA;cAEL,MAAA,GAAM,WAAA,EAAwB,SAAA,GAAS,gBAAA;EAAA,IAK/C,MAAA,CAAA,GAAU,KAAA;EAIR,OAAA,CAAA,GAAW,OAAA;EAEX,QAAA,CAAA,GAAY,OAAA;AAAA"}

package/dist/index.js

@@ -0,0 +1,35 @@
+import { t as RedisConfig } from "./redis.config-DvXFWRzU.js";
+import { Injectable, LifecycleManager, inject } from "@zeltjs/core";
+import Redis from "ioredis";
+//#region src/redis.service.ts
+function _ts_decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+function _ts_metadata(k, v) {
+	if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+var RedisService = class {
+	get client() {
+		return this._client;
+	}
+	async startup() {}
+	async shutdown() {
+		this._client.disconnect();
+	}
+	constructor(config = inject(RedisConfig), lifecycle = inject(LifecycleManager)) {
+		this._client = new Redis(config.url, config.options);
+		lifecycle.register(this);
+	}
+};
+RedisService = _ts_decorate([
+	Injectable(),
+	_ts_metadata("design:type", Function),
+	_ts_metadata("design:paramtypes", [void 0, void 0])
+], RedisService);
+//#endregion
+export { RedisConfig, RedisService };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Injectable","inject","LifecycleManager","Redis","RedisConfig","RedisService","client","_client","startup","shutdown","disconnect","config","lifecycle","url","options","register"],"sources":["../src/redis.service.ts"],"sourcesContent":["import type { Lifecycle } from '@zeltjs/core';\nimport { Injectable, inject, LifecycleManager } from '@zeltjs/core';\nimport Redis from 'ioredis';\n\nimport { RedisConfig } from './redis.config';\n\n@Injectable()\nexport class RedisService implements Lifecycle {\n  private readonly _client: Redis;\n\n  constructor(config = inject(RedisConfig), lifecycle = inject(LifecycleManager)) {\n    this._client = new Redis(config.url, config.options);\n    lifecycle.register(this);\n  }\n\n  get client(): Redis {\n    return this._client;\n  }\n\n  async startup(): Promise<void> {}\n\n  async shutdown(): Promise<void> {\n    this._client.disconnect();\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAOA,IAAaK,eAAb,MAAaA;CAQX,IAAIC,SAAgB;AAClB,SAAO,KAAKC;;CAGd,MAAMC,UAAyB;CAE/B,MAAMC,WAA0B;AAC9B,OAAKF,QAAQG,YAAU;;CAZzB,YAAYC,SAASV,OAAOG,YAAY,EAAEQ,YAAYX,OAAOC,iBAAiB,EAAE;AAC9E,OAAKK,UAAU,IAAIJ,MAAMQ,OAAOE,KAAKF,OAAOG,QAAO;AACnDF,YAAUG,SAAS,KAAI"}

package/dist/redis.config-DvXFWRzU.js

@@ -0,0 +1,31 @@
+import { Config, EnvService, inject } from "@zeltjs/core";
+//#region src/redis.config.ts
+function _ts_decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+function _ts_metadata(k, v) {
+	if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+var RedisConfig = class {
+	get url() {
+		return this.env.getString("REDIS_URL", "redis://localhost:6379");
+	}
+	get options() {
+		return {};
+	}
+	constructor(env = inject(EnvService)) {
+		this.env = env;
+	}
+};
+RedisConfig = _ts_decorate([
+	Config,
+	_ts_metadata("design:type", Function),
+	_ts_metadata("design:paramtypes", [void 0])
+], RedisConfig);
+//#endregion
+export { RedisConfig as t };
+
+//# sourceMappingURL=redis.config-DvXFWRzU.js.map

package/dist/redis.config-DvXFWRzU.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.config-DvXFWRzU.js","names":["Config","EnvService","inject","RedisConfig","url","env","getString","options"],"sources":["../src/redis.config.ts"],"sourcesContent":["import { Config, EnvService, inject } from '@zeltjs/core';\nimport type { RedisOptions } from 'ioredis';\n\n@Config\nexport class RedisConfig {\n  constructor(private env = inject(EnvService)) {}\n\n  get url(): string {\n    return this.env.getString('REDIS_URL', 'redis://localhost:6379');\n  }\n\n  get options(): RedisOptions {\n    return {};\n  }\n}\n"],"mappings":";;;;;;;;;;;AAIA,IAAaG,cAAb,MAAaA;CAGX,IAAIC,MAAc;AAChB,SAAO,KAAKC,IAAIC,UAAU,aAAa,yBAAA;;CAGzC,IAAIC,UAAwB;AAC1B,SAAO,EAAC;;CAPV,YAAY,MAAcL,OAAOD,WAAW,EAAE;OAA1BI,MAAAA"}

package/dist/redis.config-r7UIae2S.d.ts

@@ -0,0 +1,13 @@
+import { EnvService } from "@zeltjs/core";
+import { RedisOptions } from "ioredis";
+
+//#region src/redis.config.d.ts
+declare class RedisConfig {
+  private env;
+  constructor(env?: EnvService);
+  get url(): string;
+  get options(): RedisOptions;
+}
+//#endregion
+export { RedisConfig as t };
+//# sourceMappingURL=redis.config-r7UIae2S.d.ts.map

package/dist/redis.config-r7UIae2S.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.config-r7UIae2S.d.ts","names":[],"sources":["../src/redis.config.ts"],"mappings":";;;;cAIa,WAAA;EAAA,QACS,GAAA;cAAA,GAAA,GAAG,UAAA;EAAA,IAEnB,GAAA,CAAA;EAAA,IAIA,OAAA,CAAA,GAAW,YAAA;AAAA"}

package/dist/testing/index.d.ts

@@ -0,0 +1,17 @@
+import { t as RedisConfig } from "../redis.config-r7UIae2S.js";
+import { Lifecycle, LifecycleManager } from "@zeltjs/core";
+
+//#region src/testing/redis-test-container.config.d.ts
+declare class RedisTestContainerConfig extends RedisConfig implements Lifecycle {
+  private container;
+  private connectionUrl;
+  constructor(lifecycle?: LifecycleManager);
+  protected get image(): string;
+  startup(): Promise<void>;
+  shutdown(): Promise<void>;
+  get url(): string;
+  get options(): RedisConfig['options'];
+}
+//#endregion
+export { RedisTestContainerConfig };
+//# sourceMappingURL=index.d.ts.map

package/dist/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/testing/redis-test-container.config.ts"],"mappings":";;;;cAQa,wBAAA,SAAiC,WAAA,YAAuB,SAAA;EAAA,QAC3D,SAAA;EAAA,QACA,aAAA;cAEI,SAAA,GAAS,gBAAA;EAAA,cAKP,KAAA,CAAA;EAIR,OAAA,CAAA,GAAW,OAAA;EAOX,QAAA,CAAA,GAAY,OAAA;EAAA,IAIL,GAAA,CAAA;EAAA,IAIA,OAAA,CAAA,GAAW,WAAA;AAAA"}

package/dist/testing/index.js

@@ -0,0 +1,46 @@
+import { t as RedisConfig } from "../redis.config-DvXFWRzU.js";
+import { Config, LifecycleManager, inject } from "@zeltjs/core";
+import { GenericContainer } from "testcontainers";
+//#region src/testing/redis-test-container.config.ts
+function _ts_decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+function _ts_metadata(k, v) {
+	if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+var RedisTestContainerConfig = class extends RedisConfig {
+	get image() {
+		return "redis:7-alpine";
+	}
+	async startup() {
+		this.container = await new GenericContainer(this.image).withExposedPorts(6379).start();
+		const host = this.container.getHost();
+		const port = this.container.getMappedPort(6379);
+		this.connectionUrl = `redis://${host}:${port}`;
+	}
+	async shutdown() {
+		await this.container?.stop();
+	}
+	get url() {
+		return this.connectionUrl;
+	}
+	get options() {
+		return {};
+	}
+	constructor(lifecycle = inject(LifecycleManager)) {
+		super(), this.connectionUrl = "";
+		lifecycle.register(this);
+	}
+};
+RedisTestContainerConfig = _ts_decorate([
+	Config,
+	_ts_metadata("design:type", Function),
+	_ts_metadata("design:paramtypes", [void 0])
+], RedisTestContainerConfig);
+//#endregion
+export { RedisTestContainerConfig };
+
+//# sourceMappingURL=index.js.map

package/dist/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Config","inject","LifecycleManager","GenericContainer","RedisConfig","RedisTestContainerConfig","image","startup","container","withExposedPorts","start","host","getHost","port","getMappedPort","connectionUrl","shutdown","stop","url","options","lifecycle","register"],"sources":["../../src/testing/redis-test-container.config.ts"],"sourcesContent":["import type { Lifecycle } from '@zeltjs/core';\nimport { Config, inject, LifecycleManager } from '@zeltjs/core';\nimport type { StartedTestContainer } from 'testcontainers';\nimport { GenericContainer } from 'testcontainers';\n\nimport { RedisConfig } from '../redis.config';\n\n@Config\nexport class RedisTestContainerConfig extends RedisConfig implements Lifecycle {\n  private container: StartedTestContainer | undefined;\n  private connectionUrl = '';\n\n  constructor(lifecycle = inject(LifecycleManager)) {\n    super();\n    lifecycle.register(this);\n  }\n\n  protected get image(): string {\n    return 'redis:7-alpine';\n  }\n\n  async startup(): Promise<void> {\n    this.container = await new GenericContainer(this.image).withExposedPorts(6379).start();\n    const host = this.container.getHost();\n    const port = this.container.getMappedPort(6379);\n    this.connectionUrl = `redis://${host}:${port}`;\n  }\n\n  async shutdown(): Promise<void> {\n    await this.container?.stop();\n  }\n\n  override get url(): string {\n    return this.connectionUrl;\n  }\n\n  override get options(): RedisConfig['options'] {\n    return {};\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAQA,IAAaK,2BAAb,cAA8CD,YAAAA;CAS5C,IAAcE,QAAgB;AAC5B,SAAO;;CAGT,MAAMC,UAAyB;AAC7B,OAAKC,YAAY,MAAM,IAAIL,iBAAiB,KAAKG,MAAK,CAAEG,iBAAiB,KAAA,CAAMC,OAAK;EACpF,MAAMC,OAAO,KAAKH,UAAUI,SAAO;EACnC,MAAMC,OAAO,KAAKL,UAAUM,cAAc,KAAA;AAC1C,OAAKC,gBAAgB,WAAWJ,KAAK,GAAGE;;CAG1C,MAAMG,WAA0B;AAC9B,QAAM,KAAKR,WAAWS,MAAAA;;CAGxB,IAAaC,MAAc;AACzB,SAAO,KAAKH;;CAGd,IAAaI,UAAkC;AAC7C,SAAO,EAAC;;CAzBV,YAAYC,YAAYnB,OAAOC,iBAAiB,EAAE;AAChD,SAAK,EAAA,KAHCa,gBAAgB;AAItBK,YAAUC,SAAS,KAAI"}

package/package.json

@@ -1,10 +1,57 @@
 {
   "name": "@zeltjs/redis",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @zeltjs/redis",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+  "version": "0.5.0",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zeltjs/zelt.git",
+    "directory": "packages/redis"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "import": "./dist/testing/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "testcontainers": ">=10 <12",
+    "@zeltjs/core": "0.5.0",
+    "@zeltjs/testing": "0.5.0"
+  },
+  "peerDependenciesMeta": {
+    "@zeltjs/testing": {
+      "optional": true
+    },
+    "testcontainers": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "ioredis": "5.10.1"
+  },
+  "devDependencies": {
+    "@types/node": "22.19.17",
+    "testcontainers": "10.25.0",
+    "@zeltjs/testing": "0.5.0",
+    "@zeltjs/core": "0.5.0"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "typecheck": "tsc -b"
+  }
+}