@hile/redis-idempotency 2.1.2 → 3.0.1

package/README.md

@@ -170,26 +170,29 @@ await pipeline.dispatch(ctx)
 console.log(ctx.state.result)
 ```
 
-Current `@hile/model@2.1.1` `defineModel()` returns a local `result` variable from its terminal middleware. That means a short-circuited middleware cannot make `model.handler()` return `ctx.state.result`. Until `@hile/model` returns `ctx.state.result`, prefer function-level `withIdempotency()` inside `main()`:
+With `@hile/model@3.0.0+`, `defineModel()` returns `ctx.state.result` after the pipeline finishes, so `idempotent()` can be used directly as model middleware when the middleware is created with an already available Redis client. A cached idempotency hit can short-circuit the pipeline and still become the model result:
 
 ```typescript
-const debitModel = defineModel({
-  services: [redisService],
-  async main([redis], input: DebitInput) {
-    return withIdempotency(
-      redis,
-      `idem:prod:wallet:debit:${input.tenantId}:${input.requestId}`,
-      () => performDebit(input),
-      {
+function createDebitModel(redis: Redis) {
+  return defineModel({
+    pipelines: [
+      idempotent({
+        redis,
+        key: (input: DebitInput) => `idem:prod:wallet:debit:${input.tenantId}:${input.requestId}`,
+        fingerprint: stableHash,
         lockTtl: 60_000,
         resultTtl: 86_400_000,
-        fingerprint: stableHash(input),
-      },
-    )
-  },
-})
+      }),
+    ],
+    async main(input: DebitInput) {
+      return performDebit(input, redis)
+    },
+  })
+}
 ```
 
+For normal Hile models that load Redis through `services: [redisService]`, or for code that needs a narrower critical section than the whole model, use function-level `withIdempotency()` inside `main()` instead.
+
 ## Error Types
 
 | Error | When it happens | Recommended handling |

package/SKILL.md

@@ -44,9 +44,9 @@ Build `stableHash()` fingerprints from plain DTOs. It rejects unsupported object
 
 Default cached results must be plain JSON values. If the wrapped function returns `Date`, `BigInt`, class instances, `Map` / `Set`, or any other rich type, pass `resultCodec` so cache hits deserialize to the same shape as the first call.
 
-## Current Model Guidance
+## Model Guidance
 
-Prefer function-level `withIdempotency()` inside `defineModel().main`. Current `@hile/model@2.1.1` does not return `ctx.state.result` on middleware short-circuit, so `idempotent()` is safe for raw `Pipeline` usage and future model versions that return `ctx.state.result`, but not for current `defineModel` cache hits.
+With `@hile/model@3.0.0+`, `defineModel()` returns `ctx.state.result` after the pipeline finishes, so `idempotent()` can short-circuit model execution when the middleware is created with an already available Redis client. Prefer function-level `withIdempotency()` inside `defineModel().main` when Redis is loaded through model `services`, or when only a smaller part of `main()` needs duplicate-execution protection.
 
 ## Failure Policy
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hile/redis-idempotency",
-  "version": "2.1.2",
+  "version": "3.0.1",
   "type": "module",
   "main": "./dist/index.js",
   "scripts": {
@@ -22,7 +22,7 @@
     "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@hile/model": "^2.1.1"
+    "@hile/model": "^3.0.1"
   },
-  "gitHead": "93da114ef293e48682e7df94d89418dfbf9a0226"
+  "gitHead": "ffc9f14ed2591075290c77c1bcc0afc67ecf1794"
 }