effect 4.0.0-beta.4 → 4.0.0-beta.40

package/src/unstable/httpapi/HttpApiError.ts

@@ -1,27 +1,27 @@
 /**
  * @since 4.0.0
  */
+import * as Effect from "../../Effect.ts"
+import * as ErrorReporter from "../../ErrorReporter.ts"
+import { identity } from "../../Function.ts"
 import * as Schema from "../../Schema.ts"
+import * as Transformation from "../../SchemaTransformation.ts"
+import * as HttpServerRespondable from "../http/HttpServerRespondable.ts"
+import * as HttpServerResponse from "../http/HttpServerResponse.ts"
 import * as HttpApiSchema from "./HttpApiSchema.ts"
 
-/**
- * @category errors
- * @since 4.0.0
- */
-export class HttpApiSchemaError extends Schema.ErrorClass<HttpApiSchemaError>("effect/HttpApiSchemaError")({
-  _tag: Schema.tag("HttpApiSchemaError"),
-  message: Schema.String
-}, {
-  httpApiStatus: 400,
-  description: "The request or response did not match the expected schema"
-}) {
-  /**
-   * @since 4.0.0
-   */
-  static fromSchemaError(error: Schema.SchemaError): HttpApiSchemaError {
-    return new HttpApiSchemaError({ message: error.message })
-  }
-}
+const badRequestResponse = HttpServerResponse.empty({ status: 400 })
+const unauthorizedResponse = HttpServerResponse.empty({ status: 401 })
+const forbiddenResponse = HttpServerResponse.empty({ status: 403 })
+const notFoundResponse = HttpServerResponse.empty({ status: 404 })
+const methodNotAllowedResponse = HttpServerResponse.empty({ status: 405 })
+const notAcceptableResponse = HttpServerResponse.empty({ status: 406 })
+const requestTimeoutResponse = HttpServerResponse.empty({ status: 408 })
+const conflictResponse = HttpServerResponse.empty({ status: 409 })
+const goneResponse = HttpServerResponse.empty({ status: 410 })
+const internalServerErrorResponse = HttpServerResponse.empty({ status: 500 })
+const notImplementedResponse = HttpServerResponse.empty({ status: 501 })
+const serviceUnavailableResponse = HttpServerResponse.empty({ status: 503 })
 
 /**
  * @category Built-in errors
@@ -32,7 +32,13 @@ export class BadRequest extends Schema.ErrorClass<BadRequest>("effect/HttpApiErr
 }, {
   description: "BadRequest",
   httpApiStatus: 400
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(badRequestResponse)
+  }
+  static readonly singleton = new BadRequest()
+}
 
 /**
  * @category NoContent errors
@@ -42,6 +48,26 @@ export const BadRequestNoContent = BadRequest.pipe(HttpApiSchema.asNoContent({
   decode: () => new BadRequest({})
 }))
 
+/**
+ * @category Built-in errors
+ * @since 4.0.0
+ */
+export const BadRequestFromSchemaError = BadRequest.pipe(
+  Schema.decodeTo(
+    Schema.Union([Schema.declare(Schema.isSchemaError), BadRequest]),
+    Transformation.transform({
+      encode: (_) => BadRequest.singleton,
+      decode: identity
+    })
+  ),
+  HttpApiSchema.asNoContent({
+    decode: () => new BadRequest({})
+  })
+).annotate({
+  httpApiStatus: 400,
+  description: "BadRequest"
+})
+
 /**
  * @category Built-in errors
  * @since 4.0.0
@@ -51,7 +77,12 @@ export class Unauthorized extends Schema.ErrorClass<Unauthorized>("effect/HttpAp
 }, {
   description: "Unauthorized",
   httpApiStatus: 401
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(unauthorizedResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -70,7 +101,12 @@ export class Forbidden extends Schema.ErrorClass<Forbidden>("effect/HttpApiError
 }, {
   description: "Forbidden",
   httpApiStatus: 403
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(forbiddenResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -89,7 +125,12 @@ export class NotFound extends Schema.ErrorClass<NotFound>("effect/HttpApiError/N
 }, {
   description: "NotFound",
   httpApiStatus: 404
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(notFoundResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -108,7 +149,12 @@ export class MethodNotAllowed extends Schema.ErrorClass<MethodNotAllowed>("effec
 }, {
   description: "MethodNotAllowed",
   httpApiStatus: 405
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(methodNotAllowedResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -127,7 +173,12 @@ export class NotAcceptable extends Schema.ErrorClass<NotAcceptable>("effect/Http
 }, {
   description: "NotAcceptable",
   httpApiStatus: 406
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(notAcceptableResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -146,7 +197,12 @@ export class RequestTimeout extends Schema.ErrorClass<RequestTimeout>("effect/Ht
 }, {
   description: "RequestTimeout",
   httpApiStatus: 408
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(requestTimeoutResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -165,7 +221,12 @@ export class Conflict extends Schema.ErrorClass<Conflict>("effect/HttpApiError/C
 }, {
   description: "Conflict",
   httpApiStatus: 409
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(conflictResponse)
+  }
+}
 
 /**
  * @since 4.0.0
@@ -184,7 +245,12 @@ export class Gone extends Schema.ErrorClass<Gone>("effect/HttpApiError/Gone")({
 }, {
   description: "Gone",
   httpApiStatus: 410
-}) {}
+}) {
+  override readonly [ErrorReporter.ignore] = true;
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(goneResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -205,7 +271,11 @@ export class InternalServerError
     description: "InternalServerError",
     httpApiStatus: 500
   })
-{}
+{
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(internalServerErrorResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -224,7 +294,11 @@ export class NotImplemented extends Schema.ErrorClass<NotImplemented>("effect/Ht
 }, {
   description: "NotImplemented",
   httpApiStatus: 501
-}) {}
+}) {
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(notImplementedResponse)
+  }
+}
 
 /**
  * @category NoContent errors
@@ -245,7 +319,11 @@ export class ServiceUnavailable
     description: "ServiceUnavailable",
     httpApiStatus: 503
   })
-{}
+{
+  [HttpServerRespondable.symbol]() {
+    return Effect.succeed(serviceUnavailableResponse)
+  }
+}
 
 /**
  * @category NoContent errors

package/src/unstable/httpapi/HttpApiGroup.ts

@@ -61,7 +61,7 @@ export interface HttpApiGroup<
    * Endpoints added after this api is called **will not** have the middleware
    * applied.
    */
-  middleware<I extends HttpApiMiddleware.AnyId, S>(middleware: ServiceMap.Service<I, S>): HttpApiGroup<
+  middleware<I extends HttpApiMiddleware.AnyId, S>(middleware: ServiceMap.Key<I, S>): HttpApiGroup<
     Id,
     HttpApiEndpoint.AddMiddleware<Endpoints, I>,
     TopLevel
@@ -75,7 +75,7 @@ export interface HttpApiGroup<
   /**
    * Add an annotation to an `HttpApiGroup`.
    */
-  annotate<I, S>(key: ServiceMap.Service<I, S>, value: S): HttpApiGroup<Id, Endpoints, TopLevel>
+  annotate<I, S>(key: ServiceMap.Key<I, S>, value: S): HttpApiGroup<Id, Endpoints, TopLevel>
 
   /**
    * For each endpoint in an `HttpApiGroup`, update the annotations with a new
@@ -91,7 +91,7 @@ export interface HttpApiGroup<
    * Note that this will only add the annotation to the endpoints before this api
    * is called.
    */
-  annotateEndpoints<I, S>(key: ServiceMap.Service<I, S>, value: S): HttpApiGroup<Id, Endpoints, TopLevel>
+  annotateEndpoints<I, S>(key: ServiceMap.Key<I, S>, value: S): HttpApiGroup<Id, Endpoints, TopLevel>
 }
 
 /**
@@ -112,6 +112,7 @@ export interface Any {
   readonly [TypeId]: typeof TypeId
   readonly identifier: string
   readonly key: string
+  readonly endpoints: Record.ReadonlyRecord<string, HttpApiEndpoint.Any>
 }
 
 /**
@@ -238,7 +239,7 @@ const Proto = {
       annotations: this.annotations
     })
   },
-  middleware(this: AnyWithProps, middleware: HttpApiMiddleware.AnyKey) {
+  middleware(this: AnyWithProps, middleware: HttpApiMiddleware.AnyService) {
     return makeProto({
       identifier: this.identifier,
       topLevel: this.topLevel,
@@ -254,7 +255,7 @@ const Proto = {
       annotations: ServiceMap.merge(this.annotations, annotations)
     })
   },
-  annotate<I, S>(this: AnyWithProps, annotation: ServiceMap.Service<I, S>, value: S) {
+  annotate<I, S>(this: AnyWithProps, annotation: ServiceMap.Key<I, S>, value: S) {
     return makeProto({
       identifier: this.identifier,
       topLevel: this.topLevel,
@@ -270,7 +271,7 @@ const Proto = {
       annotations: this.annotations
     })
   },
-  annotateEndpoints<I, S>(this: AnyWithProps, annotation: ServiceMap.Service<I, S>, value: S) {
+  annotateEndpoints<I, S>(this: AnyWithProps, annotation: ServiceMap.Key<I, S>, value: S) {
     return makeProto({
       identifier: this.identifier,
       topLevel: this.topLevel,

package/src/unstable/httpapi/HttpApiMiddleware.ts

@@ -4,7 +4,7 @@
 import * as Effect from "../../Effect.ts"
 import * as Layer from "../../Layer.ts"
 import { hasProperty } from "../../Predicate.ts"
-import type * as Schema from "../../Schema.ts"
+import * as Schema from "../../Schema.ts"
 import { Scope } from "../../Scope.ts"
 import * as ServiceMap from "../../ServiceMap.ts"
 import type { unhandled } from "../../Types.ts"
@@ -25,19 +25,25 @@ const SecurityTypeId = "~effect/httpapi/HttpApiMiddleware/Security"
  * @since 4.0.0
  * @category guards
  */
-export const isSecurity = (u: AnyKey): u is AnyKeySecurity => hasProperty(u, SecurityTypeId)
+export const isSecurity = (u: AnyService): u is AnyServiceSecurity => hasProperty(u, SecurityTypeId)
+
+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
  * @category models
  */
-export type HttpApiMiddleware<Provides, E extends Schema.Top, Requires> = (
+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 | E["Type"], Requires | HttpRouter.Provided>
+) => Effect.Effect<HttpServerResponse, unhandled | ErrorSchemaFromConstraint<E>["Type"], Requires | HttpRouter.Provided>
 
 /**
  * @since 4.0.0
@@ -46,7 +52,7 @@ export type HttpApiMiddleware<Provides, E extends Schema.Top, Requires> = (
 export type HttpApiMiddlewareSecurity<
   Security extends Record<string, HttpApiSecurity.HttpApiSecurity>,
   Provides,
-  E extends Schema.Top,
+  E extends ErrorConstraint,
   Requires
 > = {
   readonly [K in keyof Security]: (
@@ -56,7 +62,11 @@ export type HttpApiMiddlewareSecurity<
       readonly endpoint: HttpApiEndpoint.AnyWithProps
       readonly group: HttpApiGroup.AnyWithProps
     }
-  ) => Effect.Effect<HttpServerResponse, unhandled | E["Type"], Requires | HttpRouter.Provided>
+  ) => Effect.Effect<
+    HttpServerResponse,
+    unhandled | ErrorSchemaFromConstraint<E>["Type"],
+    Requires | HttpRouter.Provided
+  >
 }
 
 /**
@@ -87,10 +97,10 @@ export interface ForClient<Id> {
  * @since 4.0.0
  * @category models
  */
-export interface AnyKey extends ServiceMap.Service<any, any> {
+export interface AnyService extends ServiceMap.Key<any, any> {
   readonly [TypeId]: typeof TypeId
   readonly provides: any
-  readonly error: Schema.Top
+  readonly error: ReadonlySet<Schema.Top>
   readonly requiredForClient: boolean
   readonly "~ClientError": any
 }
@@ -99,7 +109,7 @@ export interface AnyKey extends ServiceMap.Service<any, any> {
  * @since 4.0.0
  * @category models
  */
-export interface AnyKeySecurity extends AnyKey {
+export interface AnyServiceSecurity extends AnyService {
   readonly [SecurityTypeId]: typeof SecurityTypeId
   readonly security: Record<string, HttpApiSecurity.HttpApiSecurity>
 }
@@ -112,7 +122,7 @@ export interface AnyId {
   readonly [TypeId]: {
     readonly provides: any
     readonly requires: any
-    readonly error: Schema.Top
+    readonly error: ErrorConstraint
     readonly clientError: any
     readonly requiredForClient: boolean
   }
@@ -140,8 +150,7 @@ export type ApplyServices<A extends AnyId, R> = Exclude<R, Provides<A>> | Requir
  * @since 4.0.0
  * @category models
  */
-export type ErrorSchema<A> = A extends { readonly [TypeId]: { readonly error: infer E } }
-  ? E extends Schema.Top ? E : never
+export type ErrorSchema<A> = A extends { readonly [TypeId]: { readonly error: infer E } } ? ErrorSchemaFromConstraint<E>
   : never
 
 /**
@@ -195,7 +204,7 @@ export type ServiceClass<
   Config extends {
     requires: any
     provides: any
-    error: Schema.Top
+    error: ErrorConstraint
     clientError: any
     requiredForClient: boolean
     security: Record<string, HttpApiSecurity.HttpApiSecurity>
@@ -216,7 +225,7 @@ export type ServiceClass<
       }
     }
     readonly [TypeId]: typeof TypeId
-    readonly error: Config["error"]
+    readonly error: ReadonlySet<Schema.Top>
     readonly requiredForClient: Config["requiredForClient"]
     readonly "~ClientError": Config["clientError"]
   }
@@ -238,7 +247,7 @@ export const Service = <
   } = { requires: never; provides: never; clientError: never }
 >(): <
   const Id extends string,
-  Error extends Schema.Top = never,
+  const Error extends ErrorConstraint = never,
   const Security extends Record<string, HttpApiSecurity.HttpApiSecurity> = never,
   RequiredForClient extends boolean = false
 >(
@@ -260,7 +269,7 @@ export const Service = <
   id: string,
   options?: {
     readonly security?: Record<string, HttpApiSecurity.HttpApiSecurity> | undefined
-    readonly error?: Schema.Top | undefined
+    readonly error?: ErrorConstraint | undefined
     readonly requiredForClient?: boolean | undefined
   } | undefined
 ) => {
@@ -278,10 +287,8 @@ export const Service = <
     }
   })
   self[TypeId] = TypeId
+  self.error = getError(options?.error)
   self.requiredForClient = options?.requiredForClient ?? false
-  if (options?.error !== undefined) {
-    self.error = options.error
-  }
   if (options?.security !== undefined) {
     if (Object.keys(options.security).length === 0) {
       throw new Error("HttpApiMiddleware.Service: security object must not be empty")
@@ -292,16 +299,70 @@ export const Service = <
   return self
 }
 
+function getError(error: ErrorConstraint | undefined): ReadonlySet<Schema.Top> {
+  if (error === undefined) return new Set()
+  return new Set(Array.isArray(error) ? error : [error])
+}
+
+/**
+ * Implement a middleware Layer that transforms `SchemaError`'s.
+ *
+ * ```ts
+ * import { Effect, Schema } from "effect"
+ * import { HttpApiMiddleware } from "effect/unstable/httpapi"
+ *
+ * export class CustomError extends Schema.TaggedErrorClass<CustomError>()("CustomError", {}) {}
+ *
+ * export class ErrorHandler extends HttpApiMiddleware.Service<ErrorHandler>()("api/ErrorHandler", {
+ *   error: CustomError
+ * }) {}
+ *
+ * export const ErrorHandlerLayer = HttpApiMiddleware.layerSchemaErrorTransform(
+ *   ErrorHandler,
+ *   (schemaError) =>
+ *     Effect.log("Got SchemaError", schemaError).pipe(
+ *       Effect.andThen(Effect.fail(new CustomError()))
+ *     )
+ * )
+ * ```
+ *
+ * @since 4.0.0
+ * @category SchemaError transform
+ */
+export const layerSchemaErrorTransform = <Id, E extends ErrorConstraint, Requires>(
+  service: ServiceMap.Service<Id, HttpApiMiddleware<never, E, Requires>>,
+  transform: (
+    error: Schema.SchemaError,
+    context: { readonly endpoint: HttpApiEndpoint.AnyWithProps; readonly group: HttpApiGroup.AnyWithProps }
+  ) => Effect.Effect<
+    HttpServerResponse,
+    ErrorSchemaFromConstraint<E>["Type"] | Schema.SchemaError,
+    Requires | HttpRouter.Provided
+  >
+): Layer.Layer<Id> =>
+  Layer.succeed(
+    service,
+    (httpEffect, options) =>
+      Effect.catch(
+        httpEffect,
+        (e): Effect.Effect<
+          HttpServerResponse,
+          unhandled | Schema.SchemaError | ErrorSchemaFromConstraint<E>["Type"],
+          Requires | HttpRouter.Provided
+        > => Schema.isSchemaError(e) ? transform(e, options) : Effect.fail(e)
+      )
+  )
+
 /**
  * @since 4.0.0
  * @category client
  */
 export const layerClient = <Id extends AnyId, S, R, EX = never, RX = never>(
-  tag: ServiceMap.Service<Id, S>,
+  tag: ServiceMap.Key<Id, S>,
   service:
-    | HttpApiMiddlewareClient<Id[typeof TypeId]["error"]["Type"], Id[typeof TypeId]["clientError"], R>
+    | HttpApiMiddlewareClient<Error<Id>, Id[typeof TypeId]["clientError"], R>
     | Effect.Effect<
-      HttpApiMiddlewareClient<Id[typeof TypeId]["error"]["Type"], Id[typeof TypeId]["clientError"], R>,
+      HttpApiMiddlewareClient<Error<Id>, Id[typeof TypeId]["clientError"], R>,
       EX,
       RX
     >

package/src/unstable/httpapi/HttpApiScalar.ts

@@ -98,6 +98,12 @@ export type ScalarConfig = {
    * Default: `false`
    */
   defaultOpenAllTags?: boolean
+  /**
+   * Whether to display the operation ID in the operation reference.
+   *
+   * Default: `false`
+   */
+  showOperationId?: boolean
 }
 
 type ScalarSource =

package/src/unstable/httpapi/HttpApiSchema.ts

@@ -31,6 +31,7 @@ import { constVoid, type LazyArg } from "../../Function.ts"
 import * as Schema from "../../Schema.ts"
 import * as AST from "../../SchemaAST.ts"
 import * as Transformation from "../../SchemaTransformation.ts"
+import { hasBody, type HttpMethod } from "../http/HttpMethod.ts"
 import type * as Multipart_ from "../http/Multipart.ts"
 
 declare module "../../Schema.ts" {
@@ -332,6 +333,17 @@ export function asUint8Array(options?: {
   return <S extends Schema.Top & { readonly Encoded: Uint8Array }>(self: S) =>
     asNonMultipartEncoding(self, { _tag: "Uint8Array", ...options })
 }
+/**
+ * @since 4.0.0
+ */
+export const isNoContent = (ast: AST.AST): boolean => {
+  if (AST.isVoid(ast)) return true
+  const encoded = AST.toEncoded(ast)
+  if (AST.isVoid(encoded)) return true
+  const target = ast.encoding?.[0].to
+  if (target === undefined) return false
+  return AST.isVoid(target)
+}
 
 const resolveHttpApiEncoding = AST.resolveAt<Encoding>("~httpApiEncoding")
 
@@ -341,14 +353,20 @@ const defaultJsonEncoding: Encoding = {
   _tag: "Json",
   contentType: "application/json"
 }
+const defaultUrlEncodedEncoding: Encoding = {
+  _tag: "FormUrlEncoded",
+  contentType: "application/x-www-form-urlencoded"
+}
 
 function getEncoding(ast: AST.AST): Encoding {
   return resolveHttpApiEncoding(ast) ?? defaultJsonEncoding
 }
 
 /** @internal */
-export function getPayloadEncoding(ast: AST.AST): PayloadEncoding {
-  return getEncoding(ast)
+export function getPayloadEncoding(ast: AST.AST, method: HttpMethod): PayloadEncoding {
+  const encoding = resolveHttpApiEncoding(ast)
+  if (encoding) return encoding
+  return hasBody(method) ? defaultJsonEncoding : defaultUrlEncodedEncoding
 }
 
 /** @internal */

package/src/unstable/httpapi/HttpApiSecurity.ts

@@ -161,15 +161,15 @@ export const annotate: {
    * @since 4.0.0
    * @category annotations
    */
-  <I, S>(service: ServiceMap.Service<I, S>, value: S): <A extends HttpApiSecurity>(self: A) => A
+  <I, S>(service: ServiceMap.Key<I, S>, value: S): <A extends HttpApiSecurity>(self: A) => A
   /**
    * @since 4.0.0
    * @category annotations
    */
-  <A extends HttpApiSecurity, I, S>(self: A, service: ServiceMap.Service<I, S>, value: S): A
+  <A extends HttpApiSecurity, I, S>(self: A, service: ServiceMap.Key<I, S>, value: S): A
 } = dual(
   3,
-  <A extends HttpApiSecurity, I, S>(self: A, service: ServiceMap.Service<I, S>, value: S): A =>
+  <A extends HttpApiSecurity, I, S>(self: A, service: ServiceMap.Key<I, S>, value: S): A =>
     Object.assign(Object.create(Proto), {
       ...self,
       annotations: ServiceMap.add(self.annotations, service, value)