use branded type for Headers (#359)

.changeset/four-scissors-tie.md

@@ -0,0 +1,6 @@
+---
+"@effect/platform-node": patch
+"@effect/platform": patch
+---
+
+use branded type for Headers

.changeset/many-rats-notice.md

@@ -0,0 +1,6 @@
+---
+"@effect/platform-node": patch
+"@effect/platform": patch
+---
+
+change UrlParams to ReadonlyArray

docs/platform/Http/Headers.ts.md

@@ -15,15 +15,20 @@ Added in v1.0.0
 - [combinators](#combinators)
   - [get](#get)
   - [has](#has)
+  - [merge](#merge)
   - [remove](#remove)
   - [set](#set)
   - [setAll](#setall)
 - [constructors](#constructors)
   - [empty](#empty)
   - [fromInput](#frominput)
+  - [unsafeFromRecord](#unsafefromrecord)
 - [models](#models)
-  - [Headers (interface)](#headers-interface)
+  - [Headers (type alias)](#headers-type-alias)
   - [Input (type alias)](#input-type-alias)
+- [type ids](#type-ids)
+  - [HeadersTypeId](#headerstypeid)
+  - [HeadersTypeId (type alias)](#headerstypeid-type-alias)
 
 ---
 
@@ -52,6 +57,19 @@ export declare const has: { (key: string): (self: Headers) => boolean; (self: He
 
 Added in v1.0.0
 
+## merge
+
+**Signature**
+
+```ts
+export declare const merge: {
+  (headers: Headers): (self: Headers) => Headers
+  (self: Headers, headers: Headers): Headers
+}
+```
+
+Added in v1.0.0
+
 ## remove
 
 **Signature**
@@ -107,14 +125,24 @@ export declare const fromInput: (input?: Input) => Headers
 
 Added in v1.0.0
 
+## unsafeFromRecord
+
+**Signature**
+
+```ts
+export declare const unsafeFromRecord: (input: ReadonlyRecord.ReadonlyRecord<string>) => Headers
+```
+
+Added in v1.0.0
+
 # models
 
-## Headers (interface)
+## Headers (type alias)
 
 **Signature**
 
 ```ts
-export interface Headers extends ReadonlyRecord.ReadonlyRecord<string> {}
+export type Headers = Brand.Branded<ReadonlyRecord.ReadonlyRecord<string>, HeadersTypeId>
 ```
 
 Added in v1.0.0
@@ -124,7 +152,29 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export type Input = Headers | Iterable<readonly [string, string]>
+export type Input = ReadonlyRecord.ReadonlyRecord<string> | Iterable<readonly [string, string]>
+```
+
+Added in v1.0.0
+
+# type ids
+
+## HeadersTypeId
+
+**Signature**
+
+```ts
+export declare const HeadersTypeId: typeof HeadersTypeId
+```
+
+Added in v1.0.0
+
+## HeadersTypeId (type alias)
+
+**Signature**
+
+```ts
+export type HeadersTypeId = typeof HeadersTypeId
 ```
 
 Added in v1.0.0

docs/platform/Http/Platform.ts.md

@@ -36,7 +36,7 @@ export declare const make: (impl: {
     path: string,
     status: number,
     statusText: string | undefined,
-    headers: Record<string, string>,
+    headers: Headers.Headers,
     start: number,
     end: number | undefined,
     contentLength: number
@@ -45,7 +45,7 @@ export declare const make: (impl: {
     file: Body.Body.FileLike,
     status: number,
     statusText: string | undefined,
-    headers: Record<string, string>,
+    headers: Headers.Headers,
     options?: FileSystem.StreamOptions | undefined
   ) => ServerResponse.ServerResponse
 }) => Effect.Effect<FileSystem.FileSystem | Etag.Generator, never, Platform>

docs/platform/Http/UrlParams.ts.md

@@ -149,7 +149,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export type Input = UrlParams | Readonly<Record<string, string>> | Iterable<readonly [string, string]> | URLSearchParams
+export type Input = Readonly<Record<string, string>> | Iterable<readonly [string, string]> | URLSearchParams
 ```
 
 Added in v1.0.0
@@ -159,7 +159,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export interface UrlParams extends Chunk.Chunk<[string, string]> {}
+export interface UrlParams extends ReadonlyArray<readonly [string, string]> {}
 ```
 
 Added in v1.0.0

packages/platform-node/src/internal/http/platform.ts

@@ -1,3 +1,4 @@
+import * as Headers from "@effect/platform/Http/Headers"
 import * as Platform from "@effect/platform/Http/Platform"
 import * as ServerResponse from "@effect/platform/Http/ServerResponse"
 import { pipe } from "effect/Function"
@@ -24,11 +25,13 @@ export const make = Platform.make({
   },
   fileWebResponse(file, status, statusText, headers, _options) {
     return ServerResponse.raw(Readable.fromWeb(file.stream() as any), {
-      headers: {
-        ...headers,
-        "content-type": headers["content-type"] ?? Mime.getType(file.name) ?? "application/octet-stream",
-        "content-length": file.size.toString()
-      },
+      headers: Headers.merge(
+        headers,
+        Headers.unsafeFromRecord({
+          "content-type": headers["content-type"] ?? Mime.getType(file.name) ?? "application/octet-stream",
+          "content-length": file.size.toString()
+        })
+      ),
       status,
       statusText
     })

packages/platform/src/Http/Headers.ts

@@ -1,28 +1,41 @@
 /**
  * @since 1.0.0
  */
+import type * as Brand from "effect/Brand"
 import { dual } from "effect/Function"
 import type * as Option from "effect/Option"
 import * as ReadonlyArray from "effect/ReadonlyArray"
 import * as ReadonlyRecord from "effect/ReadonlyRecord"
 
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export const HeadersTypeId = Symbol.for("@effect/platform/Http/Headers")
+
+/**
+ * @since 1.0.0
+ * @category type ids
+ */
+export type HeadersTypeId = typeof HeadersTypeId
+
 /**
  * @since 1.0.0
  * @category models
  */
-export interface Headers extends ReadonlyRecord.ReadonlyRecord<string> {}
+export type Headers = Brand.Branded<ReadonlyRecord.ReadonlyRecord<string>, HeadersTypeId>
 
 /**
  * @since 1.0.0
  * @category models
  */
-export type Input = Headers | Iterable<readonly [string, string]>
+export type Input = ReadonlyRecord.ReadonlyRecord<string> | Iterable<readonly [string, string]>
 
 /**
  * @since 1.0.0
  * @category constructors
  */
-export const empty: Headers = ReadonlyRecord.empty()
+export const empty: Headers = Object.create(null) as Headers
 
 /**
  * @since 1.0.0
@@ -35,13 +48,19 @@ export const fromInput: (input?: Input) => Headers = (input) => {
     return ReadonlyRecord.fromEntries(ReadonlyArray.map(
       ReadonlyArray.fromIterable(input),
       ([k, v]) => [k.toLowerCase(), v] as const
-    ))
+    )) as Headers
   }
   return ReadonlyRecord.fromEntries(
     Object.entries(input).map(([k, v]) => [k.toLowerCase(), v])
-  )
+  ) as Headers
 }
 
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const unsafeFromRecord = (input: ReadonlyRecord.ReadonlyRecord<string>): Headers => input as Headers
+
 /**
  * @since 1.0.0
  * @category combinators
@@ -96,6 +115,21 @@ export const setAll: {
   ...fromInput(headers)
 }))
 
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const merge: {
+  (headers: Headers): (self: Headers) => Headers
+  (self: Headers, headers: Headers): Headers
+} = dual<
+  (headers: Headers) => (self: Headers) => Headers,
+  (self: Headers, headers: Headers) => Headers
+>(2, (self, headers) => ({
+  ...self,
+  ...headers
+}))
+
 /**
  * @since 1.0.0
  * @category combinators
@@ -106,4 +140,4 @@ export const remove: {
 } = dual<
   (key: string) => (self: Headers) => Headers,
   (self: Headers, key: string) => Headers
->(2, (self, key) => ReadonlyRecord.remove(self, key.toLowerCase()))
+>(2, (self, key) => ReadonlyRecord.remove(self, key.toLowerCase()) as Headers)

packages/platform/src/Http/Platform.ts

@@ -8,6 +8,7 @@ import type * as FileSystem from "../FileSystem.js"
 import * as internal from "../internal/http/platform.js"
 import type * as Body from "./Body.js"
 import type * as Etag from "./Etag.js"
+import type * as Headers from "./Headers.js"
 import type * as ServerResponse from "./ServerResponse.js"
 
 /**
@@ -54,7 +55,7 @@ export const make: (
       path: string,
       status: number,
       statusText: string | undefined,
-      headers: Record<string, string>,
+      headers: Headers.Headers,
       start: number,
       end: number | undefined,
       contentLength: number
@@ -63,7 +64,7 @@ export const make: (
       file: Body.Body.FileLike,
       status: number,
       statusText: string | undefined,
-      headers: Record<string, string>,
+      headers: Headers.Headers,
       options?: FileSystem.StreamOptions | undefined
     ) => ServerResponse.ServerResponse
   }