effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/unstable/persistence/Redis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Redis.d.ts","sourceRoot":"","sources":["../../../src/unstable/persistence/Redis.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAIzC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;;mBAOxB,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;mBAE9F,CACb,MAAM,SAAS;QACb,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACvC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;KACzB,EACD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;;AAZ3G;;;GAGG;AACH,qBAAa,KAAM,SAAQ,UASK;CAAG;AAEnC;;;GAGG;AACH,eAAO,MAAM,IAAI;mBAEE,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;;mBAhBhG,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;mBAE9F,CACb,MAAM,SAAS;QACb,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACvC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;KACzB,EACD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;gBAsCzG,CAAA;AAEF,KAAK,WAAW,GAAG,sCAAsC,CAAA;AACzD,QAAA,MAAM,WAAW,EAAE,WAAoD,CAAA;;;;;AAEvE;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAG9B;IACA;;OAEG;IACH,QAAQ,CAAC,CAAC,WAAW,CAAC,EAAE,WAAW,CAAc;CAClD;AAED,KAAK,YAAY,GAAG,kCAAkC,CAAA;AACtD,QAAA,MAAM,YAAY,EAAE,YAAiD,CAAA;AAErE;;;GAGG;AACH,MAAM,WAAW,MAAM,CACrB,MAAM,SAAS;IACb,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;IACvC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB;IAED,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE;QACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;KAClC,CAAA;IACD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,aAAa,CAAC,OAAO,CAAC,CAAA;IACxE,QAAQ,CAAC,YAAY,EAAE,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAA;IAE9D;;OAEG;IACH,cAAc,CAAC,MAAM,KAAK,MAAM,CAAC;QAC/B,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QACxB,MAAM,EAAE,MAAM,CAAA;KACf,CAAC,CAAA;CACH;AAkBD;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,SAAS,aAAa,CAAC,GAAG,CAAC,EACtD,GAAG,CAAC,GAAG,MAAM,EAAE,MAAM,KAAK,aAAa,CAAC,OAAO,CAAC,EAChD,SAAS;IACP,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,CAAA;CAChE,KACA,MAAM,CAAC;IACR,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,IAAI,CAAA;CACb,CAKG,CAAA"}
+{"version":3,"file":"Redis.d.ts","sourceRoot":"","sources":["../../../src/unstable/persistence/Redis.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAIzC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;;mBASxB,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;mBAE9F,CACb,MAAM,SAAS;QACb,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACvC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;KACzB,EACD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;;AAd3G;;;;;GAKG;AACH,qBAAa,KAAM,SAAQ,UASK;CAAG;AAEnC;;;;;;;;GAQG;AACH,eAAO,MAAM,IAAI;mBAEE,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;;mBArBhG,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;mBAE9F,CACb,MAAM,SAAS;QACb,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACvC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;KACzB,EACD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;gBA2CzG,CAAA;AAEF,KAAK,WAAW,GAAG,sCAAsC,CAAA;AACzD,QAAA,MAAM,WAAW,EAAE,WAAoD,CAAA;;;;;AAEvE;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,eAG9B;IACA;;;;OAIG;IACH,QAAQ,CAAC,CAAC,WAAW,CAAC,EAAE,WAAW,CAAc;CAClD;AAED,KAAK,YAAY,GAAG,kCAAkC,CAAA;AACtD,QAAA,MAAM,YAAY,EAAE,YAAiD,CAAA;AAErE;;;;;;;;GAQG;AACH,MAAM,WAAW,MAAM,CACrB,MAAM,SAAS;IACb,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;IACvC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB;IAED,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE;QACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;KAClC,CAAA;IACD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,aAAa,CAAC,OAAO,CAAC,CAAA;IACxE,QAAQ,CAAC,YAAY,EAAE,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAA;IAE9D;;OAEG;IACH,cAAc,CAAC,MAAM,KAAK,MAAM,CAAC;QAC/B,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QACxB,MAAM,EAAE,MAAM,CAAA;KACf,CAAC,CAAA;CACH;AAkBD;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,SAAS,aAAa,CAAC,GAAG,CAAC,EACtD,GAAG,CAAC,GAAG,MAAM,EAAE,MAAM,KAAK,aAAa,CAAC,OAAO,CAAC,EAChD,SAAS;IACP,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,CAAA;CAChE,KACA,MAAM,CAAC;IACR,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,IAAI,CAAA;CACb,CAKG,CAAA"}

package/dist/unstable/persistence/Redis.js

@@ -1,4 +1,20 @@
 /**
+ * Low-level Redis integration for the persistence modules.
+ *
+ * This module defines the `Redis` service used by Redis-backed persistence,
+ * persisted queues, and rate limiter stores. It adapts an external Redis
+ * connection to Effect through `send` for raw commands and `eval` for typed
+ * Lua scripts that are loaded with `SCRIPT LOAD` and executed with `EVALSHA`.
+ *
+ * The service does not create or manage Redis connections; callers provide a
+ * command sender from their Redis client or pool. Higher-level stores layer on
+ * key prefixes and store ids, so choose stable prefixes to avoid collisions
+ * and remember that schema or primary-key changes can make previously persisted
+ * JSON values fail to decode. Finite TTLs in the persistence stores are applied
+ * with millisecond Redis expirations, while non-finite TTLs are stored without
+ * expiration. Script parameters are stringified before execution, and the
+ * script descriptor's key count controls how Redis splits `KEYS` from `ARGV`.
+ *
  * @since 4.0.0
  */
 import * as Cache from "../../Cache.js";
@@ -9,13 +25,20 @@ import { constant, identity } from "../../Function.js";
 import * as Hash from "../../Hash.js";
 import * as Schema from "../../Schema.js";
 /**
+ * Service for sending Redis commands and evaluating cached Lua scripts.
+ *
+ * @category services
  * @since 4.0.0
- * @category Service
  */
 export class Redis extends /*#__PURE__*/Context.Service()("effect/persistence/Redis") {}
 /**
+ * Creates a `Redis` service from a raw command sender.
+ *
+ * Lua scripts are loaded through `SCRIPT LOAD`, cached, and then invoked with
+ * `EVALSHA`.
+ *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export const make = /*#__PURE__*/Effect.fnUntraced(function* (options) {
   const scriptCache = yield* Cache.make({
@@ -30,14 +53,18 @@ export const make = /*#__PURE__*/Effect.fnUntraced(function* (options) {
 });
 const ErrorTypeId = "~effect/persistence/Redis/RedisError";
 /**
+ * Error raised by Redis command or script execution.
+ *
+ * @category errors
  * @since 4.0.0
- * @category Errors
  */
 export class RedisError extends /*#__PURE__*/Schema.ErrorClass(ErrorTypeId)({
   _tag: /*#__PURE__*/Schema.tag("RedisError"),
   cause: Schema.Defect
 }) {
   /**
+   * Marks this value as a Redis persistence error for runtime guards.
+   *
    * @since 4.0.0
    */
   [ErrorTypeId] = ErrorTypeId;
@@ -59,8 +86,13 @@ const ScriptProto = {
   }
 };
 /**
- * @since 4.0.0
+ * Constructs a typed Redis Lua script descriptor.
+ *
+ * The result type defaults to `void` and can be refined with
+ * `withReturnType`.
+ *
  * @category Scripting
+ * @since 4.0.0
  */
 export const script = (f, options) => Object.assign(Object.create(ScriptProto), {
   ...options,

package/dist/unstable/persistence/Redis.js.map

@@ -1 +1 @@
-{"version":3,"file":"Redis.js","names":["Cache","Context","Effect","Equal","constant","identity","Hash","Schema","Redis","Service","make","fnUntraced","options","scriptCache","lookup","script","send","lua","capacity","Number","POSITIVE_INFINITY","eval_","params","flatMap","get","sha","numberOfKeys","toString","map","param","String","eval","ErrorTypeId","RedisError","ErrorClass","_tag","tag","cause","Defect","ScriptTypeId","ScriptProto","result","withReturnType","symbol","that","random","f","Object","assign","create"],"sources":["../../../src/unstable/persistence/Redis.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,SAASC,QAAQ,EAAEC,QAAQ,QAAQ,mBAAmB;AACtD,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC;;;;AAIA,OAAM,MAAOC,KAAM,sBAAQP,OAAO,CAACQ,OAAO,EAStC,CAAC,0BAA0B,CAAC;AAEhC;;;;AAIA,OAAO,MAAMC,IAAI,gBAAGR,MAAM,CAACS,UAAU,CAAC,WACpCC,OAEC;EAED,MAAMC,WAAW,GAAG,OAAOb,KAAK,CAACU,IAAI,CAAC;IACpCI,MAAM,EAAGC,MAAmB,IAAKH,OAAO,CAACI,IAAI,CAAS,QAAQ,EAAE,MAAM,EAAED,MAAM,CAACE,GAAG,CAAC;IACnFC,QAAQ,EAAEC,MAAM,CAACC;GAClB,CAAC;EAEF,MAAMC,KAAK,GAMTN,MAAsB,IAExB,CAAC,GAAGO,MAAwB,KAC1BpB,MAAM,CAACqB,OAAO,CAACvB,KAAK,CAACwB,GAAG,CAACX,WAAW,EAAEE,MAAM,CAAC,EAAGU,GAAG,IACjDb,OAAO,CAACI,IAAI,CACV,SAAS,EACTS,GAAG,EACHV,MAAM,CAACW,YAAY,CAAC,GAAGJ,MAAM,CAAC,CAACK,QAAQ,EAAE,EACzC,GAAGZ,MAAM,CAACO,MAAM,CAAC,GAAGA,MAAM,CAAC,CAACM,GAAG,CAAEC,KAAK,IAAKC,MAAM,CAACD,KAAK,CAAC,CAAC,CAC1D,CAAC;EAEN,OAAOxB,QAAQ,CAAmB;IAChCW,IAAI,EAAEJ,OAAO,CAACI,IAAI;IAClBe,IAAI,EAAEV;GACP,CAAC;AACJ,CAAC,CAAC;AAGF,MAAMW,WAAW,GAAgB,sCAAsC;AAEvE;;;;AAIA,OAAM,MAAOC,UAAW,sBAAQ1B,MAAM,CAAC2B,UAAU,CAAaF,WAAW,CAAC,CAAC;EACzEG,IAAI,eAAE5B,MAAM,CAAC6B,GAAG,CAAC,YAAY,CAAC;EAC9BC,KAAK,EAAE9B,MAAM,CAAC+B;CACf,CAAC;EACA;;;EAGS,CAACN,WAAW,IAAiBA,WAAW;;AAInD,MAAMO,YAAY,GAAiB,kCAAkC;AA6BrE,MAAMC,WAAW,GAAG;EAClB,CAACD,YAAY,GAAG;IACdjB,MAAM,EAAEjB,QAAQ;IAChBoC,MAAM,EAAEpC;GACT;EACDqC,cAAcA,CAAA;IACZ,OAAO,IAAI;EACb,CAAC;EACD,CAACvC,KAAK,CAACwC,MAAM,EAAEC,IAAa;IAC1B,OAAO,IAAI,KAAKA,IAAI;EACtB,CAAC;EACD,CAACtC,IAAI,CAACqC,MAAM,IAAC;IACX,OAAOrC,IAAI,CAACuC,MAAM,CAAC,IAAI,CAAC;EAC1B;CACD;AAED;;;;AAIA,OAAO,MAAM9B,MAAM,GAAGA,CACpB+B,CAAgD,EAChDlC,OAGC,KAKDmC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACT,WAAW,CAAC,EAAE;EACxC,GAAG5B,OAAO;EACVU,MAAM,EAAEwB,CAAC;EACTpB,YAAY,EAAE,OAAOd,OAAO,CAACc,YAAY,KAAK,QAAQ,GAAGtB,QAAQ,CAACQ,OAAO,CAACc,YAAY,CAAC,GAAGd,OAAO,CAACc;CACnG,CAAC","ignoreList":[]}
+{"version":3,"file":"Redis.js","names":["Cache","Context","Effect","Equal","constant","identity","Hash","Schema","Redis","Service","make","fnUntraced","options","scriptCache","lookup","script","send","lua","capacity","Number","POSITIVE_INFINITY","eval_","params","flatMap","get","sha","numberOfKeys","toString","map","param","String","eval","ErrorTypeId","RedisError","ErrorClass","_tag","tag","cause","Defect","ScriptTypeId","ScriptProto","result","withReturnType","symbol","that","random","f","Object","assign","create"],"sources":["../../../src/unstable/persistence/Redis.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKA,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,SAASC,QAAQ,EAAEC,QAAQ,QAAQ,mBAAmB;AACtD,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC;;;;;;AAMA,OAAM,MAAOC,KAAM,sBAAQP,OAAO,CAACQ,OAAO,EAStC,CAAC,0BAA0B,CAAC;AAEhC;;;;;;;;;AASA,OAAO,MAAMC,IAAI,gBAAGR,MAAM,CAACS,UAAU,CAAC,WACpCC,OAEC;EAED,MAAMC,WAAW,GAAG,OAAOb,KAAK,CAACU,IAAI,CAAC;IACpCI,MAAM,EAAGC,MAAmB,IAAKH,OAAO,CAACI,IAAI,CAAS,QAAQ,EAAE,MAAM,EAAED,MAAM,CAACE,GAAG,CAAC;IACnFC,QAAQ,EAAEC,MAAM,CAACC;GAClB,CAAC;EAEF,MAAMC,KAAK,GAMTN,MAAsB,IAExB,CAAC,GAAGO,MAAwB,KAC1BpB,MAAM,CAACqB,OAAO,CAACvB,KAAK,CAACwB,GAAG,CAACX,WAAW,EAAEE,MAAM,CAAC,EAAGU,GAAG,IACjDb,OAAO,CAACI,IAAI,CACV,SAAS,EACTS,GAAG,EACHV,MAAM,CAACW,YAAY,CAAC,GAAGJ,MAAM,CAAC,CAACK,QAAQ,EAAE,EACzC,GAAGZ,MAAM,CAACO,MAAM,CAAC,GAAGA,MAAM,CAAC,CAACM,GAAG,CAAEC,KAAK,IAAKC,MAAM,CAACD,KAAK,CAAC,CAAC,CAC1D,CAAC;EAEN,OAAOxB,QAAQ,CAAmB;IAChCW,IAAI,EAAEJ,OAAO,CAACI,IAAI;IAClBe,IAAI,EAAEV;GACP,CAAC;AACJ,CAAC,CAAC;AAGF,MAAMW,WAAW,GAAgB,sCAAsC;AAEvE;;;;;;AAMA,OAAM,MAAOC,UAAW,sBAAQ1B,MAAM,CAAC2B,UAAU,CAAaF,WAAW,CAAC,CAAC;EACzEG,IAAI,eAAE5B,MAAM,CAAC6B,GAAG,CAAC,YAAY,CAAC;EAC9BC,KAAK,EAAE9B,MAAM,CAAC+B;CACf,CAAC;EACA;;;;;EAKS,CAACN,WAAW,IAAiBA,WAAW;;AAInD,MAAMO,YAAY,GAAiB,kCAAkC;AAkCrE,MAAMC,WAAW,GAAG;EAClB,CAACD,YAAY,GAAG;IACdjB,MAAM,EAAEjB,QAAQ;IAChBoC,MAAM,EAAEpC;GACT;EACDqC,cAAcA,CAAA;IACZ,OAAO,IAAI;EACb,CAAC;EACD,CAACvC,KAAK,CAACwC,MAAM,EAAEC,IAAa;IAC1B,OAAO,IAAI,KAAKA,IAAI;EACtB,CAAC;EACD,CAACtC,IAAI,CAACqC,MAAM,IAAC;IACX,OAAOrC,IAAI,CAACuC,MAAM,CAAC,IAAI,CAAC;EAC1B;CACD;AAED;;;;;;;;;AASA,OAAO,MAAM9B,MAAM,GAAGA,CACpB+B,CAAgD,EAChDlC,OAGC,KAKDmC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACT,WAAW,CAAC,EAAE;EACxC,GAAG5B,OAAO;EACVU,MAAM,EAAEwB,CAAC;EACTpB,YAAY,EAAE,OAAOd,OAAO,CAACc,YAAY,KAAK,QAAQ,GAAGtB,QAAQ,CAACQ,OAAO,CAACc,YAAY,CAAC,GAAGd,OAAO,CAACc;CACnG,CAAC","ignoreList":[]}

package/dist/unstable/persistence/index.d.ts

@@ -2,30 +2,177 @@
  * @since 4.0.0
  */
 /**
+ * Effectful key/value storage for persistence backends.
+ *
+ * This module defines the `KeyValueStore` service used by the persistence
+ * package when a simple string or binary store is enough. It is useful for
+ * lightweight durable state, browser storage, local file-backed data, SQL
+ * tables, test stores, and as the storage primitive underneath higher-level
+ * persistence APIs.
+ *
+ * Values are stored as strings or `Uint8Array`s, and `toSchemaStore` adds a
+ * schema-aware JSON layer for typed values. Schema changes can make existing
+ * JSON fail to decode, and `prefix` should be used to separate namespaces when
+ * several logical stores share the same backend. This service does not provide
+ * native TTL support; higher-level persistence layers encode expiration
+ * metadata in stored values when they need TTLs.
+ *
+ * Backend behavior is intentionally small but not identical: Web Storage is
+ * string-only, `makeStringOnly` stores binary values as base64, filesystem
+ * keys become encoded file names, SQL stores value type metadata in a table,
+ * and the memory layer is process-local. Choose keys, prefixes, table names,
+ * and value formats with those backend constraints in mind.
+ *
  * @since 4.0.0
  */
 export * as KeyValueStore from "./KeyValueStore.ts";
 /**
+ * Defines the request-side contract used by the persistence layer.
+ *
+ * A `Persistable` request is a `PrimaryKey` value that carries the success and
+ * error schemas needed to encode and decode the stored `Exit` for that request.
+ * Persisted request resolvers and `PersistedCache` use this metadata to restore
+ * previous lookup results from a backing store before running the lookup again.
+ *
+ * Use `Class` for cacheable or durable requests whose results can safely be
+ * reused across fibers, processes, or restarts. The request primary key is the
+ * entry id inside a persistence store, so it should be stable, collision-free,
+ * and usually include a request-specific prefix. The `storeId` is configured on
+ * `Persistence` or `PersistedCache`; it selects the backing store namespace and
+ * is separate from the request primary key.
+ *
+ * Success and error schemas are encoded with the JSON codec, so persisted
+ * values must be representable by those schemas and any required schema services
+ * must be available where the store reads or writes entries. Changing a schema,
+ * primary-key format, or store id can make existing persisted values fail to
+ * decode or stop being found, so treat those changes as persistence migrations.
+ *
  * @since 4.0.0
  */
 export * as Persistable from "./Persistable.ts";
 /**
+ * Persistent caching for `Persistable` request keys.
+ *
+ * A `PersistedCache` combines a scoped in-memory `Cache` with a named
+ * `Persistence` store. It is useful for expensive or idempotent lookups such as
+ * remote API calls, database reads, and request results that should be reused
+ * across fibers, process restarts, or multiple workers sharing the same backing
+ * store.
+ *
+ * The persistent `timeToLive` is evaluated for the stored `Exit`, so successes
+ * and failures can be cached with different lifetimes. The in-memory cache has
+ * its own `inMemoryTTL` and capacity, and `invalidate` removes both the
+ * persisted value and the in-memory entry. Persisted values are encoded with
+ * the key's success and error schemas and stored under the key's primary key, so
+ * schema changes, primary-key changes, or store-id collisions can make old
+ * entries fail to decode until they are invalidated or written under a new
+ * `storeId`.
+ *
  * @since 4.0.0
  */
 export * as PersistedCache from "./PersistedCache.ts";
 /**
+ * Schema-aware persisted queues for background work.
+ *
+ * A `PersistedQueue` stores JSON-encoded values in a named queue and lets
+ * workers `take` one value at a time inside a scoped processing window. It is
+ * useful for durable handoffs, background jobs, outbox-style integrations, and
+ * workloads where failed work should be retried across fibers, process
+ * restarts, or multiple workers sharing Redis or SQL.
+ *
+ * Delivery is at-least-once: a handler that fails, is interrupted, or loses its
+ * backing-store lock may see the same element again until `maxAttempts` is
+ * reached. Use stable custom ids when offering idempotent work, and choose ids
+ * that are collision-free for the backing store because stores can enforce
+ * uniqueness at the queue, prefix, or table level. Ordering is intentionally a
+ * store-level concern; retries, lock expiration, polling, and multiple workers
+ * can move entries behind newer work, so handlers should not rely on strict
+ * FIFO processing.
+ *
+ * Values are encoded and decoded with the supplied schema using the JSON codec,
+ * so schema services must be available when offering and taking values. Changing
+ * a queue name, schema, Redis prefix, SQL table, or id format is a persistence
+ * migration: old entries may decode differently, stop being visible, or collide
+ * with new entries. The memory store is process-local and volatile, while Redis
+ * and SQL stores use leases that should be tuned for the expected processing
+ * time.
+ *
  * @since 4.0.0
  */
 export * as PersistedQueue from "./PersistedQueue.ts";
 /**
+ * Durable storage for encoded `Persistable` request results.
+ *
+ * The `Persistence` service creates scoped stores that read and write
+ * schema-encoded `Exit` values keyed by each request's `PrimaryKey`. It is the
+ * lower-level persistence layer used by `PersistedCache` and similar request
+ * workflows to reuse expensive or idempotent lookup results across fibers,
+ * process restarts, and workers that share a backing store.
+ *
+ * Each store is selected by a `storeId`, while each entry id comes from the
+ * request's primary key. Keep both stable and collision-free: changing the
+ * `storeId`, the primary-key format, or the success/error schemas is a
+ * persistence migration, because old entries may stop being found or fail to
+ * decode. Values are encoded with the request's success and error schemas using
+ * the JSON codec, so any required schema services must be available at store
+ * read and write time, and the backing value must stay JSON-compatible.
+ *
+ * TTLs are computed from the stored `Exit` and request key. Infinite TTLs are
+ * stored without an expiration, finite TTLs become backing-store expirations,
+ * and zero or negative TTLs skip the write entirely. Backing layers provide
+ * process-local memory, `KeyValueStore`, Redis, and SQL implementations; store
+ * ids are used as prefixes, table names, or SQL partitions and should be
+ * chosen with the target backing store in mind.
+ *
  * @since 4.0.0
  */
 export * as Persistence from "./Persistence.ts";
 /**
+ * Persistent rate limiting for effects that need to coordinate token
+ * consumption through a shared `RateLimiterStore`.
+ *
+ * The module exposes a `RateLimiter` service that can consume tokens for
+ * string keys using either fixed-window counters or token-bucket state. It is
+ * useful for protecting external APIs, enforcing per-user or per-tenant quotas,
+ * throttling job workers, and coordinating limits across multiple fibers or
+ * processes when they share the Redis-backed store. The helpers can fail fast
+ * with `RateLimiterError`, return a delay to apply yourself, or wrap an effect
+ * so it waits before continuing.
+ *
+ * Rate-limit keys and Redis prefixes are part of the persistence namespace, so
+ * choose stable, collision-free values. The in-memory store is process-local
+ * and is only coordinated inside one runtime, while the Redis store uses Lua
+ * scripts for atomic updates under concurrent consumers. Time is measured with
+ * the Effect `Clock`, windows are clamped to at least one millisecond, and
+ * refill calculations use millisecond granularity.
+ *
+ * Fixed-window state is TTL-driven: rejected `fail` attempts do not extend the
+ * current TTL, and Redis fixed-window keys expire automatically. Token-bucket
+ * state keeps the remaining token count and last-refill time instead of using a
+ * TTL, so high-cardinality dynamic keys may need an external cleanup or bounded
+ * key strategy. With `onExceeded: "delay"`, overflow can be recorded so callers
+ * should actually sleep for the returned delay, or use the provided accessors.
+ *
  * @since 4.0.0
  */
 export * as RateLimiter from "./RateLimiter.ts";
 /**
+ * Low-level Redis integration for the persistence modules.
+ *
+ * This module defines the `Redis` service used by Redis-backed persistence,
+ * persisted queues, and rate limiter stores. It adapts an external Redis
+ * connection to Effect through `send` for raw commands and `eval` for typed
+ * Lua scripts that are loaded with `SCRIPT LOAD` and executed with `EVALSHA`.
+ *
+ * The service does not create or manage Redis connections; callers provide a
+ * command sender from their Redis client or pool. Higher-level stores layer on
+ * key prefixes and store ids, so choose stable prefixes to avoid collisions
+ * and remember that schema or primary-key changes can make previously persisted
+ * JSON values fail to decode. Finite TTLs in the persistence stores are applied
+ * with millisecond Redis expirations, while non-finite TTLs are stored without
+ * expiration. Script parameters are stringified before execution, and the
+ * script descriptor's key count controls how Redis splits `KEYS` from `ARGV`.
+ *
  * @since 4.0.0
  */
 export * as Redis from "./Redis.ts";

package/dist/unstable/persistence/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/unstable/persistence/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/unstable/persistence/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA"}

package/dist/unstable/persistence/index.js

@@ -3,30 +3,177 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * Effectful key/value storage for persistence backends.
+ *
+ * This module defines the `KeyValueStore` service used by the persistence
+ * package when a simple string or binary store is enough. It is useful for
+ * lightweight durable state, browser storage, local file-backed data, SQL
+ * tables, test stores, and as the storage primitive underneath higher-level
+ * persistence APIs.
+ *
+ * Values are stored as strings or `Uint8Array`s, and `toSchemaStore` adds a
+ * schema-aware JSON layer for typed values. Schema changes can make existing
+ * JSON fail to decode, and `prefix` should be used to separate namespaces when
+ * several logical stores share the same backend. This service does not provide
+ * native TTL support; higher-level persistence layers encode expiration
+ * metadata in stored values when they need TTLs.
+ *
+ * Backend behavior is intentionally small but not identical: Web Storage is
+ * string-only, `makeStringOnly` stores binary values as base64, filesystem
+ * keys become encoded file names, SQL stores value type metadata in a table,
+ * and the memory layer is process-local. Choose keys, prefixes, table names,
+ * and value formats with those backend constraints in mind.
+ *
  * @since 4.0.0
  */
 export * as KeyValueStore from "./KeyValueStore.js";
 /**
+ * Defines the request-side contract used by the persistence layer.
+ *
+ * A `Persistable` request is a `PrimaryKey` value that carries the success and
+ * error schemas needed to encode and decode the stored `Exit` for that request.
+ * Persisted request resolvers and `PersistedCache` use this metadata to restore
+ * previous lookup results from a backing store before running the lookup again.
+ *
+ * Use `Class` for cacheable or durable requests whose results can safely be
+ * reused across fibers, processes, or restarts. The request primary key is the
+ * entry id inside a persistence store, so it should be stable, collision-free,
+ * and usually include a request-specific prefix. The `storeId` is configured on
+ * `Persistence` or `PersistedCache`; it selects the backing store namespace and
+ * is separate from the request primary key.
+ *
+ * Success and error schemas are encoded with the JSON codec, so persisted
+ * values must be representable by those schemas and any required schema services
+ * must be available where the store reads or writes entries. Changing a schema,
+ * primary-key format, or store id can make existing persisted values fail to
+ * decode or stop being found, so treat those changes as persistence migrations.
+ *
  * @since 4.0.0
  */
 export * as Persistable from "./Persistable.js";
 /**
+ * Persistent caching for `Persistable` request keys.
+ *
+ * A `PersistedCache` combines a scoped in-memory `Cache` with a named
+ * `Persistence` store. It is useful for expensive or idempotent lookups such as
+ * remote API calls, database reads, and request results that should be reused
+ * across fibers, process restarts, or multiple workers sharing the same backing
+ * store.
+ *
+ * The persistent `timeToLive` is evaluated for the stored `Exit`, so successes
+ * and failures can be cached with different lifetimes. The in-memory cache has
+ * its own `inMemoryTTL` and capacity, and `invalidate` removes both the
+ * persisted value and the in-memory entry. Persisted values are encoded with
+ * the key's success and error schemas and stored under the key's primary key, so
+ * schema changes, primary-key changes, or store-id collisions can make old
+ * entries fail to decode until they are invalidated or written under a new
+ * `storeId`.
+ *
  * @since 4.0.0
  */
 export * as PersistedCache from "./PersistedCache.js";
 /**
+ * Schema-aware persisted queues for background work.
+ *
+ * A `PersistedQueue` stores JSON-encoded values in a named queue and lets
+ * workers `take` one value at a time inside a scoped processing window. It is
+ * useful for durable handoffs, background jobs, outbox-style integrations, and
+ * workloads where failed work should be retried across fibers, process
+ * restarts, or multiple workers sharing Redis or SQL.
+ *
+ * Delivery is at-least-once: a handler that fails, is interrupted, or loses its
+ * backing-store lock may see the same element again until `maxAttempts` is
+ * reached. Use stable custom ids when offering idempotent work, and choose ids
+ * that are collision-free for the backing store because stores can enforce
+ * uniqueness at the queue, prefix, or table level. Ordering is intentionally a
+ * store-level concern; retries, lock expiration, polling, and multiple workers
+ * can move entries behind newer work, so handlers should not rely on strict
+ * FIFO processing.
+ *
+ * Values are encoded and decoded with the supplied schema using the JSON codec,
+ * so schema services must be available when offering and taking values. Changing
+ * a queue name, schema, Redis prefix, SQL table, or id format is a persistence
+ * migration: old entries may decode differently, stop being visible, or collide
+ * with new entries. The memory store is process-local and volatile, while Redis
+ * and SQL stores use leases that should be tuned for the expected processing
+ * time.
+ *
  * @since 4.0.0
  */
 export * as PersistedQueue from "./PersistedQueue.js";
 /**
+ * Durable storage for encoded `Persistable` request results.
+ *
+ * The `Persistence` service creates scoped stores that read and write
+ * schema-encoded `Exit` values keyed by each request's `PrimaryKey`. It is the
+ * lower-level persistence layer used by `PersistedCache` and similar request
+ * workflows to reuse expensive or idempotent lookup results across fibers,
+ * process restarts, and workers that share a backing store.
+ *
+ * Each store is selected by a `storeId`, while each entry id comes from the
+ * request's primary key. Keep both stable and collision-free: changing the
+ * `storeId`, the primary-key format, or the success/error schemas is a
+ * persistence migration, because old entries may stop being found or fail to
+ * decode. Values are encoded with the request's success and error schemas using
+ * the JSON codec, so any required schema services must be available at store
+ * read and write time, and the backing value must stay JSON-compatible.
+ *
+ * TTLs are computed from the stored `Exit` and request key. Infinite TTLs are
+ * stored without an expiration, finite TTLs become backing-store expirations,
+ * and zero or negative TTLs skip the write entirely. Backing layers provide
+ * process-local memory, `KeyValueStore`, Redis, and SQL implementations; store
+ * ids are used as prefixes, table names, or SQL partitions and should be
+ * chosen with the target backing store in mind.
+ *
  * @since 4.0.0
  */
 export * as Persistence from "./Persistence.js";
 /**
+ * Persistent rate limiting for effects that need to coordinate token
+ * consumption through a shared `RateLimiterStore`.
+ *
+ * The module exposes a `RateLimiter` service that can consume tokens for
+ * string keys using either fixed-window counters or token-bucket state. It is
+ * useful for protecting external APIs, enforcing per-user or per-tenant quotas,
+ * throttling job workers, and coordinating limits across multiple fibers or
+ * processes when they share the Redis-backed store. The helpers can fail fast
+ * with `RateLimiterError`, return a delay to apply yourself, or wrap an effect
+ * so it waits before continuing.
+ *
+ * Rate-limit keys and Redis prefixes are part of the persistence namespace, so
+ * choose stable, collision-free values. The in-memory store is process-local
+ * and is only coordinated inside one runtime, while the Redis store uses Lua
+ * scripts for atomic updates under concurrent consumers. Time is measured with
+ * the Effect `Clock`, windows are clamped to at least one millisecond, and
+ * refill calculations use millisecond granularity.
+ *
+ * Fixed-window state is TTL-driven: rejected `fail` attempts do not extend the
+ * current TTL, and Redis fixed-window keys expire automatically. Token-bucket
+ * state keeps the remaining token count and last-refill time instead of using a
+ * TTL, so high-cardinality dynamic keys may need an external cleanup or bounded
+ * key strategy. With `onExceeded: "delay"`, overflow can be recorded so callers
+ * should actually sleep for the returned delay, or use the provided accessors.
+ *
  * @since 4.0.0
  */
 export * as RateLimiter from "./RateLimiter.js";
 /**
+ * Low-level Redis integration for the persistence modules.
+ *
+ * This module defines the `Redis` service used by Redis-backed persistence,
+ * persisted queues, and rate limiter stores. It adapts an external Redis
+ * connection to Effect through `send` for raw commands and `eval` for typed
+ * Lua scripts that are loaded with `SCRIPT LOAD` and executed with `EVALSHA`.
+ *
+ * The service does not create or manage Redis connections; callers provide a
+ * command sender from their Redis client or pool. Higher-level stores layer on
+ * key prefixes and store ids, so choose stable prefixes to avoid collisions
+ * and remember that schema or primary-key changes can make previously persisted
+ * JSON values fail to decode. Finite TTLs in the persistence stores are applied
+ * with millisecond Redis expirations, while non-finite TTLs are stored without
+ * expiration. Script parameters are stringified before execution, and the
+ * script descriptor's key count controls how Redis splits `KEYS` from `ARGV`.
+ *
  * @since 4.0.0
  */
 export * as Redis from "./Redis.js";

package/dist/unstable/persistence/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["KeyValueStore","Persistable","PersistedCache","PersistedQueue","Persistence","RateLimiter","Redis"],"sources":["../../../src/unstable/persistence/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,KAAK,MAAM,YAAY","ignoreList":[]}
+{"version":3,"file":"index.js","names":["KeyValueStore","Persistable","PersistedCache","PersistedQueue","Persistence","RateLimiter","Redis"],"sources":["../../../src/unstable/persistence/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,KAAKA,aAAa,MAAM,oBAAoB;AAEnD;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKC,KAAK,MAAM,YAAY","ignoreList":[]}