effect 4.0.0-beta.66 → 4.0.0-beta.67

package/dist/unstable/httpapi/HttpApiError.js

@@ -1,4 +1,23 @@
 /**
+ * The `HttpApiError` module defines the built-in error types used by Effect's
+ * unstable HTTP API layer for common failure responses.
+ *
+ * Each exported status error is a `Schema.ErrorClass` with an `httpApiStatus`
+ * annotation, so it can be declared as an endpoint or middleware error schema
+ * and then used by reflection, OpenAPI generation, clients, and server response
+ * encoding. The classes also implement `HttpServerRespondable`, which means
+ * using one directly as a server response produces an empty response with the
+ * matching HTTP status.
+ *
+ * Use the `*NoContent` variants when the wire response intentionally has no
+ * body but clients should still decode that status into a typed error value.
+ * For custom error schemas, make sure to add the intended
+ * `HttpApiSchema.status` annotation; error schemas without one are treated as
+ * `500 Internal Server Error` by the HTTP API machinery. Schema failures raised
+ * while decoding params, headers, query, body, or payload values are represented
+ * separately by `HttpApiSchemaError`, which responds as `400 Bad Request` unless
+ * transformed by middleware.
+ *
  * @since 4.0.0
  */
 import * as Data from "../../Data.js";
@@ -46,6 +65,9 @@ const serviceUnavailableResponse = /*#__PURE__*/HttpServerResponse.empty({
   status: 503
 });
 /**
+ * Built-in HTTP API error for a `400 Bad Request` response. When used directly as
+ * a server response, it renders as an empty response with status 400.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -62,6 +84,9 @@ export class BadRequest extends /*#__PURE__*/Schema.ErrorClass("effect/HttpApiEr
   static singleton = /*#__PURE__*/new BadRequest();
 }
 /**
+ * No-content schema variant for `BadRequest`, decoding an empty 400 response into
+ * a `BadRequest` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -69,6 +94,9 @@ export const BadRequestNoContent = /*#__PURE__*/BadRequest.pipe(/*#__PURE__*/Htt
   decode: () => new BadRequest({})
 }));
 /**
+ * Built-in HTTP API error for a `401 Unauthorized` response. When used directly as
+ * a server response, it renders as an empty response with status 401.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -84,6 +112,9 @@ export class Unauthorized extends /*#__PURE__*/Schema.ErrorClass("effect/HttpApi
   }
 }
 /**
+ * No-content schema variant for `Unauthorized`, decoding an empty 401 response
+ * into an `Unauthorized` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -91,6 +122,9 @@ export const UnauthorizedNoContent = /*#__PURE__*/Unauthorized.pipe(/*#__PURE__*
   decode: () => new Unauthorized({})
 }));
 /**
+ * Built-in HTTP API error for a `403 Forbidden` response. When used directly as a
+ * server response, it renders as an empty response with status 403.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -106,6 +140,9 @@ export class Forbidden extends /*#__PURE__*/Schema.ErrorClass("effect/HttpApiErr
   }
 }
 /**
+ * No-content schema variant for `Forbidden`, decoding an empty 403 response into a
+ * `Forbidden` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -113,6 +150,9 @@ export const ForbiddenNoContent = /*#__PURE__*/Forbidden.pipe(/*#__PURE__*/HttpA
   decode: () => new Forbidden({})
 }));
 /**
+ * Built-in HTTP API error for a `404 Not Found` response. When used directly as a
+ * server response, it renders as an empty response with status 404.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -128,6 +168,9 @@ export class NotFound extends /*#__PURE__*/Schema.ErrorClass("effect/HttpApiErro
   }
 }
 /**
+ * No-content schema variant for `NotFound`, decoding an empty 404 response into a
+ * `NotFound` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -135,6 +178,9 @@ export const NotFoundNoContent = /*#__PURE__*/NotFound.pipe(/*#__PURE__*/HttpApi
   decode: () => new NotFound({})
 }));
 /**
+ * Built-in HTTP API error for a `405 Method Not Allowed` response. When used
+ * directly as a server response, it renders as an empty response with status 405.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -150,6 +196,9 @@ export class MethodNotAllowed extends /*#__PURE__*/Schema.ErrorClass("effect/Htt
   }
 }
 /**
+ * No-content schema variant for `MethodNotAllowed`, decoding an empty 405 response
+ * into a `MethodNotAllowed` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -157,6 +206,9 @@ export const MethodNotAllowedNoContent = /*#__PURE__*/MethodNotAllowed.pipe(/*#_
   decode: () => new MethodNotAllowed({})
 }));
 /**
+ * Built-in HTTP API error for a `406 Not Acceptable` response. When used directly
+ * as a server response, it renders as an empty response with status 406.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -172,6 +224,9 @@ export class NotAcceptable extends /*#__PURE__*/Schema.ErrorClass("effect/HttpAp
   }
 }
 /**
+ * No-content schema variant for `NotAcceptable`, decoding an empty 406 response
+ * into a `NotAcceptable` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -179,6 +234,9 @@ export const NotAcceptableNoContent = /*#__PURE__*/NotAcceptable.pipe(/*#__PURE_
   decode: () => new NotAcceptable({})
 }));
 /**
+ * Built-in HTTP API error for a `408 Request Timeout` response. When used directly
+ * as a server response, it renders as an empty response with status 408.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -194,6 +252,9 @@ export class RequestTimeout extends /*#__PURE__*/Schema.ErrorClass("effect/HttpA
   }
 }
 /**
+ * No-content schema variant for `RequestTimeout`, decoding an empty 408 response
+ * into a `RequestTimeout` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -201,6 +262,9 @@ export const RequestTimeoutNoContent = /*#__PURE__*/RequestTimeout.pipe(/*#__PUR
   decode: () => new RequestTimeout({})
 }));
 /**
+ * Built-in HTTP API error for a `409 Conflict` response. When used directly as a
+ * server response, it renders as an empty response with status 409.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -216,13 +280,19 @@ export class Conflict extends /*#__PURE__*/Schema.ErrorClass("effect/HttpApiErro
   }
 }
 /**
- * @since 4.0.0
+ * No-content schema variant for `Conflict`, decoding an empty 409 response into a
+ * `Conflict` error value.
+ *
  * @category NoContent errors
+ * @since 4.0.0
  */
 export const ConflictNoContent = /*#__PURE__*/Conflict.pipe(/*#__PURE__*/HttpApiSchema.asNoContent({
   decode: () => new Conflict({})
 }));
 /**
+ * Built-in HTTP API error for a `410 Gone` response. When used directly as a
+ * server response, it renders as an empty response with status 410.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -238,6 +308,9 @@ export class Gone extends /*#__PURE__*/Schema.ErrorClass("effect/HttpApiError/Go
   }
 }
 /**
+ * No-content schema variant for `Gone`, decoding an empty 410 response into a
+ * `Gone` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -245,6 +318,9 @@ export const GoneNoContent = /*#__PURE__*/Gone.pipe(/*#__PURE__*/HttpApiSchema.a
   decode: () => new Gone({})
 }));
 /**
+ * Built-in HTTP API error for a `500 Internal Server Error` response. When used
+ * directly as a server response, it renders as an empty response with status 500.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -259,6 +335,9 @@ export class InternalServerError extends /*#__PURE__*/Schema.ErrorClass("effect/
   }
 }
 /**
+ * No-content schema variant for `InternalServerError`, decoding an empty 500
+ * response into an `InternalServerError` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -266,6 +345,9 @@ export const InternalServerErrorNoContent = /*#__PURE__*/InternalServerError.pip
   decode: () => new InternalServerError({})
 }));
 /**
+ * Built-in HTTP API error for a `501 Not Implemented` response. When used directly
+ * as a server response, it renders as an empty response with status 501.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -280,6 +362,9 @@ export class NotImplemented extends /*#__PURE__*/Schema.ErrorClass("effect/HttpA
   }
 }
 /**
+ * No-content schema variant for `NotImplemented`, decoding an empty 501 response
+ * into a `NotImplemented` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -287,6 +372,9 @@ export const NotImplementedNoContent = /*#__PURE__*/NotImplemented.pipe(/*#__PUR
   decode: () => new NotImplemented({})
 }));
 /**
+ * Built-in HTTP API error for a `503 Service Unavailable` response. When used
+ * directly as a server response, it renders as an empty response with status 503.
+ *
  * @category Built-in errors
  * @since 4.0.0
  */
@@ -301,6 +389,9 @@ export class ServiceUnavailable extends /*#__PURE__*/Schema.ErrorClass("effect/H
   }
 }
 /**
+ * No-content schema variant for `ServiceUnavailable`, decoding an empty 503
+ * response into a `ServiceUnavailable` error value.
+ *
  * @category NoContent errors
  * @since 4.0.0
  */
@@ -308,11 +399,17 @@ export const ServiceUnavailableNoContent = /*#__PURE__*/ServiceUnavailable.pipe(
   decode: () => new ServiceUnavailable({})
 }));
 /**
+ * Runtime identifier used to mark and detect `HttpApiSchemaError` values.
+ *
  * @category Parsing errors
  * @since 4.0.0
  */
 export const HttpApiSchemaErrorTypeId = "~effect/httpapi/HttpApiError/HttpApiSchemaError";
 /**
+ * Error raised when an HTTP API request component fails schema decoding. It records
+ * which component failed and responds as an empty `400 Bad Request` when rendered
+ * as a server response.
+ *
  * @category Parsing errors
  * @since 4.0.0
  */

package/dist/unstable/httpapi/HttpApiError.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpApiError.js","names":["Data","Effect","ErrorReporter","hasProperty","Schema","HttpServerRespondable","HttpServerResponse","HttpApiSchema","badRequestResponse","empty","status","unauthorizedResponse","forbiddenResponse","notFoundResponse","methodNotAllowedResponse","notAcceptableResponse","requestTimeoutResponse","conflictResponse","goneResponse","internalServerErrorResponse","notImplementedResponse","serviceUnavailableResponse","BadRequest","ErrorClass","_tag","tag","description","httpApiStatus","ignore","symbol","succeed","singleton","BadRequestNoContent","pipe","asNoContent","decode","Unauthorized","UnauthorizedNoContent","Forbidden","ForbiddenNoContent","NotFound","NotFoundNoContent","MethodNotAllowed","MethodNotAllowedNoContent","NotAcceptable","NotAcceptableNoContent","RequestTimeout","RequestTimeoutNoContent","Conflict","ConflictNoContent","Gone","GoneNoContent","InternalServerError","InternalServerErrorNoContent","NotImplemented","NotImplementedNoContent","ServiceUnavailable","ServiceUnavailableNoContent","HttpApiSchemaErrorTypeId","HttpApiSchemaError","TaggedClass","is","u","wrap","kind","effect","mapError","error","cause","name","message"],"sources":["../../../src/unstable/httpapi/HttpApiError.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,aAAa,MAAM,wBAAwB;AACvD,SAASC,WAAW,QAAQ,oBAAoB;AAChD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,qBAAqB,MAAM,kCAAkC;AACzE,OAAO,KAAKC,kBAAkB,MAAM,+BAA+B;AACnE,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD,MAAMC,kBAAkB,gBAAGF,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACpE,MAAMC,oBAAoB,gBAAGL,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACtE,MAAME,iBAAiB,gBAAGN,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACnE,MAAMG,gBAAgB,gBAAGP,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAClE,MAAMI,wBAAwB,gBAAGR,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAC1E,MAAMK,qBAAqB,gBAAGT,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACvE,MAAMM,sBAAsB,gBAAGV,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACxE,MAAMO,gBAAgB,gBAAGX,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAClE,MAAMQ,YAAY,gBAAGZ,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAC9D,MAAMS,2BAA2B,gBAAGb,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAC7E,MAAMU,sBAAsB,gBAAGd,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACxE,MAAMW,0BAA0B,gBAAGf,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAE5E;;;;AAIA,OAAM,MAAOY,UAAW,sBAAQlB,MAAM,CAACmB,UAAU,CAAa,gCAAgC,CAAC,CAAC;EAC9FC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,YAAY;CAC9B,EAAE;EACDC,WAAW,EAAE,YAAY;EACzBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACtB,kBAAkB,CAAC;EAC3C;EACA,OAAgBuB,SAAS,gBAAG,IAAIT,UAAU,EAAE;;AAG9C;;;;AAIA,OAAO,MAAMU,mBAAmB,gBAAGV,UAAU,CAACW,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC3EC,MAAM,EAAEA,CAAA,KAAM,IAAIb,UAAU,CAAC,EAAE;CAChC,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOc,YAAa,sBAAQhC,MAAM,CAACmB,UAAU,CAAe,kCAAkC,CAAC,CAAC;EACpGC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,cAAc;CAChC,EAAE;EACDC,WAAW,EAAE,cAAc;EAC3BC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACnB,oBAAoB,CAAC;EAC7C;;AAGF;;;;AAIA,OAAO,MAAM0B,qBAAqB,gBAAGD,YAAY,CAACH,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC/EC,MAAM,EAAEA,CAAA,KAAM,IAAIC,YAAY,CAAC,EAAE;CAClC,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,SAAU,sBAAQlC,MAAM,CAACmB,UAAU,CAAY,+BAA+B,CAAC,CAAC;EAC3FC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,WAAW;CAC7B,EAAE;EACDC,WAAW,EAAE,WAAW;EACxBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAAClB,iBAAiB,CAAC;EAC1C;;AAGF;;;;AAIA,OAAO,MAAM2B,kBAAkB,gBAAGD,SAAS,CAACL,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACzEC,MAAM,EAAEA,CAAA,KAAM,IAAIG,SAAS,CAAC,EAAE;CAC/B,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,QAAS,sBAAQpC,MAAM,CAACmB,UAAU,CAAW,8BAA8B,CAAC,CAAC;EACxFC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,UAAU;CAC5B,EAAE;EACDC,WAAW,EAAE,UAAU;EACvBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACjB,gBAAgB,CAAC;EACzC;;AAGF;;;;AAIA,OAAO,MAAM4B,iBAAiB,gBAAGD,QAAQ,CAACP,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACvEC,MAAM,EAAEA,CAAA,KAAM,IAAIK,QAAQ,CAAC,EAAE;CAC9B,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,gBAAiB,sBAAQtC,MAAM,CAACmB,UAAU,CAAmB,sCAAsC,CAAC,CAAC;EAChHC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,kBAAkB;CACpC,EAAE;EACDC,WAAW,EAAE,kBAAkB;EAC/BC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAAChB,wBAAwB,CAAC;EACjD;;AAGF;;;;AAIA,OAAO,MAAM6B,yBAAyB,gBAAGD,gBAAgB,CAACT,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACvFC,MAAM,EAAEA,CAAA,KAAM,IAAIO,gBAAgB,CAAC,EAAE;CACtC,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,aAAc,sBAAQxC,MAAM,CAACmB,UAAU,CAAgB,mCAAmC,CAAC,CAAC;EACvGC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,eAAe;CACjC,EAAE;EACDC,WAAW,EAAE,eAAe;EAC5BC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACf,qBAAqB,CAAC;EAC9C;;AAGF;;;;AAIA,OAAO,MAAM8B,sBAAsB,gBAAGD,aAAa,CAACX,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACjFC,MAAM,EAAEA,CAAA,KAAM,IAAIS,aAAa,CAAC,EAAE;CACnC,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,cAAe,sBAAQ1C,MAAM,CAACmB,UAAU,CAAiB,oCAAoC,CAAC,CAAC;EAC1GC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,gBAAgB;CAClC,EAAE;EACDC,WAAW,EAAE,gBAAgB;EAC7BC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACd,sBAAsB,CAAC;EAC/C;;AAGF;;;;AAIA,OAAO,MAAM+B,uBAAuB,gBAAGD,cAAc,CAACb,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACnFC,MAAM,EAAEA,CAAA,KAAM,IAAIW,cAAc,CAAC,EAAE;CACpC,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,QAAS,sBAAQ5C,MAAM,CAACmB,UAAU,CAAW,8BAA8B,CAAC,CAAC;EACxFC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,UAAU;CAC5B,EAAE;EACDC,WAAW,EAAE,UAAU;EACvBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACb,gBAAgB,CAAC;EACzC;;AAGF;;;;AAIA,OAAO,MAAMgC,iBAAiB,gBAAGD,QAAQ,CAACf,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACvEC,MAAM,EAAEA,CAAA,KAAM,IAAIa,QAAQ,CAAC,EAAE;CAC9B,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,IAAK,sBAAQ9C,MAAM,CAACmB,UAAU,CAAO,0BAA0B,CAAC,CAAC;EAC5EC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,MAAM;CACxB,EAAE;EACDC,WAAW,EAAE,MAAM;EACnBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACZ,YAAY,CAAC;EACrC;;AAGF;;;;AAIA,OAAO,MAAMiC,aAAa,gBAAGD,IAAI,CAACjB,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC/DC,MAAM,EAAEA,CAAA,KAAM,IAAIe,IAAI,CAAC,EAAE;CAC1B,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,mBACX,sBAAQhD,MAAM,CAACmB,UAAU,CAAsB,yCAAyC,CAAC,CAAC;EACxFC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,qBAAqB;CACvC,EAAE;EACDC,WAAW,EAAE,qBAAqB;EAClCC,aAAa,EAAE;CAChB,CAAC;EAEF,CAACtB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACX,2BAA2B,CAAC;EACpD;;AAGF;;;;AAIA,OAAO,MAAMkC,4BAA4B,gBAAGD,mBAAmB,CAACnB,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC7FC,MAAM,EAAEA,CAAA,KAAM,IAAIiB,mBAAmB,CAAC,EAAE;CACzC,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,cAAe,sBAAQlD,MAAM,CAACmB,UAAU,CAAiB,oCAAoC,CAAC,CAAC;EAC1GC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,gBAAgB;CAClC,EAAE;EACDC,WAAW,EAAE,gBAAgB;EAC7BC,aAAa,EAAE;CAChB,CAAC;EACA,CAACtB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACV,sBAAsB,CAAC;EAC/C;;AAGF;;;;AAIA,OAAO,MAAMmC,uBAAuB,gBAAGD,cAAc,CAACrB,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACnFC,MAAM,EAAEA,CAAA,KAAM,IAAImB,cAAc,CAAC,EAAE;CACpC,CAAC,CAAC;AAEH;;;;AAIA,OAAM,MAAOE,kBACX,sBAAQpD,MAAM,CAACmB,UAAU,CAAqB,wCAAwC,CAAC,CAAC;EACtFC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,oBAAoB;CACtC,EAAE;EACDC,WAAW,EAAE,oBAAoB;EACjCC,aAAa,EAAE;CAChB,CAAC;EAEF,CAACtB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACT,0BAA0B,CAAC;EACnD;;AAGF;;;;AAIA,OAAO,MAAMoC,2BAA2B,gBAAGD,kBAAkB,CAACvB,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC3FC,MAAM,EAAEA,CAAA,KAAM,IAAIqB,kBAAkB,CAAC,EAAE;CACxC,CAAC,CAAC;AAQH;;;;AAIA,OAAO,MAAME,wBAAwB,GAA6B,iDAAiD;AAEnH;;;;AAIA,OAAM,MAAOC,kBAAmB,sBAAQ3D,IAAI,CAAC4D,WAAW,CAAC,oBAAoB,CAG3E;EACS,CAACF,wBAAwB,IAA8BA,wBAAwB;EAExF,OAAOG,EAAEA,CAACC,CAAU;IAClB,OAAO3D,WAAW,CAAC2D,CAAC,EAAEJ,wBAAwB,CAAC;EACjD;EAEA,OAAOK,IAAIA,CACTC,IAAgC,EAChCC,MAA+C;IAE/C,OAAOhE,MAAM,CAACiE,QAAQ,CAACD,MAAM,EAAGE,KAAK,IAAK,IAAIR,kBAAkB,CAAC;MAAEK,IAAI;MAAEI,KAAK,EAAED;IAAK,CAAE,CAAC,CAAC;EAC3F;EAESE,IAAI,GAAG,oBAAoB;EAC3BC,OAAO,GAAG,IAAI,CAACN,IAAI;EAE5B,CAAC3D,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACtB,kBAAkB,CAAC;EAC3C","ignoreList":[]}
+{"version":3,"file":"HttpApiError.js","names":["Data","Effect","ErrorReporter","hasProperty","Schema","HttpServerRespondable","HttpServerResponse","HttpApiSchema","badRequestResponse","empty","status","unauthorizedResponse","forbiddenResponse","notFoundResponse","methodNotAllowedResponse","notAcceptableResponse","requestTimeoutResponse","conflictResponse","goneResponse","internalServerErrorResponse","notImplementedResponse","serviceUnavailableResponse","BadRequest","ErrorClass","_tag","tag","description","httpApiStatus","ignore","symbol","succeed","singleton","BadRequestNoContent","pipe","asNoContent","decode","Unauthorized","UnauthorizedNoContent","Forbidden","ForbiddenNoContent","NotFound","NotFoundNoContent","MethodNotAllowed","MethodNotAllowedNoContent","NotAcceptable","NotAcceptableNoContent","RequestTimeout","RequestTimeoutNoContent","Conflict","ConflictNoContent","Gone","GoneNoContent","InternalServerError","InternalServerErrorNoContent","NotImplemented","NotImplementedNoContent","ServiceUnavailable","ServiceUnavailableNoContent","HttpApiSchemaErrorTypeId","HttpApiSchemaError","TaggedClass","is","u","wrap","kind","effect","mapError","error","cause","name","message"],"sources":["../../../src/unstable/httpapi/HttpApiError.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,KAAKA,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,aAAa,MAAM,wBAAwB;AACvD,SAASC,WAAW,QAAQ,oBAAoB;AAChD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,qBAAqB,MAAM,kCAAkC;AACzE,OAAO,KAAKC,kBAAkB,MAAM,+BAA+B;AACnE,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD,MAAMC,kBAAkB,gBAAGF,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACpE,MAAMC,oBAAoB,gBAAGL,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACtE,MAAME,iBAAiB,gBAAGN,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACnE,MAAMG,gBAAgB,gBAAGP,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAClE,MAAMI,wBAAwB,gBAAGR,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAC1E,MAAMK,qBAAqB,gBAAGT,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACvE,MAAMM,sBAAsB,gBAAGV,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACxE,MAAMO,gBAAgB,gBAAGX,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAClE,MAAMQ,YAAY,gBAAGZ,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAC9D,MAAMS,2BAA2B,gBAAGb,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAC7E,MAAMU,sBAAsB,gBAAGd,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AACxE,MAAMW,0BAA0B,gBAAGf,kBAAkB,CAACG,KAAK,CAAC;EAAEC,MAAM,EAAE;AAAG,CAAE,CAAC;AAE5E;;;;;;;AAOA,OAAM,MAAOY,UAAW,sBAAQlB,MAAM,CAACmB,UAAU,CAAa,gCAAgC,CAAC,CAAC;EAC9FC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,YAAY;CAC9B,EAAE;EACDC,WAAW,EAAE,YAAY;EACzBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACtB,kBAAkB,CAAC;EAC3C;EACA,OAAgBuB,SAAS,gBAAG,IAAIT,UAAU,EAAE;;AAG9C;;;;;;;AAOA,OAAO,MAAMU,mBAAmB,gBAAGV,UAAU,CAACW,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC3EC,MAAM,EAAEA,CAAA,KAAM,IAAIb,UAAU,CAAC,EAAE;CAChC,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOc,YAAa,sBAAQhC,MAAM,CAACmB,UAAU,CAAe,kCAAkC,CAAC,CAAC;EACpGC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,cAAc;CAChC,EAAE;EACDC,WAAW,EAAE,cAAc;EAC3BC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACnB,oBAAoB,CAAC;EAC7C;;AAGF;;;;;;;AAOA,OAAO,MAAM0B,qBAAqB,gBAAGD,YAAY,CAACH,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC/EC,MAAM,EAAEA,CAAA,KAAM,IAAIC,YAAY,CAAC,EAAE;CAClC,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,SAAU,sBAAQlC,MAAM,CAACmB,UAAU,CAAY,+BAA+B,CAAC,CAAC;EAC3FC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,WAAW;CAC7B,EAAE;EACDC,WAAW,EAAE,WAAW;EACxBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAAClB,iBAAiB,CAAC;EAC1C;;AAGF;;;;;;;AAOA,OAAO,MAAM2B,kBAAkB,gBAAGD,SAAS,CAACL,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACzEC,MAAM,EAAEA,CAAA,KAAM,IAAIG,SAAS,CAAC,EAAE;CAC/B,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,QAAS,sBAAQpC,MAAM,CAACmB,UAAU,CAAW,8BAA8B,CAAC,CAAC;EACxFC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,UAAU;CAC5B,EAAE;EACDC,WAAW,EAAE,UAAU;EACvBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACjB,gBAAgB,CAAC;EACzC;;AAGF;;;;;;;AAOA,OAAO,MAAM4B,iBAAiB,gBAAGD,QAAQ,CAACP,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACvEC,MAAM,EAAEA,CAAA,KAAM,IAAIK,QAAQ,CAAC,EAAE;CAC9B,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,gBAAiB,sBAAQtC,MAAM,CAACmB,UAAU,CAAmB,sCAAsC,CAAC,CAAC;EAChHC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,kBAAkB;CACpC,EAAE;EACDC,WAAW,EAAE,kBAAkB;EAC/BC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAAChB,wBAAwB,CAAC;EACjD;;AAGF;;;;;;;AAOA,OAAO,MAAM6B,yBAAyB,gBAAGD,gBAAgB,CAACT,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACvFC,MAAM,EAAEA,CAAA,KAAM,IAAIO,gBAAgB,CAAC,EAAE;CACtC,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,aAAc,sBAAQxC,MAAM,CAACmB,UAAU,CAAgB,mCAAmC,CAAC,CAAC;EACvGC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,eAAe;CACjC,EAAE;EACDC,WAAW,EAAE,eAAe;EAC5BC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACf,qBAAqB,CAAC;EAC9C;;AAGF;;;;;;;AAOA,OAAO,MAAM8B,sBAAsB,gBAAGD,aAAa,CAACX,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACjFC,MAAM,EAAEA,CAAA,KAAM,IAAIS,aAAa,CAAC,EAAE;CACnC,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,cAAe,sBAAQ1C,MAAM,CAACmB,UAAU,CAAiB,oCAAoC,CAAC,CAAC;EAC1GC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,gBAAgB;CAClC,EAAE;EACDC,WAAW,EAAE,gBAAgB;EAC7BC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACd,sBAAsB,CAAC;EAC/C;;AAGF;;;;;;;AAOA,OAAO,MAAM+B,uBAAuB,gBAAGD,cAAc,CAACb,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACnFC,MAAM,EAAEA,CAAA,KAAM,IAAIW,cAAc,CAAC,EAAE;CACpC,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,QAAS,sBAAQ5C,MAAM,CAACmB,UAAU,CAAW,8BAA8B,CAAC,CAAC;EACxFC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,UAAU;CAC5B,EAAE;EACDC,WAAW,EAAE,UAAU;EACvBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACb,gBAAgB,CAAC;EACzC;;AAGF;;;;;;;AAOA,OAAO,MAAMgC,iBAAiB,gBAAGD,QAAQ,CAACf,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACvEC,MAAM,EAAEA,CAAA,KAAM,IAAIa,QAAQ,CAAC,EAAE;CAC9B,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,IAAK,sBAAQ9C,MAAM,CAACmB,UAAU,CAAO,0BAA0B,CAAC,CAAC;EAC5EC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,MAAM;CACxB,EAAE;EACDC,WAAW,EAAE,MAAM;EACnBC,aAAa,EAAE;CAChB,CAAC;EACkB,CAACzB,aAAa,CAAC0B,MAAM,IAAI,IAAI;EAC/C,CAACvB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACZ,YAAY,CAAC;EACrC;;AAGF;;;;;;;AAOA,OAAO,MAAMiC,aAAa,gBAAGD,IAAI,CAACjB,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC/DC,MAAM,EAAEA,CAAA,KAAM,IAAIe,IAAI,CAAC,EAAE;CAC1B,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,mBACX,sBAAQhD,MAAM,CAACmB,UAAU,CAAsB,yCAAyC,CAAC,CAAC;EACxFC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,qBAAqB;CACvC,EAAE;EACDC,WAAW,EAAE,qBAAqB;EAClCC,aAAa,EAAE;CAChB,CAAC;EAEF,CAACtB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACX,2BAA2B,CAAC;EACpD;;AAGF;;;;;;;AAOA,OAAO,MAAMkC,4BAA4B,gBAAGD,mBAAmB,CAACnB,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC7FC,MAAM,EAAEA,CAAA,KAAM,IAAIiB,mBAAmB,CAAC,EAAE;CACzC,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,cAAe,sBAAQlD,MAAM,CAACmB,UAAU,CAAiB,oCAAoC,CAAC,CAAC;EAC1GC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,gBAAgB;CAClC,EAAE;EACDC,WAAW,EAAE,gBAAgB;EAC7BC,aAAa,EAAE;CAChB,CAAC;EACA,CAACtB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACV,sBAAsB,CAAC;EAC/C;;AAGF;;;;;;;AAOA,OAAO,MAAMmC,uBAAuB,gBAAGD,cAAc,CAACrB,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EACnFC,MAAM,EAAEA,CAAA,KAAM,IAAImB,cAAc,CAAC,EAAE;CACpC,CAAC,CAAC;AAEH;;;;;;;AAOA,OAAM,MAAOE,kBACX,sBAAQpD,MAAM,CAACmB,UAAU,CAAqB,wCAAwC,CAAC,CAAC;EACtFC,IAAI,eAAEpB,MAAM,CAACqB,GAAG,CAAC,oBAAoB;CACtC,EAAE;EACDC,WAAW,EAAE,oBAAoB;EACjCC,aAAa,EAAE;CAChB,CAAC;EAEF,CAACtB,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACT,0BAA0B,CAAC;EACnD;;AAGF;;;;;;;AAOA,OAAO,MAAMoC,2BAA2B,gBAAGD,kBAAkB,CAACvB,IAAI,cAAC1B,aAAa,CAAC2B,WAAW,CAAC;EAC3FC,MAAM,EAAEA,CAAA,KAAM,IAAIqB,kBAAkB,CAAC,EAAE;CACxC,CAAC,CAAC;AAUH;;;;;;AAMA,OAAO,MAAME,wBAAwB,GAA6B,iDAAiD;AAEnH;;;;;;;;AAQA,OAAM,MAAOC,kBAAmB,sBAAQ3D,IAAI,CAAC4D,WAAW,CAAC,oBAAoB,CAG3E;EACS,CAACF,wBAAwB,IAA8BA,wBAAwB;EAExF,OAAOG,EAAEA,CAACC,CAAU;IAClB,OAAO3D,WAAW,CAAC2D,CAAC,EAAEJ,wBAAwB,CAAC;EACjD;EAEA,OAAOK,IAAIA,CACTC,IAAgC,EAChCC,MAA+C;IAE/C,OAAOhE,MAAM,CAACiE,QAAQ,CAACD,MAAM,EAAGE,KAAK,IAAK,IAAIR,kBAAkB,CAAC;MAAEK,IAAI;MAAEI,KAAK,EAAED;IAAK,CAAE,CAAC,CAAC;EAC3F;EAESE,IAAI,GAAG,oBAAoB;EAC3BC,OAAO,GAAG,IAAI,CAACN,IAAI;EAE5B,CAAC3D,qBAAqB,CAACwB,MAAM,IAAC;IAC5B,OAAO5B,MAAM,CAAC6B,OAAO,CAACtB,kBAAkB,CAAC;EAC3C","ignoreList":[]}

package/dist/unstable/httpapi/HttpApiGroup.d.ts

@@ -1,4 +1,28 @@
 /**
+ * The `HttpApiGroup` module defines named collections of `HttpApiEndpoint`s
+ * within an `HttpApi`.
+ *
+ * Groups are the main way to organize endpoints by a domain boundary, resource,
+ * or feature area before those endpoints are added to an API and implemented
+ * with `HttpApiBuilder.group`. A group carries its identifier, endpoint set,
+ * annotations, and `topLevel` flag, which are later used by builders, clients,
+ * URL builders, and OpenAPI generation. Non-top-level groups expose nested
+ * client methods under the group name, while top-level groups expose their
+ * endpoint methods directly.
+ *
+ * Composition is order-sensitive. Adding an endpoint with the same name as an
+ * existing endpoint replaces it, and `prefix`, `middleware`,
+ * `annotateEndpoints`, and `annotateEndpointsMerge` only affect endpoints that
+ * are already present when those APIs are called. Group annotations apply to the
+ * group itself; use the endpoint annotation helpers when metadata should be
+ * attached to each endpoint.
+ *
+ * The type helpers in this module reflect the endpoint union for a group and
+ * aggregate the services required by endpoint schemas, middleware, and declared
+ * errors. Error schemas are still declared on endpoints, while middleware can
+ * contribute additional error schemas and client/server service requirements
+ * through the endpoint middleware set.
+ *
  * @since 4.0.0
  */
 import type { NonEmptyReadonlyArray } from "../../Array.ts";
@@ -10,8 +34,11 @@ import type * as HttpApiEndpoint from "./HttpApiEndpoint.ts";
 import type * as HttpApiMiddleware from "./HttpApiMiddleware.ts";
 declare const TypeId = "~effect/httpapi/HttpApiGroup";
 /**
- * @since 4.0.0
+ * Returns `true` when a value is an `HttpApiGroup`, narrowing the value to the
+ * group interface.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export declare const isHttpApiGroup: (u: unknown) => u is Any;
 /**
@@ -20,8 +47,8 @@ export declare const isHttpApiGroup: (u: unknown) => u is Any;
  *
  * The endpoints can be implemented later using the `HttpApiBuilder.group` api.
  *
- * @since 4.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface HttpApiGroup<out Id extends string, out Endpoints extends HttpApiEndpoint.Any = never, out TopLevel extends boolean = false> extends Pipeable {
     new (_: never): {};
@@ -71,8 +98,11 @@ export interface HttpApiGroup<out Id extends string, out Endpoints extends HttpA
     annotateEndpoints<I, S>(key: Context.Key<I, S>, value: S): HttpApiGroup<Id, Endpoints, TopLevel>;
 }
 /**
- * @since 4.0.0
+ * Type-level identity for a group within an HTTP API, pairing the API id with the
+ * group name for service derivation.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface ApiGroup<ApiId extends string, Name extends string> {
     readonly _: unique symbol;
@@ -80,8 +110,11 @@ export interface ApiGroup<ApiId extends string, Name extends string> {
     readonly name: Name;
 }
 /**
- * @since 4.0.0
+ * A widened `HttpApiGroup` type used when the concrete group name, endpoints, and
+ * top-level flag are not needed.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Any {
     readonly [TypeId]: typeof TypeId;
@@ -90,80 +123,114 @@ export interface Any {
     readonly endpoints: Record.ReadonlyRecord<string, HttpApiEndpoint.Any>;
 }
 /**
- * @since 4.0.0
+ * A widened group type that preserves concrete runtime properties such as
+ * identifier, key, top-level status, endpoints, and annotations.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type AnyWithProps = HttpApiGroup<string, HttpApiEndpoint.AnyWithProps, boolean>;
 /**
- * @since 4.0.0
+ * Derives the API-specific `ApiGroup` service identity for an HTTP API group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ToService<ApiId extends string, A> = A extends HttpApiGroup<infer Name, infer _Endpoints, infer _TopLevel> ? ApiGroup<ApiId, Name> : never;
 /**
- * @since 4.0.0
+ * Selects the group with the specified identifier from a union of groups.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type WithName<Group, Name extends string> = Extract<Group, {
     readonly identifier: Name;
 }>;
 /**
- * @since 4.0.0
+ * Extracts the identifier literal from an `HttpApiGroup`.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Name<Group> = Group extends HttpApiGroup<infer _Name, infer _Endpoints, infer _TopLevel> ? _Name : never;
 /**
- * @since 4.0.0
+ * Extracts the endpoint union contained in an `HttpApiGroup`.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Endpoints<Group> = Group extends HttpApiGroup<infer _Name, infer _Endpoints, infer _TopLevel> ? _Endpoints : never;
 /**
- * @since 4.0.0
+ * Computes the services required to encode error responses for every endpoint in a
+ * group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorServicesEncode<Group> = HttpApiEndpoint.ErrorServicesEncode<Endpoints<Group>>;
 /**
- * @since 4.0.0
+ * Computes the services required to decode error responses for every endpoint in a
+ * group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorServicesDecode<Group> = HttpApiEndpoint.ErrorServicesDecode<Endpoints<Group>>;
 /**
- * @since 4.0.0
+ * Computes the middleware error union for every endpoint in a group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type MiddlewareError<Group> = HttpApiEndpoint.MiddlewareError<Endpoints<Group>>;
 /**
- * @since 4.0.0
+ * Computes the services provided by middleware attached to any endpoint in a
+ * group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type MiddlewareProvides<Group> = HttpApiEndpoint.MiddlewareProvides<Endpoints<Group>>;
 /**
- * @since 4.0.0
+ * Computes the client-side middleware services required by endpoints in a group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type MiddlewareClient<Group> = HttpApiEndpoint.MiddlewareClient<Endpoints<Group>>;
 /**
- * @since 4.0.0
+ * Extracts the runtime services required by middleware attached to the endpoints in an `HttpApiGroup`.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type MiddlewareServices<Group> = HttpApiEndpoint.MiddlewareServices<Endpoints<Group>>;
 /**
- * @since 4.0.0
+ * Selects the endpoints in a group whose `name` matches the provided endpoint name.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type EndpointsWithName<Group extends Any, Name extends string> = Endpoints<WithName<Group, Name>>;
 /**
- * @since 4.0.0
+ * Computes the schema encoding and decoding services required by clients for all endpoints in a group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ClientServices<Group> = Group extends HttpApiGroup<infer _Name, infer _Endpoints, infer _TopLevel> ? HttpApiEndpoint.ClientServices<_Endpoints> : never;
 /**
- * @since 4.0.0
+ * Returns the type of a group after adding the supplied path prefix to each endpoint in the group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type AddPrefix<Group, Prefix extends PathInput> = Group extends HttpApiGroup<infer _Name, infer _Endpoints, infer _TopLevel> ? HttpApiGroup<_Name, HttpApiEndpoint.AddPrefix<_Endpoints, Prefix>, _TopLevel> : never;
 /**
- * @since 4.0.0
+ * Returns the type of a group after applying a middleware identifier to every endpoint in the group.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type AddMiddleware<Group, Id extends HttpApiMiddleware.AnyId> = Group extends HttpApiGroup<infer _Name, infer _Endpoints, infer _TopLevel> ? HttpApiGroup<_Name, HttpApiEndpoint.AddMiddleware<_Endpoints, Id>, _TopLevel> : never;
 /**
@@ -172,8 +239,8 @@ export type AddMiddleware<Group, Id extends HttpApiMiddleware.AnyId> = Group ext
  *
  * The endpoints can be implemented later using the `HttpApiBuilder.group` api.
  *
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const make: <const Id extends string, const TopLevel extends boolean = false>(identifier: Id, options?: {
     readonly topLevel?: TopLevel | undefined;

package/dist/unstable/httpapi/HttpApiGroup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpApiGroup.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiGroup.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAEhE,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAC5D,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAEhE,QAAA,MAAM,MAAM,iCAAiC,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,GAAuC,CAAA;AAExF;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY,CAC3B,GAAG,CAAC,EAAE,SAAS,MAAM,EACrB,GAAG,CAAC,SAAS,SAAS,eAAe,CAAC,GAAG,GAAG,KAAK,EACjD,GAAG,CAAC,QAAQ,SAAS,OAAO,GAAG,KAAK,CACpC,SAAQ,QAAQ;IAChB,KAAI,CAAC,EAAE,KAAK,GAAG,EAAE,CAAA;IACjB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAA;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC5D,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAE5C;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,qBAAqB,CAAC,eAAe,CAAC,GAAG,CAAC,EACtD,GAAG,SAAS,EAAE,CAAC,GACd,YAAY,CAAC,EAAE,EAAE,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAA;IAEpD;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,SAAS,SAAS,EACnC,MAAM,EAAE,MAAM,GACb,YAAY,CAAC,EAAE,EAAE,eAAe,CAAC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAA;IAE3E;;;;;OAKG;IACH,UAAU,CAAC,CAAC,SAAS,iBAAiB,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAC3F,EAAE,EACF,eAAe,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,CAAC,EAC3C,QAAQ,CACT,CAAA;IAED;;OAEG;IACH,aAAa,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAExF;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAEvF;;;;;OAKG;IACH,sBAAsB,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAEjG;;;;;OAKG;IACH,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;CACjG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,KAAK,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM;IACjE,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;IACrB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,CAAC,CAAA;CACvE;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,EAAE,eAAe,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;AAEtF;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,YAAY,CAAC,MAAM,IAAI,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GACpH,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,GACnB,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,KAAK,EAAE,IAAI,SAAS,MAAM,IAAI,OAAO,CAAC,KAAK,EAAE;IAAE,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC,CAAA;AAEhG;;;GAGG;AACH,MAAM,MAAM,IAAI,CAAC,KAAK,IAAI,KAAK,SAAS,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAAG,KAAK,GACxG,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,IAAI,KAAK,SAAS,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAAG,UAAU,GAClH,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI,eAAe,CAAC,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAE9F;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI,eAAe,CAAC,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAE9F;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,IAAI,eAAe,CAAC,eAAe,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAEtF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,KAAK,IAAI,eAAe,CAAC,kBAAkB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAE5F;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,IAAI,eAAe,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAExF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,KAAK,IAAI,eAAe,CAAC,kBAAkB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAE5F;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,GAAG,EAAE,IAAI,SAAS,MAAM,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;AAExG;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,IAAI,KAAK,SAAS,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAC5G,eAAe,CAAC,cAAc,CAAC,UAAU,CAAC,GACxC,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,EAAE,MAAM,SAAS,SAAS,IAAI,KAAK,SAC5D,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAC5D,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,GAC3E,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,EAAE,EAAE,SAAS,iBAAiB,CAAC,KAAK,IAAI,KAAK,SAC1E,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAC5D,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,aAAa,CAAC,UAAU,EAAE,EAAE,CAAC,EAAE,SAAS,CAAC,GAC3E,KAAK,CAAA;AAqFT;;;;;;;;GAQG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,KAAK,CAAC,QAAQ,SAAS,OAAO,GAAG,KAAK,EAAE,YAAY,EAAE,EAAE,UAAU;IAC9G,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;CACzC,KAAG,YAAY,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,CAMzB,CAAA"}
+{"version":3,"file":"HttpApiGroup.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiGroup.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAEhE,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAC5D,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAEhE,QAAA,MAAM,MAAM,iCAAiC,CAAA;AAE7C;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,GAAuC,CAAA;AAExF;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY,CAC3B,GAAG,CAAC,EAAE,SAAS,MAAM,EACrB,GAAG,CAAC,SAAS,SAAS,eAAe,CAAC,GAAG,GAAG,KAAK,EACjD,GAAG,CAAC,QAAQ,SAAS,OAAO,GAAG,KAAK,CACpC,SAAQ,QAAQ;IAChB,KAAI,CAAC,EAAE,KAAK,GAAG,EAAE,CAAA;IACjB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAA;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC5D,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAE5C;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,qBAAqB,CAAC,eAAe,CAAC,GAAG,CAAC,EACtD,GAAG,SAAS,EAAE,CAAC,GACd,YAAY,CAAC,EAAE,EAAE,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAA;IAEpD;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,SAAS,SAAS,EACnC,MAAM,EAAE,MAAM,GACb,YAAY,CAAC,EAAE,EAAE,eAAe,CAAC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAA;IAE3E;;;;;OAKG;IACH,UAAU,CAAC,CAAC,SAAS,iBAAiB,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAC3F,EAAE,EACF,eAAe,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,CAAC,EAC3C,QAAQ,CACT,CAAA;IAED;;OAEG;IACH,aAAa,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAExF;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAEvF;;;;;OAKG;IACH,sBAAsB,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAEjG;;;;;OAKG;IACH,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;CACjG;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ,CAAC,KAAK,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM;IACjE,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;IACrB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,CAAC,CAAA;CACvE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,EAAE,eAAe,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;AAEtF;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,YAAY,CAAC,MAAM,IAAI,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GACpH,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,GACnB,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,KAAK,EAAE,IAAI,SAAS,MAAM,IAAI,OAAO,CAAC,KAAK,EAAE;IAAE,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC,CAAA;AAEhG;;;;;GAKG;AACH,MAAM,MAAM,IAAI,CAAC,KAAK,IAAI,KAAK,SAAS,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAAG,KAAK,GACxG,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,IAAI,KAAK,SAAS,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAAG,UAAU,GAClH,KAAK,CAAA;AAET;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI,eAAe,CAAC,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAE9F;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI,eAAe,CAAC,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAE9F;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,IAAI,eAAe,CAAC,eAAe,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAEtF;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAAC,KAAK,IAAI,eAAe,CAAC,kBAAkB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAE5F;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,IAAI,eAAe,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAExF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAAC,KAAK,IAAI,eAAe,CAAC,kBAAkB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAE5F;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,GAAG,EAAE,IAAI,SAAS,MAAM,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;AAExG;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,IAAI,KAAK,SAAS,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAC5G,eAAe,CAAC,cAAc,CAAC,UAAU,CAAC,GACxC,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,EAAE,MAAM,SAAS,SAAS,IAAI,KAAK,SAC5D,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAC5D,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,GAC3E,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,EAAE,EAAE,SAAS,iBAAiB,CAAC,KAAK,IAAI,KAAK,SAC1E,YAAY,CAAC,MAAM,KAAK,EAAE,MAAM,UAAU,EAAE,MAAM,SAAS,CAAC,GAC5D,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,aAAa,CAAC,UAAU,EAAE,EAAE,CAAC,EAAE,SAAS,CAAC,GAC3E,KAAK,CAAA;AAqFT;;;;;;;;GAQG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,KAAK,CAAC,QAAQ,SAAS,OAAO,GAAG,KAAK,EAAE,YAAY,EAAE,EAAE,UAAU;IAC9G,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;CACzC,KAAG,YAAY,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,CAMzB,CAAA"}

package/dist/unstable/httpapi/HttpApiGroup.js

@@ -4,8 +4,11 @@ import * as Predicate from "../../Predicate.js";
 import * as Record from "../../Record.js";
 const TypeId = "~effect/httpapi/HttpApiGroup";
 /**
- * @since 4.0.0
+ * Returns `true` when a value is an `HttpApiGroup`, narrowing the value to the
+ * group interface.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export const isHttpApiGroup = u => Predicate.hasProperty(u, TypeId);
 const Proto = {
@@ -88,8 +91,8 @@ const makeProto = options => {
  *
  * The endpoints can be implemented later using the `HttpApiBuilder.group` api.
  *
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export const make = (identifier, options) => makeProto({
   identifier,

package/dist/unstable/httpapi/HttpApiGroup.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpApiGroup.js","names":["Context","pipeArguments","Predicate","Record","TypeId","isHttpApiGroup","u","hasProperty","Proto","add","toAdd","endpoints","endpoint","name","makeProto","identifier","topLevel","annotations","prefix","map","middleware","annotateMerge","merge","annotate","annotation","value","annotateEndpointsMerge","annotateEndpoints","pipe","arguments","options","HttpApiGroup","Object","setPrototypeOf","key","assign","make","empty"],"sources":["../../../src/unstable/httpapi/HttpApiGroup.ts"],"sourcesContent":[null],"mappings":"AAIA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,SAAwBC,aAAa,QAAQ,mBAAmB;AAChE,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAKzC,MAAMC,MAAM,GAAG,8BAA8B;AAE7C;;;;AAIA,OAAO,MAAMC,cAAc,GAAIC,CAAU,IAAeJ,SAAS,CAACK,WAAW,CAACD,CAAC,EAAEF,MAAM,CAAC;AAyMxF,MAAMI,KAAK,GAAG;EACZ,CAACJ,MAAM,GAAGA,MAAM;EAChBK,GAAGA,CAAqB,GAAGC,KAA0D;IACnF,MAAMC,SAAS,GAAG;MAAE,GAAG,IAAI,CAACA;IAAS,CAAE;IACvC,KAAK,MAAMC,QAAQ,IAAIF,KAAK,EAAE;MAC5BC,SAAS,CAACC,QAAQ,CAACC,IAAI,CAAC,GAAGD,QAAQ;IACrC;IACA,OAAOE,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS;MACTM,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDC,MAAMA,CAAqBA,MAAiB;IAC1C,OAAOJ,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAER,MAAM,CAACgB,GAAG,CAAC,IAAI,CAACR,SAAS,EAAGC,QAAQ,IAAKA,QAAQ,CAACM,MAAM,CAACA,MAAM,CAAC,CAAC;MAC5ED,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDG,UAAUA,CAAqBA,UAAwC;IACrE,OAAON,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAER,MAAM,CAACgB,GAAG,CAAC,IAAI,CAACR,SAAS,EAAGC,QAAQ,IAAKA,QAAQ,CAACQ,UAAU,CAACA,UAAiB,CAAC,CAAC;MAC3FH,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDI,aAAaA,CAAwBJ,WAA+B;IAClE,OAAOH,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAE,IAAI,CAACA,SAAS;MACzBM,WAAW,EAAEjB,OAAO,CAACsB,KAAK,CAAC,IAAI,CAACL,WAAW,EAAEA,WAAW;KACzD,CAAC;EACJ,CAAC;EACDM,QAAQA,CAA2BC,UAA6B,EAAEC,KAAQ;IACxE,OAAOX,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAE,IAAI,CAACA,SAAS;MACzBM,WAAW,EAAEjB,OAAO,CAACS,GAAG,CAAC,IAAI,CAACQ,WAAW,EAAEO,UAAU,EAAEC,KAAK;KAC7D,CAAC;EACJ,CAAC;EACDC,sBAAsBA,CAAwBT,WAA+B;IAC3E,OAAOH,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAER,MAAM,CAACgB,GAAG,CAAC,IAAI,CAACR,SAAS,EAAGC,QAAQ,IAAKA,QAAQ,CAACS,aAAa,CAACJ,WAAW,CAAC,CAAC;MACxFA,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDU,iBAAiBA,CAA2BH,UAA6B,EAAEC,KAAQ;IACjF,OAAOX,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAER,MAAM,CAACgB,GAAG,CAAC,IAAI,CAACR,SAAS,EAAGC,QAAQ,IAAKA,QAAQ,CAACW,QAAQ,CAACC,UAAU,EAAEC,KAAK,CAAC,CAAC;MACzFR,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDW,IAAIA,CAAA;IACF,OAAO3B,aAAa,CAAC,IAAI,EAAE4B,SAAS,CAAC;EACvC;CACD;AAED,MAAMf,SAAS,GAIbgB,OAKD,IAA2C;EAC1C,SAASC,YAAYA,CAAA,GAAI;EACzBC,MAAM,CAACC,cAAc,CAACF,YAAY,EAAEvB,KAAK,CAAC;EAC1CuB,YAAY,CAACG,GAAG,GAAG,+BAA+BJ,OAAO,CAACf,UAAU,EAAE;EACtE,OAAOiB,MAAM,CAACG,MAAM,CAACJ,YAAY,EAAED,OAAO,CAAQ;AACpD,CAAC;AAED;;;;;;;;;AASA,OAAO,MAAMM,IAAI,GAAGA,CAAkErB,UAAc,EAAEe,OAErG,KACChB,SAAS,CAAC;EACRC,UAAU;EACVC,QAAQ,EAAEc,OAAO,EAAEd,QAAQ,IAAI,KAAY;EAC3CL,SAAS,EAAER,MAAM,CAACkC,KAAK,EAAE;EACzBpB,WAAW,EAAEjB,OAAO,CAACqC,KAAK;CAC3B,CAAQ","ignoreList":[]}
+{"version":3,"file":"HttpApiGroup.js","names":["Context","pipeArguments","Predicate","Record","TypeId","isHttpApiGroup","u","hasProperty","Proto","add","toAdd","endpoints","endpoint","name","makeProto","identifier","topLevel","annotations","prefix","map","middleware","annotateMerge","merge","annotate","annotation","value","annotateEndpointsMerge","annotateEndpoints","pipe","arguments","options","HttpApiGroup","Object","setPrototypeOf","key","assign","make","empty"],"sources":["../../../src/unstable/httpapi/HttpApiGroup.ts"],"sourcesContent":[null],"mappings":"AA4BA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,SAAwBC,aAAa,QAAQ,mBAAmB;AAChE,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAKzC,MAAMC,MAAM,GAAG,8BAA8B;AAE7C;;;;;;;AAOA,OAAO,MAAMC,cAAc,GAAIC,CAAU,IAAeJ,SAAS,CAACK,WAAW,CAACD,CAAC,EAAEF,MAAM,CAAC;AAiPxF,MAAMI,KAAK,GAAG;EACZ,CAACJ,MAAM,GAAGA,MAAM;EAChBK,GAAGA,CAAqB,GAAGC,KAA0D;IACnF,MAAMC,SAAS,GAAG;MAAE,GAAG,IAAI,CAACA;IAAS,CAAE;IACvC,KAAK,MAAMC,QAAQ,IAAIF,KAAK,EAAE;MAC5BC,SAAS,CAACC,QAAQ,CAACC,IAAI,CAAC,GAAGD,QAAQ;IACrC;IACA,OAAOE,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS;MACTM,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDC,MAAMA,CAAqBA,MAAiB;IAC1C,OAAOJ,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAER,MAAM,CAACgB,GAAG,CAAC,IAAI,CAACR,SAAS,EAAGC,QAAQ,IAAKA,QAAQ,CAACM,MAAM,CAACA,MAAM,CAAC,CAAC;MAC5ED,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDG,UAAUA,CAAqBA,UAAwC;IACrE,OAAON,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAER,MAAM,CAACgB,GAAG,CAAC,IAAI,CAACR,SAAS,EAAGC,QAAQ,IAAKA,QAAQ,CAACQ,UAAU,CAACA,UAAiB,CAAC,CAAC;MAC3FH,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDI,aAAaA,CAAwBJ,WAA+B;IAClE,OAAOH,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAE,IAAI,CAACA,SAAS;MACzBM,WAAW,EAAEjB,OAAO,CAACsB,KAAK,CAAC,IAAI,CAACL,WAAW,EAAEA,WAAW;KACzD,CAAC;EACJ,CAAC;EACDM,QAAQA,CAA2BC,UAA6B,EAAEC,KAAQ;IACxE,OAAOX,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAE,IAAI,CAACA,SAAS;MACzBM,WAAW,EAAEjB,OAAO,CAACS,GAAG,CAAC,IAAI,CAACQ,WAAW,EAAEO,UAAU,EAAEC,KAAK;KAC7D,CAAC;EACJ,CAAC;EACDC,sBAAsBA,CAAwBT,WAA+B;IAC3E,OAAOH,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAER,MAAM,CAACgB,GAAG,CAAC,IAAI,CAACR,SAAS,EAAGC,QAAQ,IAAKA,QAAQ,CAACS,aAAa,CAACJ,WAAW,CAAC,CAAC;MACxFA,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDU,iBAAiBA,CAA2BH,UAA6B,EAAEC,KAAQ;IACjF,OAAOX,SAAS,CAAC;MACfC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,QAAQ,EAAE,IAAI,CAACA,QAAQ;MACvBL,SAAS,EAAER,MAAM,CAACgB,GAAG,CAAC,IAAI,CAACR,SAAS,EAAGC,QAAQ,IAAKA,QAAQ,CAACW,QAAQ,CAACC,UAAU,EAAEC,KAAK,CAAC,CAAC;MACzFR,WAAW,EAAE,IAAI,CAACA;KACnB,CAAC;EACJ,CAAC;EACDW,IAAIA,CAAA;IACF,OAAO3B,aAAa,CAAC,IAAI,EAAE4B,SAAS,CAAC;EACvC;CACD;AAED,MAAMf,SAAS,GAIbgB,OAKD,IAA2C;EAC1C,SAASC,YAAYA,CAAA,GAAI;EACzBC,MAAM,CAACC,cAAc,CAACF,YAAY,EAAEvB,KAAK,CAAC;EAC1CuB,YAAY,CAACG,GAAG,GAAG,+BAA+BJ,OAAO,CAACf,UAAU,EAAE;EACtE,OAAOiB,MAAM,CAACG,MAAM,CAACJ,YAAY,EAAED,OAAO,CAAQ;AACpD,CAAC;AAED;;;;;;;;;AASA,OAAO,MAAMM,IAAI,GAAGA,CAAkErB,UAAc,EAAEe,OAErG,KACChB,SAAS,CAAC;EACRC,UAAU;EACVC,QAAQ,EAAEc,OAAO,EAAEd,QAAQ,IAAI,KAAY;EAC3CL,SAAS,EAAER,MAAM,CAACkC,KAAK,EAAE;EACzBpB,WAAW,EAAEjB,OAAO,CAACqC,KAAK;CAC3B,CAAQ","ignoreList":[]}