@effect/platform 0.57.8 → 0.58.0

package/src/HttpServer.ts

@@ -1,126 +1,195 @@
 /**
  * @since 1.0.0
  */
-import * as app from "./Http/App.js"
-import * as body from "./Http/Body.js"
-import * as cookies from "./Http/Cookies.js"
-import * as etag from "./Http/Etag.js"
-import * as headers from "./Http/Headers.js"
-import * as middleware from "./Http/Middleware.js"
-import * as multipart from "./Http/Multipart.js"
-import * as multiplex from "./Http/Multiplex.js"
-import * as platform from "./Http/Platform.js"
-import * as router from "./Http/Router.js"
-import * as server from "./Http/Server.js"
-import * as error from "./Http/ServerError.js"
-import * as request from "./Http/ServerRequest.js"
-import * as response from "./Http/ServerResponse.js"
-import * as urlParams from "./Http/UrlParams.js"
-
-export {
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/App](https://effect-ts.github.io/effect/platform/Http/App.ts.html)
-   * - Module: `@effect/platform/Http/App`
-   */
-  app,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Body](https://effect-ts.github.io/effect/platform/Http/Body.ts.html)
-   * - Module: `@effect/platform/Http/Body`
-   */
-  body,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Cookies](https://effect-ts.github.io/effect/platform/Http/Cookies.ts.html)
-   * - Module: `@effect/platform/Http/Cookies`
-   */
-  cookies,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/ServerError](https://effect-ts.github.io/effect/platform/Http/ServerError.ts.html)
-   * - Module: `@effect/platform/Http/ServerError`
-   */
-  error,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Etag](https://effect-ts.github.io/effect/platform/Http/Etag.ts.html)
-   * - Module: `@effect/platform/Http/Etag`
-   */
-  etag,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Headers](https://effect-ts.github.io/effect/platform/Http/Headers.ts.html)
-   * - Module: `@effect/platform/Http/Headers`
-   */
-  headers,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Middleware](https://effect-ts.github.io/effect/platform/Http/Middleware.ts.html)
-   * - Module: `@effect/platform/Http/Middleware`
-   */
-  middleware,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Multipart](https://effect-ts.github.io/effect/platform/Http/Multipart.ts.html)
-   * - Module: `@effect/platform/Http/Multipart`
-   */
-  multipart,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Multiplex](https://effect-ts.github.io/effect/platform/Http/Multiplex.ts.html)
-   * - Module: `@effect/platform/Http/Multiplex`
-   */
-  multiplex,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Platform](https://effect-ts.github.io/effect/platform/Http/Platform.ts.html)
-   * - Module: `@effect/platform/Http/Platform`
-   */
-  platform,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/ServerRequest](https://effect-ts.github.io/effect/platform/Http/ServerRequest.ts.html)
-   * - Module: `@effect/platform/Http/ServerRequest`
-   */
-  request,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/ServerResponse](https://effect-ts.github.io/effect/platform/Http/ServerResponse.ts.html)
-   * - Module: `@effect/platform/Http/ServerResponse`
-   */
-  response,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Router](https://effect-ts.github.io/effect/platform/Http/Router.ts.html)
-   * - Module: `@effect/platform/Http/Router`
-   */
-  router,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/Server](https://effect-ts.github.io/effect/platform/Http/Server.ts.html)
-   * - Module: `@effect/platform/Http/Server`
-   */
-  server,
-  /**
-   * @since 1.0.0
-   *
-   * - Docs: [Http/UrlParams](https://effect-ts.github.io/effect/platform/Http/UrlParams.ts.html)
-   * - Module: `@effect/platform/Http/UrlParams`
-   */
-  urlParams
+import type * as Context from "effect/Context"
+import type * as Effect from "effect/Effect"
+import type * as Layer from "effect/Layer"
+import type * as Scope from "effect/Scope"
+import type * as App from "./HttpApp.js"
+import type * as Middleware from "./HttpMiddleware.js"
+import type * as ServerRequest from "./HttpServerRequest.js"
+import * as internal from "./internal/httpServer.js"
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export const TypeId: unique symbol = internal.TypeId
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface HttpServer {
+  readonly [TypeId]: TypeId
+  readonly serve: {
+    <E, R>(httpApp: App.Default<E, R>): Effect.Effect<
+      void,
+      never,
+      Exclude<R, ServerRequest.HttpServerRequest> | Scope.Scope
+    >
+    <E, R, App extends App.Default<any, any>>(
+      httpApp: App.Default<E, R>,
+      middleware: Middleware.HttpMiddleware.Applied<App, E, R>
+    ): Effect.Effect<
+      void,
+      never,
+      Exclude<R, ServerRequest.HttpServerRequest> | Scope.Scope
+    >
+  }
+  readonly address: Address
+}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface ServeOptions {
+  readonly respond: boolean
 }
+
+/**
+ * @since 1.0.0
+ * @category address
+ */
+export type Address = UnixAddress | TcpAddress
+
+/**
+ * @since 1.0.0
+ * @category address
+ */
+export interface TcpAddress {
+  readonly _tag: "TcpAddress"
+  readonly hostname: string
+  readonly port: number
+}
+
+/**
+ * @since 1.0.0
+ * @category address
+ */
+export interface UnixAddress {
+  readonly _tag: "UnixAddress"
+  readonly path: string
+}
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const HttpServer: Context.Tag<HttpServer, HttpServer> = internal.serverTag
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const make: (
+  options: {
+    readonly serve: (
+      httpApp: App.Default<unknown>,
+      middleware?: Middleware.HttpMiddleware
+    ) => Effect.Effect<void, never, Scope.Scope>
+    readonly address: Address
+  }
+) => HttpServer = internal.make
+
+/**
+ * @since 1.0.0
+ * @category accessors
+ */
+export const serve: {
+  (): <E, R>(
+    httpApp: App.Default<E, R>
+  ) => Layer.Layer<never, never, HttpServer | Exclude<R, ServerRequest.HttpServerRequest | Scope.Scope>>
+  <E, R, App extends App.Default<any, any>>(
+    middleware: Middleware.HttpMiddleware.Applied<App, E, R>
+  ): (
+    httpApp: App.Default<E, R>
+  ) => Layer.Layer<
+    never,
+    never,
+    HttpServer | Exclude<Effect.Effect.Context<App>, ServerRequest.HttpServerRequest | Scope.Scope>
+  >
+  <E, R>(
+    httpApp: App.Default<E, R>
+  ): Layer.Layer<never, never, HttpServer | Exclude<R, ServerRequest.HttpServerRequest | Scope.Scope>>
+  <E, R, App extends App.Default<any, any>>(
+    httpApp: App.Default<E, R>,
+    middleware: Middleware.HttpMiddleware.Applied<App, E, R>
+  ): Layer.Layer<
+    never,
+    never,
+    HttpServer | Exclude<Effect.Effect.Context<App>, ServerRequest.HttpServerRequest | Scope.Scope>
+  >
+} = internal.serve
+
+/**
+ * @since 1.0.0
+ * @category accessors
+ */
+export const serveEffect: {
+  (): <E, R>(
+    httpApp: App.Default<E, R>
+  ) => Effect.Effect<void, never, Scope.Scope | HttpServer | Exclude<R, ServerRequest.HttpServerRequest>>
+  <E, R, App extends App.Default<any, any>>(
+    middleware: Middleware.HttpMiddleware.Applied<App, E, R>
+  ): (
+    httpApp: App.Default<E, R>
+  ) => Effect.Effect<
+    void,
+    never,
+    Scope.Scope | HttpServer | Exclude<Effect.Effect.Context<App>, ServerRequest.HttpServerRequest>
+  >
+  <E, R>(
+    httpApp: App.Default<E, R>
+  ): Effect.Effect<void, never, Scope.Scope | HttpServer | Exclude<R, ServerRequest.HttpServerRequest>>
+  <E, R, App extends App.Default<any, any>>(
+    httpApp: App.Default<E, R>,
+    middleware: Middleware.HttpMiddleware.Applied<App, E, R>
+  ): Effect.Effect<
+    void,
+    never,
+    Scope.Scope | HttpServer | Exclude<Effect.Effect.Context<App>, ServerRequest.HttpServerRequest>
+  >
+} = internal.serveEffect
+
+/**
+ * @since 1.0.0
+ * @category address
+ */
+export const formatAddress: (address: Address) => string = internal.formatAddress
+
+/**
+ * @since 1.0.0
+ * @category address
+ */
+export const addressWith: <A, E, R>(
+  effect: (address: Address) => Effect.Effect<A, E, R>
+) => Effect.Effect<A, E, HttpServer | R> = internal.addressWith
+
+/**
+ * @since 1.0.0
+ * @category address
+ */
+export const addressFormattedWith: <A, E, R>(
+  effect: (address: string) => Effect.Effect<A, E, R>
+) => Effect.Effect<A, E, HttpServer | R> = internal.addressFormattedWith
+
+/**
+ * @since 1.0.0
+ * @category address
+ */
+export const logAddress: Effect.Effect<void, never, HttpServer> = internal.logAddress
+
+/**
+ * @since 1.0.0
+ * @category address
+ */
+export const withLogAddress: <A, E, R>(layer: Layer.Layer<A, E, R>) => Layer.Layer<A, E, R | Exclude<HttpServer, A>> =
+  internal.withLogAddress

package/src/{Http/ServerError.ts → HttpServerError.ts}

@@ -3,10 +3,10 @@
  */
 import type * as Cause from "effect/Cause"
 import type * as FiberId from "effect/FiberId"
-import { RefailError, TypeIdError } from "../Error.js"
-import * as internal from "../internal/http/serverError.js"
-import type * as ServerRequest from "./ServerRequest.js"
-import type * as ServerResponse from "./ServerResponse.js"
+import { RefailError, TypeIdError } from "./Error.js"
+import type * as ServerRequest from "./HttpServerRequest.js"
+import type * as ServerResponse from "./HttpServerResponse.js"
+import * as internal from "./internal/httpServerError.js"
 
 /**
  * @since 1.0.0
@@ -31,7 +31,7 @@ export type HttpServerError = RequestError | ResponseError | RouteNotFound | Ser
  * @category error
  */
 export class RequestError extends RefailError(TypeId, "RequestError")<{
-  readonly request: ServerRequest.ServerRequest
+  readonly request: ServerRequest.HttpServerRequest
   readonly reason: "Transport" | "Decode"
 }> {
   get methodAndUrl() {
@@ -54,7 +54,7 @@ export const isServerError: (u: unknown) => u is HttpServerError = internal.isSe
  * @category error
  */
 export class RouteNotFound extends TypeIdError(TypeId, "RouteNotFound")<{
-  readonly request: ServerRequest.ServerRequest
+  readonly request: ServerRequest.HttpServerRequest
 }> {
   get message() {
     return `${this.request.method} ${this.request.url} not found`
@@ -66,8 +66,8 @@ export class RouteNotFound extends TypeIdError(TypeId, "RouteNotFound")<{
  * @category error
  */
 export class ResponseError extends RefailError(TypeId, "ResponseError")<{
-  readonly request: ServerRequest.ServerRequest
-  readonly response: ServerResponse.ServerResponse
+  readonly request: ServerRequest.HttpServerRequest
+  readonly response: ServerResponse.HttpServerResponse
   readonly reason: "Decode"
 }> {
   get methodAndUrl() {

package/src/{Http/ServerRequest.ts → HttpServerRequest.ts}

@@ -11,15 +11,15 @@ import type * as Effect from "effect/Effect"
 import type { ReadonlyRecord } from "effect/Record"
 import type * as Scope from "effect/Scope"
 import type * as Stream from "effect/Stream"
-import type * as FileSystem from "../FileSystem.js"
-import * as internal from "../internal/http/serverRequest.js"
-import type * as Path from "../Path.js"
-import type * as Socket from "../Socket.js"
+import type * as FileSystem from "./FileSystem.js"
 import type * as Headers from "./Headers.js"
-import type * as IncomingMessage from "./IncomingMessage.js"
-import type { Method } from "./Method.js"
+import type * as IncomingMessage from "./HttpIncomingMessage.js"
+import type { HttpMethod } from "./HttpMethod.js"
+import type * as Error from "./HttpServerError.js"
+import * as internal from "./internal/httpServerRequest.js"
 import type * as Multipart from "./Multipart.js"
-import type * as Error from "./ServerError.js"
+import type * as Path from "./Path.js"
+import type * as Socket from "./Socket.js"
 
 export {
   /**
@@ -27,7 +27,7 @@ export {
    * @category fiber refs
    */
   maxBodySize
-} from "./IncomingMessage.js"
+} from "./HttpIncomingMessage.js"
 
 /**
  * @since 1.0.0
@@ -45,12 +45,12 @@ export type TypeId = typeof TypeId
  * @since 1.0.0
  * @category models
  */
-export interface ServerRequest extends IncomingMessage.IncomingMessage<Error.RequestError> {
+export interface HttpServerRequest extends IncomingMessage.HttpIncomingMessage<Error.RequestError> {
   readonly [TypeId]: TypeId
   readonly source: unknown
   readonly url: string
   readonly originalUrl: string
-  readonly method: Method
+  readonly method: HttpMethod
   readonly cookies: ReadonlyRecord<string, string>
 
   readonly multipart: Effect.Effect<
@@ -68,14 +68,14 @@ export interface ServerRequest extends IncomingMessage.IncomingMessage<Error.Req
       readonly headers?: Headers.Headers
       readonly remoteAddress?: string
     }
-  ) => ServerRequest
+  ) => HttpServerRequest
 }
 
 /**
  * @since 1.0.0
  * @category context
  */
-export const ServerRequest: Context.Tag<ServerRequest, ServerRequest> = internal.serverRequestTag
+export const HttpServerRequest: Context.Tag<HttpServerRequest, HttpServerRequest> = internal.serverRequestTag
 
 /**
  * @since 1.0.0
@@ -106,14 +106,14 @@ export const searchParamsFromURL: (url: URL) => ReadonlyRecord<string, string |
 export const persistedMultipart: Effect.Effect<
   unknown,
   Multipart.MultipartError,
-  Scope.Scope | FileSystem.FileSystem | Path.Path | ServerRequest
+  Scope.Scope | FileSystem.FileSystem | Path.Path | HttpServerRequest
 > = internal.multipartPersisted
 
 /**
  * @since 1.0.0
  * @category accessors
  */
-export const upgrade: Effect.Effect<Socket.Socket, Error.RequestError, ServerRequest> = internal.upgrade
+export const upgrade: Effect.Effect<Socket.Socket, Error.RequestError, HttpServerRequest> = internal.upgrade
 
 /**
  * @since 1.0.0
@@ -126,7 +126,7 @@ export const upgradeChannel: <IE = never>() => Channel<
   IE,
   void,
   unknown,
-  ServerRequest
+  HttpServerRequest
 > = internal.upgradeChannel
 
 /**
@@ -136,7 +136,7 @@ export const upgradeChannel: <IE = never>() => Channel<
 export const schemaCookies: <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
-) => Effect.Effect<A, ParseResult.ParseError, ServerRequest | R> = internal.schemaCookies
+) => Effect.Effect<A, ParseResult.ParseError, HttpServerRequest | R> = internal.schemaCookies
 
 /**
  * @since 1.0.0
@@ -145,7 +145,7 @@ export const schemaCookies: <A, I extends Readonly<Record<string, string>>, R>(
 export const schemaHeaders: <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
-) => Effect.Effect<A, ParseResult.ParseError, ServerRequest | R> = internal.schemaHeaders
+) => Effect.Effect<A, ParseResult.ParseError, HttpServerRequest | R> = internal.schemaHeaders
 
 /**
  * @since 1.0.0
@@ -163,7 +163,7 @@ export const schemaSearchParams: <A, I extends Readonly<Record<string, string |
 export const schemaBodyJson: <A, I, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
-) => Effect.Effect<A, Error.RequestError | ParseResult.ParseError, ServerRequest | R> = internal.schemaBodyJson
+) => Effect.Effect<A, Error.RequestError | ParseResult.ParseError, HttpServerRequest | R> = internal.schemaBodyJson
 
 /**
  * @since 1.0.0
@@ -175,7 +175,7 @@ export const schemaBodyForm: <A, I extends Partial<Multipart.Persisted>, R>(
 ) => Effect.Effect<
   A,
   Multipart.MultipartError | ParseResult.ParseError | Error.RequestError,
-  R | ServerRequest | Scope.Scope | FileSystem.FileSystem | Path.Path
+  R | HttpServerRequest | Scope.Scope | FileSystem.FileSystem | Path.Path
 > = internal.schemaBodyForm
 
 /**
@@ -185,7 +185,7 @@ export const schemaBodyForm: <A, I extends Partial<Multipart.Persisted>, R>(
 export const schemaBodyUrlParams: <A, I extends Readonly<Record<string, string>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
-) => Effect.Effect<A, ParseResult.ParseError | Error.RequestError, R | ServerRequest> = internal.schemaBodyUrlParams
+) => Effect.Effect<A, ParseResult.ParseError | Error.RequestError, R | HttpServerRequest> = internal.schemaBodyUrlParams
 
 /**
  * @since 1.0.0
@@ -197,7 +197,7 @@ export const schemaBodyMultipart: <A, I extends Partial<Multipart.Persisted>, R>
 ) => Effect.Effect<
   A,
   Multipart.MultipartError | ParseResult.ParseError,
-  R | ServerRequest | Scope.Scope | FileSystem.FileSystem | Path.Path
+  R | HttpServerRequest | Scope.Scope | FileSystem.FileSystem | Path.Path
 > = internal.schemaBodyMultipart
 
 /**
@@ -212,11 +212,11 @@ export const schemaBodyFormJson: <A, I, R>(
 ) => Effect.Effect<
   A,
   ParseResult.ParseError | Error.RequestError,
-  R | ServerRequest | FileSystem.FileSystem | Path.Path | Scope.Scope
+  R | HttpServerRequest | FileSystem.FileSystem | Path.Path | Scope.Scope
 > = internal.schemaBodyFormJson
 
 /**
  * @since 1.0.0
  * @category conversions
  */
-export const fromWeb: (request: Request) => ServerRequest = internal.fromWeb
+export const fromWeb: (request: Request) => HttpServerRequest = internal.fromWeb