@chat-adapter/state-ioredis 4.29.0 → 4.31.0

package/README.md

@@ -1,26 +1,40 @@
 # @chat-adapter/state-ioredis
 
+> npm package: [`@chat-adapter/state-ioredis`](https://www.npmjs.com/package/@chat-adapter/state-ioredis)
+
 [![npm version](https://img.shields.io/npm/v/@chat-adapter/state-ioredis)](https://www.npmjs.com/package/@chat-adapter/state-ioredis)
 [![npm downloads](https://img.shields.io/npm/dm/@chat-adapter/state-ioredis)](https://www.npmjs.com/package/@chat-adapter/state-ioredis)
 
 Alternative Redis state adapter for [Chat SDK](https://chat-sdk.dev) using [ioredis](https://www.npmjs.com/package/ioredis). Use this if you already have ioredis in your project or need Redis Cluster/Sentinel support.
 
+Documentation: [chat-sdk.dev/adapters/official/ioredis](https://chat-sdk.dev/adapters/official/ioredis) · Guides: [vercel.com/kb/chat-sdk](https://vercel.com/kb/chat-sdk)
+
 ## Installation
 
 ```bash
 pnpm add @chat-adapter/state-ioredis
 ```
 
+## Scaffold with the CLI
+
+To scaffold a new Slack bot that uses ioredis for state:
+
+```bash
+npx create-chat-sdk@latest my-bot --adapter slack ioredis
+```
+
+Visit the [adapters directory](https://chat-sdk.dev/adapters) to see other available official and vendor-official adapters.
+
 ## Usage
 
 ```typescript
 import { Chat } from "chat";
-import { createIORedisState } from "@chat-adapter/state-ioredis";
+import { createIoRedisState } from "@chat-adapter/state-ioredis";
 
 const bot = new Chat({
   userName: "mybot",
   adapters: { /* ... */ },
-  state: createIORedisState({
+  state: createIoRedisState({
     url: process.env.REDIS_URL!,
   }),
 });
@@ -33,7 +47,7 @@ import Redis from "ioredis";
 
 const client = new Redis("redis://localhost:6379");
 
-const state = createIORedisState({ client });
+const state = createIoRedisState({ client });
 ```
 
 ## Configuration
@@ -43,6 +57,7 @@ const state = createIORedisState({ client });
 | `url` | Yes* | Redis connection URL |
 | `client` | No | Existing `ioredis` client instance |
 | `keyPrefix` | No | Prefix for all keys (default: `"chat-sdk"`) |
+| `logger` | No | Logger for error reporting (default: console logger) |
 
 *Either `url` or `client` is required.
 
@@ -82,6 +97,26 @@ const state = createIORedisState({ client });
 | Redis Sentinel support | Yes |
 | Key prefix namespacing | Yes |
 
+## AI Coding Agents
+
+If you use an AI coding agent such as OpenAI Codex, Claude Code, or Cursor, install the Chat SDK skill so it knows the SDK APIs, adapter patterns, and project conventions before writing code.
+
+```bash
+npx skills add vercel/chat
+```
+
+The skill references bundled documentation in `node_modules/chat/docs`, plus adapter guides and starter templates in the published package.
+
+You can also install the [Vercel Plugin](https://vercel.com/docs/agent-resources/vercel-plugin) for a broader agent toolkit — it includes the Chat SDK skill alongside specialist agents, agent slash commands, and more:
+
+```bash
+npx plugins add vercel/vercel-plugin
+```
+
+The plugin is optional; the skill alone is enough to build with Chat SDK.
+
+For agent-readable documentation, see [chat-sdk.dev/llms.txt](https://chat-sdk.dev/llms.txt) (page index) or [chat-sdk.dev/llms-full.txt](https://chat-sdk.dev/llms-full.txt) (full text).
+
 ## License
 
 MIT

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { Logger, StateAdapter, Lock, QueueEntry } from 'chat';
+import { StateAdapter, Logger, Lock, QueueEntry } from 'chat';
 import Redis from 'ioredis';
 
 interface IoRedisStateAdapterUrlOptions {
     /** Key prefix for all Redis keys (default: "chat-sdk") */
     keyPrefix?: string;
-    /** Logger instance for error reporting */
-    logger: Logger;
+    /** Logger instance for error reporting (default: console logger) */
+    logger?: Logger;
     /** Redis connection URL (e.g., redis://localhost:6379) */
     url: string;
 }
@@ -14,8 +14,8 @@ interface IoRedisStateAdapterClientOptions {
     client: Redis;
     /** Key prefix for all Redis keys (default: "chat-sdk") */
     keyPrefix?: string;
-    /** Logger instance for error reporting */
-    logger: Logger;
+    /** Logger instance for error reporting (default: console logger) */
+    logger?: Logger;
 }
 type IoRedisStateAdapterOptions = IoRedisStateAdapterUrlOptions | IoRedisStateAdapterClientOptions;
 /**

package/dist/index.js

@@ -1,4 +1,5 @@
 // src/index.ts
+import { ConsoleLogger } from "chat";
 import Redis from "ioredis";
 var IoRedisStateAdapter = class {
   client;
@@ -16,7 +17,7 @@ var IoRedisStateAdapter = class {
       this.ownsClient = true;
     }
     this.keyPrefix = options.keyPrefix || "chat-sdk";
-    this.logger = options.logger;
+    this.logger = options.logger ?? new ConsoleLogger("info").child("ioredis");
     this.client.on("error", (err) => {
       this.logger.error("ioredis client error", { error: err });
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chat-adapter/state-ioredis",
-  "version": "4.29.0",
-  "description": "ioredis state adapter for chat (production)",
+  "version": "4.31.0",
+  "description": "ioredis state adapter for Chat SDK — production state with Redis Cluster and Sentinel support via ioredis",
   "type": "module",
   "engines": {
     "node": ">=20"
@@ -20,14 +20,14 @@
   ],
   "dependencies": {
     "ioredis": "^5.4.1",
-    "chat": "4.29.0"
+    "chat": "4.31.0"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vercel/chat.git",
     "directory": "packages/state-ioredis"
   },
-  "homepage": "https://github.com/vercel/chat#readme",
+  "homepage": "https://chat-sdk.dev/adapters/official/ioredis",
   "bugs": {
     "url": "https://github.com/vercel/chat/issues"
   },
@@ -42,10 +42,20 @@
   },
   "keywords": [
     "chat",
+    "chat-sdk",
     "state",
+    "state-adapter",
     "ioredis",
     "redis",
-    "production"
+    "redis-cluster",
+    "sentinel",
+    "subscriptions",
+    "distributed-lock",
+    "cache",
+    "queues",
+    "production",
+    "typescript",
+    "vercel"
   ],
   "license": "MIT",
   "scripts": {