@effect/platform 0.66.2 → 0.67.0

package/src/HttpClientRequest.ts

@@ -138,7 +138,15 @@ export const options: (url: string | URL, options?: Options.NoUrl) => HttpClient
  * @category combinators
  */
 export const modify: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (options: Options): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, options: Options): HttpClientRequest
 } = internal.modify
 
@@ -147,7 +155,15 @@ export const modify: {
  * @category combinators
  */
 export const setMethod: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (method: HttpMethod): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, method: HttpMethod): HttpClientRequest
 } = internal.setMethod
 
@@ -156,7 +172,15 @@ export const setMethod: {
  * @category combinators
  */
 export const setHeader: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, key: string, value: string): HttpClientRequest
 } = internal.setHeader
 
@@ -165,7 +189,15 @@ export const setHeader: {
  * @category combinators
  */
 export const setHeaders: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (input: Headers.Input): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, input: Headers.Input): HttpClientRequest
 } = internal.setHeaders
 
@@ -174,8 +206,20 @@ export const setHeaders: {
  * @category combinators
  */
 export const basicAuth: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (username: string | Redacted, password: string | Redacted): (self: HttpClientRequest) => HttpClientRequest
-  (self: HttpClientRequest, username: string | Redacted, password: string | Redacted): HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  (
+    self: HttpClientRequest,
+    username: string | Redacted,
+    password: string | Redacted
+  ): HttpClientRequest
 } = internal.basicAuth
 
 /**
@@ -183,7 +227,15 @@ export const basicAuth: {
  * @category combinators
  */
 export const bearerToken: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (token: string | Redacted): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, token: string | Redacted): HttpClientRequest
 } = internal.bearerToken
 
@@ -192,7 +244,15 @@ export const bearerToken: {
  * @category combinators
  */
 export const accept: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (mediaType: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, mediaType: string): HttpClientRequest
 } = internal.accept
 
@@ -207,7 +267,15 @@ export const acceptJson: (self: HttpClientRequest) => HttpClientRequest = intern
  * @category combinators
  */
 export const setUrl: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (url: string | URL): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, url: string | URL): HttpClientRequest
 } = internal.setUrl
 
@@ -216,7 +284,15 @@ export const setUrl: {
  * @category combinators
  */
 export const prependUrl: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (path: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, path: string): HttpClientRequest
 } = internal.prependUrl
 
@@ -225,7 +301,15 @@ export const prependUrl: {
  * @category combinators
  */
 export const appendUrl: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (path: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, path: string): HttpClientRequest
 } = internal.appendUrl
 
@@ -234,7 +318,15 @@ export const appendUrl: {
  * @category combinators
  */
 export const updateUrl: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (f: (url: string) => string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, f: (url: string) => string): HttpClientRequest
 } = internal.updateUrl
 
@@ -243,7 +335,15 @@ export const updateUrl: {
  * @category combinators
  */
 export const setUrlParam: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, key: string, value: string): HttpClientRequest
 } = internal.setUrlParam
 
@@ -252,7 +352,15 @@ export const setUrlParam: {
  * @category combinators
  */
 export const setUrlParams: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (input: UrlParams.Input): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, input: UrlParams.Input): HttpClientRequest
 } = internal.setUrlParams
 
@@ -261,7 +369,15 @@ export const setUrlParams: {
  * @category combinators
  */
 export const appendUrlParam: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, key: string, value: string): HttpClientRequest
 } = internal.appendUrlParam
 
@@ -270,7 +386,15 @@ export const appendUrlParam: {
  * @category combinators
  */
 export const appendUrlParams: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (input: UrlParams.Input): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, input: UrlParams.Input): HttpClientRequest
 } = internal.appendUrlParams
 
@@ -279,7 +403,15 @@ export const appendUrlParams: {
  * @category combinators
  */
 export const setHash: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (hash: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, hash: string): HttpClientRequest
 } = internal.setHash
 
@@ -294,7 +426,15 @@ export const removeHash: (self: HttpClientRequest) => HttpClientRequest = intern
  * @category combinators
  */
 export const setBody: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (body: Body.HttpBody): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, body: Body.HttpBody): HttpClientRequest
 } = internal.setBody
 
@@ -303,7 +443,15 @@ export const setBody: {
  * @category combinators
  */
 export const bodyUint8Array: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (body: Uint8Array, contentType?: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, body: Uint8Array, contentType?: string): HttpClientRequest
 } = internal.bodyUint8Array
 
@@ -312,7 +460,15 @@ export const bodyUint8Array: {
  * @category combinators
  */
 export const bodyText: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (body: string, contentType?: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, body: string, contentType?: string): HttpClientRequest
 } = internal.bodyText
 
@@ -321,7 +477,15 @@ export const bodyText: {
  * @category combinators
  */
 export const bodyJson: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (body: unknown): (self: HttpClientRequest) => Effect.Effect<HttpClientRequest, Body.HttpBodyError>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, body: unknown): Effect.Effect<HttpClientRequest, Body.HttpBodyError>
 } = internal.bodyJson
 
@@ -330,7 +494,15 @@ export const bodyJson: {
  * @category combinators
  */
 export const bodyUnsafeJson: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (body: unknown): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, body: unknown): HttpClientRequest
 } = internal.bodyUnsafeJson
 
@@ -351,7 +523,15 @@ export const schemaBodyJson: <A, I, R>(
  * @category combinators
  */
 export const bodyUrlParams: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (input: UrlParams.Input): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, input: UrlParams.Input): HttpClientRequest
 } = internal.bodyUrlParams
 
@@ -360,7 +540,15 @@ export const bodyUrlParams: {
  * @category combinators
  */
 export const bodyFormData: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (body: FormData): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, body: FormData): HttpClientRequest
 } = internal.bodyFormData
 
@@ -369,10 +557,18 @@ export const bodyFormData: {
  * @category combinators
  */
 export const bodyStream: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     body: Stream.Stream<Uint8Array, unknown>,
     options?: { readonly contentType?: string | undefined; readonly contentLength?: number | undefined } | undefined
   ): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: HttpClientRequest,
     body: Stream.Stream<Uint8Array, unknown>,
@@ -385,10 +581,18 @@ export const bodyStream: {
  * @category combinators
  */
 export const bodyFile: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     path: string,
     options?: FileSystem.StreamOptions & { readonly contentType?: string }
   ): (self: HttpClientRequest) => Effect.Effect<HttpClientRequest, PlatformError.PlatformError, FileSystem.FileSystem>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: HttpClientRequest,
     path: string,
@@ -401,6 +605,14 @@ export const bodyFile: {
  * @category combinators
  */
 export const bodyFileWeb: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (file: Body.HttpBody.FileLike): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpClientRequest, file: Body.HttpBody.FileLike): HttpClientRequest
 } = internal.bodyFileWeb

package/src/HttpClientResponse.ts

@@ -50,6 +50,7 @@ export type TypeId = typeof TypeId
  */
 export interface HttpClientResponse extends IncomingMessage.HttpIncomingMessage<Error.ResponseError> {
   readonly [TypeId]: TypeId
+  readonly request: ClientRequest.HttpClientRequest
   readonly status: number
   readonly cookies: Cookies.Cookies
   readonly formData: Effect.Effect<FormData, Error.ResponseError>
@@ -109,6 +110,10 @@ export const stream: <E, R>(
  * @category pattern matching
  */
 export const matchStatus: {
+  /**
+   * @since 1.0.0
+   * @category pattern matching
+   */
   <
     const Cases extends {
       readonly [status: number]: (_: HttpClientResponse) => any
@@ -119,6 +124,10 @@ export const matchStatus: {
       readonly orElse: (_: HttpClientResponse) => any
     }
   >(cases: Cases): (self: HttpClientResponse) => Cases[keyof Cases] extends (_: any) => infer R ? Unify<R> : never
+  /**
+   * @since 1.0.0
+   * @category pattern matching
+   */
   <
     const Cases extends {
       readonly [status: number]: (_: HttpClientResponse) => any
@@ -130,3 +139,27 @@ export const matchStatus: {
     }
   >(self: HttpClientResponse, cases: Cases): Cases[keyof Cases] extends (_: any) => infer R ? Unify<R> : never
 } = internal.matchStatus
+
+/**
+ * @since 1.0.0
+ * @category filters
+ */
+export const filterStatus: {
+  /**
+   * @since 1.0.0
+   * @category filters
+   */
+  (f: (status: number) => boolean): (self: HttpClientResponse) => Effect.Effect<HttpClientResponse, Error.ResponseError>
+  /**
+   * @since 1.0.0
+   * @category filters
+   */
+  (self: HttpClientResponse, f: (status: number) => boolean): Effect.Effect<HttpClientResponse, Error.ResponseError>
+} = internal.filterStatus
+
+/**
+ * @since 1.0.0
+ * @category filters
+ */
+export const filterStatusOk: (self: HttpClientResponse) => Effect.Effect<HttpClientResponse, Error.ResponseError> =
+  internal.filterStatusOk

package/src/HttpIncomingMessage.ts

@@ -91,7 +91,15 @@ export const maxBodySize: FiberRef.FiberRef<Option.Option<FileSystem.Size>> = Gl
  * @category fiber refs
  */
 export const withMaxBodySize = dual<
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (size: Option.Option<FileSystem.SizeInput>) => <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>,
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, size: Option.Option<FileSystem.SizeInput>) => Effect.Effect<A, E, R>
 >(2, (effect, size) => Effect.locally(effect, maxBodySize, Option.map(size, FileSystem.Size)))
 

package/src/HttpMiddleware.ts

@@ -66,9 +66,17 @@ export const currentTracerDisabledWhen: FiberRef.FiberRef<Predicate.Predicate<Se
  * @category fiber refs
  */
 export const withTracerDisabledWhen: {
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (
     predicate: Predicate.Predicate<ServerRequest.HttpServerRequest>
   ): <A, E, R>(layer: Layer.Layer<A, E, R>) => Layer.Layer<A, E, R>
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(
     layer: Layer.Layer<A, E, R>,
     predicate: Predicate.Predicate<ServerRequest.HttpServerRequest>
@@ -80,9 +88,17 @@ export const withTracerDisabledWhen: {
  * @category fiber refs
  */
 export const withTracerDisabledWhenEffect: {
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (
     predicate: Predicate.Predicate<ServerRequest.HttpServerRequest>
   ): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(
     effect: Effect.Effect<A, E, R>,
     predicate: Predicate.Predicate<ServerRequest.HttpServerRequest>
@@ -94,7 +110,15 @@ export const withTracerDisabledWhenEffect: {
  * @category fiber refs
  */
 export const withTracerDisabledForUrls: {
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (urls: ReadonlyArray<string>): <A, E, R>(layer: Layer.Layer<A, E, R>) => Layer.Layer<A, E, R>
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(layer: Layer.Layer<A, E, R>, urls: ReadonlyArray<string>): Layer.Layer<A, E, R>
 } = internal.withTracerDisabledForUrls
 

package/src/HttpMultiplex.ts

@@ -58,10 +58,18 @@ export const make: <E, R>(
  * @category combinators
  */
 export const add: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2, E3, R3>(
     predicate: (request: ServerRequest.HttpServerRequest) => Effect.Effect<boolean, E2, R2>,
     app: App.Default<E3, R3>
   ): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E3 | E, R2 | R3 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2, E3, R3>(
     self: HttpMultiplex<E, R>,
     predicate: (request: ServerRequest.HttpServerRequest) => Effect.Effect<boolean, E2, R2>,
@@ -74,11 +82,19 @@ export const add: {
  * @category combinators
  */
 export const headerExact: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2>(
     header: string,
     value: string,
     app: App.Default<E2, R2>
   ): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E, R2 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(
     self: HttpMultiplex<E, R>,
     header: string,
@@ -92,11 +108,19 @@ export const headerExact: {
  * @category combinators
  */
 export const headerRegex: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2>(
     header: string,
     regex: RegExp,
     app: App.Default<E2, R2>
   ): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E, R2 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(
     self: HttpMultiplex<E, R>,
     header: string,
@@ -110,11 +134,19 @@ export const headerRegex: {
  * @category combinators
  */
 export const headerStartsWith: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2>(
     header: string,
     prefix: string,
     app: App.Default<E2, R2>
   ): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E, R2 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(
     self: HttpMultiplex<E, R>,
     header: string,
@@ -128,11 +160,19 @@ export const headerStartsWith: {
  * @category combinators
  */
 export const headerEndsWith: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2>(
     header: string,
     suffix: string,
     app: App.Default<E2, R2>
   ): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E, R2 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(
     self: HttpMultiplex<E, R>,
     header: string,
@@ -146,7 +186,15 @@ export const headerEndsWith: {
  * @category combinators
  */
 export const hostExact: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2>(host: string, app: App.Default<E2, R2>): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E, R2 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(self: HttpMultiplex<E, R>, host: string, app: App.Default<E2, R2>): HttpMultiplex<E | E2, R | R2>
 } = internal.hostExact
 
@@ -155,7 +203,15 @@ export const hostExact: {
  * @category combinators
  */
 export const hostRegex: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2>(regex: RegExp, app: App.Default<E2, R2>): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E, R2 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(self: HttpMultiplex<E, R>, regex: RegExp, app: App.Default<E2, R2>): HttpMultiplex<E | E2, R | R2>
 } = internal.hostRegex
 
@@ -164,7 +220,15 @@ export const hostRegex: {
  * @category combinators
  */
 export const hostStartsWith: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2>(prefix: string, app: App.Default<E2, R2>): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E, R2 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(self: HttpMultiplex<E, R>, prefix: string, app: App.Default<E2, R2>): HttpMultiplex<E | E2, R | R2>
 } = internal.hostStartsWith
 
@@ -173,6 +237,14 @@ export const hostStartsWith: {
  * @category combinators
  */
 export const hostEndsWith: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E2, R2>(suffix: string, app: App.Default<E2, R2>): <E, R>(self: HttpMultiplex<E, R>) => HttpMultiplex<E2 | E, R2 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(self: HttpMultiplex<E, R>, suffix: string, app: App.Default<E2, R2>): HttpMultiplex<E | E2, R | R2>
 } = internal.hostEndsWith