support undefined in http request schema apis (#3136)

Co-authored-by: Tim Smart <tim.smart@arisechurch.com>
Effect-TS · Jul 1, 2024 · 7f8900a · 7f8900a
1 parent a4982f6
commit 7f8900a
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 9 deletions.
diff --git a/.changeset/forty-crabs-turn.md b/.changeset/forty-crabs-turn.md
@@ -0,0 +1,5 @@
+---
+"@effect/platform": patch
+---
+
+support undefined in http request schema apis
diff --git a/packages/platform/src/HttpIncomingMessage.ts b/packages/platform/src/HttpIncomingMessage.ts
@@ -69,7 +69,7 @@ export const schemaBodyJsonScoped = <A, I, R>(schema: Schema.Schema<A, I, R>, op
  * @since 1.0.0
  * @category schema
  */
-export const schemaBodyUrlParams = <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaBodyUrlParams = <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -82,7 +82,7 @@ export const schemaBodyUrlParams = <A, I extends Readonly<Record<string, string>
  * @since 1.0.0
  * @category schema
  */
-export const schemaBodyUrlParamsScoped = <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaBodyUrlParamsScoped = <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -109,7 +109,7 @@ export const schemaHeaders = <A, I extends Readonly<Record<string, string | unde
  * @since 1.0.0
  * @category schema
  */
-export const schemaHeadersScoped = <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaHeadersScoped = <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {

diff --git a/packages/platform/src/HttpServerRequest.ts b/packages/platform/src/HttpServerRequest.ts
@@ -134,7 +134,7 @@ export const upgradeChannel: <IE = never>() => Channel<
  * @since 1.0.0
  * @category schema
  */
-export const schemaCookies: <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaCookies: <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, HttpServerRequest | R> = internal.schemaCookies
@@ -143,7 +143,7 @@ export const schemaCookies: <A, I extends Readonly<Record<string, string>>, R>(
  * @since 1.0.0
  * @category schema
  */
-export const schemaHeaders: <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaHeaders: <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, HttpServerRequest | R> = internal.schemaHeaders
@@ -183,7 +183,7 @@ export const schemaBodyForm: <A, I extends Partial<Multipart.Persisted>, R>(
  * @since 1.0.0
  * @category schema
  */
-export const schemaBodyUrlParams: <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaBodyUrlParams: <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError | Error.RequestError, R | HttpServerRequest> = internal.schemaBodyUrlParams

diff --git a/packages/platform/src/internal/httpServerRequest.ts b/packages/platform/src/internal/httpServerRequest.ts
@@ -63,7 +63,7 @@ export const searchParamsFromURL = (url: URL): ReadonlyRecord<string, string | A
 }
 
 /** @internal */
-export const schemaCookies = <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaCookies = <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -72,7 +72,7 @@ export const schemaCookies = <A, I extends Readonly<Record<string, string>>, R>(
 }
 
 /** @internal */
-export const schemaHeaders = <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaHeaders = <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {
@@ -118,7 +118,7 @@ export const schemaBodyForm = <A, I extends Partial<Multipart.Persisted>, R>(
 }
 
 /** @internal */
-export const schemaBodyUrlParams = <A, I extends Readonly<Record<string, string>>, R>(
+export const schemaBodyUrlParams = <A, I extends Readonly<Record<string, string | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {