effect 4.0.0-beta.65 → 4.0.0-beta.67

package/dist/unstable/encoding/Ndjson.js

@@ -1,4 +1,20 @@
 /**
+ * Utilities for encoding Effect channel payloads and schema values as
+ * newline-delimited JSON.
+ *
+ * NDJSON represents a stream as one complete JSON value per line, making this
+ * module useful for log pipelines, long-lived HTTP responses, socket protocols,
+ * and file formats where records should be processed incrementally instead of
+ * buffering a whole JSON array. Use the byte helpers at transport boundaries
+ * that speak UTF-8, the string helpers when text framing is already handled,
+ * and the schema-aware helpers when each record should be validated or
+ * transformed at the boundary.
+ *
+ * Encoders append a trailing newline after each emitted chunk, and decoders
+ * tolerate records split across input chunks. Empty lines are only skipped when
+ * `ignoreEmptyLines` is enabled; otherwise they are passed to `JSON.parse` and
+ * fail like any other invalid JSON record.
+ *
  * @since 4.0.0
  */
 import * as Arr from "../../Array.js";
@@ -10,15 +26,24 @@ import { dual, identity } from "../../Function.js";
 const NdjsonErrorTypeId = "~effect/encoding/Ndjson/NdjsonError";
 const encoder = /*#__PURE__*/new TextEncoder();
 /**
- * @since 4.0.0
+ * Error raised when NDJSON encoding or decoding fails.
+ *
+ * The `kind` field identifies whether the failure happened while packing or
+ * unpacking, and `cause` preserves the original error.
+ *
  * @category errors
+ * @since 4.0.0
  */
 export class NdjsonError extends /*#__PURE__*/Data.TaggedError("NdjsonError") {
   /**
+   * Marks this value as an NDJSON encoding or decoding error for runtime guards.
+   *
    * @since 4.0.0
    */
   [NdjsonErrorTypeId] = NdjsonErrorTypeId;
   /**
+   * Uses the failed NDJSON operation as the public message.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -26,8 +51,13 @@ export class NdjsonError extends /*#__PURE__*/Data.TaggedError("NdjsonError") {
   }
 }
 /**
- * @since 4.0.0
+ * Creates a channel that encodes chunks of values as NDJSON strings.
+ *
+ * Each input item is `JSON.stringify`-encoded, separated by newlines, and the
+ * output chunk ends with a trailing newline.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const encodeString = () => Channel.fromTransform((upstream, _scope) => Effect.succeed(Effect.flatMap(upstream, input => {
   try {
@@ -40,23 +70,40 @@ export const encodeString = () => Channel.fromTransform((upstream, _scope) => Ef
   }
 })));
 /**
- * @since 4.0.0
+ * Creates a channel that encodes chunks of values as UTF-8 NDJSON bytes.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const encode = () => Channel.map(encodeString(), Arr.map(_ => encoder.encode(_)));
 /**
- * @since 4.0.0
+ * Creates an NDJSON byte encoder channel for values of a schema.
+ *
+ * Values are first encoded with the schema and then written as UTF-8
+ * newline-delimited JSON.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const encodeSchema = schema => () => Channel.pipeTo(ChannelSchema.encode(schema)(), encode());
 /**
- * @since 4.0.0
+ * Creates an NDJSON string encoder channel for values of a schema.
+ *
+ * Values are first encoded with the schema and then written as newline-delimited
+ * JSON strings.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const encodeSchemaString = schema => () => Channel.pipeTo(ChannelSchema.encode(schema)(), encodeString());
 /**
- * @since 4.0.0
+ * Creates a channel that parses NDJSON string chunks into values.
+ *
+ * Lines may span input chunks. Set `ignoreEmptyLines` to skip blank lines before
+ * calling `JSON.parse`; otherwise blank lines are parsed and fail as invalid JSON.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const decodeString = options => {
   const lines = Channel.splitLines().pipe(options?.ignoreEmptyLines === true ? Channel.filterArray(line => line.length > 0) : identity);
@@ -72,40 +119,77 @@ export const decodeString = options => {
   });
 };
 /**
- * @since 4.0.0
+ * Creates a channel that decodes UTF-8 byte chunks and parses them as NDJSON.
+ *
+ * Lines may span input chunks, and `ignoreEmptyLines` controls whether blank
+ * lines are skipped before JSON parsing.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const decode = options => {
   return Channel.pipeTo(Channel.decodeText(), decodeString(options));
 };
 /**
- * @since 4.0.0
+ * Creates an NDJSON byte decoder channel for values of a schema.
+ *
+ * The channel decodes UTF-8 bytes, parses each NDJSON line, and then decodes
+ * each parsed value with the schema.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const decodeSchema = schema => options => Channel.pipeTo(decode(options), ChannelSchema.decodeUnknown(schema)());
 /**
- * @since 4.0.0
+ * Creates an NDJSON string decoder channel for values of a schema.
+ *
+ * The channel parses each line as JSON and then decodes each parsed value with
+ * the schema.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const decodeSchemaString = schema => options => Channel.pipeTo(decodeString(options), ChannelSchema.decodeUnknown(schema)());
 /**
- * @since 4.0.0
+ * Wraps a bidirectional byte channel with NDJSON encoding and decoding.
+ *
+ * Outgoing values are written as UTF-8 NDJSON bytes, and incoming bytes are
+ * parsed as NDJSON values.
+ *
  * @category combinators
+ * @since 4.0.0
  */
 export const duplex = /*#__PURE__*/dual(args => Channel.isChannel(args[0]), (self, options) => Channel.pipeTo(Channel.pipeTo(encode(), self), decode(options)));
 /**
- * @since 4.0.0
+ * Wraps a bidirectional string channel with NDJSON encoding and decoding.
+ *
+ * Outgoing values are written as NDJSON strings, and incoming strings are parsed
+ * as NDJSON values.
+ *
  * @category combinators
+ * @since 4.0.0
  */
 export const duplexString = /*#__PURE__*/dual(args => Channel.isChannel(args[0]), (self, options) => Channel.pipeTo(Channel.pipeTo(encodeString(), self), decodeString(options)));
 /**
- * @since 4.0.0
+ * Wraps a bidirectional byte channel with schema-aware NDJSON encoding and
+ * decoding.
+ *
+ * Values sent to the wrapped channel are encoded with `inputSchema`; bytes
+ * received from it are parsed as NDJSON and decoded with `outputSchema`.
+ *
  * @category combinators
+ * @since 4.0.0
  */
 export const duplexSchema = /*#__PURE__*/dual(2, (self, options) => ChannelSchema.duplexUnknown(duplex(self, options), options));
 /**
- * @since 4.0.0
+ * Wraps a bidirectional string channel with schema-aware NDJSON encoding and
+ * decoding.
+ *
+ * Values sent to the wrapped channel are encoded with `inputSchema`; strings
+ * received from it are parsed as NDJSON and decoded with `outputSchema`.
+ *
  * @category combinators
+ * @since 4.0.0
  */
 export const duplexSchemaString = /*#__PURE__*/dual(2, (self, options) => ChannelSchema.duplexUnknown(duplexString(self, options), options));
 //# sourceMappingURL=Ndjson.js.map

package/dist/unstable/encoding/Ndjson.js.map

@@ -1 +1 @@
-{"version":3,"file":"Ndjson.js","names":["Arr","Channel","ChannelSchema","Data","Effect","dual","identity","NdjsonErrorTypeId","encoder","TextEncoder","NdjsonError","TaggedError","message","kind","encodeString","fromTransform","upstream","_scope","succeed","flatMap","input","of","map","item","JSON","stringify","join","cause","fail","encode","_","encodeSchema","schema","pipeTo","encodeSchemaString","decodeString","options","lines","splitLines","pipe","ignoreEmptyLines","filterArray","line","length","mapEffect","chunk","parse","decode","decodeText","decodeSchema","decodeUnknown","decodeSchemaString","duplex","args","isChannel","self","duplexString","duplexSchema","duplexUnknown","duplexSchemaString"],"sources":["../../../src/unstable/encoding/Ndjson.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,GAAG,MAAM,gBAAgB;AACrC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,aAAa,MAAM,wBAAwB;AACvD,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,IAAI,EAAEC,QAAQ,QAAQ,mBAAmB;AAGlD,MAAMC,iBAAiB,GAAG,qCAAqC;AAE/D,MAAMC,OAAO,gBAAG,IAAIC,WAAW,EAAE;AAEjC;;;;AAIA,OAAM,MAAOC,WAAY,sBAAQP,IAAI,CAACQ,WAAW,CAAC,aAAa,CAG7D;EACA;;;EAGS,CAACJ,iBAAiB,IAAIA,iBAAiB;EAEhD;;;EAGA,IAAaK,OAAOA,CAAA;IAClB,OAAO,IAAI,CAACC,IAAI;EAClB;;AAGF;;;;AAIA,OAAO,MAAMC,YAAY,GAAGA,CAAA,KAQ1Bb,OAAO,CAACc,aAAa,CAAC,CAACC,QAAQ,EAAEC,MAAM,KACrCb,MAAM,CAACc,OAAO,CAACd,MAAM,CAACe,OAAO,CAACH,QAAQ,EAAGI,KAAK,IAAI;EAChD,IAAI;IACF,OAAOhB,MAAM,CAACc,OAAO,CAAClB,GAAG,CAACqB,EAAE,CAACD,KAAK,CAACE,GAAG,CAAEC,IAAI,IAAKC,IAAI,CAACC,SAAS,CAACF,IAAI,CAAC,CAAC,CAACG,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;EAC5F,CAAC,CAAC,OAAOC,KAAK,EAAE;IACd,OAAOvB,MAAM,CAACwB,IAAI,CAAC,IAAIlB,WAAW,CAAC;MAAEG,IAAI,EAAE,MAAM;MAAEc;IAAK,CAAE,CAAC,CAAC;EAC9D;AACF,CAAC,CAAC,CAAC,CACJ;AAEH;;;;AAIA,OAAO,MAAME,MAAM,GAAGA,CAAA,KAOjB5B,OAAO,CAACqB,GAAG,CAACR,YAAY,EAAE,EAAEd,GAAG,CAACsB,GAAG,CAAEQ,CAAC,IAAKtB,OAAO,CAACqB,MAAM,CAACC,CAAC,CAAC,CAAC,CAAC;AAEnE;;;;AAIA,OAAO,MAAMC,YAAY,GACvBC,MAAS,IAEX,MAQK/B,OAAO,CAACgC,MAAM,CAAC/B,aAAa,CAAC2B,MAAM,CAACG,MAAM,CAAC,EAAE,EAAEH,MAAM,EAAE,CAAC;AAE7D;;;;AAIA,OAAO,MAAMK,kBAAkB,GAC7BF,MAAS,IAEX,MAQK/B,OAAO,CAACgC,MAAM,CAAC/B,aAAa,CAAC2B,MAAM,CAACG,MAAM,CAAC,EAAE,EAAElB,YAAY,EAAE,CAAC;AAEnE;;;;AAIA,OAAO,MAAMqB,YAAY,GAAgCC,OAExD,IAOG;EACF,MAAMC,KAAK,GAAGpC,OAAO,CAACqC,UAAU,EAAY,CAACC,IAAI,CAC/CH,OAAO,EAAEI,gBAAgB,KAAK,IAAI,GAChCvC,OAAO,CAACwC,WAAW,CAAEC,IAAI,IAAKA,IAAI,CAACC,MAAM,GAAG,CAAC,CAAC,GAC9CrC,QAAQ,CACX;EACD,OAAOL,OAAO,CAAC2C,SAAS,CAACP,KAAK,EAAGQ,KAAK,IAAI;IACxC,IAAI;MACF,OAAOzC,MAAM,CAACc,OAAO,CAAClB,GAAG,CAACsB,GAAG,CAACuB,KAAK,EAAGH,IAAI,IAAKlB,IAAI,CAACsB,KAAK,CAACJ,IAAI,CAAC,CAAC,CAAC;IACnE,CAAC,CAAC,OAAOf,KAAK,EAAE;MACd,OAAOvB,MAAM,CAACwB,IAAI,CAAC,IAAIlB,WAAW,CAAC;QAAEG,IAAI,EAAE,QAAQ;QAAEc;MAAK,CAAE,CAAC,CAAC;IAChE;EACF,CAAC,CAAC;AACJ,CAAC;AAED;;;;AAIA,OAAO,MAAMoB,MAAM,GAAgCX,OAElD,IAOG;EACF,OAAOnC,OAAO,CAACgC,MAAM,CAAChC,OAAO,CAAC+C,UAAU,EAAE,EAAEb,YAAY,CAACC,OAAO,CAAC,CAAC;AACpE,CAAC;AAED;;;;AAIA,OAAO,MAAMa,YAAY,GACvBjB,MAAS,IAEkBI,OAE5B,IAQInC,OAAO,CAACgC,MAAM,CAACc,MAAM,CAACX,OAAO,CAAC,EAAElC,aAAa,CAACgD,aAAa,CAAClB,MAAM,CAAC,EAAE,CAAC;AAE3E;;;;AAIA,OAAO,MAAMmB,kBAAkB,GAC7BnB,MAAS,IAEkBI,OAE5B,IAQInC,OAAO,CAACgC,MAAM,CAACE,YAAY,CAACC,OAAO,CAAC,EAAElC,aAAa,CAACgD,aAAa,CAAClB,MAAM,CAAC,EAAE,CAAC;AAEjF;;;;AAIA,OAAO,MAAMoB,MAAM,gBAsDf/C,IAAI,CAAEgD,IAAI,IAAKpD,OAAO,CAACqD,SAAS,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAC7CE,IAQC,EACDnB,OAEC,KAUDnC,OAAO,CAACgC,MAAM,CACZhC,OAAO,CAACgC,MAAM,CAACJ,MAAM,EAAE,EAAE0B,IAAI,CAAC,EAC9BR,MAAM,CAACX,OAAO,CAAC,CAChB,CAAC;AAEJ;;;;AAIA,OAAO,MAAMoB,YAAY,gBAsDrBnD,IAAI,CAAEgD,IAAI,IAAKpD,OAAO,CAACqD,SAAS,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAC7CE,IAQC,EACDnB,OAEC,KAUDnC,OAAO,CAACgC,MAAM,CACZhC,OAAO,CAACgC,MAAM,CAACnB,YAAY,EAAE,EAAEyC,IAAI,CAAC,EACpCpB,YAAY,CAACC,OAAO,CAAC,CACtB,CAAC;AAEJ;;;;AAIA,OAAO,MAAMqB,YAAY,gBA0DrBpD,IAAI,CAAC,CAAC,EAAE,CACVkD,IAQC,EACDnB,OAIC,KASElC,aAAa,CAACwD,aAAa,CAACN,MAAM,CAACG,IAAI,EAAEnB,OAAO,CAAC,EAAEA,OAAO,CAAC,CAAC;AAEjE;;;;AAIA,OAAO,MAAMuB,kBAAkB,gBA0D3BtD,IAAI,CAAC,CAAC,EAAE,CACVkD,IAQC,EACDnB,OAIC,KASElC,aAAa,CAACwD,aAAa,CAACF,YAAY,CAACD,IAAI,EAAEnB,OAAO,CAAC,EAAEA,OAAO,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"Ndjson.js","names":["Arr","Channel","ChannelSchema","Data","Effect","dual","identity","NdjsonErrorTypeId","encoder","TextEncoder","NdjsonError","TaggedError","message","kind","encodeString","fromTransform","upstream","_scope","succeed","flatMap","input","of","map","item","JSON","stringify","join","cause","fail","encode","_","encodeSchema","schema","pipeTo","encodeSchemaString","decodeString","options","lines","splitLines","pipe","ignoreEmptyLines","filterArray","line","length","mapEffect","chunk","parse","decode","decodeText","decodeSchema","decodeUnknown","decodeSchemaString","duplex","args","isChannel","self","duplexString","duplexSchema","duplexUnknown","duplexSchemaString"],"sources":["../../../src/unstable/encoding/Ndjson.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKA,GAAG,MAAM,gBAAgB;AACrC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,aAAa,MAAM,wBAAwB;AACvD,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,IAAI,EAAEC,QAAQ,QAAQ,mBAAmB;AAGlD,MAAMC,iBAAiB,GAAG,qCAAqC;AAE/D,MAAMC,OAAO,gBAAG,IAAIC,WAAW,EAAE;AAEjC;;;;;;;;;AASA,OAAM,MAAOC,WAAY,sBAAQP,IAAI,CAACQ,WAAW,CAAC,aAAa,CAG7D;EACA;;;;;EAKS,CAACJ,iBAAiB,IAAIA,iBAAiB;EAEhD;;;;;EAKA,IAAaK,OAAOA,CAAA;IAClB,OAAO,IAAI,CAACC,IAAI;EAClB;;AAGF;;;;;;;;;AASA,OAAO,MAAMC,YAAY,GAAGA,CAAA,KAQ1Bb,OAAO,CAACc,aAAa,CAAC,CAACC,QAAQ,EAAEC,MAAM,KACrCb,MAAM,CAACc,OAAO,CAACd,MAAM,CAACe,OAAO,CAACH,QAAQ,EAAGI,KAAK,IAAI;EAChD,IAAI;IACF,OAAOhB,MAAM,CAACc,OAAO,CAAClB,GAAG,CAACqB,EAAE,CAACD,KAAK,CAACE,GAAG,CAAEC,IAAI,IAAKC,IAAI,CAACC,SAAS,CAACF,IAAI,CAAC,CAAC,CAACG,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;EAC5F,CAAC,CAAC,OAAOC,KAAK,EAAE;IACd,OAAOvB,MAAM,CAACwB,IAAI,CAAC,IAAIlB,WAAW,CAAC;MAAEG,IAAI,EAAE,MAAM;MAAEc;IAAK,CAAE,CAAC,CAAC;EAC9D;AACF,CAAC,CAAC,CAAC,CACJ;AAEH;;;;;;AAMA,OAAO,MAAME,MAAM,GAAGA,CAAA,KAOjB5B,OAAO,CAACqB,GAAG,CAACR,YAAY,EAAE,EAAEd,GAAG,CAACsB,GAAG,CAAEQ,CAAC,IAAKtB,OAAO,CAACqB,MAAM,CAACC,CAAC,CAAC,CAAC,CAAC;AAEnE;;;;;;;;;AASA,OAAO,MAAMC,YAAY,GACvBC,MAAS,IAEX,MAQK/B,OAAO,CAACgC,MAAM,CAAC/B,aAAa,CAAC2B,MAAM,CAACG,MAAM,CAAC,EAAE,EAAEH,MAAM,EAAE,CAAC;AAE7D;;;;;;;;;AASA,OAAO,MAAMK,kBAAkB,GAC7BF,MAAS,IAEX,MAQK/B,OAAO,CAACgC,MAAM,CAAC/B,aAAa,CAAC2B,MAAM,CAACG,MAAM,CAAC,EAAE,EAAElB,YAAY,EAAE,CAAC;AAEnE;;;;;;;;;AASA,OAAO,MAAMqB,YAAY,GAAgCC,OAExD,IAOG;EACF,MAAMC,KAAK,GAAGpC,OAAO,CAACqC,UAAU,EAAY,CAACC,IAAI,CAC/CH,OAAO,EAAEI,gBAAgB,KAAK,IAAI,GAChCvC,OAAO,CAACwC,WAAW,CAAEC,IAAI,IAAKA,IAAI,CAACC,MAAM,GAAG,CAAC,CAAC,GAC9CrC,QAAQ,CACX;EACD,OAAOL,OAAO,CAAC2C,SAAS,CAACP,KAAK,EAAGQ,KAAK,IAAI;IACxC,IAAI;MACF,OAAOzC,MAAM,CAACc,OAAO,CAAClB,GAAG,CAACsB,GAAG,CAACuB,KAAK,EAAGH,IAAI,IAAKlB,IAAI,CAACsB,KAAK,CAACJ,IAAI,CAAC,CAAC,CAAC;IACnE,CAAC,CAAC,OAAOf,KAAK,EAAE;MACd,OAAOvB,MAAM,CAACwB,IAAI,CAAC,IAAIlB,WAAW,CAAC;QAAEG,IAAI,EAAE,QAAQ;QAAEc;MAAK,CAAE,CAAC,CAAC;IAChE;EACF,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;AASA,OAAO,MAAMoB,MAAM,GAAgCX,OAElD,IAOG;EACF,OAAOnC,OAAO,CAACgC,MAAM,CAAChC,OAAO,CAAC+C,UAAU,EAAE,EAAEb,YAAY,CAACC,OAAO,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;;;AASA,OAAO,MAAMa,YAAY,GACvBjB,MAAS,IAEkBI,OAE5B,IAQInC,OAAO,CAACgC,MAAM,CAACc,MAAM,CAACX,OAAO,CAAC,EAAElC,aAAa,CAACgD,aAAa,CAAClB,MAAM,CAAC,EAAE,CAAC;AAE3E;;;;;;;;;AASA,OAAO,MAAMmB,kBAAkB,GAC7BnB,MAAS,IAEkBI,OAE5B,IAQInC,OAAO,CAACgC,MAAM,CAACE,YAAY,CAACC,OAAO,CAAC,EAAElC,aAAa,CAACgD,aAAa,CAAClB,MAAM,CAAC,EAAE,CAAC;AAEjF;;;;;;;;;AASA,OAAO,MAAMoB,MAAM,gBAgEf/C,IAAI,CAAEgD,IAAI,IAAKpD,OAAO,CAACqD,SAAS,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAC7CE,IAQC,EACDnB,OAEC,KAUDnC,OAAO,CAACgC,MAAM,CACZhC,OAAO,CAACgC,MAAM,CAACJ,MAAM,EAAE,EAAE0B,IAAI,CAAC,EAC9BR,MAAM,CAACX,OAAO,CAAC,CAChB,CAAC;AAEJ;;;;;;;;;AASA,OAAO,MAAMoB,YAAY,gBAgErBnD,IAAI,CAAEgD,IAAI,IAAKpD,OAAO,CAACqD,SAAS,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAC7CE,IAQC,EACDnB,OAEC,KAUDnC,OAAO,CAACgC,MAAM,CACZhC,OAAO,CAACgC,MAAM,CAACnB,YAAY,EAAE,EAAEyC,IAAI,CAAC,EACpCpB,YAAY,CAACC,OAAO,CAAC,CACtB,CAAC;AAEJ;;;;;;;;;;AAUA,OAAO,MAAMqB,YAAY,gBAsErBpD,IAAI,CAAC,CAAC,EAAE,CACVkD,IAQC,EACDnB,OAIC,KASElC,aAAa,CAACwD,aAAa,CAACN,MAAM,CAACG,IAAI,EAAEnB,OAAO,CAAC,EAAEA,OAAO,CAAC,CAAC;AAEjE;;;;;;;;;;AAUA,OAAO,MAAMuB,kBAAkB,gBAsE3BtD,IAAI,CAAC,CAAC,EAAE,CACVkD,IAQC,EACDnB,OAIC,KASElC,aAAa,CAACwD,aAAa,CAACF,YAAY,CAACD,IAAI,EAAEnB,OAAO,CAAC,EAAEA,OAAO,CAAC,CAAC","ignoreList":[]}

package/dist/unstable/encoding/Sse.d.ts

@@ -1,4 +1,21 @@
 /**
+ * Utilities for parsing and rendering Server-Sent Events text streams.
+ *
+ * This module is useful at HTTP streaming boundaries that speak the EventSource
+ * wire format, such as live updates, notifications, progress feeds, and other
+ * unidirectional server-to-client event streams. It provides low-level parser
+ * and encoder primitives, channel combinators for streaming chunks through
+ * Effect pipelines, and schema-aware helpers for validating or transforming the
+ * `id`, `event`, and string `data` fields at the edge of an application.
+ *
+ * SSE is line-oriented text rather than a framed binary protocol. Incoming
+ * chunks may split fields across arbitrary boundaries, events are dispatched by
+ * a blank line, repeated `data:` lines are joined with newlines, and `retry:`
+ * directives are control messages rather than regular events. The decoder
+ * handles UTF-8 byte order marks, CRLF and LF line endings, default `message`
+ * events, and retry directives so callers can reconnect with the requested
+ * delay while preserving the last event ID when available.
+ *
  * @since 4.0.0
  */
 import type { NonEmptyReadonlyArray } from "../../Array.ts";
@@ -8,13 +25,24 @@ import * as Result from "../../Result.ts";
 import * as Schema from "../../Schema.ts";
 import * as Transformation from "../../SchemaTransformation.ts";
 /**
- * @since 4.0.0
+ * Creates a channel that parses Server-Sent Events text chunks into `Event`
+ * values.
+ *
+ * SSE `retry` directives are emitted as `Retry` failures so callers can
+ * reconnect with the requested delay.
+ *
  * @category Decoding
+ * @since 4.0.0
  */
 export declare const decode: <IE, Done>() => Channel.Channel<NonEmptyReadonlyArray<Event>, IE | Retry, Done, NonEmptyReadonlyArray<string>, IE, Done>;
 /**
- * @since 4.0.0
+ * Creates an SSE decoder channel that decodes each parsed event with a schema.
+ *
+ * The schema receives the untagged event shape containing `id`, `event`, and
+ * string `data`.
+ *
  * @category Decoding
+ * @since 4.0.0
  */
 export declare const decodeSchema: <Type extends {
     readonly id?: string | undefined;
@@ -22,8 +50,14 @@ export declare const decodeSchema: <Type extends {
     readonly data: string;
 }, DecodingServices, IE, Done>(schema: Schema.Decoder<Type, DecodingServices>) => Channel.Channel<NonEmptyReadonlyArray<Type>, IE | Retry | Schema.SchemaError, Done, NonEmptyReadonlyArray<string>, IE, Done, DecodingServices>;
 /**
- * @since 4.0.0
+ * Creates an SSE decoder channel that JSON-decodes each event `data` field with
+ * a schema.
+ *
+ * The output preserves the SSE `event` name and optional `id` while replacing
+ * `data` with the decoded value.
+ *
  * @category Decoding
+ * @since 4.0.0
  */
 export declare const decodeDataSchema: <Type, DecodingServices, IE, Done>(schema: Schema.Decoder<Type, DecodingServices>) => Channel.Channel<NonEmptyReadonlyArray<{
     readonly event: string;
@@ -31,30 +65,45 @@ export declare const decodeDataSchema: <Type, DecodingServices, IE, Done>(schema
     readonly data: Type;
 }>, IE | Retry | Schema.SchemaError, Done, NonEmptyReadonlyArray<string>, IE, Done, DecodingServices>;
 /**
- * Create a SSE parser.
+ * Creates a stateful Server-Sent Events parser.
  *
- * Adapted from https://github.com/rexxars/eventsource-parser under MIT license.
+ * Call `feed` with text chunks to parse `Event` and `Retry` values through the
+ * callback, and call `reset` to clear any buffered event state.
  *
- * @since 4.0.0
  * @category Decoding
+ * @since 4.0.0
  */
 export declare function makeParser(onParse: (event: AnyEvent) => void): Parser;
 /**
- * @since 4.0.0
+ * Stateful Server-Sent Events parser returned by `makeParser`.
+ *
+ * `feed` accepts additional text chunks and `reset` clears buffered parser state.
+ *
  * @category Decoding
+ * @since 4.0.0
  */
 export interface Parser {
     feed(chunk: string): void;
     reset(): void;
 }
 /**
- * @since 4.0.0
+ * Creates a channel that encodes `Event` values as Server-Sent Events text.
+ *
+ * If the upstream channel fails with `Retry`, the retry directive is written and
+ * the encoder completes.
+ *
  * @category Encoding
+ * @since 4.0.0
  */
 export declare const encode: <IE, Done>() => Channel.Channel<NonEmptyReadonlyArray<string>, IE, void, NonEmptyReadonlyArray<Event>, IE | Retry, Done>;
 /**
- * @since 4.0.0
+ * Creates an SSE encoder channel for values accepted by a schema.
+ *
+ * Values are schema-encoded to the untagged SSE event shape, transformed to
+ * `Event`, and then written as Server-Sent Events text.
+ *
  * @category Encoding
+ * @since 4.0.0
  */
 export declare const encodeSchema: <S extends Schema.Encoder<{
     readonly id?: string | undefined;
@@ -62,15 +111,22 @@ export declare const encodeSchema: <S extends Schema.Encoder<{
     readonly data: string;
 }, unknown>, IE, Done>(schema: S) => Channel.Channel<NonEmptyReadonlyArray<string>, IE | Schema.SchemaError, void, NonEmptyReadonlyArray<S["Type"]>, IE | Retry, Done, S["EncodingServices"]>;
 /**
- * @since 4.0.0
+ * Encoder capable of rendering an `Event` or `Retry` value as Server-Sent
+ * Events text.
+ *
  * @category Encoding
+ * @since 4.0.0
  */
 export interface Encoder {
     write(event: AnyEvent): string;
 }
 /**
- * @since 4.0.0
+ * Tagged model for a Server-Sent Events message.
+ *
+ * It contains the event name, optional event ID, and string data payload.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export interface Event {
     readonly _tag: "Event";
@@ -79,8 +135,12 @@ export interface Event {
     readonly data: string;
 }
 /**
- * @since 4.0.0
+ * Schema for the untagged Server-Sent Events payload shape.
+ *
+ * The shape contains `id`, `event`, and string `data` fields.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export declare const EventEncoded: Schema.Struct<{
     readonly id: Schema.UndefinedOr<Schema.String>;
@@ -88,8 +148,13 @@ export declare const EventEncoded: Schema.Struct<{
     readonly data: Schema.String;
 }>;
 /**
- * @since 4.0.0
+ * Schema for the tagged Server-Sent Events message model.
+ *
+ * The schema adds `_tag: "Event"` to the event name, optional event ID, and
+ * string data payload.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export declare const Event: Schema.Struct<{
     readonly _tag: Schema.tag<"Event">;
@@ -98,8 +163,11 @@ export declare const Event: Schema.Struct<{
     readonly data: Schema.String;
 }>;
 /**
- * @since 4.0.0
+ * Schema transformation between the untagged SSE event shape and the tagged
+ * `Event` model.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export declare const transformEvent: Transformation.Transformation<{
     readonly id?: string | undefined;
@@ -112,8 +180,12 @@ export declare const transformEvent: Transformation.Transformation<{
     readonly data: string;
 }, never, never>;
 /**
- * @since 4.0.0
+ * Untagged Server-Sent Events payload shape.
+ *
+ * It contains the event name, optional event ID, and string data payload.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export interface EventEncoded {
     readonly event: string;
@@ -125,34 +197,53 @@ declare const Retry_base: new <A extends Record<string, any> = {}>(args: import(
     readonly _tag: "Retry";
 } & import("../../Pipeable.ts").Pipeable;
 /**
- * @since 4.0.0
+ * Server-Sent Events retry directive.
+ *
+ * Decoders surface this value as a failure to request reconnection after
+ * `duration`; encoders serialize an upstream `Retry` failure as a `retry:` line.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export declare class Retry extends Retry_base<{
     readonly duration: Duration.Duration;
     readonly lastEventId: string | undefined;
 }> {
     /**
+     * Marks this value as an SSE retry directive for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [RetryTypeId]: typeof RetryTypeId;
     /**
+     * Returns `true` when the value is an SSE retry directive.
+     *
      * @since 4.0.0
      */
     static is(u: unknown): u is Retry;
     /**
+     * Separates SSE retry directives from regular event values.
+     *
      * @since 4.0.0
      */
     static filter<A>(u: A): Result.Result<Retry, Exclude<A, Retry>>;
 }
 /**
- * @since 4.0.0
+ * Union of SSE values that can be rendered by an `Encoder`: regular events and
+ * retry directives.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export type AnyEvent = Event | Retry;
 /**
- * @since 4.0.0
+ * Default Server-Sent Events encoder.
+ *
+ * It renders `Event` values as `id`, `event`, and `data` lines and renders
+ * `Retry` values as `retry:` directives.
+ *
  * @category Encoding
+ * @since 4.0.0
  */
 export declare const encoder: Encoder;
 export {};

package/dist/unstable/encoding/Sse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Sse.d.ts","sourceRoot":"","sources":["../../../src/unstable/encoding/Sse.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAG3D,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAG3C,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAA;AAI7C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,cAAc,MAAM,+BAA+B,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,EAAE,EAAE,IAAI,OAAK,OAAO,CAAC,OAAO,CACjD,qBAAqB,CAAC,KAAK,CAAC,EAC5B,EAAE,GAAG,KAAK,EACV,IAAI,EACJ,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,EACF,IAAI,CAgCH,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,SAAS;IACX,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB,EACD,gBAAgB,EAChB,EAAE,EACF,IAAI,EAEJ,QAAQ,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAC7C,OAAO,CAAC,OAAO,CAChB,qBAAqB,CAAC,IAAI,CAAC,EAC3B,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC,WAAW,EAC/B,IAAI,EACJ,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,EACF,IAAI,EACJ,gBAAgB,CAOf,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,IAAI,EAAE,gBAAgB,EAAE,EAAE,EAAE,IAAI,EAC/D,QAAQ,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAC7C,OAAO,CAAC,OAAO,CAChB,qBAAqB,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;CACpB,CAAC,EACF,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC,WAAW,EAC/B,IAAI,EACJ,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,EACF,IAAI,EACJ,gBAAgB,CAUjB,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,GAAG,MAAM,CAsJrE;AAQD;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,KAAK,IAAI,IAAI,CAAA;CACd;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,EAAE,EAAE,IAAI,OAAK,OAAO,CAAC,OAAO,CACjD,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,EACF,IAAI,EACJ,qBAAqB,CAAC,KAAK,CAAC,EAC5B,EAAE,GAAG,KAAK,EACV,IAAI,CAeH,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,YAAY,GACvB,CAAC,SAAS,MAAM,CAAC,OAAO,CACtB;IAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EACnF,OAAO,CACR,EACD,EAAE,EACF,IAAI,EACJ,QAAQ,CAAC,KAAG,OAAO,CAAC,OAAO,CAC3B,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,GAAG,MAAM,CAAC,WAAW,EACvB,IAAI,EACJ,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAChC,EAAE,GAAG,KAAK,EACV,IAAI,EACJ,CAAC,CAAC,kBAAkB,CAAC,CAMpB,CAAA;AAEH;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC9C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAA;CAC7B,CAIC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC9C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAA;CAC7B,CAKC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc;kBACX,MAAM,GAAG,SAAS;oBAChB,MAAM;mBACP,MAAM;;mBAEN,OAAO;iBACT,MAAM,GAAG,SAAS;oBACf,MAAM;mBACP,MAAM;gBASrB,CAAA;AAEF;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED,QAAA,MAAM,WAAW,EAAG,4BAAqC,CAAA;;;;AAEzD;;;GAGG;AACH,qBAAa,KAAM,SAAQ,WAA0B;IACnD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CACzC,CAAC;IACA;;OAEG;IACH,QAAQ,CAAC,CAAC,WAAW,CAAC,EAAE,OAAO,WAAW,CAAc;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,KAAK;IAGjC;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;CAGhE;AAED;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,CAAA;AAEpC;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,OAqBrB,CAAA"}
+{"version":3,"file":"Sse.d.ts","sourceRoot":"","sources":["../../../src/unstable/encoding/Sse.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAG3D,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAG3C,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAA;AAI7C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,cAAc,MAAM,+BAA+B,CAAA;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM,GAAI,EAAE,EAAE,IAAI,OAAK,OAAO,CAAC,OAAO,CACjD,qBAAqB,CAAC,KAAK,CAAC,EAC5B,EAAE,GAAG,KAAK,EACV,IAAI,EACJ,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,EACF,IAAI,CAgCH,CAAA;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,SAAS;IACX,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB,EACD,gBAAgB,EAChB,EAAE,EACF,IAAI,EAEJ,QAAQ,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAC7C,OAAO,CAAC,OAAO,CAChB,qBAAqB,CAAC,IAAI,CAAC,EAC3B,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC,WAAW,EAC/B,IAAI,EACJ,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,EACF,IAAI,EACJ,gBAAgB,CAOf,CAAA;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,GAAI,IAAI,EAAE,gBAAgB,EAAE,EAAE,EAAE,IAAI,EAC/D,QAAQ,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAC7C,OAAO,CAAC,OAAO,CAChB,qBAAqB,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;CACpB,CAAC,EACF,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC,WAAW,EAC/B,IAAI,EACJ,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,EACF,IAAI,EACJ,gBAAgB,CAUjB,CAAA;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,GAAG,MAAM,CAsJrE;AAQD;;;;;;;GAOG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,KAAK,IAAI,IAAI,CAAA;CACd;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,GAAI,EAAE,EAAE,IAAI,OAAK,OAAO,CAAC,OAAO,CACjD,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,EACF,IAAI,EACJ,qBAAqB,CAAC,KAAK,CAAC,EAC5B,EAAE,GAAG,KAAK,EACV,IAAI,CAeH,CAAA;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,CAAC,SAAS,MAAM,CAAC,OAAO,CACtB;IAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EACnF,OAAO,CACR,EACD,EAAE,EACF,IAAI,EACJ,QAAQ,CAAC,KAAG,OAAO,CAAC,OAAO,CAC3B,qBAAqB,CAAC,MAAM,CAAC,EAC7B,EAAE,GAAG,MAAM,CAAC,WAAW,EACvB,IAAI,EACJ,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAChC,EAAE,GAAG,KAAK,EACV,IAAI,EACJ,CAAC,CAAC,kBAAkB,CAAC,CAMpB,CAAA;AAEH;;;;;;GAMG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,CAAA;CAC/B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC9C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAA;CAC7B,CAIC,CAAA;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC9C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAA;CAC7B,CAKC,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;kBACX,MAAM,GAAG,SAAS;oBAChB,MAAM;mBACP,MAAM;;mBAEN,OAAO;iBACT,MAAM,GAAG,SAAS;oBACf,MAAM;mBACP,MAAM;gBASrB,CAAA;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED,QAAA,MAAM,WAAW,EAAG,4BAAqC,CAAA;;;;AAEzD;;;;;;;;GAQG;AACH,qBAAa,KAAM,SAAQ,WAA0B;IACnD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CACzC,CAAC;IACA;;;;OAIG;IACH,QAAQ,CAAC,CAAC,WAAW,CAAC,EAAE,OAAO,WAAW,CAAc;IACxD;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,KAAK;IAGjC;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;CAGhE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,CAAA;AAEpC;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,EAAE,OAqBrB,CAAA"}

package/dist/unstable/encoding/Sse.js

@@ -11,8 +11,14 @@ import * as Result from "../../Result.js";
 import * as Schema from "../../Schema.js";
 import * as Transformation from "../../SchemaTransformation.js";
 /**
- * @since 4.0.0
+ * Creates a channel that parses Server-Sent Events text chunks into `Event`
+ * values.
+ *
+ * SSE `retry` directives are emitted as `Retry` failures so callers can
+ * reconnect with the requested delay.
+ *
  * @category Decoding
+ * @since 4.0.0
  */
 export const decode = () => Channel.fromTransform((upstream, _scope) => Effect.sync(() => {
   let buffer = [];
@@ -42,13 +48,24 @@ export const decode = () => Channel.fromTransform((upstream, _scope) => Effect.s
   });
 }));
 /**
- * @since 4.0.0
+ * Creates an SSE decoder channel that decodes each parsed event with a schema.
+ *
+ * The schema receives the untagged event shape containing `id`, `event`, and
+ * string `data`.
+ *
  * @category Decoding
+ * @since 4.0.0
  */
 export const decodeSchema = schema => Channel.pipeTo(decode(), ChannelSchema.decode(EventEncoded.pipe(Schema.decodeTo(schema)))());
 /**
- * @since 4.0.0
+ * Creates an SSE decoder channel that JSON-decodes each event `data` field with
+ * a schema.
+ *
+ * The output preserves the SSE `event` name and optional `id` while replacing
+ * `data` with the decoded value.
+ *
  * @category Decoding
+ * @since 4.0.0
  */
 export const decodeDataSchema = schema => {
   const eventSchema = Schema.Struct({
@@ -58,12 +75,13 @@ export const decodeDataSchema = schema => {
   return Channel.pipeTo(decode(), ChannelSchema.decode(eventSchema)());
 };
 /**
- * Create a SSE parser.
+ * Creates a stateful Server-Sent Events parser.
  *
- * Adapted from https://github.com/rexxars/eventsource-parser under MIT license.
+ * Call `feed` with text chunks to parse `Event` and `Retry` values through the
+ * callback, and call `reset` to clear any buffered event state.
  *
- * @since 4.0.0
  * @category Decoding
+ * @since 4.0.0
  */
 export function makeParser(onParse) {
   // Processing state
@@ -202,8 +220,13 @@ function hasBom(buffer) {
   return BOM.every((charCode, index) => buffer.charCodeAt(index) === charCode);
 }
 /**
- * @since 4.0.0
+ * Creates a channel that encodes `Event` values as Server-Sent Events text.
+ *
+ * If the upstream channel fails with `Retry`, the retry directive is written and
+ * the encoder completes.
+ *
  * @category Encoding
+ * @since 4.0.0
  */
 export const encode = () => Channel.fromTransform((upstream, _scope) => Effect.sync(() => {
   let done = false;
@@ -214,13 +237,22 @@ export const encode = () => Channel.fromTransform((upstream, _scope) => Effect.s
   return Effect.suspend(() => done ? Cause.done() : pull);
 }));
 /**
- * @since 4.0.0
+ * Creates an SSE encoder channel for values accepted by a schema.
+ *
+ * Values are schema-encoded to the untagged SSE event shape, transformed to
+ * `Event`, and then written as Server-Sent Events text.
+ *
  * @category Encoding
+ * @since 4.0.0
  */
 export const encodeSchema = schema => ChannelSchema.encode(Event.pipe(Schema.decodeTo(schema, transformEvent)))().pipe(Channel.pipeTo(encode()));
 /**
- * @since 4.0.0
+ * Schema for the untagged Server-Sent Events payload shape.
+ *
+ * The shape contains `id`, `event`, and string `data` fields.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export const EventEncoded = /*#__PURE__*/Schema.Struct({
   id: /*#__PURE__*/Schema.UndefinedOr(Schema.String),
@@ -228,8 +260,13 @@ export const EventEncoded = /*#__PURE__*/Schema.Struct({
   data: Schema.String
 });
 /**
- * @since 4.0.0
+ * Schema for the tagged Server-Sent Events message model.
+ *
+ * The schema adds `_tag: "Event"` to the event name, optional event ID, and
+ * string data payload.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export const Event = /*#__PURE__*/Schema.Struct({
   _tag: /*#__PURE__*/Schema.tag("Event"),
@@ -238,8 +275,11 @@ export const Event = /*#__PURE__*/Schema.Struct({
   data: Schema.String
 });
 /**
- * @since 4.0.0
+ * Schema transformation between the untagged SSE event shape and the tagged
+ * `Event` model.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export const transformEvent = /*#__PURE__*/Transformation.transform({
   decode: event => event,
@@ -252,21 +292,32 @@ export const transformEvent = /*#__PURE__*/Transformation.transform({
 });
 const RetryTypeId = "~effect/encoding/Sse/Retry";
 /**
- * @since 4.0.0
+ * Server-Sent Events retry directive.
+ *
+ * Decoders surface this value as a failure to request reconnection after
+ * `duration`; encoders serialize an upstream `Retry` failure as a `retry:` line.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export class Retry extends /*#__PURE__*/Data.TaggedClass("Retry") {
   /**
+   * Marks this value as an SSE retry directive for runtime guards.
+   *
    * @since 4.0.0
    */
   [RetryTypeId] = RetryTypeId;
   /**
+   * Returns `true` when the value is an SSE retry directive.
+   *
    * @since 4.0.0
    */
   static is(u) {
     return hasProperty(u, RetryTypeId);
   }
   /**
+   * Separates SSE retry directives from regular event values.
+   *
    * @since 4.0.0
    */
   static filter(u) {
@@ -274,8 +325,13 @@ export class Retry extends /*#__PURE__*/Data.TaggedClass("Retry") {
   }
 }
 /**
- * @since 4.0.0
+ * Default Server-Sent Events encoder.
+ *
+ * It renders `Event` values as `id`, `event`, and `data` lines and renders
+ * `Retry` values as `retry:` directives.
+ *
  * @category Encoding
+ * @since 4.0.0
  */
 export const encoder = {
   write(event) {