@effect/platform 0.57.8 → 0.58.0

package/src/{Http/Router.ts → HttpRouter.ts}

@@ -11,11 +11,11 @@ import type * as Effect from "effect/Effect"
 import type { Inspectable } from "effect/Inspectable"
 import type * as Option from "effect/Option"
 import type * as Scope from "effect/Scope"
-import * as internal from "../internal/http/router.js"
-import type * as App from "./App.js"
-import type * as Method from "./Method.js"
-import type * as Error from "./ServerError.js"
-import type * as ServerRequest from "./ServerRequest.js"
+import type * as App from "./HttpApp.js"
+import type * as Method from "./HttpMethod.js"
+import type * as Error from "./HttpServerError.js"
+import type * as ServerRequest from "./HttpServerRequest.js"
+import * as internal from "./internal/httpRouter.js"
 
 /**
  * @since 1.0.0
@@ -33,7 +33,7 @@ export type TypeId = typeof TypeId
  * @since 1.0.0
  * @category models
  */
-export interface Router<E = never, R = never>
+export interface HttpRouter<E = never, R = never>
   extends App.Default<E | Error.RouteNotFound, Exclude<R, RouteContext>>, Inspectable
 {
   readonly [TypeId]: TypeId
@@ -50,13 +50,13 @@ export interface Router<E = never, R = never>
 /**
  * @since 1.0.0
  */
-export declare namespace Router {
+export declare namespace HttpRouter {
   /**
    * @since 1.0.0
    */
   export type ExcludeProvided<A> = Exclude<
     A,
-    RouteContext | ServerRequest.ServerRequest | ServerRequest.ParsedSearchParams | Scope.Scope
+    RouteContext | ServerRequest.HttpServerRequest | ServerRequest.ParsedSearchParams | Scope.Scope
   >
 }
 
@@ -84,7 +84,7 @@ export type PathInput = `/${string}` | "*"
  */
 export interface Route<E = never, R = never> extends Inspectable {
   readonly [RouteTypeId]: RouteTypeId
-  readonly method: Method.Method | "*"
+  readonly method: Method.HttpMethod | "*"
   readonly path: PathInput
   readonly handler: Route.Handler<E, R>
   readonly prefix: Option.Option<string>
@@ -146,7 +146,7 @@ export const params: Effect.Effect<
 export const schemaJson: <
   R,
   I extends Partial<{
-    readonly method: Method.Method
+    readonly method: Method.HttpMethod
     readonly url: string
     readonly cookies: Readonly<Record<string, string | undefined>>
     readonly headers: Readonly<Record<string, string | undefined>>
@@ -161,7 +161,7 @@ export const schemaJson: <
 ) => Effect.Effect<
   A,
   Error.RequestError | ParseResult.ParseError,
-  RouteContext | R | ServerRequest.ServerRequest | ServerRequest.ParsedSearchParams
+  RouteContext | R | ServerRequest.HttpServerRequest | ServerRequest.ParsedSearchParams
 > = internal.schemaJson
 
 /**
@@ -172,7 +172,7 @@ export const schemaNoBody: <
   R,
   I extends Partial<
     {
-      readonly method: Method.Method
+      readonly method: Method.HttpMethod
       readonly url: string
       readonly cookies: Readonly<Record<string, string | undefined>>
       readonly headers: Readonly<Record<string, string | undefined>>
@@ -187,7 +187,7 @@ export const schemaNoBody: <
 ) => Effect.Effect<
   A,
   ParseResult.ParseError,
-  R | RouteContext | ServerRequest.ServerRequest | ServerRequest.ParsedSearchParams
+  R | RouteContext | ServerRequest.HttpServerRequest | ServerRequest.ParsedSearchParams
 > = internal.schemaNoBody
 
 /**
@@ -213,7 +213,7 @@ export const schemaPathParams: <A, I extends Readonly<Record<string, string | un
  * @since 1.0.0
  * @category constructors
  */
-export const empty: Router = internal.empty
+export const empty: HttpRouter = internal.empty
 
 /**
  * @since 1.0.0
@@ -221,7 +221,7 @@ export const empty: Router = internal.empty
  */
 export const fromIterable: <R extends Route<any, any>>(
   routes: Iterable<R>
-) => Router<R extends Route<infer E, infer _> ? E : never, R extends Route<infer _, infer Env> ? Env : never> =
+) => HttpRouter<R extends Route<infer E, infer _> ? E : never, R extends Route<infer _, infer Env> ? Env : never> =
   internal.fromIterable
 
 /**
@@ -229,20 +229,20 @@ export const fromIterable: <R extends Route<any, any>>(
  * @category constructors
  */
 export const makeRoute: <E, R>(
-  method: Method.Method,
+  method: Method.HttpMethod,
   path: PathInput,
   handler: Route.Handler<E, R>,
   prefix?: Option.Option<string>,
   uninterruptible?: boolean
-) => Route<E, Router.ExcludeProvided<R>> = internal.makeRoute
+) => Route<E, HttpRouter.ExcludeProvided<R>> = internal.makeRoute
 
 /**
  * @since 1.0.0
  * @category combinators
  */
 export const prefixAll: {
-  (prefix: PathInput): <E, R>(self: Router<E, R>) => Router<E, R>
-  <E, R>(self: Router<E, R>, prefix: PathInput): Router<E, R>
+  (prefix: PathInput): <E, R>(self: HttpRouter<E, R>) => HttpRouter<E, R>
+  <E, R>(self: HttpRouter<E, R>, prefix: PathInput): HttpRouter<E, R>
 } = internal.prefixAll
 
 /**
@@ -250,10 +250,10 @@ export const prefixAll: {
  * @category combinators
  */
 export const concat: {
-  <R1, E1>(that: Router<E1, R1>): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R1 | R>
-  <E, R, R1, E1>(self: Router<E, R>, that: Router<E1, R1>): Router<
+  <R1, E1>(that: HttpRouter<E1, R1>): <E, R>(
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R1 | R>
+  <E, R, R1, E1>(self: HttpRouter<E, R>, that: HttpRouter<E1, R1>): HttpRouter<
     E | E1,
     R | R1
   >
@@ -264,8 +264,8 @@ export const concat: {
  * @category routing
  */
 export const mount: {
-  <R1, E1>(path: `/${string}`, that: Router<E1, R1>): <E, R>(self: Router<E, R>) => Router<E1 | E, R1 | R>
-  <E, R, E1, R1>(self: Router<E, R>, path: `/${string}`, that: Router<E1, R1>): Router<E | E1, R | R1>
+  <R1, E1>(path: `/${string}`, that: HttpRouter<E1, R1>): <E, R>(self: HttpRouter<E, R>) => HttpRouter<E1 | E, R1 | R>
+  <E, R, E1, R1>(self: HttpRouter<E, R>, path: `/${string}`, that: HttpRouter<E1, R1>): HttpRouter<E | E1, R | R1>
 } = internal.mount
 
 /**
@@ -278,21 +278,21 @@ export const mountApp: {
     that: App.Default<E1, R1>,
     options?: { readonly includePrefix?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<
+    self: HttpRouter<E, R>
+  ) => HttpRouter<
     E1 | E,
-    | Router.ExcludeProvided<R1>
-    | Router.ExcludeProvided<R>
+    | HttpRouter.ExcludeProvided<R1>
+    | HttpRouter.ExcludeProvided<R>
   >
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: `/${string}`,
     that: App.Default<E1, R1>,
     options?: { readonly includePrefix?: boolean | undefined } | undefined
-  ): Router<
+  ): HttpRouter<
     E | E1,
-    | Router.ExcludeProvided<R>
-    | Router.ExcludeProvided<R1>
+    | HttpRouter.ExcludeProvided<R>
+    | HttpRouter.ExcludeProvided<R1>
   >
 } = internal.mountApp
 
@@ -301,21 +301,21 @@ export const mountApp: {
  * @category routing
  */
 export const route: (
-  method: Method.Method | "*"
+  method: Method.HttpMethod | "*"
 ) => {
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R | Exclude<R1, ServerRequest.ServerRequest | RouteContext | Scope.Scope>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R | Exclude<R1, ServerRequest.HttpServerRequest | RouteContext | Scope.Scope>>
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<E | E1, R | Exclude<R1, ServerRequest.ServerRequest | RouteContext | Scope.Scope>>
+  ): HttpRouter<E | E1, R | Exclude<R1, ServerRequest.HttpServerRequest | RouteContext | Scope.Scope>>
 } = internal.route
 
 /**
@@ -328,19 +328,19 @@ export const all: {
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<
+    self: HttpRouter<E, R>
+  ) => HttpRouter<
     E1 | E,
-    R | Router.ExcludeProvided<R1>
+    R | HttpRouter.ExcludeProvided<R1>
   >
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<
+  ): HttpRouter<
     E | E1,
-    R | Router.ExcludeProvided<R1>
+    R | HttpRouter.ExcludeProvided<R1>
   >
 } = internal.all
 
@@ -354,14 +354,14 @@ export const get: {
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R | Router.ExcludeProvided<R1>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<E | E1, R | Router.ExcludeProvided<R1>>
+  ): HttpRouter<E | E1, R | HttpRouter.ExcludeProvided<R1>>
 } = internal.get
 
 /**
@@ -374,14 +374,14 @@ export const post: {
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R | Router.ExcludeProvided<R1>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<E | E1, R | Router.ExcludeProvided<R1>>
+  ): HttpRouter<E | E1, R | HttpRouter.ExcludeProvided<R1>>
 } = internal.post
 
 /**
@@ -394,14 +394,14 @@ export const patch: {
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R | Router.ExcludeProvided<R1>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<E | E1, R | Router.ExcludeProvided<R1>>
+  ): HttpRouter<E | E1, R | HttpRouter.ExcludeProvided<R1>>
 } = internal.patch
 
 /**
@@ -414,14 +414,14 @@ export const put: {
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R | Router.ExcludeProvided<R1>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<E | E1, R | Router.ExcludeProvided<R1>>
+  ): HttpRouter<E | E1, R | HttpRouter.ExcludeProvided<R1>>
 } = internal.put
 
 /**
@@ -434,14 +434,14 @@ export const del: {
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R | Router.ExcludeProvided<R1>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<E | E1, R | Router.ExcludeProvided<R1>>
+  ): HttpRouter<E | E1, R | HttpRouter.ExcludeProvided<R1>>
 } = internal.del
 
 /**
@@ -454,14 +454,14 @@ export const head: {
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R | Router.ExcludeProvided<R1>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<E | E1, R | Router.ExcludeProvided<R1>>
+  ): HttpRouter<E | E1, R | HttpRouter.ExcludeProvided<R1>>
 } = internal.head
 
 /**
@@ -474,14 +474,14 @@ export const options: {
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<E1 | E, R | Router.ExcludeProvided<R1>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
   <E, R, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     path: PathInput,
     handler: Route.Handler<E1, R1>,
     options?: { readonly uninterruptible?: boolean | undefined } | undefined
-  ): Router<E | E1, R | Router.ExcludeProvided<R1>>
+  ): HttpRouter<E | E1, R | HttpRouter.ExcludeProvided<R1>>
 } = internal.options
 
 /**
@@ -491,11 +491,11 @@ export const options: {
 export const use: {
   <E, R, R1, E1>(
     f: (self: Route.Handler<E, R>) => App.Default<E1, R1>
-  ): (self: Router<E, R>) => Router<E1, Router.ExcludeProvided<R1>>
+  ): (self: HttpRouter<E, R>) => HttpRouter<E1, HttpRouter.ExcludeProvided<R1>>
   <E, R, R1, E1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     f: (self: Route.Handler<E, R>) => App.Default<E1, R1>
-  ): Router<E1, Router.ExcludeProvided<R1>>
+  ): HttpRouter<E1, HttpRouter.ExcludeProvided<R1>>
 } = internal.use
 
 /**
@@ -505,11 +505,11 @@ export const use: {
 export const catchAll: {
   <E, E2, R2>(
     f: (e: E) => Route.Handler<E2, R2>
-  ): <R>(self: Router<E, R>) => Router<E2, R | Router.ExcludeProvided<R2>>
+  ): <R>(self: HttpRouter<E, R>) => HttpRouter<E2, R | HttpRouter.ExcludeProvided<R2>>
   <E, R, E2, R2>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     f: (e: E) => Route.Handler<E2, R2>
-  ): Router<E2, R | Router.ExcludeProvided<R2>>
+  ): HttpRouter<E2, R | HttpRouter.ExcludeProvided<R2>>
 } = internal.catchAll
 
 /**
@@ -519,11 +519,11 @@ export const catchAll: {
 export const catchAllCause: {
   <E, E2, R2>(
     f: (e: Cause.Cause<E>) => Route.Handler<E2, R2>
-  ): <R>(self: Router<E, R>) => Router<E2, R | Router.ExcludeProvided<R2>>
+  ): <R>(self: HttpRouter<E, R>) => HttpRouter<E2, R | HttpRouter.ExcludeProvided<R2>>
   <E, R, E2, R2>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     f: (e: Cause.Cause<E>) => Route.Handler<E2, R2>
-  ): Router<E2, R | Router.ExcludeProvided<R2>>
+  ): HttpRouter<E2, R | HttpRouter.ExcludeProvided<R2>>
 } = internal.catchAllCause
 
 /**
@@ -535,13 +535,13 @@ export const catchTag: {
     k: K,
     f: (e: Extract<E, { _tag: K }>) => Route.Handler<E1, R1>
   ): <R>(
-    self: Router<E, R>
-  ) => Router<E1 | Exclude<E, { _tag: K }>, R | Router.ExcludeProvided<R1>>
+    self: HttpRouter<E, R>
+  ) => HttpRouter<E1 | Exclude<E, { _tag: K }>, R | HttpRouter.ExcludeProvided<R1>>
   <E, R, K extends E extends { _tag: string } ? E["_tag"] : never, E1, R1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     k: K,
     f: (e: Extract<E, { _tag: K }>) => Route.Handler<E1, R1>
-  ): Router<E1 | Exclude<E, { _tag: K }>, R | Router.ExcludeProvided<R1>>
+  ): HttpRouter<E1 | Exclude<E, { _tag: K }>, R | HttpRouter.ExcludeProvided<R1>>
 } = internal.catchTag
 
 /**
@@ -557,14 +557,14 @@ export const catchTags: {
   >(
     cases: Cases
   ): <R>(
-    self: Router<E, R>
-  ) => Router<
+    self: HttpRouter<E, R>
+  ) => HttpRouter<
     | Exclude<E, { _tag: keyof Cases }>
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect.Effect<any, infer E, any> ? E : never
     }[keyof Cases],
     | R
-    | Router.ExcludeProvided<
+    | HttpRouter.ExcludeProvided<
       {
         [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect.Effect<any, any, infer R> ? R : never
       }[keyof Cases]
@@ -577,15 +577,15 @@ export const catchTags: {
       ? { [K in E["_tag"]]+?: ((error: Extract<E, { _tag: K }>) => Route.Handler<any, any>) | undefined } :
       {}
   >(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     cases: Cases
-  ): Router<
+  ): HttpRouter<
     | Exclude<E, { _tag: keyof Cases }>
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect.Effect<any, infer E, any> ? E : never
     }[keyof Cases],
     | R
-    | Router.ExcludeProvided<
+    | HttpRouter.ExcludeProvided<
       {
         [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect.Effect<any, any, infer R> ? R : never
       }[keyof Cases]
@@ -601,12 +601,12 @@ export const provideService: {
   <T extends Context.Tag<any, any>>(
     tag: T,
     service: Context.Tag.Service<T>
-  ): <E, R>(self: Router<E, R>) => Router<E, Exclude<R, Context.Tag.Identifier<T>>>
+  ): <E, R>(self: HttpRouter<E, R>) => HttpRouter<E, Exclude<R, Context.Tag.Identifier<T>>>
   <E, R, T extends Context.Tag<any, any>>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     tag: T,
     service: Context.Tag.Service<T>
-  ): Router<E, Exclude<R, Context.Tag.Identifier<T>>>
+  ): HttpRouter<E, Exclude<R, Context.Tag.Identifier<T>>>
 } = internal.provideService
 
 /**
@@ -618,19 +618,19 @@ export const provideServiceEffect: {
     tag: T,
     effect: Effect.Effect<Context.Tag.Service<T>, E1, R1>
   ): <E, R>(
-    self: Router<E, R>
-  ) => Router<
+    self: HttpRouter<E, R>
+  ) => HttpRouter<
     E1 | E,
     | Exclude<R, Context.Tag.Identifier<T>>
-    | Exclude<Router.ExcludeProvided<R1>, Context.Tag.Identifier<T>>
+    | Exclude<HttpRouter.ExcludeProvided<R1>, Context.Tag.Identifier<T>>
   >
   <E, R, T extends Context.Tag<any, any>, R1, E1>(
-    self: Router<E, R>,
+    self: HttpRouter<E, R>,
     tag: T,
     effect: Effect.Effect<Context.Tag.Service<T>, E1, R1>
-  ): Router<
+  ): HttpRouter<
     E | E1,
     | Exclude<R, Context.Tag.Identifier<T>>
-    | Exclude<Router.ExcludeProvided<R1>, Context.Tag.Identifier<T>>
+    | Exclude<HttpRouter.ExcludeProvided<R1>, Context.Tag.Identifier<T>>
   >
 } = internal.provideServiceEffect