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

package/dist/unstable/http/HttpClientResponse.d.ts

@@ -1,4 +1,21 @@
 /**
+ * Utilities for inspecting, decoding, and filtering HTTP client responses.
+ *
+ * An `HttpClientResponse` pairs the platform `Response` with the request that
+ * produced it, exposing status, headers, cookies, and effectful views of the
+ * response body. Use this module after an `HttpClient` call to branch on status
+ * with `matchStatus` or `filterStatus`, decode JSON or URL-encoded bodies with
+ * schemas, stream bytes, or adapt a Web `Response` with `fromWeb`.
+ *
+ * Response bodies come from the underlying Web response and should be decoded
+ * deliberately: `json` parses an empty text body as `null`, body readers fail
+ * with `HttpClientError` when decoding fails, and the raw stream fails when no
+ * body is present. Headers are represented by the HTTP `Headers` module's
+ * single-value, lowercase map, while response cookies are parsed separately from
+ * `Set-Cookie` headers. Status values are not considered errors by themselves;
+ * use the provided filters or matchers when only specific status codes are
+ * acceptable.
+ *
  * @since 4.0.0
  */
 import * as Effect from "../../Effect.ts";
@@ -13,28 +30,32 @@ import type * as HttpClientRequest from "./HttpClientRequest.ts";
 import * as HttpIncomingMessage from "./HttpIncomingMessage.ts";
 export { 
 /**
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 schemaBodyJson, 
 /**
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 schemaBodyUrlParams, 
 /**
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 schemaHeaders } from "./HttpIncomingMessage.ts";
 /**
+ * Type identifier for `HttpClientResponse` values.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export declare const TypeId = "~effect/http/HttpClientResponse";
 /**
- * @since 4.0.0
+ * Model of an HTTP client response, including the original request, status, cookies, headers, and body accessors.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface HttpClientResponse extends HttpIncomingMessage.HttpIncomingMessage<Error.HttpClientError>, Pipeable {
     readonly [TypeId]: typeof TypeId;
@@ -44,13 +65,17 @@ export interface HttpClientResponse extends HttpIncomingMessage.HttpIncomingMess
     readonly formData: Effect.Effect<FormData, Error.HttpClientError>;
 }
 /**
- * @since 4.0.0
+ * Wraps a Web `Response` and its original `HttpClientRequest` as an `HttpClientResponse`.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const fromWeb: (request: HttpClientRequest.HttpClientRequest, source: Response) => HttpClientResponse;
 /**
+ * Creates a decoder for a response's status, headers, and JSON body using the supplied schema.
+ *
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 export declare const schemaJson: <A, I extends {
     readonly status?: number | undefined;
@@ -58,26 +83,34 @@ export declare const schemaJson: <A, I extends {
     readonly body?: unknown;
 }, RD, RE>(schema: Schema.Codec<A, I, RD, RE>, options?: ParseOptions | undefined) => (self: HttpClientResponse) => Effect.Effect<A, Schema.SchemaError | Error.HttpClientError, RD>;
 /**
+ * Creates a decoder for a response's status and headers without reading a response body.
+ *
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 export declare const schemaNoBody: <A, I extends {
     readonly status?: number | undefined;
     readonly headers?: Readonly<Record<string, string>> | undefined;
 }, RD, RE>(schema: Schema.Codec<A, I, RD, RE>, options?: ParseOptions | undefined) => (self: HttpClientResponse) => Effect.Effect<A, Schema.SchemaError, RD>;
 /**
- * @since 4.0.0
+ * Converts an effect producing an `HttpClientResponse` into a stream of response body bytes.
+ *
  * @category accessors
+ * @since 4.0.0
  */
 export declare const stream: <E, R>(effect: Effect.Effect<HttpClientResponse, E, R>) => Stream.Stream<Uint8Array, Error.HttpClientError | E, R>;
 /**
- * @since 4.0.0
+ * Pattern matches on a response status, checking exact status handlers before status-class handlers and `orElse`.
+ *
  * @category pattern matching
+ * @since 4.0.0
  */
 export declare const matchStatus: {
     /**
-     * @since 4.0.0
+     * Pattern matches on a response status, checking exact status handlers before status-class handlers and `orElse`.
+     *
      * @category pattern matching
+     * @since 4.0.0
      */
     <const Cases extends {
         readonly [status: number]: (_: HttpClientResponse) => any;
@@ -88,8 +121,10 @@ export declare const matchStatus: {
         readonly orElse: (_: HttpClientResponse) => any;
     }>(cases: Cases): (self: HttpClientResponse) => Cases[keyof Cases] extends (_: any) => infer R ? Unify<R> : never;
     /**
-     * @since 4.0.0
+     * Pattern matches on a response status, checking exact status handlers before status-class handlers and `orElse`.
+     *
      * @category pattern matching
+     * @since 4.0.0
      */
     <const Cases extends {
         readonly [status: number]: (_: HttpClientResponse) => any;
@@ -101,24 +136,32 @@ export declare const matchStatus: {
     }>(self: HttpClientResponse, cases: Cases): Cases[keyof Cases] extends (_: any) => infer R ? Unify<R> : never;
 };
 /**
- * @since 4.0.0
+ * Succeeds with the response when its status satisfies the predicate, otherwise fails with `HttpClientError`.
+ *
  * @category filters
+ * @since 4.0.0
  */
 export declare const filterStatus: {
     /**
-     * @since 4.0.0
+     * Succeeds with the response when its status satisfies the predicate, otherwise fails with `HttpClientError`.
+     *
      * @category filters
+     * @since 4.0.0
      */
     (f: (status: number) => boolean): (self: HttpClientResponse) => Effect.Effect<HttpClientResponse, Error.HttpClientError>;
     /**
-     * @since 4.0.0
+     * Succeeds with the response when its status satisfies the predicate, otherwise fails with `HttpClientError`.
+     *
      * @category filters
+     * @since 4.0.0
      */
     (self: HttpClientResponse, f: (status: number) => boolean): Effect.Effect<HttpClientResponse, Error.HttpClientError>;
 };
 /**
- * @since 4.0.0
+ * Succeeds with the response only when its status is in the 2xx range, otherwise fails with `HttpClientError`.
+ *
  * @category filters
+ * @since 4.0.0
  */
 export declare const filterStatusOk: (self: HttpClientResponse) => Effect.Effect<HttpClientResponse, Error.HttpClientError>;
 //# sourceMappingURL=HttpClientResponse.d.ts.map

package/dist/unstable/http/HttpClientResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpClientResponse.d.ts","sourceRoot":"","sources":["../../../src/unstable/http/HttpClientResponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAIzC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAA;AAC7C,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAChE,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAG/D,OAAO;AACL;;;GAGG;AACH,cAAc;AACd;;;GAGG;AACH,mBAAmB;AACnB;;;GAGG;AACH,aAAa,EACd,MAAM,0BAA0B,CAAA;AAEjC;;;GAGG;AACH,eAAO,MAAM,MAAM,oCAAoC,CAAA;AAEvD;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB,CAAC,mBAAmB,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,QAAQ;IAClH,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAA;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;CAClE;AAED;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,SAAS,iBAAiB,CAAC,iBAAiB,EAAE,QAAQ,QAAQ,KAAG,kBAC7C,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,UAAU,GACrB,CAAC,EACD,CAAC,SAAS;IACR,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IAC3E,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CACxB,EACD,EAAE,EACF,EAAE,EAEF,QAAQ,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAClC,UAAU,YAAY,GAAG,SAAS,MAIhC,MAAM,kBAAkB,KACvB,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,eAAe,EAAE,EAAE,CAOnE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,GACvB,CAAC,EACD,CAAC,SAAS;IACR,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAA;CAChE,EACD,EAAE,EACF,EAAE,EAEF,QAAQ,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAClC,UAAU,YAAY,GAAG,SAAS,MAG1B,MAAM,kBAAkB,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,EAAE,CAK3E,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,CAAC,EACzB,QAAQ,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,KAC9C,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,eAAe,GAAG,CAAC,EAAE,CAAC,CAA6D,CAAA;AAEtH;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB;;;OAGG;IACH,CACE,KAAK,CAAC,KAAK,SAAS;QAClB,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QACzD,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;KAChD,EACD,KAAK,EAAE,KAAK,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;IAChH;;;OAGG;IACH,CACE,KAAK,CAAC,KAAK,SAAS;QAClB,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QACzD,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;KAChD,EACD,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;CAwB5G,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;OAGG;IACH,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;IACxH;;;OAGG;IACH,CAAC,IAAI,EAAE,kBAAkB,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;CAerH,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,kBAAkB,KAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,eAAe,CAS9G,CAAA"}
+{"version":3,"file":"HttpClientResponse.d.ts","sourceRoot":"","sources":["../../../src/unstable/http/HttpClientResponse.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAIzC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAA;AAC7C,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAChE,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAG/D,OAAO;AACL;;;GAGG;AACH,cAAc;AACd;;;GAGG;AACH,mBAAmB;AACnB;;;GAGG;AACH,aAAa,EACd,MAAM,0BAA0B,CAAA;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,MAAM,oCAAoC,CAAA;AAEvD;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB,CAAC,mBAAmB,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,QAAQ;IAClH,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAA;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;CAClE;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,SAAS,iBAAiB,CAAC,iBAAiB,EAAE,QAAQ,QAAQ,KAAG,kBAC7C,CAAA;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GACrB,CAAC,EACD,CAAC,SAAS;IACR,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IAC3E,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CACxB,EACD,EAAE,EACF,EAAE,EAEF,QAAQ,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAClC,UAAU,YAAY,GAAG,SAAS,MAIhC,MAAM,kBAAkB,KACvB,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,eAAe,EAAE,EAAE,CAOnE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GACvB,CAAC,EACD,CAAC,SAAS;IACR,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAA;CAChE,EACD,EAAE,EACF,EAAE,EAEF,QAAQ,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAClC,UAAU,YAAY,GAAG,SAAS,MAG1B,MAAM,kBAAkB,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,EAAE,CAK3E,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,CAAC,EACzB,QAAQ,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,KAC9C,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,eAAe,GAAG,CAAC,EAAE,CAAC,CAA6D,CAAA;AAEtH;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB;;;;;OAKG;IACH,CACE,KAAK,CAAC,KAAK,SAAS;QAClB,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QACzD,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;KAChD,EACD,KAAK,EAAE,KAAK,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;IAChH;;;;;OAKG;IACH,CACE,KAAK,CAAC,KAAK,SAAS;QAClB,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QACzD,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;QAC/C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,GAAG,CAAA;KAChD,EACD,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;CAwB5G,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;OAKG;IACH,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;IACxH;;;;;OAKG;IACH,CAAC,IAAI,EAAE,kBAAkB,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;CAerH,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,kBAAkB,KAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,KAAK,CAAC,eAAe,CAS9G,CAAA"}

package/dist/unstable/http/HttpClientResponse.js

@@ -1,4 +1,21 @@
 /**
+ * Utilities for inspecting, decoding, and filtering HTTP client responses.
+ *
+ * An `HttpClientResponse` pairs the platform `Response` with the request that
+ * produced it, exposing status, headers, cookies, and effectful views of the
+ * response body. Use this module after an `HttpClient` call to branch on status
+ * with `matchStatus` or `filterStatus`, decode JSON or URL-encoded bodies with
+ * schemas, stream bytes, or adapt a Web `Response` with `fromWeb`.
+ *
+ * Response bodies come from the underlying Web response and should be decoded
+ * deliberately: `json` parses an empty text body as `null`, body readers fail
+ * with `HttpClientError` when decoding fails, and the raw stream fails when no
+ * body is present. Headers are represented by the HTTP `Headers` module's
+ * single-value, lowercase map, while response cookies are parsed separately from
+ * `Set-Cookie` headers. Status values are not considered errors by themselves;
+ * use the provided filters or matchers when only specific status codes are
+ * acceptable.
+ *
  * @since 4.0.0
  */
 import * as Effect from "../../Effect.js";
@@ -15,33 +32,39 @@ import * as HttpIncomingMessage from "./HttpIncomingMessage.js";
 import * as UrlParams from "./UrlParams.js";
 export {
 /**
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 schemaBodyJson,
 /**
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 schemaBodyUrlParams,
 /**
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 schemaHeaders } from "./HttpIncomingMessage.js";
 /**
+ * Type identifier for `HttpClientResponse` values.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export const TypeId = "~effect/http/HttpClientResponse";
 /**
- * @since 4.0.0
+ * Wraps a Web `Response` and its original `HttpClientRequest` as an `HttpClientResponse`.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const fromWeb = (request, source) => new WebHttpClientResponse(request, source);
 /**
+ * Creates a decoder for a response's status, headers, and JSON body using the supplied schema.
+ *
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 export const schemaJson = (schema, options) => {
   const decode = Schema.decodeEffect(Schema.toCodecJson(schema).annotate({
@@ -54,8 +77,10 @@ export const schemaJson = (schema, options) => {
   }));
 };
 /**
+ * Creates a decoder for a response's status and headers without reading a response body.
+ *
+ * @category schemas
  * @since 4.0.0
- * @category schema
  */
 export const schemaNoBody = (schema, options) => {
   const decode = Schema.decodeEffect(schema.annotate({
@@ -67,13 +92,17 @@ export const schemaNoBody = (schema, options) => {
   });
 };
 /**
- * @since 4.0.0
+ * Converts an effect producing an `HttpClientResponse` into a stream of response body bytes.
+ *
  * @category accessors
+ * @since 4.0.0
  */
 export const stream = effect => Stream.unwrap(Effect.map(effect, self => self.stream));
 /**
- * @since 4.0.0
+ * Pattern matches on a response status, checking exact status handlers before status-class handlers and `orElse`.
+ *
  * @category pattern matching
+ * @since 4.0.0
  */
 export const matchStatus = /*#__PURE__*/dual(2, (self, cases) => {
   const status = self.status;
@@ -91,8 +120,10 @@ export const matchStatus = /*#__PURE__*/dual(2, (self, cases) => {
   return cases.orElse(self);
 });
 /**
- * @since 4.0.0
+ * Succeeds with the response when its status satisfies the predicate, otherwise fails with `HttpClientError`.
+ *
  * @category filters
+ * @since 4.0.0
  */
 export const filterStatus = /*#__PURE__*/dual(2, (self, f) => Effect.suspend(() => f(self.status) ? Effect.succeed(self) : Effect.fail(new Error.HttpClientError({
   reason: new Error.StatusCodeError({
@@ -102,8 +133,10 @@ export const filterStatus = /*#__PURE__*/dual(2, (self, f) => Effect.suspend(()
   })
 }))));
 /**
- * @since 4.0.0
+ * Succeeds with the response only when its status is in the 2xx range, otherwise fails with `HttpClientError`.
+ *
  * @category filters
+ * @since 4.0.0
  */
 export const filterStatusOk = self => self.status >= 200 && self.status < 300 ? Effect.succeed(self) : Effect.fail(new Error.HttpClientError({
   reason: new Error.StatusCodeError({

package/dist/unstable/http/HttpClientResponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpClientResponse.js","names":["Effect","dual","Inspectable","Option","pipeArguments","Schema","Stream","Cookies","Headers","Error","HttpIncomingMessage","UrlParams","schemaBodyJson","schemaBodyUrlParams","schemaHeaders","TypeId","fromWeb","request","source","WebHttpClientResponse","schemaJson","schema","options","decode","decodeEffect","toCodecJson","annotate","self","flatMap","json","body","status","headers","schemaNoBody","stream","effect","unwrap","map","matchStatus","cases","orElse","filterStatus","f","suspend","succeed","fail","HttpClientError","reason","StatusCodeError","response","description","filterStatusOk","Class","constructor","toJSON","inspect","_id","fromInput","cachedCookies","cookies","fromSetCookie","getSetCookie","remoteAddress","none","fromReadableStream","evaluate","onError","cause","DecodeError","EmptyBodyError","text","try","JSON","parse","catch","textBody","tryPromise","pipe","cached","runSync","arrayBufferBody","_","TextEncoder","encode","buffer","urlParamsBody","URLSearchParams","formDataBody","formData","arrayBuffer","TextDecoder","arguments"],"sources":["../../../src/unstable/http/HttpClientResponse.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AACzC,SAASC,IAAI,QAAQ,mBAAmB;AACxC,OAAO,KAAKC,WAAW,MAAM,sBAAsB;AACnD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAAwBC,aAAa,QAAQ,mBAAmB;AAChE,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,OAAO,MAAM,cAAc;AACvC,OAAO,KAAKC,OAAO,MAAM,cAAc;AACvC,OAAO,KAAKC,KAAK,MAAM,sBAAsB;AAE7C,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B;AAC/D,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;AACE;;;;AAIAC,cAAc;AACd;;;;AAIAC,mBAAmB;AACnB;;;;AAIAC,aAAa,QACR,0BAA0B;AAEjC;;;;AAIA,OAAO,MAAMC,MAAM,GAAG,iCAAiC;AAcvD;;;;AAIA,OAAO,MAAMC,OAAO,GAAGA,CAACC,OAA4C,EAAEC,MAAgB,KACpF,IAAIC,qBAAqB,CAACF,OAAO,EAAEC,MAAM,CAAC;AAE5C;;;;AAIA,OAAO,MAAME,UAAU,GAAGA,CAUxBC,MAAkC,EAClCC,OAAkC,KAChC;EACF,MAAMC,MAAM,GAAGlB,MAAM,CAACmB,YAAY,CAACnB,MAAM,CAACoB,WAAW,CAACJ,MAAM,CAAC,CAACK,QAAQ,CAAC;IAAEJ;EAAO,CAAE,CAAC,CAAC;EACpF,OACEK,IAAwB,IAExB3B,MAAM,CAAC4B,OAAO,CAACD,IAAI,CAACE,IAAI,EAAGC,IAAI,IAC7BP,MAAM,CAAC;IACLQ,MAAM,EAAEJ,IAAI,CAACI,MAAM;IACnBC,OAAO,EAAEL,IAAI,CAACK,OAAO;IACrBF;GACD,CAAC,CAAC;AACT,CAAC;AAED;;;;AAIA,OAAO,MAAMG,YAAY,GAAGA,CAS1BZ,MAAkC,EAClCC,OAAkC,KAChC;EACF,MAAMC,MAAM,GAAGlB,MAAM,CAACmB,YAAY,CAACH,MAAM,CAACK,QAAQ,CAAC;IAAEJ;EAAO,CAAE,CAAC,CAAC;EAChE,OAAQK,IAAwB,IAC9BJ,MAAM,CAAC;IACLQ,MAAM,EAAEJ,IAAI,CAACI,MAAM;IACnBC,OAAO,EAAEL,IAAI,CAACK;GACH,CAAC;AAClB,CAAC;AAED;;;;AAIA,OAAO,MAAME,MAAM,GACjBC,MAA+C,IACa7B,MAAM,CAAC8B,MAAM,CAACpC,MAAM,CAACqC,GAAG,CAACF,MAAM,EAAGR,IAAI,IAAKA,IAAI,CAACO,MAAM,CAAC,CAAC;AAEtH;;;;AAIA,OAAO,MAAMI,WAAW,gBA6BpBrC,IAAI,CAAC,CAAC,EAAE,CASV0B,IAAwB,EAAEY,KAAY,KAAI;EAC1C,MAAMR,MAAM,GAAGJ,IAAI,CAACI,MAAM;EAC1B,IAAIQ,KAAK,CAACR,MAAM,CAAC,EAAE;IACjB,OAAOQ,KAAK,CAACR,MAAM,CAAC,CAACJ,IAAI,CAAC;EAC5B,CAAC,MAAM,IAAII,MAAM,IAAI,GAAG,IAAIA,MAAM,GAAG,GAAG,IAAIQ,KAAK,CAAC,KAAK,CAAC,EAAE;IACxD,OAAOA,KAAK,CAAC,KAAK,CAAC,CAACZ,IAAI,CAAC;EAC3B,CAAC,MAAM,IAAII,MAAM,IAAI,GAAG,IAAIA,MAAM,GAAG,GAAG,IAAIQ,KAAK,CAAC,KAAK,CAAC,EAAE;IACxD,OAAOA,KAAK,CAAC,KAAK,CAAC,CAACZ,IAAI,CAAC;EAC3B,CAAC,MAAM,IAAII,MAAM,IAAI,GAAG,IAAIA,MAAM,GAAG,GAAG,IAAIQ,KAAK,CAAC,KAAK,CAAC,EAAE;IACxD,OAAOA,KAAK,CAAC,KAAK,CAAC,CAACZ,IAAI,CAAC;EAC3B,CAAC,MAAM,IAAII,MAAM,IAAI,GAAG,IAAIA,MAAM,GAAG,GAAG,IAAIQ,KAAK,CAAC,KAAK,CAAC,EAAE;IACxD,OAAOA,KAAK,CAAC,KAAK,CAAC,CAACZ,IAAI,CAAC;EAC3B;EACA,OAAOY,KAAK,CAACC,MAAM,CAACb,IAAI,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;AAIA,OAAO,MAAMc,YAAY,gBAWrBxC,IAAI,CACN,CAAC,EACD,CAAC0B,IAAwB,EAAEe,CAA8B,KACvD1C,MAAM,CAAC2C,OAAO,CAAC,MACbD,CAAC,CAACf,IAAI,CAACI,MAAM,CAAC,GAAG/B,MAAM,CAAC4C,OAAO,CAACjB,IAAI,CAAC,GAAG3B,MAAM,CAAC6C,IAAI,CACjD,IAAIpC,KAAK,CAACqC,eAAe,CAAC;EACxBC,MAAM,EAAE,IAAItC,KAAK,CAACuC,eAAe,CAAC;IAChCC,QAAQ,EAAEtB,IAAI;IACdV,OAAO,EAAEU,IAAI,CAACV,OAAO;IACrBiC,WAAW,EAAE;GACd;CACF,CAAC,CACH,CACF,CACJ;AAED;;;;AAIA,OAAO,MAAMC,cAAc,GAAIxB,IAAwB,IACrDA,IAAI,CAACI,MAAM,IAAI,GAAG,IAAIJ,IAAI,CAACI,MAAM,GAAG,GAAG,GAAG/B,MAAM,CAAC4C,OAAO,CAACjB,IAAI,CAAC,GAAG3B,MAAM,CAAC6C,IAAI,CAC1E,IAAIpC,KAAK,CAACqC,eAAe,CAAC;EACxBC,MAAM,EAAE,IAAItC,KAAK,CAACuC,eAAe,CAAC;IAChCC,QAAQ,EAAEtB,IAAI;IACdV,OAAO,EAAEU,IAAI,CAACV,OAAO;IACrBiC,WAAW,EAAE;GACd;CACF,CAAC,CACH;AAEH;AACA;AACA;AAEA,MAAM/B,qBAAsB,SAAQjB,WAAW,CAACkD,KAAK;EAC1C,CAAC1C,mBAAmB,CAACK,MAAM;EAC3B,CAACA,MAAM;EAEPE,OAAO;EACCC,MAAM;EAEvBmC,YACEpC,OAA4C,EAC5CC,MAA2B;IAE3B,KAAK,EAAE;IACP,IAAI,CAACD,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACR,mBAAmB,CAACK,MAAM,CAAC,GAAGL,mBAAmB,CAACK,MAAM;IAC7D,IAAI,CAACA,MAAM,CAAC,GAAGA,MAAM;EACvB;EAEAuC,MAAMA,CAAA;IACJ,OAAO5C,mBAAmB,CAAC6C,OAAO,CAAC,IAAI,EAAE;MACvCC,GAAG,EAAE,oBAAoB;MACzBvC,OAAO,EAAE,IAAI,CAACA,OAAO,CAACqC,MAAM,EAAE;MAC9BvB,MAAM,EAAE,IAAI,CAACA;KACd,CAAC;EACJ;EAEA,IAAIA,MAAMA,CAAA;IACR,OAAO,IAAI,CAACb,MAAM,CAACa,MAAM;EAC3B;EAEA,IAAIC,OAAOA,CAAA;IACT,OAAOxB,OAAO,CAACiD,SAAS,CAAC,IAAI,CAACvC,MAAM,CAACc,OAAO,CAAC;EAC/C;EAEA0B,aAAa;EACb,IAAIC,OAAOA,CAAA;IACT,IAAI,IAAI,CAACD,aAAa,EAAE;MACtB,OAAO,IAAI,CAACA,aAAa;IAC3B;IACA,OAAO,IAAI,CAACA,aAAa,GAAGnD,OAAO,CAACqD,aAAa,CAAC,IAAI,CAAC1C,MAAM,CAACc,OAAO,CAAC6B,YAAY,EAAE,CAAC;EACvF;EAEA,IAAIC,aAAaA,CAAA;IACf,OAAO3D,MAAM,CAAC4D,IAAI,EAAE;EACtB;EAEA,IAAI7B,MAAMA,CAAA;IACR,OAAO,IAAI,CAAChB,MAAM,CAACY,IAAI,GACnBxB,MAAM,CAAC0D,kBAAkB,CAAC;MAC1BC,QAAQ,EAAEA,CAAA,KAAM,IAAI,CAAC/C,MAAM,CAACY,IAAK;MACjCoC,OAAO,EAAGC,KAAK,IACb,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,GACA7D,MAAM,CAACuC,IAAI,CACX,IAAIpC,KAAK,CAACqC,eAAe,CAAC;MACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC4D,cAAc,CAAC;QAC/BpD,OAAO,EAAE,IAAI,CAACA,OAAO;QACrBgC,QAAQ,EAAE,IAAI;QACdC,WAAW,EAAE;OACd;KACF,CAAC,CACH;EACL;EAEA,IAAIrB,IAAIA,CAAA;IACN,OAAO7B,MAAM,CAAC4B,OAAO,CAAC,IAAI,CAAC0C,IAAI,EAAGA,IAAI,IACpCtE,MAAM,CAACuE,GAAG,CAAC;MACTA,GAAG,EAAEA,CAAA,KAAMD,IAAI,KAAK,EAAE,GAAG,IAAI,GAAGE,IAAI,CAACC,KAAK,CAACH,IAAI,CAAC;MAChDI,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAAC;EACP;EAEQQ,QAAQ;EAChB,IAAIL,IAAIA,CAAA;IACN,IAAI,IAAI,CAACK,QAAQ,EAAE;MACjB,OAAO,IAAI,CAACA,QAAQ;IACtB;IACA,IAAI,CAACA,QAAQ,GAAG3E,MAAM,CAAC4E,UAAU,CAAC;MAChCL,GAAG,EAAEA,CAAA,KAAM,IAAI,CAACrD,MAAM,CAACoD,IAAI,EAAE;MAC7BI,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAACU,IAAI,CAAC7E,MAAM,CAAC8E,MAAM,EAAE9E,MAAM,CAAC+E,OAAO,CAAC;IACtC,IAAI,CAACC,eAAe,GAAGhF,MAAM,CAACqC,GAAG,CAAC,IAAI,CAACsC,QAAQ,EAAGM,CAAC,IAAK,IAAIC,WAAW,EAAE,CAACC,MAAM,CAACF,CAAC,CAAC,CAACG,MAAM,CAAC;IAC3F,OAAO,IAAI,CAACT,QAAQ;EACtB;EAEA,IAAIU,aAAaA,CAAA;IACf,OAAOrF,MAAM,CAAC4B,OAAO,CAAC,IAAI,CAAC0C,IAAI,EAAGW,CAAC,IACjCjF,MAAM,CAACuE,GAAG,CAAC;MACTA,GAAG,EAAEA,CAAA,KAAM5D,SAAS,CAAC8C,SAAS,CAAC,IAAI6B,eAAe,CAACL,CAAC,CAAC,CAAC;MACtDP,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAAC;EACP;EAEQoB,YAAY;EACpB,IAAIC,QAAQA,CAAA;IACV,OAAO,IAAI,CAACD,YAAY,KAAKvF,MAAM,CAAC4E,UAAU,CAAC;MAC7CL,GAAG,EAAEA,CAAA,KAAM,IAAI,CAACrD,MAAM,CAACsE,QAAQ,EAAE;MACjCd,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAACU,IAAI,CAAC7E,MAAM,CAAC8E,MAAM,EAAE9E,MAAM,CAAC+E,OAAO,CAAC;EACxC;EAEQC,eAAe;EACvB,IAAIS,WAAWA,CAAA;IACb,IAAI,IAAI,CAACT,eAAe,EAAE;MACxB,OAAO,IAAI,CAACA,eAAe;IAC7B;IACA,IAAI,CAACA,eAAe,GAAGhF,MAAM,CAAC4E,UAAU,CAAC;MACvCL,GAAG,EAAEA,CAAA,KAAM,IAAI,CAACrD,MAAM,CAACuE,WAAW,EAAE;MACpCf,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAACU,IAAI,CAAC7E,MAAM,CAAC8E,MAAM,EAAE9E,MAAM,CAAC+E,OAAO,CAAC;IACtC,IAAI,CAACJ,QAAQ,GAAG3E,MAAM,CAACqC,GAAG,CAAC,IAAI,CAAC2C,eAAe,EAAGC,CAAC,IAAK,IAAIS,WAAW,EAAE,CAACnE,MAAM,CAAC0D,CAAC,CAAC,CAAC;IACpF,OAAO,IAAI,CAACD,eAAe;EAC7B;EAEAH,IAAIA,CAAA;IACF,OAAOzE,aAAa,CAAC,IAAI,EAAEuF,SAAS,CAAC;EACvC","ignoreList":[]}
+{"version":3,"file":"HttpClientResponse.js","names":["Effect","dual","Inspectable","Option","pipeArguments","Schema","Stream","Cookies","Headers","Error","HttpIncomingMessage","UrlParams","schemaBodyJson","schemaBodyUrlParams","schemaHeaders","TypeId","fromWeb","request","source","WebHttpClientResponse","schemaJson","schema","options","decode","decodeEffect","toCodecJson","annotate","self","flatMap","json","body","status","headers","schemaNoBody","stream","effect","unwrap","map","matchStatus","cases","orElse","filterStatus","f","suspend","succeed","fail","HttpClientError","reason","StatusCodeError","response","description","filterStatusOk","Class","constructor","toJSON","inspect","_id","fromInput","cachedCookies","cookies","fromSetCookie","getSetCookie","remoteAddress","none","fromReadableStream","evaluate","onError","cause","DecodeError","EmptyBodyError","text","try","JSON","parse","catch","textBody","tryPromise","pipe","cached","runSync","arrayBufferBody","_","TextEncoder","encode","buffer","urlParamsBody","URLSearchParams","formDataBody","formData","arrayBuffer","TextDecoder","arguments"],"sources":["../../../src/unstable/http/HttpClientResponse.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AACzC,SAASC,IAAI,QAAQ,mBAAmB;AACxC,OAAO,KAAKC,WAAW,MAAM,sBAAsB;AACnD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAAwBC,aAAa,QAAQ,mBAAmB;AAChE,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,OAAO,MAAM,cAAc;AACvC,OAAO,KAAKC,OAAO,MAAM,cAAc;AACvC,OAAO,KAAKC,KAAK,MAAM,sBAAsB;AAE7C,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B;AAC/D,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;AACE;;;;AAIAC,cAAc;AACd;;;;AAIAC,mBAAmB;AACnB;;;;AAIAC,aAAa,QACR,0BAA0B;AAEjC;;;;;;AAMA,OAAO,MAAMC,MAAM,GAAG,iCAAiC;AAgBvD;;;;;;AAMA,OAAO,MAAMC,OAAO,GAAGA,CAACC,OAA4C,EAAEC,MAAgB,KACpF,IAAIC,qBAAqB,CAACF,OAAO,EAAEC,MAAM,CAAC;AAE5C;;;;;;AAMA,OAAO,MAAME,UAAU,GAAGA,CAUxBC,MAAkC,EAClCC,OAAkC,KAChC;EACF,MAAMC,MAAM,GAAGlB,MAAM,CAACmB,YAAY,CAACnB,MAAM,CAACoB,WAAW,CAACJ,MAAM,CAAC,CAACK,QAAQ,CAAC;IAAEJ;EAAO,CAAE,CAAC,CAAC;EACpF,OACEK,IAAwB,IAExB3B,MAAM,CAAC4B,OAAO,CAACD,IAAI,CAACE,IAAI,EAAGC,IAAI,IAC7BP,MAAM,CAAC;IACLQ,MAAM,EAAEJ,IAAI,CAACI,MAAM;IACnBC,OAAO,EAAEL,IAAI,CAACK,OAAO;IACrBF;GACD,CAAC,CAAC;AACT,CAAC;AAED;;;;;;AAMA,OAAO,MAAMG,YAAY,GAAGA,CAS1BZ,MAAkC,EAClCC,OAAkC,KAChC;EACF,MAAMC,MAAM,GAAGlB,MAAM,CAACmB,YAAY,CAACH,MAAM,CAACK,QAAQ,CAAC;IAAEJ;EAAO,CAAE,CAAC,CAAC;EAChE,OAAQK,IAAwB,IAC9BJ,MAAM,CAAC;IACLQ,MAAM,EAAEJ,IAAI,CAACI,MAAM;IACnBC,OAAO,EAAEL,IAAI,CAACK;GACH,CAAC;AAClB,CAAC;AAED;;;;;;AAMA,OAAO,MAAME,MAAM,GACjBC,MAA+C,IACa7B,MAAM,CAAC8B,MAAM,CAACpC,MAAM,CAACqC,GAAG,CAACF,MAAM,EAAGR,IAAI,IAAKA,IAAI,CAACO,MAAM,CAAC,CAAC;AAEtH;;;;;;AAMA,OAAO,MAAMI,WAAW,gBAiCpBrC,IAAI,CAAC,CAAC,EAAE,CASV0B,IAAwB,EAAEY,KAAY,KAAI;EAC1C,MAAMR,MAAM,GAAGJ,IAAI,CAACI,MAAM;EAC1B,IAAIQ,KAAK,CAACR,MAAM,CAAC,EAAE;IACjB,OAAOQ,KAAK,CAACR,MAAM,CAAC,CAACJ,IAAI,CAAC;EAC5B,CAAC,MAAM,IAAII,MAAM,IAAI,GAAG,IAAIA,MAAM,GAAG,GAAG,IAAIQ,KAAK,CAAC,KAAK,CAAC,EAAE;IACxD,OAAOA,KAAK,CAAC,KAAK,CAAC,CAACZ,IAAI,CAAC;EAC3B,CAAC,MAAM,IAAII,MAAM,IAAI,GAAG,IAAIA,MAAM,GAAG,GAAG,IAAIQ,KAAK,CAAC,KAAK,CAAC,EAAE;IACxD,OAAOA,KAAK,CAAC,KAAK,CAAC,CAACZ,IAAI,CAAC;EAC3B,CAAC,MAAM,IAAII,MAAM,IAAI,GAAG,IAAIA,MAAM,GAAG,GAAG,IAAIQ,KAAK,CAAC,KAAK,CAAC,EAAE;IACxD,OAAOA,KAAK,CAAC,KAAK,CAAC,CAACZ,IAAI,CAAC;EAC3B,CAAC,MAAM,IAAII,MAAM,IAAI,GAAG,IAAIA,MAAM,GAAG,GAAG,IAAIQ,KAAK,CAAC,KAAK,CAAC,EAAE;IACxD,OAAOA,KAAK,CAAC,KAAK,CAAC,CAACZ,IAAI,CAAC;EAC3B;EACA,OAAOY,KAAK,CAACC,MAAM,CAACb,IAAI,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMc,YAAY,gBAerBxC,IAAI,CACN,CAAC,EACD,CAAC0B,IAAwB,EAAEe,CAA8B,KACvD1C,MAAM,CAAC2C,OAAO,CAAC,MACbD,CAAC,CAACf,IAAI,CAACI,MAAM,CAAC,GAAG/B,MAAM,CAAC4C,OAAO,CAACjB,IAAI,CAAC,GAAG3B,MAAM,CAAC6C,IAAI,CACjD,IAAIpC,KAAK,CAACqC,eAAe,CAAC;EACxBC,MAAM,EAAE,IAAItC,KAAK,CAACuC,eAAe,CAAC;IAChCC,QAAQ,EAAEtB,IAAI;IACdV,OAAO,EAAEU,IAAI,CAACV,OAAO;IACrBiC,WAAW,EAAE;GACd;CACF,CAAC,CACH,CACF,CACJ;AAED;;;;;;AAMA,OAAO,MAAMC,cAAc,GAAIxB,IAAwB,IACrDA,IAAI,CAACI,MAAM,IAAI,GAAG,IAAIJ,IAAI,CAACI,MAAM,GAAG,GAAG,GAAG/B,MAAM,CAAC4C,OAAO,CAACjB,IAAI,CAAC,GAAG3B,MAAM,CAAC6C,IAAI,CAC1E,IAAIpC,KAAK,CAACqC,eAAe,CAAC;EACxBC,MAAM,EAAE,IAAItC,KAAK,CAACuC,eAAe,CAAC;IAChCC,QAAQ,EAAEtB,IAAI;IACdV,OAAO,EAAEU,IAAI,CAACV,OAAO;IACrBiC,WAAW,EAAE;GACd;CACF,CAAC,CACH;AAEH;AACA;AACA;AAEA,MAAM/B,qBAAsB,SAAQjB,WAAW,CAACkD,KAAK;EAC1C,CAAC1C,mBAAmB,CAACK,MAAM;EAC3B,CAACA,MAAM;EAEPE,OAAO;EACCC,MAAM;EAEvBmC,YACEpC,OAA4C,EAC5CC,MAA2B;IAE3B,KAAK,EAAE;IACP,IAAI,CAACD,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACR,mBAAmB,CAACK,MAAM,CAAC,GAAGL,mBAAmB,CAACK,MAAM;IAC7D,IAAI,CAACA,MAAM,CAAC,GAAGA,MAAM;EACvB;EAEAuC,MAAMA,CAAA;IACJ,OAAO5C,mBAAmB,CAAC6C,OAAO,CAAC,IAAI,EAAE;MACvCC,GAAG,EAAE,oBAAoB;MACzBvC,OAAO,EAAE,IAAI,CAACA,OAAO,CAACqC,MAAM,EAAE;MAC9BvB,MAAM,EAAE,IAAI,CAACA;KACd,CAAC;EACJ;EAEA,IAAIA,MAAMA,CAAA;IACR,OAAO,IAAI,CAACb,MAAM,CAACa,MAAM;EAC3B;EAEA,IAAIC,OAAOA,CAAA;IACT,OAAOxB,OAAO,CAACiD,SAAS,CAAC,IAAI,CAACvC,MAAM,CAACc,OAAO,CAAC;EAC/C;EAEA0B,aAAa;EACb,IAAIC,OAAOA,CAAA;IACT,IAAI,IAAI,CAACD,aAAa,EAAE;MACtB,OAAO,IAAI,CAACA,aAAa;IAC3B;IACA,OAAO,IAAI,CAACA,aAAa,GAAGnD,OAAO,CAACqD,aAAa,CAAC,IAAI,CAAC1C,MAAM,CAACc,OAAO,CAAC6B,YAAY,EAAE,CAAC;EACvF;EAEA,IAAIC,aAAaA,CAAA;IACf,OAAO3D,MAAM,CAAC4D,IAAI,EAAE;EACtB;EAEA,IAAI7B,MAAMA,CAAA;IACR,OAAO,IAAI,CAAChB,MAAM,CAACY,IAAI,GACnBxB,MAAM,CAAC0D,kBAAkB,CAAC;MAC1BC,QAAQ,EAAEA,CAAA,KAAM,IAAI,CAAC/C,MAAM,CAACY,IAAK;MACjCoC,OAAO,EAAGC,KAAK,IACb,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,GACA7D,MAAM,CAACuC,IAAI,CACX,IAAIpC,KAAK,CAACqC,eAAe,CAAC;MACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC4D,cAAc,CAAC;QAC/BpD,OAAO,EAAE,IAAI,CAACA,OAAO;QACrBgC,QAAQ,EAAE,IAAI;QACdC,WAAW,EAAE;OACd;KACF,CAAC,CACH;EACL;EAEA,IAAIrB,IAAIA,CAAA;IACN,OAAO7B,MAAM,CAAC4B,OAAO,CAAC,IAAI,CAAC0C,IAAI,EAAGA,IAAI,IACpCtE,MAAM,CAACuE,GAAG,CAAC;MACTA,GAAG,EAAEA,CAAA,KAAMD,IAAI,KAAK,EAAE,GAAG,IAAI,GAAGE,IAAI,CAACC,KAAK,CAACH,IAAI,CAAC;MAChDI,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAAC;EACP;EAEQQ,QAAQ;EAChB,IAAIL,IAAIA,CAAA;IACN,IAAI,IAAI,CAACK,QAAQ,EAAE;MACjB,OAAO,IAAI,CAACA,QAAQ;IACtB;IACA,IAAI,CAACA,QAAQ,GAAG3E,MAAM,CAAC4E,UAAU,CAAC;MAChCL,GAAG,EAAEA,CAAA,KAAM,IAAI,CAACrD,MAAM,CAACoD,IAAI,EAAE;MAC7BI,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAACU,IAAI,CAAC7E,MAAM,CAAC8E,MAAM,EAAE9E,MAAM,CAAC+E,OAAO,CAAC;IACtC,IAAI,CAACC,eAAe,GAAGhF,MAAM,CAACqC,GAAG,CAAC,IAAI,CAACsC,QAAQ,EAAGM,CAAC,IAAK,IAAIC,WAAW,EAAE,CAACC,MAAM,CAACF,CAAC,CAAC,CAACG,MAAM,CAAC;IAC3F,OAAO,IAAI,CAACT,QAAQ;EACtB;EAEA,IAAIU,aAAaA,CAAA;IACf,OAAOrF,MAAM,CAAC4B,OAAO,CAAC,IAAI,CAAC0C,IAAI,EAAGW,CAAC,IACjCjF,MAAM,CAACuE,GAAG,CAAC;MACTA,GAAG,EAAEA,CAAA,KAAM5D,SAAS,CAAC8C,SAAS,CAAC,IAAI6B,eAAe,CAACL,CAAC,CAAC,CAAC;MACtDP,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAAC;EACP;EAEQoB,YAAY;EACpB,IAAIC,QAAQA,CAAA;IACV,OAAO,IAAI,CAACD,YAAY,KAAKvF,MAAM,CAAC4E,UAAU,CAAC;MAC7CL,GAAG,EAAEA,CAAA,KAAM,IAAI,CAACrD,MAAM,CAACsE,QAAQ,EAAE;MACjCd,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAACU,IAAI,CAAC7E,MAAM,CAAC8E,MAAM,EAAE9E,MAAM,CAAC+E,OAAO,CAAC;EACxC;EAEQC,eAAe;EACvB,IAAIS,WAAWA,CAAA;IACb,IAAI,IAAI,CAACT,eAAe,EAAE;MACxB,OAAO,IAAI,CAACA,eAAe;IAC7B;IACA,IAAI,CAACA,eAAe,GAAGhF,MAAM,CAAC4E,UAAU,CAAC;MACvCL,GAAG,EAAEA,CAAA,KAAM,IAAI,CAACrD,MAAM,CAACuE,WAAW,EAAE;MACpCf,KAAK,EAAGP,KAAK,IACX,IAAI1D,KAAK,CAACqC,eAAe,CAAC;QACxBC,MAAM,EAAE,IAAItC,KAAK,CAAC2D,WAAW,CAAC;UAC5BnD,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBgC,QAAQ,EAAE,IAAI;UACdkB;SACD;OACF;KACJ,CAAC,CAACU,IAAI,CAAC7E,MAAM,CAAC8E,MAAM,EAAE9E,MAAM,CAAC+E,OAAO,CAAC;IACtC,IAAI,CAACJ,QAAQ,GAAG3E,MAAM,CAACqC,GAAG,CAAC,IAAI,CAAC2C,eAAe,EAAGC,CAAC,IAAK,IAAIS,WAAW,EAAE,CAACnE,MAAM,CAAC0D,CAAC,CAAC,CAAC;IACpF,OAAO,IAAI,CAACD,eAAe;EAC7B;EAEAH,IAAIA,CAAA;IACF,OAAOzE,aAAa,CAAC,IAAI,EAAEuF,SAAS,CAAC;EACvC","ignoreList":[]}

package/dist/unstable/http/HttpEffect.d.ts

@@ -8,68 +8,90 @@ import { HttpServerRequest } from "./HttpServerRequest.ts";
 import type { HttpServerResponse } from "./HttpServerResponse.ts";
 import { appendPreResponseHandlerUnsafe } from "./internal/preResponseHandler.ts";
 /**
- * @since 4.0.0
+ * Runs an HTTP server effect, sends the produced response with the supplied handler, and converts failures into HTTP responses.
+ *
  * @category combinators
+ * @since 4.0.0
  */
 export declare const toHandled: <E, R, EH, RH>(self: Effect.Effect<HttpServerResponse, E, R>, handleResponse: (request: HttpServerRequest, response: HttpServerResponse) => Effect.Effect<unknown, EH, RH>, middleware?: HttpMiddleware | undefined) => Effect.Effect<void, never, Exclude<R | RH | HttpServerRequest, Scope.Scope>>;
 /**
- * If you want to finalize the http request scope elsewhere, you can use this
- * function to eject from the default scope closure.
+ * Disables automatic closing for an HTTP request scope.
+ *
+ * Use only when another owner will close the scope; otherwise resources attached
+ * to the request scope can leak.
  *
- * @since 4.0.0
  * @category Scope
+ * @since 4.0.0
  */
 export declare const scopeDisableClose: (scope: Scope.Scope) => void;
 /**
- * @since 4.0.0
+ * For streaming server responses, transfers request scope ownership to the body stream so the scope closes when the stream exits.
+ *
  * @category Scope
+ * @since 4.0.0
  */
 export declare const scopeTransferToStream: (response: HttpServerResponse) => HttpServerResponse;
 /**
- * @since 4.0.0
+ * Function run with the current request and response just before the response is sent, allowing the response to be replaced or failing with `HttpServerError`.
+ *
  * @category Pre-response handlers
+ * @since 4.0.0
  */
 export type PreResponseHandler = (request: HttpServerRequest, response: HttpServerResponse) => Effect.Effect<HttpServerResponse, HttpServerError>;
 /**
- * @since 4.0.0
+ * Registers an additional pre-response handler for the current HTTP server request.
+ *
  * @category fiber refs
+ * @since 4.0.0
  */
 export declare const appendPreResponseHandler: (handler: PreResponseHandler) => Effect.Effect<void, never, HttpServerRequest>;
 export { 
 /**
- * @since 4.0.0
  * @category fiber refs
+ * @since 4.0.0
  */
 appendPreResponseHandlerUnsafe };
 /**
- * @since 4.0.0
+ * Runs an effect after registering a pre-response handler for the current HTTP server request.
+ *
  * @category fiber refs
+ * @since 4.0.0
  */
 export declare const withPreResponseHandler: {
     /**
-     * @since 4.0.0
+     * Runs an effect after registering a pre-response handler for the current HTTP server request.
+     *
      * @category fiber refs
+     * @since 4.0.0
      */
     (handler: PreResponseHandler): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R | HttpServerRequest>;
     /**
-     * @since 4.0.0
+     * Runs an effect after registering a pre-response handler for the current HTTP server request.
+     *
      * @category fiber refs
+     * @since 4.0.0
      */
     <A, E, R>(self: Effect.Effect<A, E, R>, handler: PreResponseHandler): Effect.Effect<A, E, R | HttpServerRequest>;
 };
 /**
+ * Converts an HTTP server effect into a Web `Request` handler using the supplied base context and optional middleware.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export declare const toWebHandlerWith: <Provided, R = never, ReqR = Exclude<R, Provided | Scope.Scope | HttpServerRequest>>(context: Context.Context<Provided>) => <E>(self: Effect.Effect<HttpServerResponse, E, R>, middleware?: HttpMiddleware | undefined) => [ReqR] extends [never] ? (request: Request, context?: Context.Context<never> | undefined) => Promise<globalThis.Response> : (request: Request, context: Context.Context<ReqR>) => Promise<globalThis.Response>;
 /**
+ * Converts an HTTP server effect into a Web `Request` handler using an empty base context.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export declare const toWebHandler: <E>(self: Effect.Effect<HttpServerResponse, E, HttpServerRequest | Scope.Scope>, middleware?: HttpMiddleware | undefined) => (request: Request, context?: Context.Context<never> | undefined) => Promise<globalThis.Response>;
 /**
+ * Builds a Web `Request` handler from a layer and handler factory, returning the handler with a `dispose` function for the layer scope.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export declare const toWebHandlerLayerWith: <E, Provided, LE, R, ReqR = Exclude<R, Provided | Scope.Scope | HttpServerRequest>>(layer: Layer.Layer<Provided, LE>, options: {
     readonly toHandler: (context: Context.Context<Provided>) => Effect.Effect<Effect.Effect<HttpServerResponse, E, R>, LE>;
@@ -80,8 +102,10 @@ export declare const toWebHandlerLayerWith: <E, Provided, LE, R, ReqR = Exclude<
     readonly handler: [ReqR] extends [never] ? (request: Request, context?: Context.Context<never> | undefined) => Promise<globalThis.Response> : (request: Request, context: Context.Context<ReqR>) => Promise<globalThis.Response>;
 };
 /**
+ * Builds a Web `Request` handler for an HTTP server effect using a layer to provide its services, returning the handler with a `dispose` function.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export declare const toWebHandlerLayer: <E, R, Provided, LE, ReqR = Exclude<R, Provided | Scope.Scope | HttpServerRequest>>(self: Effect.Effect<HttpServerResponse, E, R>, layer: Layer.Layer<Provided, LE>, options?: {
     readonly middleware?: HttpMiddleware | undefined;
@@ -91,8 +115,10 @@ export declare const toWebHandlerLayer: <E, R, Provided, LE, ReqR = Exclude<R, P
     readonly handler: [ReqR] extends [never] ? (request: Request, context?: Context.Context<never> | undefined) => Promise<globalThis.Response> : (request: Request, context: Context.Context<ReqR>) => Promise<globalThis.Response>;
 };
 /**
+ * Adapts a Web `Request` handler into an HTTP server effect for the current `HttpServerRequest`.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export declare const fromWebHandler: (handler: (request: Request) => Promise<Response>) => Effect.Effect<HttpServerResponse, HttpServerError, HttpServerRequest>;
 //# sourceMappingURL=HttpEffect.d.ts.map

package/dist/unstable/http/HttpEffect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpEffect.d.ts","sourceRoot":"","sources":["../../../src/unstable/http/HttpEffect.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAKzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAGvC,OAAO,EAAE,KAAK,cAAc,EAAU,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAA8B,eAAe,EAAiB,MAAM,sBAAsB,CAAA;AACjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAEjE,OAAO,EAAE,8BAA8B,EAA8B,MAAM,kCAAkC,CAAA;AAE7G;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EACpC,MAAM,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,EAC7C,gBAAgB,CACd,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,kBAAkB,KACzB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,EACnC,aAAa,cAAc,GAAG,SAAS,KACtC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,iBAAiB,EAAE,KAAK,CAAC,KAAK,CAAC,CAuE7E,CAAA;AAID;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,KAAK,CAAC,KAAK,KAAG,IAEtD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAChC,UAAU,kBAAkB,KAC3B,kBAeF,CAAA;AAgBD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,kBAAkB,KACzB,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAA;AAEvD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GAAI,SAAS,kBAAkB,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAI/G,CAAA;AAEJ,OAAO;AACL;;;GAGG;AACH,8BAA8B,EAC/B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE;IACnC;;;OAGG;IACH,CAAC,OAAO,EAAE,kBAAkB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAA;IACpH;;;OAGG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAA;CAgB7G,CAAA;AAEL;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,EACjH,SAAS,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,MAEnC,CAAC,EACA,MAAM,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,EAC7C,aAAa,cAAc,GAAG,SAAS,KACtC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GACvB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,GAC9F,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CA0BpF,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,EAC3B,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAC,KAAK,CAAC,EAC3E,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,KACpC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CACjE,CAAA;AAEnC;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAChC,CAAC,EACD,QAAQ,EACR,EAAE,EACF,CAAC,EACD,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,EAE7D,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,EAChC,SAAS;IACP,QAAQ,CAAC,SAAS,EAAE,CAClB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAC/B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC/D,QAAQ,CAAC,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAA;CAC7C,KACA;IACD,QAAQ,CAAC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CACvC,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KACzC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,GAC/B,CACA,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAC3B,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;CA8BpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,EACjH,MAAM,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,EAC7C,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,EAChC,UAAU;IACR,QAAQ,CAAC,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAA;CAC7C,GAAG,SAAS,KACZ;IACD,QAAQ,CAAC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GACpC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,GAChG,CACA,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAC3B,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;CAKjC,CAAA;AAEJ;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,SAAS,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,KAC/C,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,eAAe,EAAE,iBAAiB,CAwBnE,CAAA"}
+{"version":3,"file":"HttpEffect.d.ts","sourceRoot":"","sources":["../../../src/unstable/http/HttpEffect.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAKzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAGvC,OAAO,EAAE,KAAK,cAAc,EAAU,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAA8B,eAAe,EAAiB,MAAM,sBAAsB,CAAA;AACjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAEjE,OAAO,EAAE,8BAA8B,EAA8B,MAAM,kCAAkC,CAAA;AAE7G;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EACpC,MAAM,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,EAC7C,gBAAgB,CACd,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,kBAAkB,KACzB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,EACnC,aAAa,cAAc,GAAG,SAAS,KACtC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,iBAAiB,EAAE,KAAK,CAAC,KAAK,CAAC,CAuE7E,CAAA;AAID;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,KAAK,CAAC,KAAK,KAAG,IAEtD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,UAAU,kBAAkB,KAC3B,kBAeF,CAAA;AAgBD;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,kBAAkB,KACzB,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAA;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,GAAI,SAAS,kBAAkB,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAI/G,CAAA;AAEJ,OAAO;AACL;;;GAGG;AACH,8BAA8B,EAC/B,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,EAAE;IACnC;;;;;OAKG;IACH,CAAC,OAAO,EAAE,kBAAkB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAA;IACpH;;;;;OAKG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAA;CAoB7G,CAAA;AAEL;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,EACjH,SAAS,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,MAEnC,CAAC,EACA,MAAM,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,EAC7C,aAAa,cAAc,GAAG,SAAS,KACtC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GACvB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,GAC9F,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CA0BpF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,EAC3B,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAC,KAAK,CAAC,EAC3E,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,KACpC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CACjE,CAAA;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,CAAC,EACD,QAAQ,EACR,EAAE,EACF,CAAC,EACD,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,EAE7D,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,EAChC,SAAS;IACP,QAAQ,CAAC,SAAS,EAAE,CAClB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAC/B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC/D,QAAQ,CAAC,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAA;CAC7C,KACA;IACD,QAAQ,CAAC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CACvC,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KACzC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,GAC/B,CACA,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAC3B,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;CA8BpC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,EACjH,MAAM,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,EAC7C,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,EAChC,UAAU;IACR,QAAQ,CAAC,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAA;CAC7C,GAAG,SAAS,KACZ;IACD,QAAQ,CAAC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GACpC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,GAChG,CACA,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAC3B,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;CAKjC,CAAA;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,SAAS,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,KAC/C,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,eAAe,EAAE,iBAAiB,CAwBnE,CAAA"}

package/dist/unstable/http/HttpEffect.js

@@ -15,8 +15,10 @@ import * as Request from "./HttpServerRequest.js";
 import * as Response from "./HttpServerResponse.js";
 import { appendPreResponseHandlerUnsafe, requestPreResponseHandlers } from "./internal/preResponseHandler.js";
 /**
- * @since 4.0.0
+ * Runs an HTTP server effect, sends the produced response with the supplied handler, and converts failures into HTTP responses.
+ *
  * @category combinators
+ * @since 4.0.0
  */
 export const toHandled = (self, handleResponse, middleware) => {
   const handleCause = cause => Effect.flatMapEager(causeResponse(cause), ([response, cause]) => {
@@ -81,19 +83,23 @@ export const toHandled = (self, handleResponse, middleware) => {
 };
 const handledSymbol = /*#__PURE__*/Symbol.for("effect/http/HttpEffect/handled");
 /**
- * If you want to finalize the http request scope elsewhere, you can use this
- * function to eject from the default scope closure.
+ * Disables automatic closing for an HTTP request scope.
+ *
+ * Use only when another owner will close the scope; otherwise resources attached
+ * to the request scope can leak.
  *
- * @since 4.0.0
  * @category Scope
+ * @since 4.0.0
  */
 export const scopeDisableClose = scope => {
   ;
   scope[scopeEjected] = true;
 };
 /**
- * @since 4.0.0
+ * For streaming server responses, transfers request scope ownership to the body stream so the scope closes when the stream exits.
+ *
  * @category Scope
+ * @since 4.0.0
  */
 export const scopeTransferToStream = response => {
   if (response.body._tag !== "Stream") {
@@ -116,8 +122,10 @@ const scoped = effect => Effect.withFiber(fiber => {
   }, true);
 });
 /**
- * @since 4.0.0
+ * Registers an additional pre-response handler for the current HTTP server request.
+ *
  * @category fiber refs
+ * @since 4.0.0
  */
 export const appendPreResponseHandler = handler => HttpServerRequest.use(request => {
   appendPreResponseHandlerUnsafe(request, handler);
@@ -125,21 +133,25 @@ export const appendPreResponseHandler = handler => HttpServerRequest.use(request
 });
 export {
 /**
- * @since 4.0.0
  * @category fiber refs
+ * @since 4.0.0
  */
 appendPreResponseHandlerUnsafe };
 /**
- * @since 4.0.0
+ * Runs an effect after registering a pre-response handler for the current HTTP server request.
+ *
  * @category fiber refs
+ * @since 4.0.0
  */
 export const withPreResponseHandler = /*#__PURE__*/dual(2, (self, handler) => HttpServerRequest.use(request => {
   appendPreResponseHandlerUnsafe(request, handler);
   return self;
 }));
 /**
+ * Converts an HTTP server effect into a Web `Request` handler using the supplied base context and optional middleware.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export const toWebHandlerWith = context => (self, middleware) => {
   const resolveSymbol = Symbol.for("@effect/platform/HttpApp/resolve");
@@ -170,13 +182,17 @@ export const toWebHandlerWith = context => (self, middleware) => {
   });
 };
 /**
+ * Converts an HTTP server effect into a Web `Request` handler using an empty base context.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export const toWebHandler = /*#__PURE__*/toWebHandlerWith(/*#__PURE__*/Context.empty());
 /**
+ * Builds a Web `Request` handler from a layer and handler factory, returning the handler with a `dispose` function for the layer scope.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export const toWebHandlerLayerWith = (layer, options) => {
   const scope = Scope.makeUnsafe();
@@ -199,16 +215,20 @@ export const toWebHandlerLayerWith = (layer, options) => {
   };
 };
 /**
+ * Builds a Web `Request` handler for an HTTP server effect using a layer to provide its services, returning the handler with a `dispose` function.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export const toWebHandlerLayer = (self, layer, options) => toWebHandlerLayerWith(layer, {
   ...options,
   toHandler: () => Effect.succeed(self)
 });
 /**
+ * Adapts a Web `Request` handler into an HTTP server effect for the current `HttpServerRequest`.
+ *
+ * @category converting
  * @since 4.0.0
- * @category conversions
  */
 export const fromWebHandler = handler => Effect.callback((resume, signal) => {
   const fiber = Fiber.getCurrent();