effect 4.0.0-beta.67 → 4.0.0-beta.68

package/dist/unstable/httpapi/HttpApiSchema.js

@@ -119,7 +119,7 @@ export function status(code) {
  * Creates a void schema with the given HTTP status code.
  * This is used to represent empty responses with a specific status code.
  *
- * @see {@link asEmpty} for creating a no content response that can be decoded into a meaningful value on the client side.
+ * @see {@link NoContent} for the predefined 204 no content schema.
  *
  * @category Empty
  * @since 4.0.0
@@ -158,7 +158,7 @@ export const Accepted = /*#__PURE__*/Empty(202);
  * @see {@link NoContent} for a void schema with the status code 204.
  * @see {@link Empty} for creating a void schema with a specific status code.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function asNoContent(options) {
@@ -172,6 +172,7 @@ export function asNoContent(options) {
 /**
  * Runtime brand key used to mark schemas as buffered multipart payloads.
  *
+ * @category type IDs
  * @since 4.0.0
  */
 export const MultipartTypeId = "~effect/httpapi/HttpApiSchema/Multipart";
@@ -180,7 +181,7 @@ export const MultipartTypeId = "~effect/httpapi/HttpApiSchema/Multipart";
  *
  * @see {@link asMultipartStream} for a multipart stream payload.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function asMultipart(options) {
@@ -196,6 +197,7 @@ export function asMultipart(options) {
 /**
  * Runtime brand key used to mark schemas as streaming multipart payloads.
  *
+ * @category type IDs
  * @since 4.0.0
  */
 export const MultipartStreamTypeId = "~effect/httpapi/HttpApiSchema/MultipartStream";
@@ -204,7 +206,7 @@ export const MultipartStreamTypeId = "~effect/httpapi/HttpApiSchema/MultipartStr
  *
  * @see {@link asMultipart} for a buffered multipart payload.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function asMultipartStream(options) {
@@ -242,7 +244,7 @@ function defaultContentType(_tag) {
 /**
  * Marks a schema as a JSON payload / response.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function asJson(options) {
@@ -256,7 +258,7 @@ export function asJson(options) {
  *
  * The schema's encoded side must be a record of strings.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function asFormUrlEncoded(options) {
@@ -270,7 +272,7 @@ export function asFormUrlEncoded(options) {
  *
  * The schema encoded side must be a string.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function asText(options) {
@@ -284,7 +286,7 @@ export function asText(options) {
  *
  * The schema encoded side must be a `Uint8Array`.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function asUint8Array(options) {
@@ -299,6 +301,7 @@ export function asUint8Array(options) {
  * The check succeeds for direct `void` schemas and schemas whose encoded or
  * transformation target is `void`.
  *
+ * @category predicates
  * @since 4.0.0
  */
 export const isNoContent = ast => {

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSchema.js","names":["constVoid","Schema","AST","Transformation","hasBody","statusCodeByLiteral","Continue","SwitchingProtocols","Processing","EarlyHints","OK","Ok","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","ImUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","PayloadTooLarge","UriTooLong","UnsupportedMediaType","RangeNotSatisfiable","ExpectationFailed","ImATeapot","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","TooEarly","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired","status","code","statusCode","self","annotate","httpApiStatus","Empty","Void","pipe","asNoContent","options","decodeTo","toType","transform","decode","encode","MultipartTypeId","asMultipart","brand","_tag","mode","contentType","defaultContentType","limits","MultipartStreamTypeId","asMultipartStream","asNonMultipartEncoding","asJson","asFormUrlEncoded","asText","asUint8Array","isNoContent","ast","isVoid","encoded","toEncoded","target","encoding","to","undefined","resolveHttpApiEncoding","resolveAt","resolveHttpApiStatus","defaultJsonEncoding","defaultUrlEncodedEncoding","getEncoding","getPayloadEncoding","method","getResponseEncoding","out","Error","getStatusSuccess","getStatusError"],"sources":["../../../src/unstable/httpapi/HttpApiSchema.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAASA,SAAS,QAAsB,mBAAmB;AAC3D,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,GAAG,MAAM,oBAAoB;AACzC,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAC/D,SAASC,OAAO,QAAyB,uBAAuB;AA+ChE,MAAMC,mBAAmB,GAAG;EAC1BC,QAAQ,EAAE,GAAG;EACbC,kBAAkB,EAAE,GAAG;EACvBC,UAAU,EAAE,GAAG;EACfC,UAAU,EAAE,GAAG;EACfC,EAAE,EAAE,GAAG;EACPC,EAAE,EAAE,GAAG;EACPC,OAAO,EAAE,GAAG;EACZC,QAAQ,EAAE,GAAG;EACbC,2BAA2B,EAAE,GAAG;EAChCC,SAAS,EAAE,GAAG;EACdC,YAAY,EAAE,GAAG;EACjBC,cAAc,EAAE,GAAG;EACnBC,WAAW,EAAE,GAAG;EAChBC,eAAe,EAAE,GAAG;EACpBC,MAAM,EAAE,GAAG;EACXC,eAAe,EAAE,GAAG;EACpBC,gBAAgB,EAAE,GAAG;EACrBC,KAAK,EAAE,GAAG;EACVC,QAAQ,EAAE,GAAG;EACbC,WAAW,EAAE,GAAG;EAChBC,iBAAiB,EAAE,GAAG;EACtBC,iBAAiB,EAAE,GAAG;EACtBC,UAAU,EAAE,GAAG;EACfC,YAAY,EAAE,GAAG;EACjBC,eAAe,EAAE,GAAG;EACpBC,SAAS,EAAE,GAAG;EACdC,QAAQ,EAAE,GAAG;EACbC,gBAAgB,EAAE,GAAG;EACrBC,aAAa,EAAE,GAAG;EAClBC,2BAA2B,EAAE,GAAG;EAChCC,cAAc,EAAE,GAAG;EACnBC,QAAQ,EAAE,GAAG;EACbC,IAAI,EAAE,GAAG;EACTC,cAAc,EAAE,GAAG;EACnBC,kBAAkB,EAAE,GAAG;EACvBC,eAAe,EAAE,GAAG;EACpBC,UAAU,EAAE,GAAG;EACfC,oBAAoB,EAAE,GAAG;EACzBC,mBAAmB,EAAE,GAAG;EACxBC,iBAAiB,EAAE,GAAG;EACtBC,SAAS,EAAE,GAAG;EACdC,kBAAkB,EAAE,GAAG;EACvBC,mBAAmB,EAAE,GAAG;EACxBC,MAAM,EAAE,GAAG;EACXC,gBAAgB,EAAE,GAAG;EACrBC,QAAQ,EAAE,GAAG;EACbC,eAAe,EAAE,GAAG;EACpBC,oBAAoB,EAAE,GAAG;EACzBC,eAAe,EAAE,GAAG;EACpBC,2BAA2B,EAAE,GAAG;EAChCC,0BAA0B,EAAE,GAAG;EAC/BC,mBAAmB,EAAE,GAAG;EACxBC,cAAc,EAAE,GAAG;EACnBC,UAAU,EAAE,GAAG;EACfC,kBAAkB,EAAE,GAAG;EACvBC,cAAc,EAAE,GAAG;EACnBC,uBAAuB,EAAE,GAAG;EAC5BC,qBAAqB,EAAE,GAAG;EAC1BC,mBAAmB,EAAE,GAAG;EACxBC,YAAY,EAAE,GAAG;EACjBC,WAAW,EAAE,GAAG;EAChBC,6BAA6B,EAAE;CACvB;AAuBV,OAAM,SAAUC,MAAMA,CAACC,IAA4B;EACjD,MAAMC,UAAU,GAAG,OAAOD,IAAI,KAAK,QAAQ,GAAGhE,mBAAmB,CAACgE,IAAI,CAAC,GAAGA,IAAI;EAC9E,OAA8BE,IAAO,IAAkB;IACrD,OAAOA,IAAI,CAACC,QAAQ,CAAC;MAAEC,aAAa,EAAEH;IAAU,CAAE,CAAC;EACrD,CAAC;AACH;AAEA;;;;;;;;;AASA,OAAO,MAAMI,KAAK,GAAIL,IAAY,IAAkBpE,MAAM,CAAC0E,IAAI,CAACC,IAAI,CAACR,MAAM,CAACC,IAAI,CAAC,CAAC;AASlF;;;;;;;AAOA,OAAO,MAAMtD,SAAS,gBAAc2D,KAAK,CAAC,GAAG,CAAC;AAS9C;;;;;;;AAOA,OAAO,MAAM9D,OAAO,gBAAY8D,KAAK,CAAC,GAAG,CAAC;AAS1C;;;;;;;AAOA,OAAO,MAAM7D,QAAQ,gBAAa6D,KAAK,CAAC,GAAG,CAAC;AAS5C;;;;;;;;;;;;AAYA,OAAM,SAAUG,WAAWA,CAAuBC,OAEjD;EACC,OAAQP,IAAO,IAAoB;IACjC,OAAOtE,MAAM,CAAC0E,IAAI,CAACC,IAAI,CACrB3E,MAAM,CAAC8E,QAAQ,CACb9E,MAAM,CAAC+E,MAAM,CAACT,IAAI,CAAC,EACnBpE,cAAc,CAAC8E,SAAS,CAAC;MACvBC,MAAM,EAAEJ,OAAO,CAACI,MAAM;MACtBC,MAAM,EAAEnF;KACT,CAAC,CACH,CACF;EACH,CAAC;AACH;AAEA;;;;;AAKA,OAAO,MAAMoF,eAAe,GAAG,yCAAyC;AAgBxE;;;;;;;;AAQA,OAAM,SAAUC,WAAWA,CAACP,OAAuC;EACjE,OAA8BP,IAAO,IACnCA,IAAI,CAACK,IAAI,CAAC3E,MAAM,CAACqF,KAAK,CAACF,eAAe,CAAC,CAAC,CAACZ,QAAQ,CAAC;IAChD,kBAAkB,EAAE;MAClBe,IAAI,EAAE,WAAW;MACjBC,IAAI,EAAE,UAAU;MAChBC,WAAW,EAAEC,kBAAkB,CAAC,WAAW,CAAC;MAC5CC,MAAM,EAAEb;;GAEX,CAAC;AACN;AAEA;;;;;AAKA,OAAO,MAAMc,qBAAqB,GAAG,+CAA+C;AAgBpF;;;;;;;;AAQA,OAAM,SAAUC,iBAAiBA,CAACf,OAAuC;EACvE,OAA8BP,IAAO,IACnCA,IAAI,CAACK,IAAI,CAAC3E,MAAM,CAACqF,KAAK,CAACM,qBAAqB,CAAC,CAAC,CAACpB,QAAQ,CAAC;IACtD,kBAAkB,EAAE;MAClBe,IAAI,EAAE,WAAW;MACjBC,IAAI,EAAE,QAAQ;MACdC,WAAW,EAAEC,kBAAkB,CAAC,WAAW,CAAC;MAC5CC,MAAM,EAAEb;;GAEX,CAAC;AACN;AAEA,SAASgB,sBAAsBA,CAAuBvB,IAAO,EAAEO,OAG9D;EACC,OAAOP,IAAI,CAACC,QAAQ,CAAC;IACnB,kBAAkB,EAAE;MAClBe,IAAI,EAAET,OAAO,CAACS,IAAI;MAClBE,WAAW,EAAEX,OAAO,CAACW,WAAW,IAAIC,kBAAkB,CAACZ,OAAO,CAACS,IAAI;;GAEtE,CAAC;AACJ;AAEA,SAASG,kBAAkBA,CAACH,IAAsB;EAChD,QAAQA,IAAI;IACV,KAAK,WAAW;MACd,OAAO,qBAAqB;IAC9B,KAAK,MAAM;MACT,OAAO,kBAAkB;IAC3B,KAAK,gBAAgB;MACnB,OAAO,mCAAmC;IAC5C,KAAK,YAAY;MACf,OAAO,0BAA0B;IACnC,KAAK,MAAM;MACT,OAAO,YAAY;EACvB;AACF;AAEA;;;;;;AAMA,OAAM,SAAUQ,MAAMA,CAACjB,OAEtB;EACC,OAA8BP,IAAO,IAAKuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,MAAM;IAAE,GAAGT;EAAO,CAAE,CAAC;AACtG;AAEA;;;;;;;;AAQA,OAAM,SAAUkB,gBAAgBA,CAAClB,OAEhC;EACC,OACEP,IAAO,IACJuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,gBAAgB;IAAE,GAAGT;EAAO,CAAE,CAAC;AAC3E;AAEA;;;;;;;;AAQA,OAAM,SAAUmB,MAAMA,CAACnB,OAEtB;EACC,OAA6DP,IAAO,IAClEuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,MAAM;IAAE,GAAGT;EAAO,CAAE,CAAC;AAC9D;AAEA;;;;;;;;AAQA,OAAM,SAAUoB,YAAYA,CAACpB,OAE5B;EACC,OAAiEP,IAAO,IACtEuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,YAAY;IAAE,GAAGT;EAAO,CAAE,CAAC;AACpE;AACA;;;;;;;;AAQA,OAAO,MAAMqB,WAAW,GAAIC,GAAY,IAAa;EACnD,IAAIlG,GAAG,CAACmG,MAAM,CAACD,GAAG,CAAC,EAAE,OAAO,IAAI;EAChC,MAAME,OAAO,GAAGpG,GAAG,CAACqG,SAAS,CAACH,GAAG,CAAC;EAClC,IAAIlG,GAAG,CAACmG,MAAM,CAACC,OAAO,CAAC,EAAE,OAAO,IAAI;EACpC,MAAME,MAAM,GAAGJ,GAAG,CAACK,QAAQ,GAAG,CAAC,CAAC,CAACC,EAAE;EACnC,IAAIF,MAAM,KAAKG,SAAS,EAAE,OAAO,KAAK;EACtC,OAAOzG,GAAG,CAACmG,MAAM,CAACG,MAAM,CAAC;AAC3B,CAAC;AAED,MAAMI,sBAAsB,gBAAG1G,GAAG,CAAC2G,SAAS,CAAW,kBAAkB,CAAC;AAE1E,MAAMC,oBAAoB,gBAAG5G,GAAG,CAAC2G,SAAS,CAAS,eAAe,CAAC;AAEnE,MAAME,mBAAmB,GAAa;EACpCxB,IAAI,EAAE,MAAM;EACZE,WAAW,EAAE;CACd;AACD,MAAMuB,yBAAyB,GAAa;EAC1CzB,IAAI,EAAE,gBAAgB;EACtBE,WAAW,EAAE;CACd;AAED,SAASwB,WAAWA,CAACb,GAAY;EAC/B,OAAOQ,sBAAsB,CAACR,GAAG,CAAC,IAAIW,mBAAmB;AAC3D;AAEA;AACA,OAAM,SAAUG,kBAAkBA,CAACd,GAAY,EAAEe,MAAkB;EACjE,MAAMV,QAAQ,GAAGG,sBAAsB,CAACR,GAAG,CAAC;EAC5C,IAAIK,QAAQ,EAAE,OAAOA,QAAQ;EAC7B,OAAOrG,OAAO,CAAC+G,MAAM,CAAC,GAAGJ,mBAAmB,GAAGC,yBAAyB;AAC1E;AAEA;AACA,OAAM,SAAUI,mBAAmBA,CAAChB,GAAY;EAC9C,MAAMiB,GAAG,GAAGJ,WAAW,CAACb,GAAG,CAAC;EAC5B,IAAIiB,GAAG,CAAC9B,IAAI,KAAK,WAAW,EAAE;IAC5B,MAAM,IAAI+B,KAAK,CAAC,wCAAwC,CAAC;EAC3D;EACA,OAAOD,GAAG;AACZ;AAEA;AACA,OAAM,SAAUE,gBAAgBA,CAAChD,IAAa;EAC5C,OAAOuC,oBAAoB,CAACvC,IAAI,CAAC,IAAI,GAAG;AAC1C;AAEA;AACA,OAAM,SAAUiD,cAAcA,CAACjD,IAAa;EAC1C,OAAOuC,oBAAoB,CAACvC,IAAI,CAAC,IAAI,GAAG;AAC1C","ignoreList":[]}
+{"version":3,"file":"HttpApiSchema.js","names":["constVoid","Schema","AST","Transformation","hasBody","statusCodeByLiteral","Continue","SwitchingProtocols","Processing","EarlyHints","OK","Ok","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","ImUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","PayloadTooLarge","UriTooLong","UnsupportedMediaType","RangeNotSatisfiable","ExpectationFailed","ImATeapot","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","TooEarly","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired","status","code","statusCode","self","annotate","httpApiStatus","Empty","Void","pipe","asNoContent","options","decodeTo","toType","transform","decode","encode","MultipartTypeId","asMultipart","brand","_tag","mode","contentType","defaultContentType","limits","MultipartStreamTypeId","asMultipartStream","asNonMultipartEncoding","asJson","asFormUrlEncoded","asText","asUint8Array","isNoContent","ast","isVoid","encoded","toEncoded","target","encoding","to","undefined","resolveHttpApiEncoding","resolveAt","resolveHttpApiStatus","defaultJsonEncoding","defaultUrlEncodedEncoding","getEncoding","getPayloadEncoding","method","getResponseEncoding","out","Error","getStatusSuccess","getStatusError"],"sources":["../../../src/unstable/httpapi/HttpApiSchema.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAASA,SAAS,QAAsB,mBAAmB;AAC3D,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,GAAG,MAAM,oBAAoB;AACzC,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAC/D,SAASC,OAAO,QAAyB,uBAAuB;AA+ChE,MAAMC,mBAAmB,GAAG;EAC1BC,QAAQ,EAAE,GAAG;EACbC,kBAAkB,EAAE,GAAG;EACvBC,UAAU,EAAE,GAAG;EACfC,UAAU,EAAE,GAAG;EACfC,EAAE,EAAE,GAAG;EACPC,EAAE,EAAE,GAAG;EACPC,OAAO,EAAE,GAAG;EACZC,QAAQ,EAAE,GAAG;EACbC,2BAA2B,EAAE,GAAG;EAChCC,SAAS,EAAE,GAAG;EACdC,YAAY,EAAE,GAAG;EACjBC,cAAc,EAAE,GAAG;EACnBC,WAAW,EAAE,GAAG;EAChBC,eAAe,EAAE,GAAG;EACpBC,MAAM,EAAE,GAAG;EACXC,eAAe,EAAE,GAAG;EACpBC,gBAAgB,EAAE,GAAG;EACrBC,KAAK,EAAE,GAAG;EACVC,QAAQ,EAAE,GAAG;EACbC,WAAW,EAAE,GAAG;EAChBC,iBAAiB,EAAE,GAAG;EACtBC,iBAAiB,EAAE,GAAG;EACtBC,UAAU,EAAE,GAAG;EACfC,YAAY,EAAE,GAAG;EACjBC,eAAe,EAAE,GAAG;EACpBC,SAAS,EAAE,GAAG;EACdC,QAAQ,EAAE,GAAG;EACbC,gBAAgB,EAAE,GAAG;EACrBC,aAAa,EAAE,GAAG;EAClBC,2BAA2B,EAAE,GAAG;EAChCC,cAAc,EAAE,GAAG;EACnBC,QAAQ,EAAE,GAAG;EACbC,IAAI,EAAE,GAAG;EACTC,cAAc,EAAE,GAAG;EACnBC,kBAAkB,EAAE,GAAG;EACvBC,eAAe,EAAE,GAAG;EACpBC,UAAU,EAAE,GAAG;EACfC,oBAAoB,EAAE,GAAG;EACzBC,mBAAmB,EAAE,GAAG;EACxBC,iBAAiB,EAAE,GAAG;EACtBC,SAAS,EAAE,GAAG;EACdC,kBAAkB,EAAE,GAAG;EACvBC,mBAAmB,EAAE,GAAG;EACxBC,MAAM,EAAE,GAAG;EACXC,gBAAgB,EAAE,GAAG;EACrBC,QAAQ,EAAE,GAAG;EACbC,eAAe,EAAE,GAAG;EACpBC,oBAAoB,EAAE,GAAG;EACzBC,eAAe,EAAE,GAAG;EACpBC,2BAA2B,EAAE,GAAG;EAChCC,0BAA0B,EAAE,GAAG;EAC/BC,mBAAmB,EAAE,GAAG;EACxBC,cAAc,EAAE,GAAG;EACnBC,UAAU,EAAE,GAAG;EACfC,kBAAkB,EAAE,GAAG;EACvBC,cAAc,EAAE,GAAG;EACnBC,uBAAuB,EAAE,GAAG;EAC5BC,qBAAqB,EAAE,GAAG;EAC1BC,mBAAmB,EAAE,GAAG;EACxBC,YAAY,EAAE,GAAG;EACjBC,WAAW,EAAE,GAAG;EAChBC,6BAA6B,EAAE;CACvB;AAuBV,OAAM,SAAUC,MAAMA,CAACC,IAA4B;EACjD,MAAMC,UAAU,GAAG,OAAOD,IAAI,KAAK,QAAQ,GAAGhE,mBAAmB,CAACgE,IAAI,CAAC,GAAGA,IAAI;EAC9E,OAA8BE,IAAO,IAAkB;IACrD,OAAOA,IAAI,CAACC,QAAQ,CAAC;MAAEC,aAAa,EAAEH;IAAU,CAAE,CAAC;EACrD,CAAC;AACH;AAEA;;;;;;;;;AASA,OAAO,MAAMI,KAAK,GAAIL,IAAY,IAAkBpE,MAAM,CAAC0E,IAAI,CAACC,IAAI,CAACR,MAAM,CAACC,IAAI,CAAC,CAAC;AAUlF;;;;;;;AAOA,OAAO,MAAMtD,SAAS,gBAAc2D,KAAK,CAAC,GAAG,CAAC;AAU9C;;;;;;;AAOA,OAAO,MAAM9D,OAAO,gBAAY8D,KAAK,CAAC,GAAG,CAAC;AAU1C;;;;;;;AAOA,OAAO,MAAM7D,QAAQ,gBAAa6D,KAAK,CAAC,GAAG,CAAC;AAU5C;;;;;;;;;;;;AAYA,OAAM,SAAUG,WAAWA,CAAuBC,OAEjD;EACC,OAAQP,IAAO,IAAoB;IACjC,OAAOtE,MAAM,CAAC0E,IAAI,CAACC,IAAI,CACrB3E,MAAM,CAAC8E,QAAQ,CACb9E,MAAM,CAAC+E,MAAM,CAACT,IAAI,CAAC,EACnBpE,cAAc,CAAC8E,SAAS,CAAC;MACvBC,MAAM,EAAEJ,OAAO,CAACI,MAAM;MACtBC,MAAM,EAAEnF;KACT,CAAC,CACH,CACF;EACH,CAAC;AACH;AAEA;;;;;;AAMA,OAAO,MAAMoF,eAAe,GAAG,yCAAyC;AAkBxE;;;;;;;;AAQA,OAAM,SAAUC,WAAWA,CAACP,OAAuC;EACjE,OAA8BP,IAAO,IACnCA,IAAI,CAACK,IAAI,CAAC3E,MAAM,CAACqF,KAAK,CAACF,eAAe,CAAC,CAAC,CAACZ,QAAQ,CAAC;IAChD,kBAAkB,EAAE;MAClBe,IAAI,EAAE,WAAW;MACjBC,IAAI,EAAE,UAAU;MAChBC,WAAW,EAAEC,kBAAkB,CAAC,WAAW,CAAC;MAC5CC,MAAM,EAAEb;;GAEX,CAAC;AACN;AAEA;;;;;;AAMA,OAAO,MAAMc,qBAAqB,GAAG,+CAA+C;AAkBpF;;;;;;;;AAQA,OAAM,SAAUC,iBAAiBA,CAACf,OAAuC;EACvE,OAA8BP,IAAO,IACnCA,IAAI,CAACK,IAAI,CAAC3E,MAAM,CAACqF,KAAK,CAACM,qBAAqB,CAAC,CAAC,CAACpB,QAAQ,CAAC;IACtD,kBAAkB,EAAE;MAClBe,IAAI,EAAE,WAAW;MACjBC,IAAI,EAAE,QAAQ;MACdC,WAAW,EAAEC,kBAAkB,CAAC,WAAW,CAAC;MAC5CC,MAAM,EAAEb;;GAEX,CAAC;AACN;AAEA,SAASgB,sBAAsBA,CAAuBvB,IAAO,EAAEO,OAG9D;EACC,OAAOP,IAAI,CAACC,QAAQ,CAAC;IACnB,kBAAkB,EAAE;MAClBe,IAAI,EAAET,OAAO,CAACS,IAAI;MAClBE,WAAW,EAAEX,OAAO,CAACW,WAAW,IAAIC,kBAAkB,CAACZ,OAAO,CAACS,IAAI;;GAEtE,CAAC;AACJ;AAEA,SAASG,kBAAkBA,CAACH,IAAsB;EAChD,QAAQA,IAAI;IACV,KAAK,WAAW;MACd,OAAO,qBAAqB;IAC9B,KAAK,MAAM;MACT,OAAO,kBAAkB;IAC3B,KAAK,gBAAgB;MACnB,OAAO,mCAAmC;IAC5C,KAAK,YAAY;MACf,OAAO,0BAA0B;IACnC,KAAK,MAAM;MACT,OAAO,YAAY;EACvB;AACF;AAEA;;;;;;AAMA,OAAM,SAAUQ,MAAMA,CAACjB,OAEtB;EACC,OAA8BP,IAAO,IAAKuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,MAAM;IAAE,GAAGT;EAAO,CAAE,CAAC;AACtG;AAEA;;;;;;;;AAQA,OAAM,SAAUkB,gBAAgBA,CAAClB,OAEhC;EACC,OACEP,IAAO,IACJuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,gBAAgB;IAAE,GAAGT;EAAO,CAAE,CAAC;AAC3E;AAEA;;;;;;;;AAQA,OAAM,SAAUmB,MAAMA,CAACnB,OAEtB;EACC,OAA6DP,IAAO,IAClEuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,MAAM;IAAE,GAAGT;EAAO,CAAE,CAAC;AAC9D;AAEA;;;;;;;;AAQA,OAAM,SAAUoB,YAAYA,CAACpB,OAE5B;EACC,OAAiEP,IAAO,IACtEuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,YAAY;IAAE,GAAGT;EAAO,CAAE,CAAC;AACpE;AACA;;;;;;;;;AASA,OAAO,MAAMqB,WAAW,GAAIC,GAAY,IAAa;EACnD,IAAIlG,GAAG,CAACmG,MAAM,CAACD,GAAG,CAAC,EAAE,OAAO,IAAI;EAChC,MAAME,OAAO,GAAGpG,GAAG,CAACqG,SAAS,CAACH,GAAG,CAAC;EAClC,IAAIlG,GAAG,CAACmG,MAAM,CAACC,OAAO,CAAC,EAAE,OAAO,IAAI;EACpC,MAAME,MAAM,GAAGJ,GAAG,CAACK,QAAQ,GAAG,CAAC,CAAC,CAACC,EAAE;EACnC,IAAIF,MAAM,KAAKG,SAAS,EAAE,OAAO,KAAK;EACtC,OAAOzG,GAAG,CAACmG,MAAM,CAACG,MAAM,CAAC;AAC3B,CAAC;AAED,MAAMI,sBAAsB,gBAAG1G,GAAG,CAAC2G,SAAS,CAAW,kBAAkB,CAAC;AAE1E,MAAMC,oBAAoB,gBAAG5G,GAAG,CAAC2G,SAAS,CAAS,eAAe,CAAC;AAEnE,MAAME,mBAAmB,GAAa;EACpCxB,IAAI,EAAE,MAAM;EACZE,WAAW,EAAE;CACd;AACD,MAAMuB,yBAAyB,GAAa;EAC1CzB,IAAI,EAAE,gBAAgB;EACtBE,WAAW,EAAE;CACd;AAED,SAASwB,WAAWA,CAACb,GAAY;EAC/B,OAAOQ,sBAAsB,CAACR,GAAG,CAAC,IAAIW,mBAAmB;AAC3D;AAEA;AACA,OAAM,SAAUG,kBAAkBA,CAACd,GAAY,EAAEe,MAAkB;EACjE,MAAMV,QAAQ,GAAGG,sBAAsB,CAACR,GAAG,CAAC;EAC5C,IAAIK,QAAQ,EAAE,OAAOA,QAAQ;EAC7B,OAAOrG,OAAO,CAAC+G,MAAM,CAAC,GAAGJ,mBAAmB,GAAGC,yBAAyB;AAC1E;AAEA;AACA,OAAM,SAAUI,mBAAmBA,CAAChB,GAAY;EAC9C,MAAMiB,GAAG,GAAGJ,WAAW,CAACb,GAAG,CAAC;EAC5B,IAAIiB,GAAG,CAAC9B,IAAI,KAAK,WAAW,EAAE;IAC5B,MAAM,IAAI+B,KAAK,CAAC,wCAAwC,CAAC;EAC3D;EACA,OAAOD,GAAG;AACZ;AAEA;AACA,OAAM,SAAUE,gBAAgBA,CAAChD,IAAa;EAC5C,OAAOuC,oBAAoB,CAACvC,IAAI,CAAC,IAAI,GAAG;AAC1C;AAEA;AACA,OAAM,SAAUiD,cAAcA,CAACjD,IAAa;EAC1C,OAAOuC,oBAAoB,CAACvC,IAAI,CAAC,IAAI,GAAG;AAC1C","ignoreList":[]}

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

@@ -40,7 +40,6 @@ export type HttpApiSecurity = Bearer | ApiKey | Basic;
 /**
  * Helper types for HTTP API security schemes.
  *
- * @category models
  * @since 4.0.0
  */
 export declare namespace HttpApiSecurity {

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSecurity.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiSecurity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,QAAA,MAAM,MAAM,oCAAoC,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;AAErD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC;;;;;OAKG;IACH,UAAiB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ;QAC5C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;SAC1B,CAAA;QACD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC7C;IAED;;;;;OAKG;IACH,KAAY,IAAI,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAA;CACvF;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AASD;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,EAAE,MAGnB,CAAA;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,MAAM,GAAI,SAAS;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;CACxD,KAAG,MAMA,CAAA;AAEJ;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,EAAE,KAGlB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B;;;;;OAKG;IACH,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IAC/E;;;;;OAKG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAQ5E,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;OAKG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IACvF;;;;;OAKG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAA;CAQpF,CAAA"}
+{"version":3,"file":"HttpApiSecurity.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiSecurity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,QAAA,MAAM,MAAM,oCAAoC,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;AAErD;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC;;;;;OAKG;IACH,UAAiB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ;QAC5C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;SAC1B,CAAA;QACD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC7C;IAED;;;;;OAKG;IACH,KAAY,IAAI,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAA;CACvF;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AASD;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,EAAE,MAGnB,CAAA;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,MAAM,GAAI,SAAS;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;CACxD,KAAG,MAMA,CAAA;AAEJ;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,EAAE,KAGlB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B;;;;;OAKG;IACH,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IAC/E;;;;;OAKG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAQ5E,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;OAKG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IACvF;;;;;OAKG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAA;CAQpF,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSecurity.js","names":["Context","dual","pipeArguments","TypeId","Proto","pipe","arguments","bearer","Object","assign","create","_tag","annotations","empty","apiKey","options","key","in","basic","annotateMerge","self","merge","annotate","service","value","add"],"sources":["../../../src/unstable/httpapi/HttpApiSecurity.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,SAASC,IAAI,QAAQ,mBAAmB;AACxC,SAAwBC,aAAa,QAAQ,mBAAmB;AAIhE,MAAMC,MAAM,GAAG,iCAAiC;AAkFhD,MAAMC,KAAK,GAAG;EACZ,CAACD,MAAM,GAAGA,MAAM;EAChBE,IAAIA,CAAA;IACF,OAAOH,aAAa,CAAC,IAAI,EAAEI,SAAS,CAAC;EACvC;CACD;AAED;;;;;;;;;AASA,OAAO,MAAMC,MAAM,gBAAWC,MAAM,CAACC,MAAM,cAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAChEO,IAAI,EAAE,QAAQ;EACdC,WAAW,eAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;AAcA,OAAO,MAAMC,MAAM,GAAIC,OAGtB,IACCP,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClCO,IAAI,EAAE,QAAQ;EACdK,GAAG,EAAED,OAAO,CAACC,GAAG;EAChBC,EAAE,EAAEF,OAAO,CAACE,EAAE,IAAI,QAAQ;EAC1BL,WAAW,EAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEJ;;;;;;;;;AASA,OAAO,MAAMK,KAAK,gBAAUV,MAAM,CAACC,MAAM,cAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAC9DO,IAAI,EAAE,OAAO;EACbC,WAAW,eAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMM,aAAa,gBAetBlB,IAAI,CACN,CAAC,EACD,CAA+BmB,IAAO,EAAER,WAA+B,KACrEJ,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClC,GAAGgB,IAAI;EACPR,WAAW,EAAEZ,OAAO,CAACqB,KAAK,CAACD,IAAI,CAACR,WAAW,EAAEA,WAAW;CACzD,CAAC,CACL;AAED;;;;;;AAMA,OAAO,MAAMU,QAAQ,gBAejBrB,IAAI,CACN,CAAC,EACD,CAAkCmB,IAAO,EAAEG,OAA0B,EAAEC,KAAQ,KAC7EhB,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClC,GAAGgB,IAAI;EACPR,WAAW,EAAEZ,OAAO,CAACyB,GAAG,CAACL,IAAI,CAACR,WAAW,EAAEW,OAAO,EAAEC,KAAK;CAC1D,CAAC,CACL","ignoreList":[]}
+{"version":3,"file":"HttpApiSecurity.js","names":["Context","dual","pipeArguments","TypeId","Proto","pipe","arguments","bearer","Object","assign","create","_tag","annotations","empty","apiKey","options","key","in","basic","annotateMerge","self","merge","annotate","service","value","add"],"sources":["../../../src/unstable/httpapi/HttpApiSecurity.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,SAASC,IAAI,QAAQ,mBAAmB;AACxC,SAAwBC,aAAa,QAAQ,mBAAmB;AAIhE,MAAMC,MAAM,GAAG,iCAAiC;AAiFhD,MAAMC,KAAK,GAAG;EACZ,CAACD,MAAM,GAAGA,MAAM;EAChBE,IAAIA,CAAA;IACF,OAAOH,aAAa,CAAC,IAAI,EAAEI,SAAS,CAAC;EACvC;CACD;AAED;;;;;;;;;AASA,OAAO,MAAMC,MAAM,gBAAWC,MAAM,CAACC,MAAM,cAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAChEO,IAAI,EAAE,QAAQ;EACdC,WAAW,eAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;AAcA,OAAO,MAAMC,MAAM,GAAIC,OAGtB,IACCP,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClCO,IAAI,EAAE,QAAQ;EACdK,GAAG,EAAED,OAAO,CAACC,GAAG;EAChBC,EAAE,EAAEF,OAAO,CAACE,EAAE,IAAI,QAAQ;EAC1BL,WAAW,EAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEJ;;;;;;;;;AASA,OAAO,MAAMK,KAAK,gBAAUV,MAAM,CAACC,MAAM,cAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAC9DO,IAAI,EAAE,OAAO;EACbC,WAAW,eAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMM,aAAa,gBAetBlB,IAAI,CACN,CAAC,EACD,CAA+BmB,IAAO,EAAER,WAA+B,KACrEJ,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClC,GAAGgB,IAAI;EACPR,WAAW,EAAEZ,OAAO,CAACqB,KAAK,CAACD,IAAI,CAACR,WAAW,EAAEA,WAAW;CACzD,CAAC,CACL;AAED;;;;;;AAMA,OAAO,MAAMU,QAAQ,gBAejBrB,IAAI,CACN,CAAC,EACD,CAAkCmB,IAAO,EAAEG,OAA0B,EAAEC,KAAQ,KAC7EhB,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClC,GAAGgB,IAAI;EACPR,WAAW,EAAEZ,OAAO,CAACyB,GAAG,CAACL,IAAI,CAACR,WAAW,EAAEW,OAAO,EAAEC,KAAK;CAC1D,CAAC,CACL","ignoreList":[]}

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

@@ -8,8 +8,6 @@ import type * as HttpApiGroup from "./HttpApiGroup.ts";
  * The route serves the OpenAPI specification generated from the API at the
  * configured path, defaulting to `/docs`.
  *
- * @param options.path Optional mount path (default "/docs").
- *
  * @category layers
  * @since 4.0.0
  */

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSwagger.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiSwagger.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAA;AAEnD,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAoCtD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EACtE,KAAK,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,EAChC,UAAU;IACR,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;CACzC,KACA,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CAI7C,CAAA"}
+{"version":3,"file":"HttpApiSwagger.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiSwagger.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAA;AAEnD,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAoCtD;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EACtE,KAAK,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,EAChC,UAAU;IACR,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;CACzC,KACA,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CAI7C,CAAA"}

package/dist/unstable/httpapi/HttpApiSwagger.js

@@ -60,8 +60,6 @@ const makeHandler = options => {
  * The route serves the OpenAPI specification generated from the API at the
  * configured path, defaulting to `/docs`.
  *
- * @param options.path Optional mount path (default "/docs").
- *
  * @category layers
  * @since 4.0.0
  */

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSwagger.js","names":["Effect","HttpRouter","HttpServerResponse","Html","internal","OpenApi","makeHandler","options","spec","fromApi","api","response","html","escape","info","title","css","escapeJson","javascript","succeed","layer","use","fnUntraced","router","handler","add","path"],"sources":["../../../src/unstable/httpapi/HttpApiSwagger.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,UAAU,MAAM,uBAAuB;AACnD,OAAO,KAAKC,kBAAkB,MAAM,+BAA+B;AAGnE,OAAO,KAAKC,IAAI,MAAM,oBAAoB;AAC1C,OAAO,KAAKC,QAAQ,MAAM,8BAA8B;AACxD,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC,MAAMC,WAAW,GAAwDC,OAExE,IAAI;EACH,MAAMC,IAAI,GAAGH,OAAO,CAACI,OAAO,CAACF,OAAO,CAACG,GAAG,CAAC;EACzC,MAAMC,QAAQ,GAAGT,kBAAkB,CAACU,IAAI,CAAC;;;;;WAKhCT,IAAI,CAACU,MAAM,CAACL,IAAI,CAACM,IAAI,CAACC,KAAK,CAAC;WAC5BX,QAAQ,CAACY,GAAG;;;;;MAKjBb,IAAI,CAACc,UAAU,CAACT,IAAI,CAAC;;;MAGrBJ,QAAQ,CAACc,UAAU;;;;;;;;;QASjB,CAAC;EACP,OAAOlB,MAAM,CAACmB,OAAO,CAACR,QAAQ,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;AAWA,OAAO,MAAMS,KAAK,GAAGA,CACnBV,GAAgC,EAChCH,OAEC,KAEDN,UAAU,CAACoB,GAAG,CAACrB,MAAM,CAACsB,UAAU,CAAC,WAAUC,MAAM;EAC/C,MAAMC,OAAO,GAAGlB,WAAW,CAAC;IAAEI;EAAG,CAAE,CAAC;EACpC,OAAOa,MAAM,CAACE,GAAG,CAAC,KAAK,EAAElB,OAAO,EAAEmB,IAAI,IAAI,OAAO,EAAEF,OAAO,CAAC;AAC7D,CAAC,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"HttpApiSwagger.js","names":["Effect","HttpRouter","HttpServerResponse","Html","internal","OpenApi","makeHandler","options","spec","fromApi","api","response","html","escape","info","title","css","escapeJson","javascript","succeed","layer","use","fnUntraced","router","handler","add","path"],"sources":["../../../src/unstable/httpapi/HttpApiSwagger.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,UAAU,MAAM,uBAAuB;AACnD,OAAO,KAAKC,kBAAkB,MAAM,+BAA+B;AAGnE,OAAO,KAAKC,IAAI,MAAM,oBAAoB;AAC1C,OAAO,KAAKC,QAAQ,MAAM,8BAA8B;AACxD,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC,MAAMC,WAAW,GAAwDC,OAExE,IAAI;EACH,MAAMC,IAAI,GAAGH,OAAO,CAACI,OAAO,CAACF,OAAO,CAACG,GAAG,CAAC;EACzC,MAAMC,QAAQ,GAAGT,kBAAkB,CAACU,IAAI,CAAC;;;;;WAKhCT,IAAI,CAACU,MAAM,CAACL,IAAI,CAACM,IAAI,CAACC,KAAK,CAAC;WAC5BX,QAAQ,CAACY,GAAG;;;;;MAKjBb,IAAI,CAACc,UAAU,CAACT,IAAI,CAAC;;;MAGrBJ,QAAQ,CAACc,UAAU;;;;;;;;;QASjB,CAAC;EACP,OAAOlB,MAAM,CAACmB,OAAO,CAACR,QAAQ,CAAC;AACjC,CAAC;AAED;;;;;;;;;AASA,OAAO,MAAMS,KAAK,GAAGA,CACnBV,GAAgC,EAChCH,OAEC,KAEDN,UAAU,CAACoB,GAAG,CAACrB,MAAM,CAACsB,UAAU,CAAC,WAAUC,MAAM;EAC/C,MAAMC,OAAO,GAAGlB,WAAW,CAAC;IAAEI;EAAG,CAAE,CAAC;EACpC,OAAOa,MAAM,CAACE,GAAG,CAAC,KAAK,EAAElB,OAAO,EAAEmB,IAAI,IAAI,OAAO,EAAEF,OAAO,CAAC;AAC7D,CAAC,CAAC,CAAC","ignoreList":[]}

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

@@ -2,80 +2,365 @@
  * @since 4.0.0
  */
 /**
+ * The `HttpApi` module defines the top-level contract for an Effect HTTP API.
+ * An `HttpApi` names an API and collects one or more `HttpApiGroup`s, whose
+ * endpoints describe the request inputs, response schemas, middleware, and
+ * annotations that later drive server builders, clients, and OpenAPI
+ * generation.
+ *
+ * Use this module when you want to compose a domain API from endpoint groups,
+ * combine APIs from multiple modules, apply a shared path prefix or middleware,
+ * attach annotations, or reflect over the final route shape. Implementations are
+ * provided separately with `HttpApiBuilder.group`, and the completed API is
+ * registered with `HttpApiBuilder.layer`.
+ *
+ * A few composition details are worth keeping in mind: group identifiers are
+ * used as keys, so adding another group with the same identifier replaces the
+ * previous one; `prefix` and `middleware` are applied to the groups and
+ * endpoints already present when they are called; and `addHttpApi` merges the
+ * added API's annotations into its groups. During reflection, success and error
+ * schemas are grouped by the HTTP status recorded on their `HttpApiSchema`
+ * annotations, endpoints without an explicit success schema default to
+ * `NoContent`, and middleware error schemas are included with endpoint errors.
+ * Extra schemas supplied through `AdditionalSchemas` must have an `identifier`
+ * annotation so they can be emitted as OpenAPI components.
+ *
  * @since 4.0.0
  */
 export * as HttpApi from "./HttpApi.ts";
 /**
+ * The `HttpApiBuilder` module connects declarative `HttpApi` definitions to
+ * runnable HTTP server routes.
+ *
+ * Use this module when you have described an API with `HttpApi`,
+ * `HttpApiGroup`, and `HttpApiEndpoint` values and need to provide the
+ * server-side implementation. `group` creates a layer for implementing every
+ * endpoint in one API group, `layer` registers the implemented groups with an
+ * `HttpRouter` and can expose the generated OpenAPI specification, and
+ * `endpoint` builds the effect for a single endpoint when custom composition is
+ * needed.
+ *
+ * The builder performs the runtime work implied by endpoint metadata: it decodes
+ * path parameters, headers, query parameters, and request payloads with
+ * `Schema`, applies endpoint middleware and security middleware, invokes the
+ * registered handler, and encodes successful or declared error results into
+ * `HttpServerResponse` values. Handlers can return an `HttpServerResponse`
+ * directly to bypass success encoding, and `handleRaw` can be used when payload
+ * decoding should be handled manually.
+ *
+ * A few implementation details are worth keeping in mind. Every group in the
+ * API must be provided with `HttpApiBuilder.group` before `layer` is evaluated,
+ * otherwise registration fails with a defect that names the missing group and
+ * the available group services. Payload decoding is selected by request media type;
+ * unsupported content types produce a `415` response before the handler runs.
+ * Schema failures are wrapped as `HttpApiSchemaError`, while ordinary handler
+ * failures are encoded with the endpoint's declared error schemas.
+ *
  * @since 4.0.0
  */
 export * as HttpApiBuilder from "./HttpApiBuilder.ts";
 /**
+ * Builds type-safe clients and URL builders from `HttpApi` declarations.
+ *
+ * This module turns the groups and endpoints described by an `HttpApi` into
+ * callable client methods backed by an `HttpClient`. Applications commonly use
+ * `make` or `makeWith` to call a remote API with the same schema-driven contract
+ * as the server, while `group`, `endpoint`, and `urlBuilder` are useful when only
+ * part of an API or only the encoded URL is needed.
+ *
+ * Client calls encode path parameters, query values, headers, and payloads from
+ * endpoint schemas before executing the request, then decode successful responses
+ * according to the endpoint success schemas. The selected `responseMode` can
+ * return the decoded value, the raw `HttpClientResponse`, or both; the raw
+ * response mode skips success and error decoding for custom response handling.
+ *
+ * Pay attention to the endpoint schemas when shaping requests: payloads for HTTP
+ * methods without request bodies are encoded into URL parameters, multipart
+ * payloads must be supplied as `FormData`, and response decoding can fail with
+ * `SchemaError`. Declared error responses are decoded into the endpoint error
+ * type, unknown statuses fail as `HttpClientError.DecodeError`, and failures while
+ * decoding a declared error response include the original status-code failure.
+ *
  * @since 4.0.0
  */
 export * as HttpApiClient from "./HttpApiClient.ts";
 /**
+ * The `HttpApiEndpoint` module defines the per-route contracts used inside an
+ * `HttpApiGroup`.
+ *
+ * An endpoint couples a stable name with an HTTP method and `HttpRouter` path,
+ * plus schemas for path parameters, query parameters, headers, request payloads,
+ * success responses, and declared errors. Server builders, generated clients,
+ * and OpenAPI generation all read this metadata to decode requests, encode
+ * responses, type handler inputs, and derive client call signatures.
+ *
+ * Use this module to declare individual operations such as `get`, `post`, `put`,
+ * `patch`, `delete`, `head`, and `options`; attach endpoint-specific middleware
+ * or annotations; and model alternatives for payloads, successes, and errors
+ * with arrays of schemas.
+ *
+ * A few declaration details are worth keeping in mind. Paths use
+ * `HttpRouter.PathInput`, so route parameters come from the router and are
+ * decoded with the optional `params` schema. When codecs are enabled, params,
+ * query, and headers are transformed through string-tree codecs; body methods
+ * use JSON payload codecs by default, while no-body methods encode payloads as
+ * query-style values. `HttpApiSchema` annotations can change payload or response
+ * encodings and status codes, multipart payloads cannot be combined under the
+ * same content type, and endpoint errors are merged with middleware errors for
+ * server encoding and client decoding.
+ *
  * @since 4.0.0
  */
 export * as HttpApiEndpoint from "./HttpApiEndpoint.ts";
 /**
+ * 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
  */
 export * as HttpApiError from "./HttpApiError.ts";
 /**
+ * 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
  */
 export * as HttpApiGroup from "./HttpApiGroup.ts";
 /**
+ * The `HttpApiMiddleware` module defines middleware services that can wrap
+ * `HttpApi` endpoint execution on the server and request execution in generated
+ * clients.
+ *
+ * Use this module for cross-cutting HTTP API behavior such as authentication and
+ * authorization, request logging or tracing, rate limiting, adding request-scoped
+ * services to the endpoint context, normalizing schema errors, or installing
+ * client-side request middleware for APIs that require the same concern on both
+ * sides. Middleware services carry type-level metadata describing the services
+ * they require and provide, the error schemas they may fail with, whether they
+ * implement security schemes, and whether generated clients must provide a
+ * matching client middleware.
+ *
+ * Security middleware is declared with non-empty `security` schemes and receives
+ * decoded credentials from `HttpApiSecurity`; ordinary middleware receives only
+ * endpoint and group metadata. Error declarations must be `Schema` values (or an
+ * array of them) because middleware failures are added to the endpoint error
+ * surface and must be encodable by the HTTP API builder. If a middleware turns
+ * `HttpApiSchemaError` failures into API errors, use
+ * `layerSchemaErrorTransform` and make sure the transformed error is covered by
+ * the middleware's declared schema. Client middleware installed with
+ * `layerClient` is made available through the `ForClient` marker and captures
+ * its surrounding context, so client requirements should be declared explicitly
+ * when `requiredForClient` is enabled.
+ *
  * @since 4.0.0
  */
 export * as HttpApiMiddleware from "./HttpApiMiddleware.ts";
 /**
+ * The `HttpApiScalar` module mounts an interactive Scalar API reference for a
+ * declarative `HttpApi`.
+ *
+ * Use this module when you want a browser-friendly documentation page for an
+ * `HttpApi` without maintaining a separate OpenAPI document. The `layer`
+ * helper registers a `GET` route on an `HttpRouter`, generates the OpenAPI
+ * specification with `OpenApi.fromApi`, embeds it into the HTML page, and loads
+ * the bundled Scalar browser script. `layerCdn` provides the same UI while
+ * loading Scalar from jsDelivr, optionally pinned with `version`.
+ *
+ * The mounted path is a documentation UI route, defaulting to `/docs`, rather
+ * than a raw JSON specification endpoint. If clients, gateways, or external
+ * documentation pipelines need the OpenAPI document directly, expose it
+ * separately with `HttpApiBuilder.layer`'s `openapiPath` option. Scalar
+ * configuration is forwarded to the page through `ScalarConfig`; values such as
+ * `proxyUrl`, theme and layout settings, and `baseServerURL` matter when
+ * enabling "Test Request", styling the docs, or rendering relative server URLs
+ * outside the browser origin.
+ *
  * @since 4.0.0
  */
 export * as HttpApiScalar from "./HttpApiScalar.ts";
 /**
- * HttpApiSchema provides helpers to annotate Effect Schema values with HTTP API metadata
- * (status codes and payload/response encodings) used by the HttpApi builder, client,
- * and OpenAPI generation.
- *
- * Mental model:
- * - A "Schema" is the base validation/encoding description from `Schema`.
- * - An "Encoding" tells HttpApi how to serialize/parse a payload or response body.
- * - A "Status" is metadata that chooses the HTTP response status code.
- * - "Empty" schemas represent responses with no body (204/201/202 or custom).
- * - "NoContent" schemas can still decode into a value via {@link asNoContent}.
- * - Multipart is a payload-only encoding for file-like form data.
- *
- * Common tasks:
- * - Set a response status on a schema -> {@link status}
- * - Declare an empty response -> {@link Empty}, {@link NoContent}, {@link Created}, {@link Accepted}
- * - Decode an empty response into a value -> {@link asNoContent}
- * - Force a specific encoding -> {@link asJson}, {@link asFormUrlEncoded}, {@link asText}, {@link asUint8Array}
- * - Mark multipart payloads -> {@link asMultipart}, {@link asMultipartStream}
- *
- * Gotchas:
- * - If you don't set an encoding, HttpApi assumes JSON by default.
- * - {@link asFormUrlEncoded} expects the schema's encoded type to be a record of strings.
- * - {@link asText} expects the encoded type to be `string`, and {@link asUint8Array} expects `Uint8Array`.
- * - Multipart encodings are intended for request payloads; response multipart is not supported.
- * - These helpers annotate schemas; they don't perform validation or IO by themselves.
+ * Helpers for attaching HTTP API metadata to Effect Schema values.
+ *
+ * This module is the schema-side bridge used by the unstable HttpApi endpoint
+ * builder, generated clients, and OpenAPI support. It does not define routes or
+ * perform IO. Instead, helpers such as {@link status}, {@link asJson},
+ * {@link asMultipart}, and {@link asNoContent} annotate schemas so downstream
+ * HTTP tooling can choose response status codes, content types, body codecs, and
+ * no-body handling while the original schema remains usable for validation and
+ * transformation.
+ *
+ * Common use cases:
+ * - Mark success or error schemas with explicit HTTP statuses using
+ *   {@link status}, {@link NoContent}, {@link Created}, {@link Accepted}, or
+ *   {@link Empty}.
+ * - Override the default JSON encoding for request payloads or responses with
+ *   {@link asFormUrlEncoded}, {@link asText}, {@link asUint8Array}, or
+ *   {@link asJson}.
+ * - Describe buffered or streaming multipart request payloads with
+ *   {@link asMultipart} and {@link asMultipartStream}.
+ * - Represent an HTTP response with no body while still decoding a client-side
+ *   value through {@link asNoContent}.
+ *
+ * Status and encoding details:
+ * - {@link status} only stores an annotation. The same annotation is interpreted
+ *   by the surrounding HttpApi context; unannotated success responses default to
+ *   `200`, and unannotated error responses default to `500`.
+ * - Missing encodings default to JSON for bodies and responses. Payload schemas
+ *   used with methods that have no request body fall back to form-url-encoded
+ *   metadata for parameter encoding.
+ * - {@link asFormUrlEncoded} expects the schema's encoded side to be a record
+ *   of strings. {@link asText} expects `string`, and {@link asUint8Array}
+ *   expects `Uint8Array`.
+ * - Multipart encodings are payload-only; response multipart is rejected when
+ *   response encoding is resolved.
+ * - These helpers attach annotations consumed by HttpApi internals. They do not
+ *   validate, encode, decode, or send data by themselves.
  *
  * @since 4.0.0
  */
 export * as HttpApiSchema from "./HttpApiSchema.ts";
 /**
+ * The `HttpApiSecurity` module defines the security scheme values used by
+ * declarative HTTP APIs.
+ *
+ * Use these constructors when an API group or endpoint needs authentication
+ * middleware for bearer tokens, API keys, or HTTP Basic credentials. The values
+ * are intentionally small declarations: `HttpApiMiddleware.Service` attaches
+ * them to middleware, `HttpApiBuilder` decodes the matching credential shape from
+ * each request, and OpenAPI generation emits the corresponding
+ * `components.securitySchemes` and operation security requirements.
+ *
+ * Common uses include modeling `Authorization: Bearer ...` tokens, Basic
+ * username/password credentials, and API keys passed through headers, query
+ * parameters, or cookies. Bearer tokens and API-key values are exposed to
+ * middleware as `Redacted` values; Basic credentials expose the username with a
+ * redacted password. Cookie API keys can also be written to responses with
+ * `HttpApiBuilder.securitySetCookie`.
+ *
+ * A security scheme does not authenticate by itself: middleware must reject empty
+ * or invalid credentials. Bearer and Basic schemes read the `Authorization`
+ * header, while API-key headers use HTTP header name normalization and API-key
+ * query or cookie names are matched exactly. OpenAPI annotations such as
+ * descriptions and bearer formats affect generated documentation only; they do
+ * not change runtime decoding.
+ *
  * @since 4.0.0
  */
 export * as HttpApiSecurity from "./HttpApiSecurity.ts";
 /**
+ * Serves Swagger UI for an `HttpApi` by rendering the OpenAPI document generated
+ * from the API directly into an HTML page.
+ *
+ * Use this module when you want a lightweight documentation route for a running
+ * `HttpApi`, typically in development, staging, internal consoles, or public API
+ * reference pages where Swagger UI's exploration and request-building tools are
+ * preferred. The exported `layer` adds a `GET` route to an `HttpRouter`,
+ * defaults the mount path to `/docs`, and leaves API implementation and server
+ * wiring to `HttpApiBuilder` and the surrounding router layers.
+ *
+ * The page is self-contained: `OpenApi.fromApi` derives the specification from
+ * the API's groups, endpoints, schemas, and OpenAPI annotations, then the JSON
+ * is embedded into the HTML served to the browser. No separate `/openapi.json`
+ * endpoint is installed by this module, so clients or documentation pipelines
+ * that need the raw spec should use `OpenApi.fromApi` directly or expose a JSON
+ * route elsewhere. If the docs are public, mount the layer behind the same
+ * routing, security, or environment controls you want for the UI; generated
+ * server URLs and operation metadata come from the API's OpenAPI annotations.
+ *
  * @since 4.0.0
  */
 export * as HttpApiSwagger from "./HttpApiSwagger.ts";
 /**
+ * The `HttpApiTest` module provides helpers for testing `HttpApi`
+ * implementations through the generated client interface without starting an
+ * HTTP server.
+ *
+ * Use this module when a test should exercise one or more implemented API
+ * groups with the same request encoding, routing, response encoding, and client
+ * decoding used by the production `HttpApiBuilder` and `HttpApiClient`
+ * pipeline. This is useful for focused handler tests, schema round-trip checks,
+ * middleware behavior, and tests that want to call an API through its typed
+ * client while keeping all traffic in memory.
+ *
+ * The selected groups must be provided in the test environment, usually by
+ * supplying the corresponding `HttpApiBuilder.group` layers. Groups that are not
+ * selected are still present on the returned client shape, but their handlers
+ * are placeholders that die if called, which helps catch accidental calls outside
+ * the test scope. The generated client is still a real `HttpApiClient`, so
+ * endpoint middleware, client middleware, platform services, and the optional
+ * `baseUrl` used for URL construction follow the same rules as normal clients;
+ * only the HTTP transport is replaced with an in-memory router dispatch.
+ *
  * @since 4.0.0
  */
 export * as HttpApiTest from "./HttpApiTest.ts";
 /**
+ * The `OpenApi` module converts declarative `HttpApi` definitions into
+ * OpenAPI 3.1 specifications and provides annotations for shaping the
+ * generated document.
+ *
+ * Use this module when you need to publish an `HttpApi` contract to tooling
+ * such as Swagger UI, Scalar, client generators, API gateways, or documentation
+ * pipelines. `fromApi` reflects the API's groups and endpoints into tags,
+ * paths, operations, parameters, request bodies, responses, security schemes,
+ * and component schemas while preserving Effect Schema metadata where OpenAPI
+ * can represent it.
+ *
+ * The generated specification is driven by annotations on APIs, groups,
+ * endpoints, security definitions, and schemas. `Title`, `Description`,
+ * `Summary`, `Version`, `Servers`, `License`, `ExternalDocs`, `Identifier`,
+ * `Deprecated`, and `Format` feed the corresponding OpenAPI fields; `Exclude`
+ * omits a group or endpoint; `Override` shallowly merges custom fields; and
+ * `Transform` can rewrite the generated API, tag, or operation object. Schema
+ * identifiers are important for stable component names, additional schemas must
+ * have identifiers, and invalid OpenAPI component keys are rejected during
+ * generation.
+ *
+ * A few generation details are worth keeping in mind: `HttpApiSchema`
+ * encodings choose media types and special representations for JSON,
+ * form-url-encoded, text, binary, and multipart payloads; no-content schemas
+ * emit responses without bodies; request and response unions are grouped by
+ * status code and content type; path parameters are rendered from `:id` route
+ * segments as `{id}`; and schemas are converted through the OpenAPI 3.1 JSON
+ * Schema representation before being patched into the final document.
+ *
  * @since 4.0.0
  */
 export * as OpenApi from "./OpenApi.ts";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA"}