@h-ai/cache 1.0.0-beta.19 → 1.0.0-beta.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.en.md +199 -36
  2. package/README.ja.md +233 -72
  3. package/README.md +234 -73
  4. package/package.json +2 -2
package/README.en.md CHANGED
@@ -4,38 +4,9 @@
4
4
 
5
5
  [Framework home](../../README.en.md) · Related modules: [@h-ai/core](../core/README.en.md)
6
6
 
7
- ## Introduction
8
-
9
7
  A unified cache module. The `cache` object provides KV / Hash / List / Set / ZSet / distributed lock operations with Memory and Redis backends.
10
8
 
11
- Memory KV entries expire at their expiration time. `incr/decr/incrBy/decrBy` accept only safe integers or integer strings; invalid increments and overflow return `OPERATION_FAILED` without changing the original value. Hash names such as `__proto__` / `constructor` remain ordinary fields and do not change the returned object's prototype.
12
-
13
- Memory KV, Hash, List, Set, and ZSet share one key namespace. `exists/expire/expireAt/ttl/persist/keys/scan/del/type` cover every structure; structure operations also treat expired keys as absent. del counts logical keys actually removed, and structure operations on another key type fail.
14
-
15
- Connections become available only after a successful health check. Failed initialization disposes its candidate; `error.ext.cleanupPending === true` identifies cleanup that still needs retry. `cache.close()` returns `Promise<HaiResult<void>>`, waits for initialization, and coalesces concurrent close calls. Once cleanup starts, `isInitialized` is false and configuration/operations are unavailable. A failed cleanup retains the resource: the next `close()` or `init()` retries disposal before allocating a replacement. Always inspect the close result.
16
-
17
- ```ts
18
- const closed = await cache.close()
19
- if (!closed.success) {
20
- // Retry once after addressing the cleanup failure; report another failure.
21
- const retried = await cache.close()
22
- if (!retried.success)
23
- throw new Error(retried.error.message)
24
- }
25
- ```
26
-
27
- Redis falls back to disconnect when QUIT fails, and reports success only after releasing the client.
28
-
29
- ## Core features
30
-
31
- - In-memory caching for development and tests
32
- - Redis caching in production (standalone, URL, Cluster, Sentinel)
33
- - Set caches for IAM sessions and permissions
34
- - Distributed locks for mutual exclusion across nodes
35
-
36
- ## Getting started
37
-
38
- ### Quick start
9
+ ## Quick Start
39
10
 
40
11
  ```ts
41
12
  import { cache } from '@h-ai/cache'
@@ -63,6 +34,188 @@ finally {
63
34
 
64
35
  `cache.config` returns a **redacted configuration snapshot**. Redis credential fields such as `password` / `url` are sanitized automatically; do not use the snapshot to write back original secrets.
65
36
 
37
+ ## Features
38
+
39
+ Memory KV entries expire at their expiration time. `incr/decr/incrBy/decrBy` accept only safe integers or integer strings; invalid increments and overflow return `OPERATION_FAILED` without changing the original value. Hash names such as `__proto__` / `constructor` remain ordinary fields and do not change the returned object's prototype.
40
+
41
+ Memory KV, Hash, List, Set, and ZSet share one key namespace. `exists/expire/expireAt/ttl/persist/keys/scan/del/type` cover every structure; structure operations also treat expired keys as absent. del counts logical keys actually removed, and structure operations on another key type fail.
42
+
43
+ Connections become available only after a successful health check. Failed initialization disposes its candidate; `error.ext.cleanupPending === true` identifies cleanup that still needs retry. `cache.close()` returns `Promise<HaiResult<void>>`, waits for initialization, and coalesces concurrent close calls. Once cleanup starts, `isInitialized` is false and configuration/operations are unavailable. A failed cleanup retains the resource: the next `close()` or `init()` retries disposal before allocating a replacement. Always inspect the close result.
44
+
45
+ ```ts
46
+ const closed = await cache.close()
47
+ if (!closed.success) {
48
+ // Retry once after addressing the cleanup failure; report another failure.
49
+ const retried = await cache.close()
50
+ if (!retried.success)
51
+ throw new Error(retried.error.message)
52
+ }
53
+ ```
54
+
55
+ Redis falls back to disconnect when QUIT fails, and reports success only after releasing the client.
56
+
57
+ ### Operations and results
58
+
59
+ Use the complete initialization flow in this section first. The host validates and authorizes example business values; check success before reading data from asynchronous domain results. Here void means completion without data, null means absent; synchronous factories/tools return the listed type directly.
60
+
61
+ key/keys identify business keys, field/fields hash fields, value/members JSON values; start/stop/index are indexes, min/max score bounds; seconds/ttl/timeout are seconds, timestamp Unix seconds; owner must come from acquire.
62
+
63
+ #### cache.kv
64
+
65
+ Cache JSON snapshots: get/mget yield values/null in input order; set takes TTL/NX/XX and returns applied boolean; mset takes [key,value][] and yields void.
66
+
67
+ | Entry | Input parameters | Successful result | Call example |
68
+ | --------------- | ------------------- | ----------------- | ---------------------------------------------------------- |
69
+ | `cache.kv.get` | key | `T \| null` | `await cache.kv.get('u:1')` |
70
+ | `cache.kv.set` | key, value, options | `boolean` | `await cache.kv.set('u:1', { name: 'Alice' }, { ex: 60 })` |
71
+ | `cache.kv.mget` | keys | `(T \| null)[]` | `await cache.kv.mget('u:1', 'u:2')` |
72
+ | `cache.kv.mset` | entries | `void` | `await cache.kv.mset([['u:1', { name: 'Alice' }]])` |
73
+
74
+ #### cache.kv
75
+
76
+ Versioned cross-node commit: key, expected, value and expiry atomically return applied; undefined means absent/delete, a mismatch preserves data and TTL.
77
+
78
+ | Entry | Input parameters | Successful result | Call example |
79
+ | ------------------------- | ----------------------------- | ----------------- | ------------------------------------------------ |
80
+ | `cache.kv.compareAndSwap` | key, expected, value, options | `boolean` | `await cache.kv.compareAndSwap('version', 1, 2)` |
81
+
82
+ #### cache.kv
83
+
84
+ Manage all structures by key: del/exists take keys and return deleted/existing counts; type takes one key and returns its structure name.
85
+
86
+ | Entry | Input parameters | Successful result | Call example |
87
+ | ----------------- | ---------------- | ----------------- | ------------------------------------- |
88
+ | `cache.kv.del` | keys | `number` | `await cache.kv.del('u:1', 'u:2')` |
89
+ | `cache.kv.exists` | keys | `number` | `await cache.kv.exists('u:1', 'u:2')` |
90
+ | `cache.kv.type` | key | `string` | `await cache.kv.type('u:1')` |
91
+
92
+ #### cache.kv
93
+
94
+ Retention: relative seconds, Unix seconds or key set/read/remove TTL. Changes yield boolean; ttl yields seconds (-1 persistent, -2 absent).
95
+
96
+ | Entry | Input parameters | Successful result | Call example |
97
+ | ------------------- | ---------------- | ----------------- | -------------------------------------------------------------------- |
98
+ | `cache.kv.expire` | key, seconds | `boolean` | `await cache.kv.expire('u:1', 60)` |
99
+ | `cache.kv.expireAt` | key, timestamp | `boolean` | `await cache.kv.expireAt('u:1', Math.floor(Date.now() / 1000) + 60)` |
100
+ | `cache.kv.ttl` | key | `number` | `await cache.kv.ttl('u:1')` |
101
+ | `cache.kv.persist` | key | `boolean` | `await cache.kv.persist('u:1')` |
102
+
103
+ #### cache.kv
104
+
105
+ Counters take a key and optional integer delta and return the new safe integer; invalid type/overflow fails without changing data.
106
+
107
+ | Entry | Input parameters | Successful result | Call example |
108
+ | ----------------- | ---------------- | ----------------- | ----------------------------------- |
109
+ | `cache.kv.incr` | key | `number` | `await cache.kv.incr('hits')` |
110
+ | `cache.kv.incrBy` | key, increment | `number` | `await cache.kv.incrBy('hits', 2)` |
111
+ | `cache.kv.decr` | key | `number` | `await cache.kv.decr('stock')` |
112
+ | `cache.kv.decrBy` | key, decrement | `number` | `await cache.kv.decrBy('stock', 2)` |
113
+
114
+ #### cache.kv
115
+
116
+ Enumeration: keys takes a glob and yields keys; scan takes an opaque cursor and match/count and yields [nextCursor,keys], without snapshot or uniqueness guarantees.
117
+
118
+ | Entry | Input parameters | Successful result | Call example |
119
+ | --------------- | ---------------- | -------------------- | -------------------------------------------------------- |
120
+ | `cache.kv.keys` | pattern | `string[]` | `await cache.kv.keys('u:*')` |
121
+ | `cache.kv.scan` | cursor, options | `[string, string[]]` | `await cache.kv.scan('0', { match: 'u:*', count: 100 })` |
122
+
123
+ #### cache.hash
124
+
125
+ Field cache accepts key plus fields/object/delta. Reads yield value/null, object, field/value arrays or length; hset/hdel count additions/deletions, hexists yields boolean, hincrBy the new integer.
126
+
127
+ | Entry | Input parameters | Successful result | Call example |
128
+ | -------------------- | --------------------- | ----------------- | ----------------------------------------------- |
129
+ | `cache.hash.hget` | key, field | `T \| null` | `await cache.hash.hget('u:1', 'name')` |
130
+ | `cache.hash.hset` | key, field, value | `number` | `await cache.hash.hset('u:1', 'name', 'Alice')` |
131
+ | `cache.hash.hdel` | key, fields | `number` | `await cache.hash.hdel('u:1', 'name')` |
132
+ | `cache.hash.hexists` | key, field | `boolean` | `await cache.hash.hexists('u:1', 'name')` |
133
+ | `cache.hash.hgetall` | key | `T` | `await cache.hash.hgetall('u:1')` |
134
+ | `cache.hash.hkeys` | key | `string[]` | `await cache.hash.hkeys('u:1')` |
135
+ | `cache.hash.hvals` | key | `T[]` | `await cache.hash.hvals('u:1')` |
136
+ | `cache.hash.hlen` | key | `number` | `await cache.hash.hlen('u:1')` |
137
+ | `cache.hash.hmget` | key, fields | `(T \| null)[]` | `await cache.hash.hmget('u:1', 'name', 'age')` |
138
+ | `cache.hash.hincrBy` | key, field, increment | `number` | `await cache.hash.hincrBy('u:1', 'visits', 1)` |
139
+
140
+ #### cache.list
141
+
142
+ Ordered queues use key, values and index/range: push returns length, pop/index value/null, range an array, set/trim void. Blocking pops take seconds and keys and return [key,value]/null.
143
+
144
+ | Entry | Input parameters | Successful result | Call example |
145
+ | ------------------- | ----------------- | --------------------- | ------------------------------------------------- |
146
+ | `cache.list.lpush` | key, values | `number` | `await cache.list.lpush('jobs', 'job-1')` |
147
+ | `cache.list.rpush` | key, values | `number` | `await cache.list.rpush('jobs', 'job-2')` |
148
+ | `cache.list.lpop` | key | `T \| null` | `await cache.list.lpop('jobs')` |
149
+ | `cache.list.rpop` | key | `T \| null` | `await cache.list.rpop('jobs')` |
150
+ | `cache.list.llen` | key | `number` | `await cache.list.llen('jobs')` |
151
+ | `cache.list.lrange` | key, start, stop | `T[]` | `await cache.list.lrange('jobs', 0, 9)` |
152
+ | `cache.list.lindex` | key, index | `T \| null` | `await cache.list.lindex('jobs', 0)` |
153
+ | `cache.list.lset` | key, index, value | `void` | `await cache.list.lset('jobs', 0, 'replacement')` |
154
+ | `cache.list.ltrim` | key, start, stop | `void` | `await cache.list.ltrim('jobs', 0, 99)` |
155
+ | `cache.list.blpop` | timeout, keys | `[string, T] \| null` | `await cache.list.blpop(5, 'jobs')` |
156
+ | `cache.list.brpop` | timeout, keys | `[string, T] \| null` | `await cache.list.brpop(5, 'jobs')` |
157
+
158
+ #### cache.set_
159
+
160
+ Deduplication/set operations: key+members add/remove/test with count/boolean; members returns an array, card a count, random/pop a member/array/null by count, intersections/unions/differences take keys and yield arrays.
161
+
162
+ | Entry | Input parameters | Successful result | Call example |
163
+ | ------------------------ | ---------------- | ------------------ | ----------------------------------------------- |
164
+ | `cache.set_.sadd` | key, members | `number` | `await cache.set_.sadd('roles', 'editor')` |
165
+ | `cache.set_.srem` | key, members | `number` | `await cache.set_.srem('roles', 'editor')` |
166
+ | `cache.set_.smembers` | key | `T[]` | `await cache.set_.smembers('roles')` |
167
+ | `cache.set_.sismember` | key, member | `boolean` | `await cache.set_.sismember('roles', 'editor')` |
168
+ | `cache.set_.scard` | key | `number` | `await cache.set_.scard('roles')` |
169
+ | `cache.set_.srandmember` | key, count | `T \| T[] \| null` | `await cache.set_.srandmember('roles', 2)` |
170
+ | `cache.set_.spop` | key, count | `T \| T[] \| null` | `await cache.set_.spop('roles', 1)` |
171
+ | `cache.set_.sinter` | keys | `T[]` | `await cache.set_.sinter('roles:a', 'roles:b')` |
172
+ | `cache.set_.sunion` | keys | `T[]` | `await cache.set_.sunion('roles:a', 'roles:b')` |
173
+ | `cache.set_.sdiff` | keys | `T[]` | `await cache.set_.sdiff('roles:a', 'roles:b')` |
174
+
175
+ #### cache.zset
176
+
177
+ Rankings accept members/scores or rank/score ranges; adds/removals yield counts, score/rank number/null, ranges member/scored-object arrays, incrBy the new score, card/count counts.
178
+
179
+ | Entry | Input parameters | Successful result | Call example |
180
+ | ----------------------------- | ---------------------------- | ----------------------- | ------------------------------------------------------------------------- |
181
+ | `cache.zset.zadd` | key, members | `number` | `await cache.zset.zadd('scores', { member: 'u1', score: 10 })` |
182
+ | `cache.zset.zrem` | key, members | `number` | `await cache.zset.zrem('scores', 'u1')` |
183
+ | `cache.zset.zscore` | key, member | `number \| null` | `await cache.zset.zscore('scores', 'u1')` |
184
+ | `cache.zset.zrank` | key, member | `number \| null` | `await cache.zset.zrank('scores', 'u1')` |
185
+ | `cache.zset.zrevrank` | key, member | `number \| null` | `await cache.zset.zrevrank('scores', 'u1')` |
186
+ | `cache.zset.zrange` | key, start, stop, withScores | `string[] \| ZMember[]` | `await cache.zset.zrange('scores', 0, 9, true)` |
187
+ | `cache.zset.zrevrange` | key, start, stop, withScores | `string[] \| ZMember[]` | `await cache.zset.zrevrange('scores', 0, 9, true)` |
188
+ | `cache.zset.zrangeByScore` | key, min, max, options | `string[] \| ZMember[]` | `await cache.zset.zrangeByScore('scores', 10, 100, { withScores: true })` |
189
+ | `cache.zset.zcard` | key | `number` | `await cache.zset.zcard('scores')` |
190
+ | `cache.zset.zcount` | key, min, max | `number` | `await cache.zset.zcount('scores', 10, 100)` |
191
+ | `cache.zset.zincrBy` | key, increment, member | `number` | `await cache.zset.zincrBy('scores', 5, 'u1')` |
192
+ | `cache.zset.zremRangeByRank` | key, start, stop | `number` | `await cache.zset.zremRangeByRank('scores', 0, 9)` |
193
+ | `cache.zset.zremRangeByScore` | key, min, max | `number` | `await cache.zset.zremRangeByScore('scores', 0, 10)` |
194
+
195
+ #### cache.lock
196
+
197
+ Short leases: acquire takes key/TTL and yields owner/null; release/extend require owner and yield boolean; isLocked only observes. A lease does not replace resource-side CAS.
198
+
199
+ | Entry | Input parameters | Successful result | Call example |
200
+ | --------------------- | ---------------- | ----------------- | ------------------------------------------------ |
201
+ | `cache.lock.acquire` | key, options | `string \| null` | `await cache.lock.acquire('daily', { ttl: 30 })` |
202
+ | `cache.lock.release` | key, owner | `boolean` | `await cache.lock.release('daily', owner)` |
203
+ | `cache.lock.isLocked` | key | `boolean` | `await cache.lock.isLocked('daily')` |
204
+ | `cache.lock.extend` | key, ttl, owner | `boolean` | `await cache.lock.extend('daily', 60, owner)` |
205
+
206
+ #### cache
207
+
208
+ Health check with no arguments; returns the backend response string or a connection failure.
209
+
210
+ | Entry | Input parameters | Successful result | Call example |
211
+ | ------------ | ---------------- | ----------------- | -------------------- |
212
+ | `cache.ping` | No arguments | `string` | `await cache.ping()` |
213
+
214
+ - In-memory caching for development and tests
215
+ - Redis caching in production (standalone, URL, Cluster, Sentinel)
216
+ - Set caches for IAM sessions and permissions
217
+ - Distributed locks for mutual exclusion across nodes
218
+
66
219
  ### Initialization options
67
220
 
68
221
  ```ts
@@ -158,7 +311,21 @@ if (acquired.success && acquired.data)
158
311
 
159
312
  The owner token only protects lease renewal and release; it is not a resource fencing token. A paused task can resume after expiry. Final writes require CAS, generation predicates or transactional constraints in the resource store; renewal or returning a failure afterwards cannot prevent a stale commit.
160
313
 
161
- ### Error codes
314
+ ### Production shared state
315
+
316
+ Production requires Redis (including Cluster); memory is for development/explicit tests. Redis errors fail rather than falling back locally. Initialization checks apply when NODE_ENV or HAI_CORE_ENV is production; only explicit HAI_E2E=1/HAI_E2E_MOCK=1 tests are exempt. [State, concurrency and recovery (Chinese)](../../.agents/instructions/distributed-state.md).
317
+
318
+ ## Configuration
319
+
320
+ Lifecycle: init takes backend/business configuration; use the module only after success. Await close before releasing borrowed dependencies. Follow the quick-start example and public signatures for exact return values.
321
+
322
+ The host loads and validates configuration before passing it to this module. Keep secrets in private server environment files. Select the backend, capacity, deadlines and logging for the actual use case; reinitialize and check the result after changes.
323
+
324
+ [Per-option purpose, use cases and examples](../../docs/usage/configuration/data.md).
325
+
326
+ ## Error Handling
327
+
328
+ Check result.success for domain operations. Handle failures with the module error definitions and safe messages; retain codes, correlation IDs and sanitized causes in server logs. Synchronous tools, factories, stream iteration and lifecycle calls follow their own signatures. A completed Promise alone is not business success. See each feature for recovery limits.
162
329
 
163
330
  All operations return `HaiResult<T>`. Common error codes:
164
331
 
@@ -174,11 +341,7 @@ All operations return `HaiResult<T>`. Common error codes:
174
341
  | `HaiCacheError.UNSUPPORTED_TYPE` | `hai:cache:011` | Unsupported cache type |
175
342
  | `HaiCacheError.CONFIG_ERROR` | `hai:cache:012` | Invalid configuration |
176
343
 
177
- ## Production shared state
178
-
179
- Production requires Redis (including Cluster); memory is for development/explicit tests. Redis errors fail rather than falling back locally. Initialization checks apply when NODE_ENV or HAI_CORE_ENV is production; only explicit HAI_E2E=1/HAI_E2E_MOCK=1 tests are exempt. [State, concurrency and recovery (Chinese)](../../.agents/instructions/distributed-state.md)。
180
-
181
- ## Development and testing
344
+ ## Development
182
345
 
183
346
  ```bash
184
347
  pnpm --filter @h-ai/cache test
package/README.ja.md CHANGED
@@ -4,38 +4,9 @@
4
4
 
5
5
  [フレームワークのホーム](../../README.ja.md) · 関連モジュール:[@h-ai/core](../core/README.ja.md)
6
6
 
7
- ## 概要
8
-
9
7
  統一されたキャッシュモジュールです。`cache` オブジェクトで KV / Hash / List / Set / ZSet / 分散ロックを操作し、メモリーと Redis のバックエンドに対応します。
10
8
 
11
- メモリー KV は有効期限に達した時点で無効になります。`incr/decr/incrBy/decrBy` は安全な整数値または整数文字列のみを受け付け、不正な増分やオーバーフローでは元の値を保持して `OPERATION_FAILED` を返します。Hash の `__proto__` / `constructor` などは通常のフィールドとして保持され、戻り値のオブジェクトのプロトタイプを変更しません。
12
-
13
- Memory の KV・Hash・List・Set・ZSet は一つの key 名前空間を共有します。`exists/expire/expireAt/ttl/persist/keys/scan/del/type` は全構造を対象とし、期限切れ key は構造操作でも直ちに存在しないものとして扱います。del は実際に削除した論理 key を数え、異なる型の構造操作は失敗します。
14
-
15
- 接続はヘルスチェック成功後に公開します。初期化失敗時は候補リソースを解放し、解放にも失敗した場合は初期化エラーの `error.ext.cleanupPending` が `true` になります。`cache.close()` は `Promise<HaiResult<void>>` を返し、初期化を待機して並行する終了処理をまとめます。解放開始後は `isInitialized` が `false` となり、設定と操作は利用できません。解放に失敗したリソースは保持され、次の `close()` または `init()` で再試行します。解放が成功するまで代替接続は作成しません。終了結果を必ず確認してください。
16
-
17
- ```ts
18
- const closed = await cache.close()
19
- if (!closed.success) {
20
- // 障害への対処後に一度再試行し、再失敗はアプリへ報告します。
21
- const retried = await cache.close()
22
- if (!retried.success)
23
- throw new Error(retried.error.message)
24
- }
25
- ```
26
-
27
- Redis の QUIT が失敗した場合は disconnect で切断し、解放が完了した場合のみ成功を返します。
28
-
29
- ## 主な機能
30
-
31
- - 開発・テスト用のメモリーキャッシュ
32
- - 本番環境の Redis キャッシュ(単一ノード、URL、Cluster、Sentinel)
33
- - IAM セッション・権限用の集合キャッシュ
34
- - 複数ノード間の排他制御に使う分散ロック
35
-
36
- ## 使い始める
37
-
38
- ### クイックスタート
9
+ ## クイックスタート
39
10
 
40
11
  ```ts
41
12
  import { cache } from '@h-ai/cache'
@@ -63,51 +34,187 @@ finally {
63
34
 
64
35
  `cache.config` は**機密情報をマスクした設定スナップショット**を返します。Redis の `password` / `url` などの認証情報は自動処理されるため、元の秘密情報を書き戻す用途には使わないでください。
65
36
 
66
- ### 初期化設定
37
+ ## 機能
38
+
39
+ メモリー KV は有効期限に達した時点で無効になります。`incr/decr/incrBy/decrBy` は安全な整数値または整数文字列のみを受け付け、不正な増分やオーバーフローでは元の値を保持して `OPERATION_FAILED` を返します。Hash の `__proto__` / `constructor` などは通常のフィールドとして保持され、戻り値のオブジェクトのプロトタイプを変更しません。
40
+
41
+ Memory の KV・Hash・List・Set・ZSet は一つの key 名前空間を共有します。`exists/expire/expireAt/ttl/persist/keys/scan/del/type` は全構造を対象とし、期限切れ key は構造操作でも直ちに存在しないものとして扱います。del は実際に削除した論理 key を数え、異なる型の構造操作は失敗します。
42
+
43
+ 接続はヘルスチェック成功後に公開します。初期化失敗時は候補リソースを解放し、解放にも失敗した場合は初期化エラーの `error.ext.cleanupPending` が `true` になります。`cache.close()` は `Promise<HaiResult<void>>` を返し、初期化を待機して並行する終了処理をまとめます。解放開始後は `isInitialized` が `false` となり、設定と操作は利用できません。解放に失敗したリソースは保持され、次の `close()` または `init()` で再試行します。解放が成功するまで代替接続は作成しません。終了結果を必ず確認してください。
67
44
 
68
45
  ```ts
69
- // Memory(开发/测试)
70
- await cache.init({ type: 'memory' })
46
+ const closed = await cache.close()
47
+ if (!closed.success) {
48
+ // 障害への対処後に一度再試行し、再失敗はアプリへ報告します。
49
+ const retried = await cache.close()
50
+ if (!retried.success)
51
+ throw new Error(retried.error.message)
52
+ }
53
+ ```
71
54
 
72
- // Redis 单机
73
- await cache.init({
74
- type: 'redis',
75
- host: 'localhost',
76
- port: 6379,
77
- password: 'secret',
78
- db: 0,
79
- })
55
+ Redis の QUIT が失敗した場合は disconnect で切断し、解放が完了した場合のみ成功を返します。
80
56
 
81
- // Redis URL(优先级最高)
82
- await cache.init({
83
- type: 'redis',
84
- url: 'redis://:password@localhost:6379/0',
85
- })
57
+ ### 操作と入出力
86
58
 
87
- // Redis 集群
88
- await cache.init({
89
- type: 'redis',
90
- cluster: [
91
- { host: 'node1', port: 6379 },
92
- { host: 'node2', port: 6379 },
93
- ],
94
- })
59
+ 本節の完全な初期化手順を先に実行します。例の業務値はホストが検証・認可し、非同期領域結果は success を確認してから data を読みます。void はデータなし完了、null は不存在、同期ファクトリー/ツールは表の型を直接返します。
95
60
 
96
- // Redis 哨兵
97
- await cache.init({
98
- type: 'redis',
99
- sentinel: {
100
- sentinels: [
101
- { host: 'sentinel1', port: 26379 }
102
- ],
103
- name: 'mymaster',
104
- },
105
- })
106
- ```
61
+ key/keys は業務キー、field/fields はハッシュ項目、value/members は JSON 値。start/stop/index は添字、min/max は点数範囲、seconds/ttl/timeout は秒、timestamp は Unix 秒。owner は acquire の戻り値。
107
62
 
108
- `cache.init(config)` は組み込み memory/redis を選択します。Provider は内部契約であり、独自バックエンドの登録 API はありません。
63
+ #### cache.kv
109
64
 
110
- `password` は単独・Cluster・Sentinel のデータノードに使用され、発見・リダイレクト後の接続にも適用します。`url` 指定時は URL 内の認証情報を使用し、独立した password フィールドでは上書きしません。
65
+ JSON スナップショットを保存。get/mget は値/null(入力順)、set は TTL/NX/XX と適用 boolean、mset は [key,value][] から void。
66
+
67
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
68
+ | --------------- | ------------------- | --------------- | ---------------------------------------------------------- |
69
+ | `cache.kv.get` | key | `T \| null` | `await cache.kv.get('u:1')` |
70
+ | `cache.kv.set` | key, value, options | `boolean` | `await cache.kv.set('u:1', { name: 'Alice' }, { ex: 60 })` |
71
+ | `cache.kv.mget` | keys | `(T \| null)[]` | `await cache.kv.mget('u:1', 'u:2')` |
72
+ | `cache.kv.mset` | entries | `void` | `await cache.kv.mset([['u:1', { name: 'Alice' }]])` |
73
+
74
+ #### cache.kv
75
+
76
+ ノード間の版付き確定。key・expected・value・期限を原子的に比較し applied を返す。undefined は不存在/削除、不一致時は値と TTL を保持。
77
+
78
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
79
+ | ------------------------- | ----------------------------- | --------- | ------------------------------------------------ |
80
+ | `cache.kv.compareAndSwap` | key, expected, value, options | `boolean` | `await cache.kv.compareAndSwap('version', 1, 2)` |
81
+
82
+ #### cache.kv
83
+
84
+ 全構造をキー単位で管理。del/exists は複数キーから削除数/存在数、type は単一キーから構造名を返す。
85
+
86
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
87
+ | ----------------- | -------- | -------- | ------------------------------------- |
88
+ | `cache.kv.del` | keys | `number` | `await cache.kv.del('u:1', 'u:2')` |
89
+ | `cache.kv.exists` | keys | `number` | `await cache.kv.exists('u:1', 'u:2')` |
90
+ | `cache.kv.type` | key | `string` | `await cache.kv.type('u:1')` |
91
+
92
+ #### cache.kv
93
+
94
+ 保存期限を管理。相対秒・Unix 秒・キーで TTL を設定/照会/解除。変更は boolean、ttl は秒(-1 無期限、-2 不存在)。
95
+
96
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
97
+ | ------------------- | -------------- | --------- | -------------------------------------------------------------------- |
98
+ | `cache.kv.expire` | key, seconds | `boolean` | `await cache.kv.expire('u:1', 60)` |
99
+ | `cache.kv.expireAt` | key, timestamp | `boolean` | `await cache.kv.expireAt('u:1', Math.floor(Date.now() / 1000) + 60)` |
100
+ | `cache.kv.ttl` | key | `number` | `await cache.kv.ttl('u:1')` |
101
+ | `cache.kv.persist` | key | `boolean` | `await cache.kv.persist('u:1')` |
102
+
103
+ #### cache.kv
104
+
105
+ カウンターはキーと整数増分から更新後の安全な整数を返す。型不正・桁あふれは元値を変更せず失敗。
106
+
107
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
108
+ | ----------------- | -------------- | -------- | ----------------------------------- |
109
+ | `cache.kv.incr` | key | `number` | `await cache.kv.incr('hits')` |
110
+ | `cache.kv.incrBy` | key, increment | `number` | `await cache.kv.incrBy('hits', 2)` |
111
+ | `cache.kv.decr` | key | `number` | `await cache.kv.decr('stock')` |
112
+ | `cache.kv.decrBy` | key, decrement | `number` | `await cache.kv.decrBy('stock', 2)` |
113
+
114
+ #### cache.kv
115
+
116
+ 列挙。keys は glob からキー配列、scan は不透明カーソルと match/count から [次カーソル,キー配列]。スナップショット・一意性保証なし。
117
+
118
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
119
+ | --------------- | --------------- | -------------------- | -------------------------------------------------------- |
120
+ | `cache.kv.keys` | pattern | `string[]` | `await cache.kv.keys('u:*')` |
121
+ | `cache.kv.scan` | cursor, options | `[string, string[]]` | `await cache.kv.scan('0', { match: 'u:*', count: 100 })` |
122
+
123
+ #### cache.hash
124
+
125
+ フィールド保存。キーとフィールド/配列/オブジェクト/増分を入力。読取は値/null・オブジェクト・配列・長さ、hset/hdel は件数、hexists は boolean、hincrBy は更新整数。
126
+
127
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
128
+ | -------------------- | --------------------- | --------------- | ----------------------------------------------- |
129
+ | `cache.hash.hget` | key, field | `T \| null` | `await cache.hash.hget('u:1', 'name')` |
130
+ | `cache.hash.hset` | key, field, value | `number` | `await cache.hash.hset('u:1', 'name', 'Alice')` |
131
+ | `cache.hash.hdel` | key, fields | `number` | `await cache.hash.hdel('u:1', 'name')` |
132
+ | `cache.hash.hexists` | key, field | `boolean` | `await cache.hash.hexists('u:1', 'name')` |
133
+ | `cache.hash.hgetall` | key | `T` | `await cache.hash.hgetall('u:1')` |
134
+ | `cache.hash.hkeys` | key | `string[]` | `await cache.hash.hkeys('u:1')` |
135
+ | `cache.hash.hvals` | key | `T[]` | `await cache.hash.hvals('u:1')` |
136
+ | `cache.hash.hlen` | key | `number` | `await cache.hash.hlen('u:1')` |
137
+ | `cache.hash.hmget` | key, fields | `(T \| null)[]` | `await cache.hash.hmget('u:1', 'name', 'age')` |
138
+ | `cache.hash.hincrBy` | key, field, increment | `number` | `await cache.hash.hincrBy('u:1', 'visits', 1)` |
139
+
140
+ #### cache.list
141
+
142
+ 順序キュー。キー・値・添字/範囲を入力し push は長さ、pop/index は値/null、range は配列、set/trim は void。阻塞 pop は秒数とキーから [key,value]/null。
143
+
144
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
145
+ | ------------------- | ----------------- | --------------------- | ------------------------------------------------- |
146
+ | `cache.list.lpush` | key, values | `number` | `await cache.list.lpush('jobs', 'job-1')` |
147
+ | `cache.list.rpush` | key, values | `number` | `await cache.list.rpush('jobs', 'job-2')` |
148
+ | `cache.list.lpop` | key | `T \| null` | `await cache.list.lpop('jobs')` |
149
+ | `cache.list.rpop` | key | `T \| null` | `await cache.list.rpop('jobs')` |
150
+ | `cache.list.llen` | key | `number` | `await cache.list.llen('jobs')` |
151
+ | `cache.list.lrange` | key, start, stop | `T[]` | `await cache.list.lrange('jobs', 0, 9)` |
152
+ | `cache.list.lindex` | key, index | `T \| null` | `await cache.list.lindex('jobs', 0)` |
153
+ | `cache.list.lset` | key, index, value | `void` | `await cache.list.lset('jobs', 0, 'replacement')` |
154
+ | `cache.list.ltrim` | key, start, stop | `void` | `await cache.list.ltrim('jobs', 0, 99)` |
155
+ | `cache.list.blpop` | timeout, keys | `[string, T] \| null` | `await cache.list.blpop(5, 'jobs')` |
156
+ | `cache.list.brpop` | timeout, keys | `[string, T] \| null` | `await cache.list.brpop(5, 'jobs')` |
157
+
158
+ #### cache.set_
159
+
160
+ 重複排除・集合演算。キーと要素の追加/削除/判定は件数/boolean。members は配列、card は数、random/pop は count により要素/配列/null、積/和/差は複数キーから配列。
161
+
162
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
163
+ | ------------------------ | ------------ | ------------------ | ----------------------------------------------- |
164
+ | `cache.set_.sadd` | key, members | `number` | `await cache.set_.sadd('roles', 'editor')` |
165
+ | `cache.set_.srem` | key, members | `number` | `await cache.set_.srem('roles', 'editor')` |
166
+ | `cache.set_.smembers` | key | `T[]` | `await cache.set_.smembers('roles')` |
167
+ | `cache.set_.sismember` | key, member | `boolean` | `await cache.set_.sismember('roles', 'editor')` |
168
+ | `cache.set_.scard` | key | `number` | `await cache.set_.scard('roles')` |
169
+ | `cache.set_.srandmember` | key, count | `T \| T[] \| null` | `await cache.set_.srandmember('roles', 2)` |
170
+ | `cache.set_.spop` | key, count | `T \| T[] \| null` | `await cache.set_.spop('roles', 1)` |
171
+ | `cache.set_.sinter` | keys | `T[]` | `await cache.set_.sinter('roles:a', 'roles:b')` |
172
+ | `cache.set_.sunion` | keys | `T[]` | `await cache.set_.sunion('roles:a', 'roles:b')` |
173
+ | `cache.set_.sdiff` | keys | `T[]` | `await cache.set_.sdiff('roles:a', 'roles:b')` |
174
+
175
+ #### cache.zset
176
+
177
+ ランキングは要素・score・順位/点数範囲を入力。追加/削除は件数、score/rank は数/null、range は要素/点数付き配列、incrBy は更新点、card/count は件数。
178
+
179
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
180
+ | ----------------------------- | ---------------------------- | ----------------------- | ------------------------------------------------------------------------- |
181
+ | `cache.zset.zadd` | key, members | `number` | `await cache.zset.zadd('scores', { member: 'u1', score: 10 })` |
182
+ | `cache.zset.zrem` | key, members | `number` | `await cache.zset.zrem('scores', 'u1')` |
183
+ | `cache.zset.zscore` | key, member | `number \| null` | `await cache.zset.zscore('scores', 'u1')` |
184
+ | `cache.zset.zrank` | key, member | `number \| null` | `await cache.zset.zrank('scores', 'u1')` |
185
+ | `cache.zset.zrevrank` | key, member | `number \| null` | `await cache.zset.zrevrank('scores', 'u1')` |
186
+ | `cache.zset.zrange` | key, start, stop, withScores | `string[] \| ZMember[]` | `await cache.zset.zrange('scores', 0, 9, true)` |
187
+ | `cache.zset.zrevrange` | key, start, stop, withScores | `string[] \| ZMember[]` | `await cache.zset.zrevrange('scores', 0, 9, true)` |
188
+ | `cache.zset.zrangeByScore` | key, min, max, options | `string[] \| ZMember[]` | `await cache.zset.zrangeByScore('scores', 10, 100, { withScores: true })` |
189
+ | `cache.zset.zcard` | key | `number` | `await cache.zset.zcard('scores')` |
190
+ | `cache.zset.zcount` | key, min, max | `number` | `await cache.zset.zcount('scores', 10, 100)` |
191
+ | `cache.zset.zincrBy` | key, increment, member | `number` | `await cache.zset.zincrBy('scores', 5, 'u1')` |
192
+ | `cache.zset.zremRangeByRank` | key, start, stop | `number` | `await cache.zset.zremRangeByRank('scores', 0, 9)` |
193
+ | `cache.zset.zremRangeByScore` | key, min, max | `number` | `await cache.zset.zremRangeByScore('scores', 0, 10)` |
194
+
195
+ #### cache.lock
196
+
197
+ 短期排他。acquire はキー/TTL から owner/null、release/extend は owner 必須で boolean、isLocked は観測のみ。資源側 CAS の代用ではない。
198
+
199
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
200
+ | --------------------- | --------------- | ---------------- | ------------------------------------------------ |
201
+ | `cache.lock.acquire` | key, options | `string \| null` | `await cache.lock.acquire('daily', { ttl: 30 })` |
202
+ | `cache.lock.release` | key, owner | `boolean` | `await cache.lock.release('daily', owner)` |
203
+ | `cache.lock.isLocked` | key | `boolean` | `await cache.lock.isLocked('daily')` |
204
+ | `cache.lock.extend` | key, ttl, owner | `boolean` | `await cache.lock.extend('daily', 60, owner)` |
205
+
206
+ #### cache
207
+
208
+ 引数なしの健全性確認。バックエンド応答文字列、接続障害は失敗。
209
+
210
+ | 入口 | 入力引数 | 成功結果 | 呼出し例 |
211
+ | ------------ | -------- | -------- | -------------------- |
212
+ | `cache.ping` | 引数なし | `string` | `await cache.ping()` |
213
+
214
+ - 開発・テスト用のメモリーキャッシュ
215
+ - 本番環境の Redis キャッシュ(単一ノード、URL、Cluster、Sentinel)
216
+ - IAM セッション・権限用の集合キャッシュ
217
+ - 複数ノード間の排他制御に使う分散ロック
111
218
 
112
219
  ### API 一覧
113
220
 
@@ -158,7 +265,65 @@ if (acquired.success && acquired.data)
158
265
 
159
266
  owner はリース延長・解除の所有権であり、リソースの fencing token ではありません。停止した処理は期限切れ後も再開できるため、最終書込には保存先の CAS・世代条件・トランザクション制約が必要です。延長や処理後の失敗返却だけでは旧書込を防げません。
160
267
 
161
- ### エラーコード
268
+ ### 本番の共有状態
269
+
270
+ 本番は Redis(Cluster を含む)が必須です。memory は開発・明示的テスト用であり、Redis 障害時もローカルへフォールバックしません。 NODE_ENV または HAI_CORE_ENV が production の場合、初期化成功前に検証します。明示的な HAI_E2E=1/HAI_E2E_MOCK=1 テストのみ除外します。 [状態・並行制御・復旧範囲(中国語)](../../.agents/instructions/distributed-state.md).
271
+
272
+ ## 設定
273
+
274
+ ライフサイクル。init にバックエンド/業務設定を渡し成功後に使用します。借用依存先の解放前に close の完了を待ち、正確な戻り値は例と公開署名に従います。
275
+
276
+ ```ts
277
+ // Memory(开发/测试)
278
+ await cache.init({ type: 'memory' })
279
+
280
+ // Redis 单机
281
+ await cache.init({
282
+ type: 'redis',
283
+ host: 'localhost',
284
+ port: 6379,
285
+ password: 'secret',
286
+ db: 0,
287
+ })
288
+
289
+ // Redis URL(优先级最高)
290
+ await cache.init({
291
+ type: 'redis',
292
+ url: 'redis://:password@localhost:6379/0',
293
+ })
294
+
295
+ // Redis 集群
296
+ await cache.init({
297
+ type: 'redis',
298
+ cluster: [
299
+ { host: 'node1', port: 6379 },
300
+ { host: 'node2', port: 6379 },
301
+ ],
302
+ })
303
+
304
+ // Redis 哨兵
305
+ await cache.init({
306
+ type: 'redis',
307
+ sentinel: {
308
+ sentinels: [
309
+ { host: 'sentinel1', port: 26379 }
310
+ ],
311
+ name: 'mymaster',
312
+ },
313
+ })
314
+ ```
315
+
316
+ `cache.init(config)` は組み込み memory/redis を選択します。Provider は内部契約であり、独自バックエンドの登録 API はありません。
317
+
318
+ `password` は単独・Cluster・Sentinel のデータノードに使用され、発見・リダイレクト後の接続にも適用します。`url` 指定時は URL 内の認証情報を使用し、独立した password フィールドでは上書きしません。
319
+
320
+ 設定はホストが読込・検証してから渡します。秘密はサーバーの非公開環境に保存し、利用場面に応じてバックエンド・容量・期限・ログを選びます。変更後は再初期化の結果を確認してください。
321
+
322
+ [項目別の用途・適用場面・例](../../docs/usage/configuration/data.md).
323
+
324
+ ## エラー処理
325
+
326
+ 領域操作は result.success を確認し、失敗時はモジュールのエラー定義と安全な説明を使います。コード・関連 ID・秘匿した原因をサーバーログに残します。同期ツール・ファクトリー・ストリーム反復・ライフサイクルは各署名に従い、Promise 完了だけで成功と判断しません。回復条件は各機能を参照してください。
162
327
 
163
328
  すべての操作は `HaiResult<T>` を返します。主なエラーコード:
164
329
 
@@ -174,10 +339,6 @@ owner はリース延長・解除の所有権であり、リソースの fencing
174
339
  | `HaiCacheError.UNSUPPORTED_TYPE` | `hai:cache:011` | 未対応のキャッシュ種別 |
175
340
  | `HaiCacheError.CONFIG_ERROR` | `hai:cache:012` | 設定エラー |
176
341
 
177
- ## 本番の共有状態
178
-
179
- 本番は Redis(Cluster を含む)が必須です。memory は開発・明示的テスト用であり、Redis 障害時もローカルへフォールバックしません。 NODE_ENV または HAI_CORE_ENV が production の場合、初期化成功前に検証します。明示的な HAI_E2E=1/HAI_E2E_MOCK=1 テストのみ除外します。 [状態・並行制御・復旧範囲(中国語)](../../.agents/instructions/distributed-state.md)。
180
-
181
342
  ## 開発とテスト
182
343
 
183
344
  ```bash
package/README.md CHANGED
@@ -4,38 +4,9 @@
4
4
 
5
5
  [框架首页](../../README.md) · 相关模块:[@h-ai/core](../core/README.md)
6
6
 
7
- ## 简介
8
-
9
7
  统一缓存模块,通过 `cache` 对象提供 KV / Hash / List / Set / ZSet / 分布式锁 操作,支持内存与 Redis 两种后端。
10
8
 
11
- 内存 KV 在到期时间点即视为失效;`incr/decr/incrBy/decrBy` 只接受安全整数数值或整数字符串,非法增量和溢出返回 `OPERATION_FAILED` 并保留原值。Hash 的 `__proto__` / `constructor` 等名称按普通字段保留,不修改返回对象原型。
12
-
13
- Memory 的 KV、Hash、List、Set、ZSet 共用 key 命名空间。`exists/expire/expireAt/ttl/persist/keys/scan/del/type` 覆盖全部结构,期限到达后结构操作也立即视为不存在;del 按实际删除的逻辑 key 计数,错误类型的结构操作返回失败。
14
-
15
- 初始化只在健康检查成功后发布连接;失败时释放候选资源。若清理仍失败,初始化错误的 `error.ext.cleanupPending` 为 `true`。`cache.close()` 返回 `Promise<HaiResult<void>>`,等待正在进行的初始化,并合并并发关闭。开始清理后 `isInitialized` 为 `false`,配置与业务操作不再可用;清理失败仍保留资源,后续 `close()` 或 `init()` 先重试释放,成功前不会创建替代连接。调用方必须检查关闭结果。
16
-
17
- ```ts
18
- const closed = await cache.close()
19
- if (!closed.success) {
20
- // 处理清理故障后有限重试;再次失败应向应用报告。
21
- const retried = await cache.close()
22
- if (!retried.success)
23
- throw new Error(retried.error.message)
24
- }
25
- ```
26
-
27
- Redis 的 QUIT 失败后会强制 disconnect;只有实际释放成功才报告关闭成功。
28
-
29
- ## 核心功能清单
30
-
31
- - 开发/测试场景下的内存缓存
32
- - 生产环境 Redis 缓存(单机、URL、集群、哨兵)
33
- - IAM 会话与权限相关的集合缓存
34
- - 分布式锁(多节点部署互斥控制)
35
-
36
- ## 使用入门
37
-
38
- ### 快速开始
9
+ ## 快速开始
39
10
 
40
11
  ```ts
41
12
  import { cache } from '@h-ai/cache'
@@ -63,51 +34,187 @@ finally {
63
34
 
64
35
  `cache.config` 返回的是**脱敏后的配置快照**:如后续接入 Redis `password` / `url` 等凭证字段,会自动做安全处理,不应用作回写原始密钥。
65
36
 
66
- ### 初始化配置
37
+ ## 功能
38
+
39
+ 内存 KV 在到期时间点即视为失效;`incr/decr/incrBy/decrBy` 只接受安全整数数值或整数字符串,非法增量和溢出返回 `OPERATION_FAILED` 并保留原值。Hash 的 `__proto__` / `constructor` 等名称按普通字段保留,不修改返回对象原型。
40
+
41
+ Memory 的 KV、Hash、List、Set、ZSet 共用 key 命名空间。`exists/expire/expireAt/ttl/persist/keys/scan/del/type` 覆盖全部结构,期限到达后结构操作也立即视为不存在;del 按实际删除的逻辑 key 计数,错误类型的结构操作返回失败。
42
+
43
+ 初始化只在健康检查成功后发布连接;失败时释放候选资源。若清理仍失败,初始化错误的 `error.ext.cleanupPending` 为 `true`。`cache.close()` 返回 `Promise<HaiResult<void>>`,等待正在进行的初始化,并合并并发关闭。开始清理后 `isInitialized` 为 `false`,配置与业务操作不再可用;清理失败仍保留资源,后续 `close()` 或 `init()` 先重试释放,成功前不会创建替代连接。调用方必须检查关闭结果。
67
44
 
68
45
  ```ts
69
- // Memory(开发/测试)
70
- await cache.init({ type: 'memory' })
46
+ const closed = await cache.close()
47
+ if (!closed.success) {
48
+ // 处理清理故障后有限重试;再次失败应向应用报告。
49
+ const retried = await cache.close()
50
+ if (!retried.success)
51
+ throw new Error(retried.error.message)
52
+ }
53
+ ```
71
54
 
72
- // Redis 单机
73
- await cache.init({
74
- type: 'redis',
75
- host: 'localhost',
76
- port: 6379,
77
- password: 'secret',
78
- db: 0,
79
- })
55
+ Redis 的 QUIT 失败后会强制 disconnect;只有实际释放成功才报告关闭成功。
80
56
 
81
- // Redis URL(优先级最高)
82
- await cache.init({
83
- type: 'redis',
84
- url: 'redis://:password@localhost:6379/0',
85
- })
57
+ ### 功能输入输出
86
58
 
87
- // Redis 集群
88
- await cache.init({
89
- type: 'redis',
90
- cluster: [
91
- { host: 'node1', port: 6379 },
92
- { host: 'node2', port: 6379 },
93
- ],
94
- })
59
+ 以下片段依赖本节完整初始化流程。示例中的业务值由宿主校验和授权后传入;异步领域结果先判断 success,再读取 data。表中 void 表示操作已完成且没有返回数据,null 表示不存在;同步工厂/工具直接返回表中类型。
95
60
 
96
- // Redis 哨兵
97
- await cache.init({
98
- type: 'redis',
99
- sentinel: {
100
- sentinels: [
101
- { host: 'sentinel1', port: 26379 }
102
- ],
103
- name: 'mymaster',
104
- },
105
- })
106
- ```
61
+ key/keys 是业务键,field/fields 是哈希字段,value/members 为 JSON 值;start/stop/index 为下标,min/max 为分数边界;seconds/ttl/timeout 为秒,timestamp 为 Unix 秒;owner 只能使用 acquire 返回值。
107
62
 
108
- 内置后端由 `cache.init(config)` 选择 memory/redis;Provider 实现是内部契约,不提供自定义后端注册入口。
63
+ #### cache.kv
109
64
 
110
- `password` 用于单机、Cluster 与 Sentinel 数据节点;Cluster 发现和重定向后的节点连接也携带密码。配置 `url` 时采用 URL 自身的认证信息,独立 password 字段不覆盖它。
65
+ 缓存 JSON 快照。get/mget 返回值或 null(批量保序);set 输入期限/NX/XX,返回实际写入 boolean;mset 接收 [key,value][] 返回 void。
66
+
67
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
68
+ | --------------- | ------------------- | --------------- | ---------------------------------------------------------- |
69
+ | `cache.kv.get` | key | `T \| null` | `await cache.kv.get('u:1')` |
70
+ | `cache.kv.set` | key, value, options | `boolean` | `await cache.kv.set('u:1', { name: 'Alice' }, { ex: 60 })` |
71
+ | `cache.kv.mget` | keys | `(T \| null)[]` | `await cache.kv.mget('u:1', 'u:2')` |
72
+ | `cache.kv.mset` | entries | `void` | `await cache.kv.mset([['u:1', { name: 'Alice' }]])` |
73
+
74
+ #### cache.kv
75
+
76
+ 跨节点版本提交。key、expected、value 加期限选项原子比较后返回 applied;undefined 代表不存在/删除,比较失败不改原值或 TTL。
77
+
78
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
79
+ | ------------------------- | ----------------------------- | --------- | ------------------------------------------------ |
80
+ | `cache.kv.compareAndSwap` | key, expected, value, options | `boolean` | `await cache.kv.compareAndSwap('version', 1, 2)` |
81
+
82
+ #### cache.kv
83
+
84
+ 按 key 管理全部数据结构;del/exists 输入一个或多个键,返回删除/存在数;type 输入单键返回结构类型。
85
+
86
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
87
+ | ----------------- | -------- | -------- | ------------------------------------- |
88
+ | `cache.kv.del` | keys | `number` | `await cache.kv.del('u:1', 'u:2')` |
89
+ | `cache.kv.exists` | keys | `number` | `await cache.kv.exists('u:1', 'u:2')` |
90
+ | `cache.kv.type` | key | `string` | `await cache.kv.type('u:1')` |
91
+
92
+ #### cache.kv
93
+
94
+ 控制保存期限;相对秒数、Unix 秒数或键分别设置/查询/移除 TTL。修改返回 boolean,ttl 返回秒数(-1 无期限、-2 不存在)。
95
+
96
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
97
+ | ------------------- | -------------- | --------- | -------------------------------------------------------------------- |
98
+ | `cache.kv.expire` | key, seconds | `boolean` | `await cache.kv.expire('u:1', 60)` |
99
+ | `cache.kv.expireAt` | key, timestamp | `boolean` | `await cache.kv.expireAt('u:1', Math.floor(Date.now() / 1000) + 60)` |
100
+ | `cache.kv.ttl` | key | `number` | `await cache.kv.ttl('u:1')` |
101
+ | `cache.kv.persist` | key | `boolean` | `await cache.kv.persist('u:1')` |
102
+
103
+ #### cache.kv
104
+
105
+ 计数器输入 key 和可选整数增量,返回新安全整数;类型不符或溢出失败且不修改原值。
106
+
107
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
108
+ | ----------------- | -------------- | -------- | ----------------------------------- |
109
+ | `cache.kv.incr` | key | `number` | `await cache.kv.incr('hits')` |
110
+ | `cache.kv.incrBy` | key, increment | `number` | `await cache.kv.incrBy('hits', 2)` |
111
+ | `cache.kv.decr` | key | `number` | `await cache.kv.decr('stock')` |
112
+ | `cache.kv.decrBy` | key, decrement | `number` | `await cache.kv.decrBy('stock', 2)` |
113
+
114
+ #### cache.kv
115
+
116
+ 运维遍历。keys 接收 glob 返回键数组;scan 接收不透明游标和 match/count,返回 [新游标,键数组],不保证快照或无重复。
117
+
118
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
119
+ | --------------- | --------------- | -------------------- | -------------------------------------------------------- |
120
+ | `cache.kv.keys` | pattern | `string[]` | `await cache.kv.keys('u:*')` |
121
+ | `cache.kv.scan` | cursor, options | `[string, string[]]` | `await cache.kv.scan('0', { match: 'u:*', count: 100 })` |
122
+
123
+ #### cache.hash
124
+
125
+ 字段缓存输入 key、field/fields/对象或增量。读取返回值/null、对象、字段/值数组或长度;hset/hdel 返回新增/删除数,hexists 返回 boolean,hincrBy 返回新整数。
126
+
127
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
128
+ | -------------------- | --------------------- | --------------- | ----------------------------------------------- |
129
+ | `cache.hash.hget` | key, field | `T \| null` | `await cache.hash.hget('u:1', 'name')` |
130
+ | `cache.hash.hset` | key, field, value | `number` | `await cache.hash.hset('u:1', 'name', 'Alice')` |
131
+ | `cache.hash.hdel` | key, fields | `number` | `await cache.hash.hdel('u:1', 'name')` |
132
+ | `cache.hash.hexists` | key, field | `boolean` | `await cache.hash.hexists('u:1', 'name')` |
133
+ | `cache.hash.hgetall` | key | `T` | `await cache.hash.hgetall('u:1')` |
134
+ | `cache.hash.hkeys` | key | `string[]` | `await cache.hash.hkeys('u:1')` |
135
+ | `cache.hash.hvals` | key | `T[]` | `await cache.hash.hvals('u:1')` |
136
+ | `cache.hash.hlen` | key | `number` | `await cache.hash.hlen('u:1')` |
137
+ | `cache.hash.hmget` | key, fields | `(T \| null)[]` | `await cache.hash.hmget('u:1', 'name', 'age')` |
138
+ | `cache.hash.hincrBy` | key, field, increment | `number` | `await cache.hash.hincrBy('u:1', 'visits', 1)` |
139
+
140
+ #### cache.list
141
+
142
+ 有序队列输入 key、值、索引/区间;push 返回长度,pop/index 返回值/null,range 返回数组,set/trim 返回 void。阻塞 pop 输入秒数与键,返回 [key,value]/null。
143
+
144
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
145
+ | ------------------- | ----------------- | --------------------- | ------------------------------------------------- |
146
+ | `cache.list.lpush` | key, values | `number` | `await cache.list.lpush('jobs', 'job-1')` |
147
+ | `cache.list.rpush` | key, values | `number` | `await cache.list.rpush('jobs', 'job-2')` |
148
+ | `cache.list.lpop` | key | `T \| null` | `await cache.list.lpop('jobs')` |
149
+ | `cache.list.rpop` | key | `T \| null` | `await cache.list.rpop('jobs')` |
150
+ | `cache.list.llen` | key | `number` | `await cache.list.llen('jobs')` |
151
+ | `cache.list.lrange` | key, start, stop | `T[]` | `await cache.list.lrange('jobs', 0, 9)` |
152
+ | `cache.list.lindex` | key, index | `T \| null` | `await cache.list.lindex('jobs', 0)` |
153
+ | `cache.list.lset` | key, index, value | `void` | `await cache.list.lset('jobs', 0, 'replacement')` |
154
+ | `cache.list.ltrim` | key, start, stop | `void` | `await cache.list.ltrim('jobs', 0, 99)` |
155
+ | `cache.list.blpop` | timeout, keys | `[string, T] \| null` | `await cache.list.blpop(5, 'jobs')` |
156
+ | `cache.list.brpop` | timeout, keys | `[string, T] \| null` | `await cache.list.brpop(5, 'jobs')` |
157
+
158
+ #### cache.set_
159
+
160
+ 去重/集合运算。key+成员用于增删/成员判定,返回数量/boolean;members 返回数组,card 返回基数,random/pop 按 count 返回成员/数组/null,交并差接收多个键返回数组。
161
+
162
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
163
+ | ------------------------ | ------------ | ------------------ | ----------------------------------------------- |
164
+ | `cache.set_.sadd` | key, members | `number` | `await cache.set_.sadd('roles', 'editor')` |
165
+ | `cache.set_.srem` | key, members | `number` | `await cache.set_.srem('roles', 'editor')` |
166
+ | `cache.set_.smembers` | key | `T[]` | `await cache.set_.smembers('roles')` |
167
+ | `cache.set_.sismember` | key, member | `boolean` | `await cache.set_.sismember('roles', 'editor')` |
168
+ | `cache.set_.scard` | key | `number` | `await cache.set_.scard('roles')` |
169
+ | `cache.set_.srandmember` | key, count | `T \| T[] \| null` | `await cache.set_.srandmember('roles', 2)` |
170
+ | `cache.set_.spop` | key, count | `T \| T[] \| null` | `await cache.set_.spop('roles', 1)` |
171
+ | `cache.set_.sinter` | keys | `T[]` | `await cache.set_.sinter('roles:a', 'roles:b')` |
172
+ | `cache.set_.sunion` | keys | `T[]` | `await cache.set_.sunion('roles:a', 'roles:b')` |
173
+ | `cache.set_.sdiff` | keys | `T[]` | `await cache.set_.sdiff('roles:a', 'roles:b')` |
174
+
175
+ #### cache.zset
176
+
177
+ 排行榜输入成员及 score、排序范围或分数范围;新增/删除返回数量,score/rank 返回数字/null,range 返回成员或带分数对象数组,incrBy 返回新分数,card/count 返回数量。
178
+
179
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
180
+ | ----------------------------- | ---------------------------- | ----------------------- | ------------------------------------------------------------------------- |
181
+ | `cache.zset.zadd` | key, members | `number` | `await cache.zset.zadd('scores', { member: 'u1', score: 10 })` |
182
+ | `cache.zset.zrem` | key, members | `number` | `await cache.zset.zrem('scores', 'u1')` |
183
+ | `cache.zset.zscore` | key, member | `number \| null` | `await cache.zset.zscore('scores', 'u1')` |
184
+ | `cache.zset.zrank` | key, member | `number \| null` | `await cache.zset.zrank('scores', 'u1')` |
185
+ | `cache.zset.zrevrank` | key, member | `number \| null` | `await cache.zset.zrevrank('scores', 'u1')` |
186
+ | `cache.zset.zrange` | key, start, stop, withScores | `string[] \| ZMember[]` | `await cache.zset.zrange('scores', 0, 9, true)` |
187
+ | `cache.zset.zrevrange` | key, start, stop, withScores | `string[] \| ZMember[]` | `await cache.zset.zrevrange('scores', 0, 9, true)` |
188
+ | `cache.zset.zrangeByScore` | key, min, max, options | `string[] \| ZMember[]` | `await cache.zset.zrangeByScore('scores', 10, 100, { withScores: true })` |
189
+ | `cache.zset.zcard` | key | `number` | `await cache.zset.zcard('scores')` |
190
+ | `cache.zset.zcount` | key, min, max | `number` | `await cache.zset.zcount('scores', 10, 100)` |
191
+ | `cache.zset.zincrBy` | key, increment, member | `number` | `await cache.zset.zincrBy('scores', 5, 'u1')` |
192
+ | `cache.zset.zremRangeByRank` | key, start, stop | `number` | `await cache.zset.zremRangeByRank('scores', 0, 9)` |
193
+ | `cache.zset.zremRangeByScore` | key, min, max | `number` | `await cache.zset.zremRangeByScore('scores', 0, 10)` |
194
+
195
+ #### cache.lock
196
+
197
+ 短期互斥。acquire 输入键/TTL 返回 owner 或 null;release/extend 必须传 owner,返回 boolean;isLocked 仅观察占用。锁不替代业务存储的 CAS。
198
+
199
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
200
+ | --------------------- | --------------- | ---------------- | ------------------------------------------------ |
201
+ | `cache.lock.acquire` | key, options | `string \| null` | `await cache.lock.acquire('daily', { ttl: 30 })` |
202
+ | `cache.lock.release` | key, owner | `boolean` | `await cache.lock.release('daily', owner)` |
203
+ | `cache.lock.isLocked` | key | `boolean` | `await cache.lock.isLocked('daily')` |
204
+ | `cache.lock.extend` | key, ttl, owner | `boolean` | `await cache.lock.extend('daily', 60, owner)` |
205
+
206
+ #### cache
207
+
208
+ 健康检查,无参数;返回后端响应字符串,连接故障为失败。
209
+
210
+ | 入口 | 输入参数 | 成功结果 | 调用示例 |
211
+ | ------------ | -------- | -------- | -------------------- |
212
+ | `cache.ping` | 无参数 | `string` | `await cache.ping()` |
213
+
214
+ - 开发/测试场景下的内存缓存
215
+ - 生产环境 Redis 缓存(单机、URL、集群、哨兵)
216
+ - IAM 会话与权限相关的集合缓存
217
+ - 分布式锁(多节点部署互斥控制)
111
218
 
112
219
  ### API 概览
113
220
 
@@ -169,7 +276,65 @@ if (acquired.success && acquired.data)
169
276
 
170
277
  owner 只保护锁的续期与释放,不是资源 fencing token。进程暂停或租约到期后旧任务仍能继续;最终写入必须在资源存储中使用 CAS、代际条件或事务约束。续租成功或最后返回失败都不能代替提交条件。
171
278
 
172
- ### 错误码
279
+ ### 生产共享状态
280
+
281
+ 生产仅使用 Redis(含 Cluster);memory 只用于开发/明确测试。Redis 故障返回失败,不回退本机缓存。 NODE_ENV 或 HAI_CORE_ENV 为 production 时在初始化发布成功前校验;仅 HAI_E2E=1/HAI_E2E_MOCK=1 明确测试可豁免。 [状态、并发和恢复边界](../../.agents/instructions/distributed-state.md).
282
+
283
+ ## 配置
284
+
285
+ 生命周期:init 输入后端/业务配置,成功后才能使用;close 在释放借用依赖前等待完成。返回值以快速开始示例和公开签名为准。
286
+
287
+ ```ts
288
+ // Memory(开发/测试)
289
+ await cache.init({ type: 'memory' })
290
+
291
+ // Redis 单机
292
+ await cache.init({
293
+ type: 'redis',
294
+ host: 'localhost',
295
+ port: 6379,
296
+ password: 'secret',
297
+ db: 0,
298
+ })
299
+
300
+ // Redis URL(优先级最高)
301
+ await cache.init({
302
+ type: 'redis',
303
+ url: 'redis://:password@localhost:6379/0',
304
+ })
305
+
306
+ // Redis 集群
307
+ await cache.init({
308
+ type: 'redis',
309
+ cluster: [
310
+ { host: 'node1', port: 6379 },
311
+ { host: 'node2', port: 6379 },
312
+ ],
313
+ })
314
+
315
+ // Redis 哨兵
316
+ await cache.init({
317
+ type: 'redis',
318
+ sentinel: {
319
+ sentinels: [
320
+ { host: 'sentinel1', port: 26379 }
321
+ ],
322
+ name: 'mymaster',
323
+ },
324
+ })
325
+ ```
326
+
327
+ 内置后端由 `cache.init(config)` 选择 memory/redis;Provider 实现是内部契约,不提供自定义后端注册入口。
328
+
329
+ `password` 用于单机、Cluster 与 Sentinel 数据节点;Cluster 发现和重定向后的节点连接也携带密码。配置 `url` 时采用 URL 自身的认证信息,独立 password 字段不覆盖它。
330
+
331
+ 配置由宿主加载和校验,再传入本模块;私密值放服务端私有环境,不传到浏览器。按实际使用场景逐项选择后端、容量、期限和日志策略,修改后重新初始化并核验成功结果。
332
+
333
+ [逐项配置说明、适用场景和示例](../../docs/usage/configuration/data.md).
334
+
335
+ ## 错误处理
336
+
337
+ 领域操作先判断 `result.success`,失败按本模块错误定义与安全提示处理,服务端保留错误码、关联编号和脱敏原因。同步工具、工厂、流迭代及生命周期按各自签名处理,不把 Promise 完成视为业务成功。具体失败与恢复边界见对应功能。
173
338
 
174
339
  所有操作返回 `HaiResult<T>`,常用错误码如下:
175
340
 
@@ -185,10 +350,6 @@ owner 只保护锁的续期与释放,不是资源 fencing token。进程暂停
185
350
  | `HaiCacheError.UNSUPPORTED_TYPE` | `hai:cache:011` | 不支持的缓存类型 |
186
351
  | `HaiCacheError.CONFIG_ERROR` | `hai:cache:012` | 配置错误 |
187
352
 
188
- ## 生产共享状态
189
-
190
- 生产仅使用 Redis(含 Cluster);memory 只用于开发/明确测试。Redis 故障返回失败,不回退本机缓存。 NODE_ENV 或 HAI_CORE_ENV 为 production 时在初始化发布成功前校验;仅 HAI_E2E=1/HAI_E2E_MOCK=1 明确测试可豁免。 [状态、并发和恢复边界](../../.agents/instructions/distributed-state.md)。
191
-
192
353
  ## 开发测试
193
354
 
194
355
  ```bash
@@ -197,7 +358,7 @@ pnpm --filter @h-ai/cache test
197
358
 
198
359
  > Redis 相关测试需要 Docker 环境。
199
360
 
200
- 公开契约与内部结构均提供可类型检查的示例;见[模块 JSDoc 约定](../../.agents/instructions/module-conventions.md#jsdoc-与示例验证)。
361
+ 公开契约与内部结构均提供可类型检查的示例;见[模块 JSDoc 约定](../../.agents/instructions/module-conventions.md#jsdoc-与示例验证).
201
362
 
202
363
  ## 许可证
203
364
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@h-ai/cache",
3
3
  "type": "module",
4
- "version": "1.0.0-beta.19",
4
+ "version": "1.0.0-beta.20",
5
5
  "description": "Hai Framework cache module with memory and Redis backends.",
6
6
  "license": "Apache-2.0",
7
7
  "exports": {
@@ -23,7 +23,7 @@
23
23
  "node": "^22.23.4 || ^24.22.1 || ^26.12.1"
24
24
  },
25
25
  "dependencies": {
26
- "@h-ai/core": "1.0.0-beta.19",
26
+ "@h-ai/core": "1.0.0-beta.20",
27
27
  "ioredis": "^6.0.0",
28
28
  "zod": "^4.6.7"
29
29
  },