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

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

@@ -1,4 +1,29 @@
 /**
+ * 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
  */
 /** @effect-diagnostics floatingEffect:skip-file */
@@ -21,23 +46,36 @@ import type * as HttpApiSecurity from "./HttpApiSecurity.ts";
 declare const TypeId = "~effect/httpapi/HttpApiMiddleware";
 declare const SecurityTypeId = "~effect/httpapi/HttpApiMiddleware/Security";
 /**
- * @since 4.0.0
+ * Returns `true` when an HTTP API middleware service is security middleware.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export declare const isSecurity: (u: AnyService) => u is AnyServiceSecurity;
 type ErrorConstraint = Schema.Top | ReadonlyArray<Schema.Top>;
 type ErrorSchemaFromConstraint<E> = E extends ReadonlyArray<Schema.Top> ? E[number] : E extends Schema.Top ? E : never;
 /**
- * @since 4.0.0
+ * Server-side middleware function for an HTTP API endpoint.
+ *
+ * It receives the endpoint response effect and endpoint/group metadata, and returns
+ * a new response effect that may require additional services and fail with the
+ * middleware's declared error schema.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type HttpApiMiddleware<Provides, E extends ErrorConstraint, Requires> = (httpEffect: Effect.Effect<HttpServerResponse, unhandled, Provides>, options: {
     readonly endpoint: HttpApiEndpoint.AnyWithProps;
     readonly group: HttpApiGroup.AnyWithProps;
 }) => Effect.Effect<HttpServerResponse, unhandled | ErrorSchemaFromConstraint<E>["Type"], Requires | HttpRouter.Provided>;
 /**
- * @since 4.0.0
+ * Server-side middleware implementations for one or more security schemes.
+ *
+ * Each property handles the credential decoded for that scheme and wraps the
+ * endpoint response effect with the middleware's declared requirements and errors.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type HttpApiMiddlewareSecurity<Security extends Record<string, HttpApiSecurity.HttpApiSecurity>, Provides, E extends ErrorConstraint, Requires> = {
     readonly [K in keyof Security]: (httpEffect: Effect.Effect<HttpServerResponse, unhandled, Provides>, options: {
@@ -47,8 +85,13 @@ export type HttpApiMiddlewareSecurity<Security extends Record<string, HttpApiSec
     }) => Effect.Effect<HttpServerResponse, unhandled | ErrorSchemaFromConstraint<E>["Type"], Requires | HttpRouter.Provided>;
 };
 /**
- * @since 4.0.0
+ * Client-side middleware function for generated HTTP API clients.
+ *
+ * It receives endpoint/group metadata, the outgoing request, and a `next` function
+ * for continuing the request pipeline.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface HttpApiMiddlewareClient<_E, CE, R> {
     (options: {
@@ -59,16 +102,20 @@ export interface HttpApiMiddlewareClient<_E, CE, R> {
     }): Effect.Effect<HttpClientResponse.HttpClientResponse, CE | HttpClientError.HttpClientError, R>;
 }
 /**
- * @since 4.0.0
+ * Client-side service marker required when a middleware declares `requiredForClient`.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface ForClient<Id> {
     readonly _: unique symbol;
     readonly id: Id;
 }
 /**
- * @since 4.0.0
+ * Base service key shape for HTTP API middleware services, including provided services, declared error schemas, and client requirements.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface AnyService extends Context.Key<any, any> {
     readonly [TypeId]: typeof TypeId;
@@ -78,16 +125,20 @@ export interface AnyService extends Context.Key<any, any> {
     readonly "~ClientError": any;
 }
 /**
- * @since 4.0.0
+ * Middleware service key shape for security middleware, including the security schemes handled by the service.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface AnyServiceSecurity extends AnyService {
     readonly [SecurityTypeId]: typeof SecurityTypeId;
     readonly security: Record<string, HttpApiSecurity.HttpApiSecurity>;
 }
 /**
- * @since 4.0.0
+ * Type-level identifier carried by middleware services to track provided services, required services, errors, client errors, and client requirements.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface AnyId {
     readonly [TypeId]: {
@@ -99,8 +150,10 @@ export interface AnyId {
     };
 }
 /**
- * @since 4.0.0
+ * Extracts the services provided by a middleware identifier.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Provides<A> = A extends {
     readonly [TypeId]: {
@@ -108,8 +161,10 @@ export type Provides<A> = A extends {
     };
 } ? P : never;
 /**
- * @since 4.0.0
+ * Extracts the services required to run a middleware implementation.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Requires<A> = A extends {
     readonly [TypeId]: {
@@ -117,13 +172,17 @@ export type Requires<A> = A extends {
     };
 } ? R : never;
 /**
- * @since 4.0.0
+ * Applies a middleware's service changes to an existing requirement type by removing services it provides and adding services it requires.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ApplyServices<A extends AnyId, R> = Exclude<R, Provides<A>> | Requires<A>;
 /**
- * @since 4.0.0
+ * Extracts the schema or schema union used for errors declared by a middleware identifier.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorSchema<A> = A extends {
     readonly [TypeId]: {
@@ -131,13 +190,17 @@ export type ErrorSchema<A> = A extends {
     };
 } ? ErrorSchemaFromConstraint<E> : never;
 /**
- * @since 4.0.0
+ * Extracts the decoded error type declared by a middleware identifier.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Error<A> = ErrorSchema<A>["Type"];
 /**
- * @since 4.0.0
+ * Extracts the client-side error type for middleware that is required on generated clients.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ClientError<A> = A extends {
     readonly [TypeId]: {
@@ -146,8 +209,10 @@ export type ClientError<A> = A extends {
     };
 } ? CE : never;
 /**
- * @since 4.0.0
+ * Computes the client-side service marker required for middleware that must also run in generated clients.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type MiddlewareClient<A> = A extends {
     readonly [TypeId]: {
@@ -155,18 +220,27 @@ export type MiddlewareClient<A> = A extends {
     };
 } ? ForClient<A> : never;
 /**
- * @since 4.0.0
+ * Extracts the schema services required to encode errors declared by a middleware identifier.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorServicesEncode<A> = ErrorSchema<A>["EncodingServices"];
 /**
- * @since 4.0.0
+ * Extracts the schema services required to decode errors declared by a middleware identifier.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ErrorServicesDecode<A> = ErrorSchema<A>["DecodingServices"];
 /**
- * @since 4.0.0
+ * Class type produced by `Service` for an HTTP API middleware service.
+ *
+ * It combines a `Context.Service` class with the middleware metadata used by
+ * endpoints, builders, and generated clients.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export type ServiceClass<Self, Id extends string, Config extends {
     requires: any;
@@ -194,8 +268,14 @@ export type ServiceClass<Self, Id extends string, Config extends {
     readonly security: Config["security"];
 });
 /**
- * @since 4.0.0
+ * Creates a `Context.Service` class for an HTTP API middleware implementation.
+ *
+ * Use the optional configuration to declare required services, provided services,
+ * typed error schemas, security schemes, client errors, and whether generated
+ * clients must provide a matching client middleware.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export declare const Service: <Self, Config extends {
     requires?: any;
@@ -218,7 +298,11 @@ export declare const Service: <Self, Config extends {
     security: Security;
 }>;
 /**
- * Implement a middleware Layer that transforms `SchemaError`'s.
+ * Creates a middleware layer that transforms `HttpApiSchemaError` failures.
+ *
+ * The middleware catches schema errors produced while running an endpoint and uses
+ * the supplied `transform` function to convert them into the middleware's declared
+ * error schema.
  *
  * ```ts
  * import { Effect, Schema } from "effect"
@@ -239,16 +323,21 @@ export declare const Service: <Self, Config extends {
  * )
  * ```
  *
- * @since 4.0.0
  * @category SchemaError transform
+ * @since 4.0.0
  */
 export declare const layerSchemaErrorTransform: <Id, E extends ErrorConstraint, Requires>(service: Context.Service<Id, HttpApiMiddleware<never, E, Requires>>, transform: (error: HttpApiSchemaError, context: {
     readonly endpoint: HttpApiEndpoint.AnyWithProps;
     readonly group: HttpApiGroup.AnyWithProps;
 }) => Effect.Effect<HttpServerResponse, ErrorSchemaFromConstraint<E>["Type"] | HttpApiSchemaError, Requires | HttpRouter.Provided>) => Layer.Layer<Id>;
 /**
- * @since 4.0.0
+ * Provides a client-side middleware implementation for a middleware that is required by generated clients.
+ *
+ * The layer captures the surrounding services and makes the middleware available
+ * through the `ForClient` service marker used by HTTP API clients.
+ *
  * @category client
+ * @since 4.0.0
  */
 export declare const layerClient: <Id extends AnyId, S, R, EX = never, RX = never>(tag: Context.Key<Id, S>, service: HttpApiMiddlewareClient<Error<Id>, Id[typeof TypeId]["clientError"], R> | Effect.Effect<HttpApiMiddlewareClient<Error<Id>, Id[typeof TypeId]["clientError"], R>, EX, RX>) => Layer.Layer<ForClient<Id>, EX, R | Exclude<RX, Scope>>;
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiMiddleware.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiMiddleware.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,mDAAmD;AACnD,gDAAgD;AAChD,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAEvC,OAAO,KAAK,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,KAAK,eAAe,MAAM,4BAA4B,CAAA;AAClE,OAAO,KAAK,KAAK,iBAAiB,MAAM,8BAA8B,CAAA;AACtE,OAAO,KAAK,KAAK,kBAAkB,MAAM,+BAA+B,CAAA;AACxE,OAAO,KAAK,KAAK,UAAU,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,KAAK,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAE5D,QAAA,MAAM,MAAM,sCAAsC,CAAA;AAElD,QAAA,MAAM,cAAc,+CAA+C,CAAA;AAEnE;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,kBAAoD,CAAA;AAEpG,KAAK,eAAe,GAAG,MAAM,CAAC,GAAG,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;AAE7D,KAAK,yBAAyB,CAAC,CAAC,IAAI,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAC/E,CAAC,SAAS,MAAM,CAAC,GAAG,GAAG,CAAC,GACxB,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,QAAQ,EAAE,CAAC,SAAS,eAAe,EAAE,QAAQ,IAAI,CAC7E,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,SAAS,EAAE,QAAQ,CAAC,EAClE,OAAO,EAAE;IACP,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAA;IAC/C,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAA;CAC1C,KACE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,SAAS,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;AAExH;;;GAGG;AACH,MAAM,MAAM,yBAAyB,CACnC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,eAAe,CAAC,EAChE,QAAQ,EACR,CAAC,SAAS,eAAe,EACzB,QAAQ,IACN;IACF,QAAQ,EAAE,CAAC,IAAI,MAAM,QAAQ,GAAG,CAC9B,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,SAAS,EAAE,QAAQ,CAAC,EAClE,OAAO,EAAE;QACP,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QACtE,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAA;QAC/C,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAA;KAC1C,KACE,MAAM,CAAC,MAAM,CAChB,kBAAkB,EAClB,SAAS,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAChD,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAC/B;CACF,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAChD,CAAC,OAAO,EAAE;QACR,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAA;QAC/C,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAA;QACzC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;QACrD,QAAQ,CAAC,IAAI,EAAE,CACb,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,KACzC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,eAAe,CAAC,eAAe,CAAC,CAAA;KAC3F,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,EAAE,GAAG,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC,CAAA;CAClG;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,EAAE;IAC3B,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAA;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC;IACvD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;IACtB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACvC,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;IACnC,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,OAAO,cAAc,CAAA;IAChD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,eAAe,CAAC,CAAA;CACnE;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;QACtB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;QACtB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAA;QAC/B,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAA;QACzB,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;KACpC,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,KAAK,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAErF;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,yBAAyB,CAAC,CAAC,CAAC,GACpH,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAE7C;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IACrC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,CAAA;QAC9B,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAA;KACjC,CAAA;CACF,GAAG,EAAE,GACF,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS;IAC1C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAA;KACjC,CAAA;CACF,GAAG,SAAS,CAAC,CAAC,CAAC,GACZ,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,YAAY,CACtB,IAAI,EACJ,EAAE,SAAS,MAAM,EACjB,MAAM,SAAS;IACb,QAAQ,EAAE,GAAG,CAAA;IACb,QAAQ,EAAE,GAAG,CAAA;IACb,KAAK,EAAE,eAAe,CAAA;IACtB,WAAW,EAAE,GAAG,CAAA;IAChB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,eAAe,CAAC,CAAA;CAC1D,EACD,OAAO,GACL,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,GAC9G,yBAAyB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAE3G,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAC9B;IACA,KAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG;QACvD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;YAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YACrC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YACrC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,CAAA;YAC3C,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAA;SACxD,CAAA;KACF,CAAA;IACD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACvC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAA;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC,CAAA;CAC/C,GACC,CAAC,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG;IACnD,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,OAAO,cAAc,CAAA;IAChD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;CACtC,CAAC,CAAA;AAEJ;;;GAGG;AACH,eAAO,MAAM,OAAO,GAClB,IAAI,EACJ,MAAM,SAAS;IACb,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,WAAW,CAAC,EAAE,GAAG,CAAA;CAClB,GAAG;IAAE,QAAQ,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC;IAAC,WAAW,EAAE,KAAK,CAAA;CAAE,OACzD,CACH,KAAK,CAAC,EAAE,SAAS,MAAM,EACvB,KAAK,CAAC,KAAK,SAAS,eAAe,GAAG,KAAK,EAC3C,KAAK,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,eAAe,CAAC,GAAG,KAAK,EAC9E,iBAAiB,SAAS,OAAO,GAAG,KAAK,EAEzC,EAAE,EAAE,EAAE,EACN,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;CAC3D,GAAG,SAAS,KACV,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE;IAC1B,QAAQ,EAAE,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAA;IACtE,QAAQ,EAAE,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAA;IACtE,KAAK,EAAE,KAAK,CAAA;IACZ,WAAW,EAAE,aAAa,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,KAAK,CAAA;IAC/E,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,QAAQ,EAAE,QAAQ,CAAA;CACnB,CAiCA,CAAA;AAOD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,yBAAyB,GAAI,EAAE,EAAE,CAAC,SAAS,eAAe,EAAE,QAAQ,EAC/E,SAAS,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,iBAAiB,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,EACnE,WAAW,CACT,KAAK,EAAE,kBAAkB,EACzB,OAAO,EAAE;IAAE,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAA;CAAE,KACpG,MAAM,CAAC,MAAM,CAChB,kBAAkB,EAClB,yBAAyB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,kBAAkB,EACzD,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAC/B,KACA,KAAK,CAAC,KAAK,CAAC,EAAE,CAYd,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,EAAE,SAAS,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,KAAK,EACxE,KAAK,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EACvB,SACI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,GACvE,MAAM,CAAC,MAAM,CACb,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,EACvE,EAAE,EACF,EAAE,CACH,KACF,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAgBnD,CAAA"}
+{"version":3,"file":"HttpApiMiddleware.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiMiddleware.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,mDAAmD;AACnD,gDAAgD;AAChD,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAEvC,OAAO,KAAK,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,KAAK,eAAe,MAAM,4BAA4B,CAAA;AAClE,OAAO,KAAK,KAAK,iBAAiB,MAAM,8BAA8B,CAAA;AACtE,OAAO,KAAK,KAAK,kBAAkB,MAAM,+BAA+B,CAAA;AACxE,OAAO,KAAK,KAAK,UAAU,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,KAAK,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAE5D,QAAA,MAAM,MAAM,sCAAsC,CAAA;AAElD,QAAA,MAAM,cAAc,+CAA+C,CAAA;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,kBAAoD,CAAA;AAEpG,KAAK,eAAe,GAAG,MAAM,CAAC,GAAG,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;AAE7D,KAAK,yBAAyB,CAAC,CAAC,IAAI,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAC/E,CAAC,SAAS,MAAM,CAAC,GAAG,GAAG,CAAC,GACxB,KAAK,CAAA;AAET;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,CAAC,QAAQ,EAAE,CAAC,SAAS,eAAe,EAAE,QAAQ,IAAI,CAC7E,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,SAAS,EAAE,QAAQ,CAAC,EAClE,OAAO,EAAE;IACP,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAA;IAC/C,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAA;CAC1C,KACE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,SAAS,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;AAExH;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,CACnC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,eAAe,CAAC,EAChE,QAAQ,EACR,CAAC,SAAS,eAAe,EACzB,QAAQ,IACN;IACF,QAAQ,EAAE,CAAC,IAAI,MAAM,QAAQ,GAAG,CAC9B,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,SAAS,EAAE,QAAQ,CAAC,EAClE,OAAO,EAAE;QACP,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QACtE,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAA;QAC/C,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAA;KAC1C,KACE,MAAM,CAAC,MAAM,CAChB,kBAAkB,EAClB,SAAS,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAChD,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAC/B;CACF,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAChD,CAAC,OAAO,EAAE;QACR,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAA;QAC/C,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAA;QACzC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;QACrD,QAAQ,CAAC,IAAI,EAAE,CACb,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,KACzC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,eAAe,CAAC,eAAe,CAAC,CAAA;KAC3F,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,EAAE,GAAG,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC,CAAA;CAClG;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS,CAAC,EAAE;IAC3B,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAA;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC;IACvD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;IACtB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACvC,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;IACnC,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,OAAO,cAAc,CAAA;IAChD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,eAAe,CAAC,CAAA;CACnE;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;QACtB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;QACtB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAA;QAC/B,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAA;QACzB,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;KACpC,CAAA;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAErG;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,KAAK,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAErF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,yBAAyB,CAAC,CAAC,CAAC,GACpH,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IACrC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,CAAA;QAC9B,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAA;KACjC,CAAA;CACF,GAAG,EAAE,GACF,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS;IAC1C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAA;KACjC,CAAA;CACF,GAAG,SAAS,CAAC,CAAC,CAAC,GACZ,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAEvE;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,CACtB,IAAI,EACJ,EAAE,SAAS,MAAM,EACjB,MAAM,SAAS;IACb,QAAQ,EAAE,GAAG,CAAA;IACb,QAAQ,EAAE,GAAG,CAAA;IACb,KAAK,EAAE,eAAe,CAAA;IACtB,WAAW,EAAE,GAAG,CAAA;IAChB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,eAAe,CAAC,CAAA;CAC1D,EACD,OAAO,GACL,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,GAC9G,yBAAyB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAE3G,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAC9B;IACA,KAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG;QACvD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;YAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YACrC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YACrC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,CAAA;YAC3C,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAA;SACxD,CAAA;KACF,CAAA;IACD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACvC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAA;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC,CAAA;CAC/C,GACC,CAAC,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG;IACnD,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,OAAO,cAAc,CAAA;IAChD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;CACtC,CAAC,CAAA;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,GAClB,IAAI,EACJ,MAAM,SAAS;IACb,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,WAAW,CAAC,EAAE,GAAG,CAAA;CAClB,GAAG;IAAE,QAAQ,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC;IAAC,WAAW,EAAE,KAAK,CAAA;CAAE,OACzD,CACH,KAAK,CAAC,EAAE,SAAS,MAAM,EACvB,KAAK,CAAC,KAAK,SAAS,eAAe,GAAG,KAAK,EAC3C,KAAK,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,eAAe,CAAC,GAAG,KAAK,EAC9E,iBAAiB,SAAS,OAAO,GAAG,KAAK,EAEzC,EAAE,EAAE,EAAE,EACN,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;CAC3D,GAAG,SAAS,KACV,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE;IAC1B,QAAQ,EAAE,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAA;IACtE,QAAQ,EAAE,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAA;IACtE,KAAK,EAAE,KAAK,CAAA;IACZ,WAAW,EAAE,aAAa,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,KAAK,CAAA;IAC/E,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,QAAQ,EAAE,QAAQ,CAAA;CACnB,CAiCA,CAAA;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,yBAAyB,GAAI,EAAE,EAAE,CAAC,SAAS,eAAe,EAAE,QAAQ,EAC/E,SAAS,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,iBAAiB,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,EACnE,WAAW,CACT,KAAK,EAAE,kBAAkB,EACzB,OAAO,EAAE;IAAE,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAA;CAAE,KACpG,MAAM,CAAC,MAAM,CAChB,kBAAkB,EAClB,yBAAyB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,kBAAkB,EACzD,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAC/B,KACA,KAAK,CAAC,KAAK,CAAC,EAAE,CAYd,CAAA;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,GAAI,EAAE,SAAS,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,KAAK,EACxE,KAAK,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EACvB,SACI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,GACvE,MAAM,CAAC,MAAM,CACb,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,EACvE,EAAE,EACF,EAAE,CACH,KACF,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAgBnD,CAAA"}

package/dist/unstable/httpapi/HttpApiMiddleware.js

@@ -1,4 +1,29 @@
 /**
+ * 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
  */
 /** @effect-diagnostics floatingEffect:skip-file */
@@ -12,13 +37,21 @@ import { HttpApiSchemaError } from "./HttpApiError.js";
 const TypeId = "~effect/httpapi/HttpApiMiddleware";
 const SecurityTypeId = "~effect/httpapi/HttpApiMiddleware/Security";
 /**
- * @since 4.0.0
+ * Returns `true` when an HTTP API middleware service is security middleware.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export const isSecurity = u => hasProperty(u, SecurityTypeId);
 /**
- * @since 4.0.0
+ * Creates a `Context.Service` class for an HTTP API middleware implementation.
+ *
+ * Use the optional configuration to declare required services, provided services,
+ * typed error schemas, security schemes, client errors, and whether generated
+ * clients must provide a matching client middleware.
+ *
  * @category Schemas
+ * @since 4.0.0
  */
 export const Service = () => (id, options) => {
   const Err = globalThis.Error;
@@ -50,7 +83,11 @@ function getError(error) {
   return new Set(Array.isArray(error) ? error : [error]);
 }
 /**
- * Implement a middleware Layer that transforms `SchemaError`'s.
+ * Creates a middleware layer that transforms `HttpApiSchemaError` failures.
+ *
+ * The middleware catches schema errors produced while running an endpoint and uses
+ * the supplied `transform` function to convert them into the middleware's declared
+ * error schema.
  *
  * ```ts
  * import { Effect, Schema } from "effect"
@@ -71,13 +108,18 @@ function getError(error) {
  * )
  * ```
  *
- * @since 4.0.0
  * @category SchemaError transform
+ * @since 4.0.0
  */
 export const layerSchemaErrorTransform = (service, transform) => Layer.succeed(service, (httpEffect, options) => Effect.catch(httpEffect, e => HttpApiSchemaError.is(e) ? transform(e, options) : Effect.fail(e)));
 /**
- * @since 4.0.0
+ * Provides a client-side middleware implementation for a middleware that is required by generated clients.
+ *
+ * The layer captures the surrounding services and makes the middleware available
+ * through the `ForClient` service marker used by HTTP API clients.
+ *
  * @category client
+ * @since 4.0.0
  */
 export const layerClient = (tag, service) => Layer.effectContext(Effect.gen(function* () {
   const services = (yield* Effect.context()).pipe(Context.omit(Scope));

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiMiddleware.js","names":["Context","Effect","Layer","hasProperty","Scope","HttpApiSchemaError","TypeId","SecurityTypeId","isSecurity","u","Service","id","options","Err","globalThis","Error","limit","stackTraceLimit","creationError","self","Object","defineProperty","get","stack","error","getError","requiredForClient","security","undefined","keys","length","Set","Array","isArray","layerSchemaErrorTransform","service","transform","succeed","httpEffect","catch","e","is","fail","layerClient","tag","effectContext","gen","services","context","pipe","omit","middleware","isEffect","makeUnsafe","Map","key","updateContext","requestContext","merge"],"sources":["../../../src/unstable/httpapi/HttpApiMiddleware.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA;AACA;AACA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,SAASC,WAAW,QAAQ,oBAAoB;AAEhD,SAASC,KAAK,QAAQ,gBAAgB;AAQtC,SAASC,kBAAkB,QAAQ,mBAAmB;AAItD,MAAMC,MAAM,GAAG,mCAAmC;AAElD,MAAMC,cAAc,GAAG,4CAA4C;AAEnE;;;;AAIA,OAAO,MAAMC,UAAU,GAAIC,CAAa,IAA8BN,WAAW,CAACM,CAAC,EAAEF,cAAc,CAAC;AAiNpG;;;;AAIA,OAAO,MAAMG,OAAO,GAAGA,CAAA,KA2BvB,CACEC,EAAU,EACVC,OAIa,KACX;EACF,MAAMC,GAAG,GAAGC,UAAU,CAACC,KAAY;EACnC,MAAMC,KAAK,GAAGH,GAAG,CAACI,eAAe;EACjCJ,GAAG,CAACI,eAAe,GAAG,CAAC;EACvB,MAAMC,aAAa,GAAG,IAAIL,GAAG,EAAE;EAC/BA,GAAG,CAACI,eAAe,GAAGD,KAAK;EAE3B,MAAMN,OAAQ,SAAQV,OAAO,CAACU,OAAO,EAAa,CAACC,EAAE,CAAC;EACtD,MAAMQ,IAAI,GAAGT,OAAc;EAC3BU,MAAM,CAACC,cAAc,CAACX,OAAO,EAAE,OAAO,EAAE;IACtCY,GAAGA,CAAA;MACD,OAAOJ,aAAa,CAACK,KAAK;IAC5B;GACD,CAAC;EACFJ,IAAI,CAACb,MAAM,CAAC,GAAGA,MAAM;EACrBa,IAAI,CAACK,KAAK,GAAGC,QAAQ,CAACb,OAAO,EAAEY,KAAK,CAAC;EACrCL,IAAI,CAACO,iBAAiB,GAAGd,OAAO,EAAEc,iBAAiB,IAAI,KAAK;EAC5D,IAAId,OAAO,EAAEe,QAAQ,KAAKC,SAAS,EAAE;IACnC,IAAIR,MAAM,CAACS,IAAI,CAACjB,OAAO,CAACe,QAAQ,CAAC,CAACG,MAAM,KAAK,CAAC,EAAE;MAC9C,MAAM,IAAIf,KAAK,CAAC,8DAA8D,CAAC;IACjF;IACAI,IAAI,CAACZ,cAAc,CAAC,GAAGA,cAAc;IACrCY,IAAI,CAACQ,QAAQ,GAAGf,OAAO,CAACe,QAAQ;EAClC;EACA,OAAOR,IAAI;AACb,CAAC;AAED,SAASM,QAAQA,CAACD,KAAkC;EAClD,IAAIA,KAAK,KAAKI,SAAS,EAAE,OAAO,IAAIG,GAAG,EAAE;EACzC,OAAO,IAAIA,GAAG,CAACC,KAAK,CAACC,OAAO,CAACT,KAAK,CAAC,GAAGA,KAAK,GAAG,CAACA,KAAK,CAAC,CAAC;AACxD;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMU,yBAAyB,GAAGA,CACvCC,OAAmE,EACnEC,SAOC,KAEDlC,KAAK,CAACmC,OAAO,CACXF,OAAO,EACP,CAACG,UAAU,EAAE1B,OAAO,KAClBX,MAAM,CAACsC,KAAK,CACVD,UAAU,EACTE,CAAC,IAIGnC,kBAAkB,CAACoC,EAAE,CAACD,CAAC,CAAC,GAAGJ,SAAS,CAACI,CAAC,EAAE5B,OAAO,CAAC,GAAGX,MAAM,CAACyC,IAAI,CAACF,CAAC,CAAC,CACvE,CACJ;AAEH;;;;AAIA,OAAO,MAAMG,WAAW,GAAGA,CACzBC,GAAuB,EACvBT,OAMG,KAEHjC,KAAK,CAAC2C,aAAa,CAAC5C,MAAM,CAAC6C,GAAG,CAAC,aAAS;EACtC,MAAMC,QAAQ,GAAG,CAAC,OAAO9C,MAAM,CAAC+C,OAAO,EAAa,EAAEC,IAAI,CACxDjD,OAAO,CAACkD,IAAI,CAAC9C,KAAK,CAAC,CACE;EACvB,MAAM+C,UAAU,GAAGlD,MAAM,CAACmD,QAAQ,CAACjB,OAAO,CAAC,GAAG,OAAOA,OAAO,GAAGA,OAAO;EACtE,OAAOnC,OAAO,CAACqD,UAAU,CACvB,IAAIC,GAAG,CAAC,CAAC,CACP,GAAGV,GAAG,CAACW,GAAG,SAAS,EAClB3C,OAAY,IACXX,MAAM,CAACuD,aAAa,CAClBL,UAAU,CAACvC,OAAO,CAAC,EAClB6C,cAAc,IAAKzD,OAAO,CAAC0D,KAAK,CAACX,QAAQ,EAAEU,cAAc,CAAC,CAC5D,CACJ,CAAC,CAAC,CACJ;AACH,CAAC,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"HttpApiMiddleware.js","names":["Context","Effect","Layer","hasProperty","Scope","HttpApiSchemaError","TypeId","SecurityTypeId","isSecurity","u","Service","id","options","Err","globalThis","Error","limit","stackTraceLimit","creationError","self","Object","defineProperty","get","stack","error","getError","requiredForClient","security","undefined","keys","length","Set","Array","isArray","layerSchemaErrorTransform","service","transform","succeed","httpEffect","catch","e","is","fail","layerClient","tag","effectContext","gen","services","context","pipe","omit","middleware","isEffect","makeUnsafe","Map","key","updateContext","requestContext","merge"],"sources":["../../../src/unstable/httpapi/HttpApiMiddleware.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA;AACA;AACA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,SAASC,WAAW,QAAQ,oBAAoB;AAEhD,SAASC,KAAK,QAAQ,gBAAgB;AAQtC,SAASC,kBAAkB,QAAQ,mBAAmB;AAItD,MAAMC,MAAM,GAAG,mCAAmC;AAElD,MAAMC,cAAc,GAAG,4CAA4C;AAEnE;;;;;;AAMA,OAAO,MAAMC,UAAU,GAAIC,CAAa,IAA8BN,WAAW,CAACM,CAAC,EAAEF,cAAc,CAAC;AAgQpG;;;;;;;;;;AAUA,OAAO,MAAMG,OAAO,GAAGA,CAAA,KA2BvB,CACEC,EAAU,EACVC,OAIa,KACX;EACF,MAAMC,GAAG,GAAGC,UAAU,CAACC,KAAY;EACnC,MAAMC,KAAK,GAAGH,GAAG,CAACI,eAAe;EACjCJ,GAAG,CAACI,eAAe,GAAG,CAAC;EACvB,MAAMC,aAAa,GAAG,IAAIL,GAAG,EAAE;EAC/BA,GAAG,CAACI,eAAe,GAAGD,KAAK;EAE3B,MAAMN,OAAQ,SAAQV,OAAO,CAACU,OAAO,EAAa,CAACC,EAAE,CAAC;EACtD,MAAMQ,IAAI,GAAGT,OAAc;EAC3BU,MAAM,CAACC,cAAc,CAACX,OAAO,EAAE,OAAO,EAAE;IACtCY,GAAGA,CAAA;MACD,OAAOJ,aAAa,CAACK,KAAK;IAC5B;GACD,CAAC;EACFJ,IAAI,CAACb,MAAM,CAAC,GAAGA,MAAM;EACrBa,IAAI,CAACK,KAAK,GAAGC,QAAQ,CAACb,OAAO,EAAEY,KAAK,CAAC;EACrCL,IAAI,CAACO,iBAAiB,GAAGd,OAAO,EAAEc,iBAAiB,IAAI,KAAK;EAC5D,IAAId,OAAO,EAAEe,QAAQ,KAAKC,SAAS,EAAE;IACnC,IAAIR,MAAM,CAACS,IAAI,CAACjB,OAAO,CAACe,QAAQ,CAAC,CAACG,MAAM,KAAK,CAAC,EAAE;MAC9C,MAAM,IAAIf,KAAK,CAAC,8DAA8D,CAAC;IACjF;IACAI,IAAI,CAACZ,cAAc,CAAC,GAAGA,cAAc;IACrCY,IAAI,CAACQ,QAAQ,GAAGf,OAAO,CAACe,QAAQ;EAClC;EACA,OAAOR,IAAI;AACb,CAAC;AAED,SAASM,QAAQA,CAACD,KAAkC;EAClD,IAAIA,KAAK,KAAKI,SAAS,EAAE,OAAO,IAAIG,GAAG,EAAE;EACzC,OAAO,IAAIA,GAAG,CAACC,KAAK,CAACC,OAAO,CAACT,KAAK,CAAC,GAAGA,KAAK,GAAG,CAACA,KAAK,CAAC,CAAC;AACxD;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,MAAMU,yBAAyB,GAAGA,CACvCC,OAAmE,EACnEC,SAOC,KAEDlC,KAAK,CAACmC,OAAO,CACXF,OAAO,EACP,CAACG,UAAU,EAAE1B,OAAO,KAClBX,MAAM,CAACsC,KAAK,CACVD,UAAU,EACTE,CAAC,IAIGnC,kBAAkB,CAACoC,EAAE,CAACD,CAAC,CAAC,GAAGJ,SAAS,CAACI,CAAC,EAAE5B,OAAO,CAAC,GAAGX,MAAM,CAACyC,IAAI,CAACF,CAAC,CAAC,CACvE,CACJ;AAEH;;;;;;;;;AASA,OAAO,MAAMG,WAAW,GAAGA,CACzBC,GAAuB,EACvBT,OAMG,KAEHjC,KAAK,CAAC2C,aAAa,CAAC5C,MAAM,CAAC6C,GAAG,CAAC,aAAS;EACtC,MAAMC,QAAQ,GAAG,CAAC,OAAO9C,MAAM,CAAC+C,OAAO,EAAa,EAAEC,IAAI,CACxDjD,OAAO,CAACkD,IAAI,CAAC9C,KAAK,CAAC,CACE;EACvB,MAAM+C,UAAU,GAAGlD,MAAM,CAACmD,QAAQ,CAACjB,OAAO,CAAC,GAAG,OAAOA,OAAO,GAAGA,OAAO;EACtE,OAAOnC,OAAO,CAACqD,UAAU,CACvB,IAAIC,GAAG,CAAC,CAAC,CACP,GAAGV,GAAG,CAACW,GAAG,SAAS,EAClB3C,OAAY,IACXX,MAAM,CAACuD,aAAa,CAClBL,UAAU,CAACvC,OAAO,CAAC,EAClB6C,cAAc,IAAKzD,OAAO,CAAC0D,KAAK,CAACX,QAAQ,EAAEU,cAAc,CAAC,CAC5D,CACJ,CAAC,CAAC,CACJ;AACH,CAAC,CAAC,CAAC","ignoreList":[]}

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

@@ -3,15 +3,19 @@ import * as HttpRouter from "../http/HttpRouter.ts";
 import type * as HttpApi from "./HttpApi.ts";
 import type * as HttpApiGroup from "./HttpApiGroup.ts";
 /**
- * @since 4.0.0
+ * Theme preset identifier accepted by the Scalar API reference UI.
+ *
  * @category model
+ * @since 4.0.0
  */
 export type ScalarThemeId = "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "saturn" | "kepler" | "mars" | "deepSpace" | "laserwave" | "none";
 /**
+ * Configuration passed to the embedded Scalar API reference UI.
+ *
  * @see https://github.com/scalar/scalar/blob/main/documentation/configuration.md
  *
- * @since 4.0.0
  * @category model
+ * @since 4.0.0
  */
 export type ScalarConfig = {
     /** A string to use one of the color presets */
@@ -84,16 +88,27 @@ export type ScalarConfig = {
     showOperationId?: boolean;
 };
 /**
- * @since 4.0.0
+ * Mounts a Scalar API reference page for an `HttpApi` using the bundled Scalar script.
+ *
+ * The route serves the OpenAPI specification generated from the API at the
+ * configured path, defaulting to `/docs`.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export declare const layer: <Id extends string, Groups extends HttpApiGroup.Any>(api: HttpApi.HttpApi<Id, Groups>, options?: {
     readonly path?: `/${string}` | undefined;
     readonly scalar?: ScalarConfig;
 } | undefined) => Layer.Layer<never, never, HttpRouter.HttpRouter>;
 /**
- * @since 4.0.0
+ * Mounts a Scalar API reference page for an `HttpApi` that loads Scalar from jsDelivr.
+ *
+ * The route serves the OpenAPI specification generated from the API at the
+ * configured path, defaulting to `/docs`; `version` selects the Scalar package
+ * version loaded from the CDN.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export declare const layerCdn: <Id extends string, Groups extends HttpApiGroup.Any>(api: HttpApi.HttpApi<Id, Groups>, options?: {
     readonly path?: `/${string}` | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiScalar.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiScalar.ts"],"names":[],"mappings":"AAIA,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;AAKtD;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,WAAW,GACX,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,WAAW,GACX,WAAW,GACX,MAAM,CAAA;AAEV;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC7B,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACrC,2CAA2C;IAC3C,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AA4DD;;;GAGG;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;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B,GAAG,SAAS,KACZ,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CAW7C,CAAA;AAEL;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EACzE,KAAK,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,EAChC,UAAU;IACR,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACtC,GAAG,SAAS,KACZ,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CAW7C,CAAA"}
+{"version":3,"file":"HttpApiScalar.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiScalar.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;AAKtD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,WAAW,GACX,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,WAAW,GACX,WAAW,GACX,MAAM,CAAA;AAEV;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC7B,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACrC,2CAA2C;IAC3C,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AA4DD;;;;;;;;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;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B,GAAG,SAAS,KACZ,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CAW7C,CAAA;AAEL;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EACzE,KAAK,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,EAChC,UAAU;IACR,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACtC,GAAG,SAAS,KACZ,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CAW7C,CAAA"}

package/dist/unstable/httpapi/HttpApiScalar.js

@@ -1,4 +1,23 @@
 /**
+ * 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
  */
 import * as Effect from "../../Effect.js";
@@ -37,8 +56,13 @@ const makeHandler = options => {
   return Effect.succeed(response);
 };
 /**
- * @since 4.0.0
+ * Mounts a Scalar API reference page for an `HttpApi` using the bundled Scalar script.
+ *
+ * The route serves the OpenAPI specification generated from the API at the
+ * configured path, defaulting to `/docs`.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export const layer = (api, options) => HttpRouter.use(Effect.fnUntraced(function* (router) {
   const handler = makeHandler({
@@ -52,8 +76,14 @@ export const layer = (api, options) => HttpRouter.use(Effect.fnUntraced(function
   yield* router.add("GET", options?.path ?? "/docs", handler);
 }));
 /**
- * @since 4.0.0
+ * Mounts a Scalar API reference page for an `HttpApi` that loads Scalar from jsDelivr.
+ *
+ * The route serves the OpenAPI specification generated from the API at the
+ * configured path, defaulting to `/docs`; `version` selects the Scalar package
+ * version loaded from the CDN.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export const layerCdn = (api, options) => HttpRouter.use(Effect.fnUntraced(function* (router) {
   const handler = makeHandler({

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

@@ -1 +1 @@
-{"version":3,"file":"HttpApiScalar.js","names":["Effect","HttpRouter","HttpServerResponse","Html","internal","OpenApi","makeHandler","options","spec","fromApi","api","scalarConfig","_integration","scalar","response","html","escape","info","title","description","escapeJson","source","_tag","version","succeed","layer","use","fnUntraced","router","handler","javascript","add","path","layerCdn"],"sources":["../../../src/unstable/httpapi/HttpApiScalar.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,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,6BAA6B;AACvD,OAAO,KAAKC,OAAO,MAAM,cAAc;AA2GvC,MAAMC,WAAW,GAAwDC,OAIxE,IAAI;EACH,MAAMC,IAAI,GAAGH,OAAO,CAACI,OAAO,CAACF,OAAO,CAACG,GAAG,CAAC;EACzC,MAAMC,YAAY,GAAG;IACnBC,YAAY,EAAE,MAAM;IACpB,GAAGL,OAAO,CAACM;GACZ;EACD,MAAMC,QAAQ,GAAGZ,kBAAkB,CAACa,IAAI,CAAC;;;;aAI9BZ,IAAI,CAACa,MAAM,CAACR,IAAI,CAACS,IAAI,CAACC,KAAK,CAAC;MAErC,CAACV,IAAI,CAACS,IAAI,CAACE,WAAW,GAClB,EAAE,GACF,qCAAqChB,IAAI,CAACa,MAAM,CAACR,IAAI,CAACS,IAAI,CAACE,WAAW,CAAC,KAC7E;MAEE,CAACX,IAAI,CAACS,IAAI,CAACE,WAAW,GAClB,EAAE,GACF,wCAAwChB,IAAI,CAACa,MAAM,CAACR,IAAI,CAACS,IAAI,CAACE,WAAW,CAAC,KAChF;;;;;;;QAOMhB,IAAI,CAACiB,UAAU,CAACZ,IAAI,CAAC;;;wFAG2DL,IAAI,CAACiB,UAAU,CAACT,YAAY,CAAC;;MAGjHJ,OAAO,CAACc,MAAM,CAACC,IAAI,KAAK,KAAK,GACzB,gBAAgB,sDAChBf,OAAO,CAACc,MAAM,CAACE,OAAO,IAAI,QAC5B,iCAAiC,yBAAyB,GACxD,WAAWhB,OAAO,CAACc,MAAM,CAACA,MAAM,WACtC;;QAEM,CAAC;EACP,OAAOrB,MAAM,CAACwB,OAAO,CAACV,QAAQ,CAAC;AACjC,CAAC;AAED;;;;AAIA,OAAO,MAAMW,KAAK,GAAGA,CACnBf,GAAgC,EAChCH,OAGa,KAEbN,UAAU,CAACyB,GAAG,CAAC1B,MAAM,CAAC2B,UAAU,CAAC,WAAUC,MAAM;EAC/C,MAAMC,OAAO,GAAGvB,WAAW,CAAC;IAC1BI,GAAG;IACHW,MAAM,EAAE;MACNC,IAAI,EAAE,QAAQ;MACdD,MAAM,EAAEjB,QAAQ,CAAC0B;KAClB;IACDjB,MAAM,EAAEN,OAAO,EAAEM;GAClB,CAAC;EACF,OAAOe,MAAM,CAACG,GAAG,CAAC,KAAK,EAAExB,OAAO,EAAEyB,IAAI,IAAI,OAAO,EAAEH,OAAO,CAAC;AAC7D,CAAC,CAAC,CAAC;AAEL;;;;AAIA,OAAO,MAAMI,QAAQ,GAAGA,CACtBvB,GAAgC,EAChCH,OAIa,KAEbN,UAAU,CAACyB,GAAG,CAAC1B,MAAM,CAAC2B,UAAU,CAAC,WAAUC,MAAM;EAC/C,MAAMC,OAAO,GAAGvB,WAAW,CAAC;IAC1BI,GAAG;IACHW,MAAM,EAAE;MACNC,IAAI,EAAE,KAAK;MACXC,OAAO,EAAEhB,OAAO,EAAEgB;KACnB;IACDV,MAAM,EAAEN,OAAO,EAAEM;GAClB,CAAC;EACF,OAAOe,MAAM,CAACG,GAAG,CAAC,KAAK,EAAExB,OAAO,EAAEyB,IAAI,IAAI,OAAO,EAAEH,OAAO,CAAC;AAC7D,CAAC,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"HttpApiScalar.js","names":["Effect","HttpRouter","HttpServerResponse","Html","internal","OpenApi","makeHandler","options","spec","fromApi","api","scalarConfig","_integration","scalar","response","html","escape","info","title","description","escapeJson","source","_tag","version","succeed","layer","use","fnUntraced","router","handler","javascript","add","path","layerCdn"],"sources":["../../../src/unstable/httpapi/HttpApiScalar.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,6BAA6B;AACvD,OAAO,KAAKC,OAAO,MAAM,cAAc;AA+GvC,MAAMC,WAAW,GAAwDC,OAIxE,IAAI;EACH,MAAMC,IAAI,GAAGH,OAAO,CAACI,OAAO,CAACF,OAAO,CAACG,GAAG,CAAC;EACzC,MAAMC,YAAY,GAAG;IACnBC,YAAY,EAAE,MAAM;IACpB,GAAGL,OAAO,CAACM;GACZ;EACD,MAAMC,QAAQ,GAAGZ,kBAAkB,CAACa,IAAI,CAAC;;;;aAI9BZ,IAAI,CAACa,MAAM,CAACR,IAAI,CAACS,IAAI,CAACC,KAAK,CAAC;MAErC,CAACV,IAAI,CAACS,IAAI,CAACE,WAAW,GAClB,EAAE,GACF,qCAAqChB,IAAI,CAACa,MAAM,CAACR,IAAI,CAACS,IAAI,CAACE,WAAW,CAAC,KAC7E;MAEE,CAACX,IAAI,CAACS,IAAI,CAACE,WAAW,GAClB,EAAE,GACF,wCAAwChB,IAAI,CAACa,MAAM,CAACR,IAAI,CAACS,IAAI,CAACE,WAAW,CAAC,KAChF;;;;;;;QAOMhB,IAAI,CAACiB,UAAU,CAACZ,IAAI,CAAC;;;wFAG2DL,IAAI,CAACiB,UAAU,CAACT,YAAY,CAAC;;MAGjHJ,OAAO,CAACc,MAAM,CAACC,IAAI,KAAK,KAAK,GACzB,gBAAgB,sDAChBf,OAAO,CAACc,MAAM,CAACE,OAAO,IAAI,QAC5B,iCAAiC,yBAAyB,GACxD,WAAWhB,OAAO,CAACc,MAAM,CAACA,MAAM,WACtC;;QAEM,CAAC;EACP,OAAOrB,MAAM,CAACwB,OAAO,CAACV,QAAQ,CAAC;AACjC,CAAC;AAED;;;;;;;;;AASA,OAAO,MAAMW,KAAK,GAAGA,CACnBf,GAAgC,EAChCH,OAGa,KAEbN,UAAU,CAACyB,GAAG,CAAC1B,MAAM,CAAC2B,UAAU,CAAC,WAAUC,MAAM;EAC/C,MAAMC,OAAO,GAAGvB,WAAW,CAAC;IAC1BI,GAAG;IACHW,MAAM,EAAE;MACNC,IAAI,EAAE,QAAQ;MACdD,MAAM,EAAEjB,QAAQ,CAAC0B;KAClB;IACDjB,MAAM,EAAEN,OAAO,EAAEM;GAClB,CAAC;EACF,OAAOe,MAAM,CAACG,GAAG,CAAC,KAAK,EAAExB,OAAO,EAAEyB,IAAI,IAAI,OAAO,EAAEH,OAAO,CAAC;AAC7D,CAAC,CAAC,CAAC;AAEL;;;;;;;;;;AAUA,OAAO,MAAMI,QAAQ,GAAGA,CACtBvB,GAAgC,EAChCH,OAIa,KAEbN,UAAU,CAACyB,GAAG,CAAC1B,MAAM,CAAC2B,UAAU,CAAC,WAAUC,MAAM;EAC/C,MAAMC,OAAO,GAAGvB,WAAW,CAAC;IAC1BI,GAAG;IACHW,MAAM,EAAE;MACNC,IAAI,EAAE,KAAK;MACXC,OAAO,EAAEhB,OAAO,EAAEgB;KACnB;IACDV,MAAM,EAAEN,OAAO,EAAEM;GAClB,CAAC;EACF,OAAOe,MAAM,CAACG,GAAG,CAAC,KAAK,EAAExB,OAAO,EAAEyB,IAAI,IAAI,OAAO,EAAEH,OAAO,CAAC;AAC7D,CAAC,CAAC,CAAC","ignoreList":[]}