@effect/platform 0.10.4 → 0.11.1

package/src/Http/ClientRequest.ts

@@ -0,0 +1,383 @@
+/**
+ * @since 1.0.0
+ */
+import type { Pipeable } from "@effect/data/Pipeable"
+import type * as Body from "@effect/platform/Http/Body"
+import type * as Error from "@effect/platform/Http/ClientError"
+import type * as Headers from "@effect/platform/Http/Headers"
+import type { Method } from "@effect/platform/Http/Method"
+import type * as UrlParams from "@effect/platform/Http/UrlParams"
+import * as internal from "@effect/platform/internal/http/clientRequest"
+import type * as Schema from "@effect/schema/Schema"
+import type * as Stream from "@effect/stream/Stream"
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export const TypeId = Symbol.for("@effect/platform/Http/ClientRequest")
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface ClientRequest extends Pipeable {
+  readonly [TypeId]: TypeId
+  readonly method: Method
+  readonly url: string
+  readonly urlParams: UrlParams.UrlParams
+  readonly headers: Headers.Headers
+  readonly body: Body.Body
+}
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const make: (
+  method: Method
+) => (
+  url: string,
+  options?: {
+    readonly url?: string
+    readonly urlParams?: UrlParams.Input
+    readonly headers?: Headers.Input
+    readonly body?: Body.Body
+    readonly accept?: string
+    readonly acceptJson?: boolean
+  }
+) => ClientRequest = internal.make
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const get: (
+  url: string,
+  options?: {
+    readonly url?: string
+    readonly urlParams?: UrlParams.Input
+    readonly headers?: Headers.Input
+    readonly accept?: string
+    readonly acceptJson?: boolean
+  }
+) => ClientRequest = internal.get
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const post: (
+  url: string,
+  options?: {
+    readonly url?: string
+    readonly urlParams?: UrlParams.Input
+    readonly headers?: Headers.Input
+    readonly body?: Body.Body
+    readonly accept?: string
+    readonly acceptJson?: boolean
+  }
+) => ClientRequest = internal.post
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const patch: (
+  url: string,
+  options?: {
+    readonly url?: string
+    readonly urlParams?: UrlParams.Input
+    readonly headers?: Headers.Input
+    readonly body?: Body.Body
+    readonly accept?: string
+    readonly acceptJson?: boolean
+  }
+) => ClientRequest = internal.patch
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const put: (
+  url: string,
+  options?: {
+    readonly url?: string
+    readonly urlParams?: UrlParams.Input
+    readonly headers?: Headers.Input
+    readonly body?: Body.Body
+    readonly accept?: string
+    readonly acceptJson?: boolean
+  }
+) => ClientRequest = internal.put
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const del: (
+  url: string,
+  options?: {
+    readonly url?: string
+    readonly urlParams?: UrlParams.Input
+    readonly headers?: Headers.Input
+    readonly accept?: string
+    readonly acceptJson?: boolean
+  }
+) => ClientRequest = internal.del
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const head: (
+  url: string,
+  options?: {
+    readonly url?: string
+    readonly urlParams?: UrlParams.Input
+    readonly headers?: Headers.Input
+    readonly accept?: string
+    readonly acceptJson?: boolean
+  }
+) => ClientRequest = internal.head
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const options: (
+  url: string,
+  options?: {
+    readonly url?: string
+    readonly urlParams?: UrlParams.Input
+    readonly headers?: Headers.Input
+    readonly accept?: string
+    readonly acceptJson?: boolean
+  }
+) => ClientRequest = internal.options
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const modify: {
+  (
+    options: {
+      readonly method?: Method
+      readonly url?: string
+      readonly urlParams?: UrlParams.Input
+      readonly headers?: Headers.Input
+      readonly body?: Body.Body
+      readonly accept?: string
+      readonly acceptJson?: boolean
+    }
+  ): (self: ClientRequest) => ClientRequest
+  (
+    self: ClientRequest,
+    options: {
+      readonly method?: Method
+      readonly url?: string
+      readonly urlParams?: UrlParams.Input
+      readonly headers?: Headers.Input
+      readonly body?: Body.Body
+      readonly accept?: string
+      readonly acceptJson?: boolean
+    }
+  ): ClientRequest
+} = internal.modify
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setMethod: {
+  (method: Method): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, method: Method): ClientRequest
+} = internal.setMethod
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setHeader: {
+  (key: string, value: string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, key: string, value: string): ClientRequest
+} = internal.setHeader
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setHeaders: {
+  (input: Headers.Input): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, input: Headers.Input): ClientRequest
+} = internal.setHeaders
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const basicAuth: {
+  (username: string, password: string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, username: string, password: string): ClientRequest
+} = internal.basicAuth
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const accept: {
+  (mediaType: string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, mediaType: string): ClientRequest
+} = internal.accept
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const acceptJson: (self: ClientRequest) => ClientRequest = internal.acceptJson
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setUrl: {
+  (url: string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, url: string): ClientRequest
+} = internal.setUrl
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const prependUrl: {
+  (path: string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, path: string): ClientRequest
+} = internal.prependUrl
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const appendUrl: {
+  (path: string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, path: string): ClientRequest
+} = internal.appendUrl
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const updateUrl: {
+  (f: (url: string) => string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, f: (url: string) => string): ClientRequest
+} = internal.updateUrl
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setUrlParam = internal.setUrlParam
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setUrlParams = internal.setUrlParams
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const appendUrlParam = internal.appendUrlParam
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const appendUrlParams = internal.appendUrlParams
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setBody: {
+  (body: Body.Body): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, body: Body.Body): ClientRequest
+} = internal.setBody
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const binaryBody: {
+  (body: Uint8Array, contentType?: string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, body: Uint8Array, contentType?: string): ClientRequest
+} = internal.binaryBody
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const textBody: {
+  (body: string, contentType?: string): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, body: string, contentType?: string): ClientRequest
+} = internal.textBody
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const jsonBody: {
+  (body: unknown): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, body: string): ClientRequest
+} = internal.jsonBody
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const schemaBody: <I, A>(schema: Schema.Schema<I, A>) => {
+  (body: A): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, body: A): ClientRequest
+} = internal.schemaBody
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const urlParamsBody: {
+  (input: UrlParams.Input): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, input: UrlParams.Input): ClientRequest
+} = internal.urlParamsBody
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const formDataBody: {
+  (body: FormData): (self: ClientRequest) => ClientRequest
+  (self: ClientRequest, body: FormData): ClientRequest
+} = internal.formDataBody
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const streamBody: {
+  (
+    body: Stream.Stream<never, Error.RequestError, Uint8Array>,
+    options?: { readonly contentType?: string; readonly contentLength?: number }
+  ): (self: ClientRequest) => ClientRequest
+  (
+    self: ClientRequest,
+    body: Stream.Stream<never, Error.RequestError, Uint8Array>,
+    options?: { readonly contentType?: string; readonly contentLength?: number }
+  ): ClientRequest
+} = internal.streamBody

package/src/Http/ClientResponse.ts

@@ -0,0 +1,42 @@
+/**
+ * @since 1.0.0
+ */
+import type * as Error from "@effect/platform/Http/ClientError"
+import type * as ClientRequest from "@effect/platform/Http/ClientRequest"
+import type * as IncomingMessage from "@effect/platform/Http/IncomingMessage"
+import * as internal from "@effect/platform/internal/http/clientResponse"
+
+export {
+  /**
+   * @since 1.0.0
+   * @category schema
+   */
+  parseSchema
+} from "@effect/platform/Http/IncomingMessage"
+
+/**
+ * @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 ClientResponse extends IncomingMessage.IncomingMessage<Error.ResponseError> {
+  readonly [TypeId]: TypeId
+  readonly status: number
+}
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const fromWeb: (request: ClientRequest.ClientRequest, source: Response) => ClientResponse = internal.fromWeb

package/src/Http/FormData.ts

@@ -0,0 +1,61 @@
+/**
+ * @since 1.0.0
+ */
+import type * as Error from "@effect/platform/Http/ClientError"
+import type * as Stream from "@effect/stream/Stream"
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export const TypeId = Symbol.for("@effect/platform/Http/FormData")
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type Part = Field | File
+
+/**
+ * @since 1.0.0
+ */
+export namespace Part {
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  export interface Proto {
+    readonly [TypeId]: TypeId
+    readonly _tag: string
+  }
+}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface Field extends Part.Proto {
+  readonly _tag: "FormDataField"
+  readonly key: string
+  readonly contentType: string
+  readonly value: string
+}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface File extends Part.Proto {
+  readonly _tag: "File"
+  readonly key: string
+  readonly name: string
+  readonly contentType: string
+  readonly content: Stream.Stream<never, Error.RequestError, Uint8Array>
+  readonly source?: unknown
+}

package/src/Http/Headers.ts

@@ -0,0 +1,69 @@
+/**
+ * @since 1.0.0
+ */
+import { dual } from "@effect/data/Function"
+import * as HashMap from "@effect/data/HashMap"
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface Headers extends HashMap.HashMap<string, string> {}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type Input = Headers | Readonly<Record<string, string>> | Iterable<readonly [string, string]>
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const empty: Headers = HashMap.empty()
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const fromInput: (input?: Input) => Headers = (input) => {
+  if (input === undefined) {
+    return empty
+  } else if (HashMap.isHashMap(input)) {
+    return input
+  } else if (Symbol.iterator in input) {
+    return HashMap.fromIterable([...input].map(([k, v]) => [k.toLowerCase(), v])) as Headers
+  }
+  return HashMap.fromIterable(Object.entries(input).map(([k, v]) => [k.toLowerCase(), v]))
+}
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const set = dual<
+  (key: string, value: string) => (self: Headers) => Headers,
+  (self: Headers, key: string, value: string) => Headers
+>(3, (self, key, value) => HashMap.set(self, key.toLowerCase(), value))
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setAll = dual<
+  (headers: Input) => (self: Headers) => Headers,
+  (self: Headers, headers: Input) => Headers
+>(2, (self, headers) =>
+  HashMap.union(
+    self,
+    fromInput(headers)
+  ))
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const remove = dual<
+  (key: string) => (self: Headers) => Headers,
+  (self: Headers, key: string) => Headers
+>(2, (self, key) => HashMap.remove(self, key.toLowerCase()))

package/src/Http/IncomingMessage.ts

@@ -0,0 +1,45 @@
+/**
+ * @since 1.0.0
+ */
+import * as Effect from "@effect/io/Effect"
+import type * as Headers from "@effect/platform/Http/Headers"
+import type * as ParseResult from "@effect/schema/ParseResult"
+import * as Schema from "@effect/schema/Schema"
+import type * as Stream from "@effect/stream/Stream"
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export const TypeId = Symbol.for("@effect/platform/Http/IncomingMessage")
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface IncomingMessage<E> {
+  readonly [TypeId]: TypeId
+  readonly headers: Headers.Headers
+  readonly json: Effect.Effect<never, E, unknown>
+  readonly text: Effect.Effect<never, E, string>
+  readonly blob: Effect.Effect<never, E, Blob>
+  readonly formData: Effect.Effect<never, E, FormData>
+  // readonly formDataStream: Stream.Stream<never, Error.TransportError, FormData.Part>
+  readonly stream: Stream.Stream<never, E, Uint8Array>
+}
+
+/**
+ * @since 1.0.0
+ * @category schema
+ */
+export const parseSchema = <I, A>(schema: Schema.Schema<I, A>) => {
+  const parse = Schema.parse(schema)
+  return <E>(self: IncomingMessage<E>): Effect.Effect<never, E | ParseResult.ParseError, A> =>
+    Effect.flatMap(self.json, parse)
+}

package/src/Http/Method.ts

@@ -0,0 +1,17 @@
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type Method =
+  | "GET"
+  | "POST"
+  | "PUT"
+  | "DELETE"
+  | "PATCH"
+  | "HEAD"
+  | "OPTIONS"
+
+/**
+ * @since 1.0.0
+ */
+export const hasBody = (method: Method): boolean => method !== "GET" && method !== "HEAD"