@effect/platform 0.72.1 → 0.73.0

package/src/HttpApiEndpoint.ts

@@ -33,6 +33,15 @@ export type TypeId = typeof TypeId
  */
 export const isHttpApiEndpoint = (u: unknown): u is HttpApiEndpoint<any, any, any> => Predicate.hasProperty(u, TypeId)
 
+/**
+ * Represents a path segment. A path segment is a string that represents a
+ * segment of a URL path.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export type PathSegment = `/${string}`
+
 /**
  * Represents an API endpoint. An API endpoint is mapped to a single route on
  * the underlying `HttpRouter`.
@@ -54,7 +63,7 @@ export interface HttpApiEndpoint<
 > extends Pipeable {
   readonly [TypeId]: TypeId
   readonly name: Name
-  readonly path: HttpRouter.PathInput
+  readonly path: PathSegment
   readonly method: Method
   readonly pathSchema: Option.Option<Schema.Schema<Path, unknown, R>>
   readonly urlParamsSchema: Option.Option<Schema.Schema<UrlParams, unknown, R>>
@@ -194,7 +203,7 @@ export interface HttpApiEndpoint<
    * Add a prefix to the path of the endpoint.
    */
   prefix(
-    prefix: HttpRouter.PathInput
+    prefix: PathSegment
   ): HttpApiEndpoint<Name, Method, Path, UrlParams, Payload, Headers, Success, Error, R, RE>
 
   /**
@@ -743,10 +752,10 @@ const Proto = {
       headersSchema: Option.some(schema)
     })
   },
-  prefix(this: HttpApiEndpoint.AnyWithProps, prefix: HttpRouter.PathInput) {
+  prefix(this: HttpApiEndpoint.AnyWithProps, prefix: PathSegment) {
     return makeProto({
       ...this,
-      path: HttpRouter.prefixPath(this.path, prefix) as HttpRouter.PathInput
+      path: HttpRouter.prefixPath(this.path, prefix) as PathSegment
     })
   },
   middleware(this: HttpApiEndpoint.AnyWithProps, middleware: HttpApiMiddleware.TagClassAny) {
@@ -783,7 +792,7 @@ const makeProto = <
   RE
 >(options: {
   readonly name: Name
-  readonly path: HttpRouter.PathInput
+  readonly path: PathSegment
   readonly method: Method
   readonly pathSchema: Option.Option<Schema.Schema<Path, unknown, R>>
   readonly urlParamsSchema: Option.Option<Schema.Schema<UrlParams, unknown, R>>
@@ -802,9 +811,9 @@ const makeProto = <
  */
 export const make = <Method extends HttpMethod>(method: Method): {
   <const Name extends string>(name: Name): HttpApiEndpoint.Constructor<Name, Method>
-  <const Name extends string>(name: Name, path: HttpRouter.PathInput): HttpApiEndpoint<Name, Method>
+  <const Name extends string>(name: Name, path: PathSegment): HttpApiEndpoint<Name, Method>
 } =>
-  ((name: string, ...args: [HttpRouter.PathInput]) => {
+  ((name: string, ...args: [PathSegment]) => {
     if (args.length === 1) {
       return makeProto({
         name,
@@ -821,7 +830,7 @@ export const make = <Method extends HttpMethod>(method: Method): {
       })
     }
     return (segments: TemplateStringsArray, ...schemas: ReadonlyArray<HttpApiSchema.AnyString>) => {
-      let path = segments[0] as HttpRouter.PathInput
+      let path = segments[0] as PathSegment
       let pathSchema = Option.none<Schema.Schema.Any>()
       if (schemas.length > 0) {
         const obj: Record<string, Schema.Schema.Any> = {}
@@ -863,7 +872,7 @@ export const get: {
    * @since 1.0.0
    * @category constructors
    */
-  <const Name extends string>(name: Name, path: HttpRouter.PathInput): HttpApiEndpoint<Name, "GET">
+  <const Name extends string>(name: Name, path: PathSegment): HttpApiEndpoint<Name, "GET">
 } = make("GET")
 
 /**
@@ -880,7 +889,7 @@ export const post: {
    * @since 1.0.0
    * @category constructors
    */
-  <const Name extends string>(name: Name, path: HttpRouter.PathInput): HttpApiEndpoint<Name, "POST">
+  <const Name extends string>(name: Name, path: PathSegment): HttpApiEndpoint<Name, "POST">
 } = make("POST")
 
 /**
@@ -897,7 +906,7 @@ export const put: {
    * @since 1.0.0
    * @category constructors
    */
-  <const Name extends string>(name: Name, path: HttpRouter.PathInput): HttpApiEndpoint<Name, "PUT">
+  <const Name extends string>(name: Name, path: PathSegment): HttpApiEndpoint<Name, "PUT">
 } = make("PUT")
 
 /**
@@ -914,7 +923,7 @@ export const patch: {
    * @since 1.0.0
    * @category constructors
    */
-  <const Name extends string>(name: Name, path: HttpRouter.PathInput): HttpApiEndpoint<Name, "PATCH">
+  <const Name extends string>(name: Name, path: PathSegment): HttpApiEndpoint<Name, "PATCH">
 } = make(
   "PATCH"
 )
@@ -933,7 +942,7 @@ export const del: {
    * @since 1.0.0
    * @category constructors
    */
-  <const Name extends string>(name: Name, path: HttpRouter.PathInput): HttpApiEndpoint<Name, "DELETE">
+  <const Name extends string>(name: Name, path: PathSegment): HttpApiEndpoint<Name, "DELETE">
 } = make(
   "DELETE"
 )

package/src/HttpApiGroup.ts

@@ -10,7 +10,6 @@ import type * as HttpApiEndpoint from "./HttpApiEndpoint.js"
 import type { HttpApiDecodeError } from "./HttpApiError.js"
 import type * as HttpApiMiddleware from "./HttpApiMiddleware.js"
 import * as HttpApiSchema from "./HttpApiSchema.js"
-import type { PathInput } from "./HttpRouter.js"
 
 /**
  * @since 1.0.0
@@ -77,7 +76,7 @@ export interface HttpApiGroup<
    * Add a path prefix to all endpoints in an `HttpApiGroup`. Note that this will only
    * add the prefix to the endpoints before this api is called.
    */
-  prefix(prefix: PathInput): HttpApiGroup<Id, Endpoints, Error, R, TopLevel>
+  prefix(prefix: HttpApiEndpoint.PathSegment): HttpApiGroup<Id, Endpoints, Error, R, TopLevel>
 
   /**
    * Add an `HttpApiMiddleware` to the `HttpApiGroup`.
@@ -315,7 +314,7 @@ const Proto = {
       middlewares: this.middlewares
     })
   },
-  prefix(this: HttpApiGroup.AnyWithProps, prefix: PathInput) {
+  prefix(this: HttpApiGroup.AnyWithProps, prefix: HttpApiEndpoint.PathSegment) {
     return makeProto({
       identifier: this.identifier,
       topLevel: this.topLevel,

package/src/HttpApiSchema.ts

@@ -180,6 +180,38 @@ export const getStatusErrorAST = (ast: AST.AST): number => getStatus(ast, 500)
  */
 export const getStatusError = <A extends Schema.Schema.All>(self: A): number => getStatusErrorAST(self.ast)
 
+/**
+ * Extracts all individual types from a union type recursively.
+ *
+ * **Details**
+ *
+ * This function traverses an AST and collects all the types within a union,
+ * even if they are nested. It ensures that every type in a union (including
+ * deeply nested unions) is included in the resulting array. The returned array
+ * contains each type as an individual AST node, preserving the order in which
+ * they appear.
+ *
+ * @internal
+ */
+export const extractUnionTypes = (ast: AST.AST): ReadonlyArray<AST.AST> => {
+  function process(ast: AST.AST): void {
+    if (AST.isUnion(ast)) {
+      for (const type of ast.types) {
+        process(type)
+      }
+    } else {
+      out.push(ast)
+    }
+  }
+  const out: Array<AST.AST> = []
+  process(ast)
+  return out
+}
+
+/** @internal */
+export const UnionUnifyAST = (self: AST.AST, that: AST.AST): AST.AST =>
+  AST.Union.make(Array.from(new Set<AST.AST>([...extractUnionTypes(self), ...extractUnionTypes(that)])))
+
 /**
  * @since 1.0.0
  */
@@ -187,14 +219,7 @@ export const UnionUnify = <A extends Schema.Schema.All, B extends Schema.Schema.
   A["Type"] | B["Type"],
   A["Encoded"] | B["Encoded"],
   A["Context"] | B["Context"]
-> => {
-  return Schema.make(AST.Union.make(Array.from(
-    new Set<AST.AST>([
-      ...(self.ast._tag === "Union" ? self.ast.types : [self.ast]),
-      ...(that.ast._tag === "Union" ? that.ast.types : [that.ast])
-    ])
-  )))
-}
+> => Schema.make(UnionUnifyAST(self.ast, that.ast))
 
 type Void$ = typeof Schema.Void
 

package/src/HttpApiSecurity.ts

@@ -113,6 +113,8 @@ export const bearer: Bearer = Object.assign(Object.create(Proto), {
  * To set the correct cookie in a handler, you can use
  * `HttpApiBuilder.securitySetCookie`.
  *
+ * The default value for `in` is "header".
+ *
  * @since 1.0.0
  * @category constructors
  */