effect-app 4.0.0-beta.17 → 4.0.0-beta.170

package/src/Schema.ts

@@ -1,22 +1,19 @@
-import { Array, Option, pipe, SchemaAST, type Tracer } from "effect"
+import { SchemaAST, type Tracer } from "effect"
 import * as S from "effect/Schema"
 import type { NonEmptyReadonlyArray } from "./Array.js"
 import { fakerArb } from "./faker.js"
 import { Email as EmailT, type Email as EmailType } from "./Schema/email.js"
-import { withDefaultMake } from "./Schema/ext.js"
+import { concurrencyUnbounded, withDefaultMake, withDefaultParseOptions } from "./Schema/ext.js"
 import { PhoneNumber as PhoneNumberT, type PhoneNumber as PhoneNumberType } from "./Schema/phoneNumber.js"
-import type { AST } from "./Schema/schema.js"
-import { extendM } from "./utils.js"
+import { copy, extendM, type StructuralCopyOrigin } from "./utils.js"
 
 export * from "effect/Schema"
-// v4: TaggedError renamed to TaggedErrorClass
-export { TaggedErrorClass as TaggedError } from "effect/Schema"
 
 export * from "./Schema/Class.js"
-export { Class, TaggedClass } from "./Schema/Class.js"
+export { Class, ErrorClass, Opaque, TaggedClass, TaggedErrorClass } from "./Schema/Class.js"
 
 export { fromBrand, nominal } from "./Schema/brand.js"
-export { Array, Boolean, Date, Literal, Map, NullOr, Number, ReadonlyMap, ReadonlySet } from "./Schema/ext.js"
+export { Array, Boolean, Date, DateFromString, DateValid, Finite, Literals, NullOr, Number, ReadonlyMap, ReadonlySet } from "./Schema/ext.js"
 export { Int, NonNegativeInt } from "./Schema/numbers.js"
 
 export * from "./Schema/email.js"
@@ -25,14 +22,153 @@ export * from "./Schema/moreStrings.js"
 export * from "./Schema/numbers.js"
 export * from "./Schema/phoneNumber.js"
 export * from "./Schema/schema.js"
+export * from "./Schema/SpecialJsonSchema.js"
+export * from "./Schema/SpecialOpenApi.js"
 export * from "./Schema/strings.js"
 export { NonEmptyString } from "./Schema/strings.js"
 
 export * as SchemaIssue from "effect/SchemaIssue"
-export * as SchemaParser from "effect/SchemaParser"
+
+export const decodeEffectConcurrently: typeof S.decodeEffect = withDefaultParseOptions(S.decodeEffect)
+export const decodeUnknownEffectConcurrently: typeof S.decodeUnknownEffect = withDefaultParseOptions(
+  S.decodeUnknownEffect
+)
+export * as SchemaParser from "./Schema/SchemaParser.js"
 
 export { Void as Void_ } from "effect/Schema"
 
+// ---------------------------------------------------------------------------
+// Struct / NonEmptyArray / Record
+// ---------------------------------------------------------------------------
+
+type WithSchemaCopy<Self extends S.Top & { readonly Type: object }> = Self & {
+  readonly copy: StructuralCopyOrigin<Self["Type"]>
+}
+
+type OptionalMakeInput<Fields extends S.Struct.Fields> = {} extends S.Struct.MakeIn<Fields> ? {
+    make(input?: S.Struct.MakeIn<Fields>, options?: S.MakeOptions): S.Struct.Type<Fields>
+  }
+  : {}
+
+export function Struct<const Fields extends S.Struct.Fields>(
+  fields: Fields
+): Struct<Fields> & OptionalMakeInput<Fields> {
+  const result = S.Struct(fields).annotate(concurrencyUnbounded)
+  const allowVoidMake = (schema: any): any => {
+    // Normalize omitted input to an empty object so optional/default-only structs can be constructed with make().
+    const origMake: any = schema.make
+    const origMakeOption: any = schema.makeOption
+    const origMakeEffect: any = schema.makeEffect
+    schema.make = function(this: any, input: any, options?: any) {
+      return origMake.call(this, input === undefined ? {} : input, options)
+    }
+    schema.makeOption = function(this: any, input: any, options?: any) {
+      return origMakeOption.call(this, input === undefined ? {} : input, options)
+    }
+    schema.makeEffect = function(this: any, input: any, options?: any) {
+      return origMakeEffect.call(this, input === undefined ? {} : input, options)
+    }
+    return schema
+  }
+  // eslint-disable-next-line @typescript-eslint/unbound-method, @typescript-eslint/no-unsafe-assignment
+  const origMapFields: any = result.mapFields
+  // eslint-disable-next-line @typescript-eslint/unbound-method, @typescript-eslint/no-unsafe-assignment
+  const origAnnotate: any = result.annotate
+  // eslint-disable-next-line @typescript-eslint/unbound-method, @typescript-eslint/no-unsafe-assignment
+  const origAnnotateKey: any = result.annotateKey
+
+  const preserveCopyAndMethods = (schema: any): any => {
+    schema.copy = copy
+    schema.mapFields = function(this: any, f: any, options?: any) {
+      return (result as any).mapFields.call(this, f, options)
+    }
+    schema.annotate = function(this: any, annotations?: any) {
+      return (result as any).annotate.call(this, annotations)
+    }
+    schema.annotateKey = function(this: any, annotations?: any) {
+      return (result as any).annotateKey.call(this, annotations)
+    }
+    return allowVoidMake(schema)
+  }
+  ;(result as any).mapFields = function(this: any, f: any, options?: any) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    const mapped = origMapFields.call(this, f, options).annotate(concurrencyUnbounded)
+    return preserveCopyAndMethods(mapped)
+  }
+  ;(result as any).annotate = function(this: any, annotations?: any) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    const annotated = origAnnotate.call(this, annotations)
+    return preserveCopyAndMethods(annotated)
+  }
+  ;(result as any).annotateKey = function(this: any, annotations?: any) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    const annotated = origAnnotateKey.call(this, annotations)
+    return preserveCopyAndMethods(annotated)
+  }
+  ;(result as any).copy = copy
+  allowVoidMake(result)
+  return result as Struct<Fields> & OptionalMakeInput<Fields>
+}
+export interface Struct<Fields extends S.Struct.Fields> extends WithSchemaCopy<S.Struct<Fields>> {
+  annotate(
+    annotations: S.Annotations.Bottom<S.Struct.Type<Fields>, S.Struct<Fields>["~type.parameters"]>
+  ): Struct<Fields>
+  annotateKey(annotations: S.Annotations.Key<S.Struct.Type<Fields>>): Struct<Fields>
+  mapFields<To extends S.Struct.Fields>(
+    f: (fields: Fields) => To,
+    options?: {
+      readonly unsafePreserveChecks?: boolean | undefined
+    }
+  ): Struct<Readonly<To>>
+}
+export declare namespace Struct {
+  export type Fields = S.Struct.Fields
+  export type Type<F extends S.Struct.Fields> = S.Struct.Type<F>
+  export type Encoded<F extends S.Struct.Fields> = S.Struct.Encoded<F>
+  export type DecodingServices<F extends S.Struct.Fields> = S.Struct.DecodingServices<F>
+  export type EncodingServices<F extends S.Struct.Fields> = S.Struct.EncodingServices<F>
+  export type MakeIn<F extends S.Struct.Fields> = S.Struct.MakeIn<F>
+  export type Iso<F extends S.Struct.Fields> = S.Struct.Iso<F>
+}
+
+export type StructNestedEncodedError<T> = {
+  readonly _tag: "StructNestedEncodedError"
+  readonly message: "Expected a Struct schema or a schema with from.Encoded"
+  readonly schema: T
+}
+
+export type StructNestedEncoded<T> = T extends { fields: infer Fields extends S.Struct.Fields } ? Struct.Encoded<Fields>
+  : T extends { readonly from: { readonly Encoded: infer Encoded } } ? Encoded
+  : StructNestedEncodedError<T>
+
+export function NonEmptyArray<Value extends S.Top>(value: Value): S.NonEmptyArray<Value> {
+  return S.NonEmptyArray(value).annotate(concurrencyUnbounded)
+}
+
+export function TaggedStruct<const Tag extends SchemaAST.LiteralValue, const Fields extends S.Struct.Fields>(
+  value: Tag,
+  fields: Fields
+): TaggedStruct<Tag, Fields> {
+  return Struct({ _tag: S.tag(value), ...fields }) as any
+}
+export type TaggedStruct<Tag extends SchemaAST.LiteralValue, Fields extends S.Struct.Fields> =
+  & WithSchemaCopy<
+    S.TaggedStruct<Tag, Fields>
+  >
+  & OptionalMakeInput<Readonly<{ readonly _tag: S.tag<Tag> } & Fields>>
+
+export function Record<Key extends S.Record.Key, Value extends S.Top>(
+  key: Key,
+  value: Value
+): S.$Record<Key, Value> {
+  return S.Record(key, value).annotate(concurrencyUnbounded)
+}
+export declare namespace Record {
+  export type Key = S.Record.Key
+  export type Type<K extends S.Record.Key, V extends S.Top> = S.Record.Type<K, V>
+  export type Encoded<K extends S.Record.Key, V extends S.Top> = S.Record.Encoded<K, V>
+}
+
 export const SpanId = Symbol()
 export type SpanId = typeof SpanId
 
@@ -66,117 +202,141 @@ export const PhoneNumber = PhoneNumberT
 
 export type PhoneNumber = PhoneNumberType
 
-export const makeIs = <A extends { _tag: string }, I, RD, RE>(
-  schema: S.Codec<A, I, RD, RE>
-) => {
-  // In v4, transformations are stored as encoding on nodes, not as wrapper nodes.
-  // Union member ASTs are directly Objects (TypeLiteral equivalent).
-  if (SchemaAST.isUnion(schema.ast)) {
-    return schema.ast.types.reduce((acc, t: AST.AST) => {
-      if (!SchemaAST.isObjects(t)) return acc
-      const tag = Array.findFirst(t.propertySignatures, (_: any) => {
-        if (_.name === "_tag" && SchemaAST.isLiteral(_.type)) {
-          return Option.some(_.type)
-        }
-        return Option.none()
-      })
-      const ast = Option.getOrUndefined(tag)
-      if (!ast) {
-        return acc
-      }
-      return {
-        ...acc,
-        [String((ast as SchemaAST.Literal).literal)]: (x: { _tag: string }) =>
-          x._tag === (ast as SchemaAST.Literal).literal
-      }
-    }, {} as Is<A>)
-  }
-  throw new Error("Unsupported")
-}
-
-export const makeIsAnyOf = <A extends { _tag: string }, I, RD, RE>(
-  schema: S.Codec<A, I, RD, RE>
-): IsAny<A> => {
-  if (SchemaAST.isUnion(schema.ast)) {
-    return <Keys extends A["_tag"][]>(...keys: Keys) => (a: A): a is ExtractUnion<A, ElemType<Keys>> =>
-      keys.includes(a._tag)
-  }
-  throw new Error("Unsupported")
-}
-
-export type ExtractUnion<A extends { _tag: string }, Tags extends A["_tag"]> = Extract<A, Record<"_tag", Tags>>
-export type Is<A extends { _tag: string }> = { [K in A as K["_tag"]]: (a: A) => a is K }
-export type ElemType<A> = A extends Array<infer E> ? E : never
-export interface IsAny<A extends { _tag: string }> {
-  <Keys extends A["_tag"][]>(...keys: Keys): (a: A) => a is ExtractUnion<A, ElemType<Keys>>
-}
-
-const getTagLiteral = <Tag extends string>(schema: S.tag<Tag>): Tag => {
-  if (!SchemaAST.isLiteral(schema.ast)) {
-    throw new Error("Unsupported _tag schema: expected a literal AST")
-  }
-  return schema.ast.literal as Tag
+// Copied from SchemaAST.collectSentinels (marked @internal in effect).
+// Returns all { key, literal } pairs that can discriminate a union member.
+const getTagFromAST = (schema: S.Top): string => {
+  const sentinels = collectSentinelsFromAST(schema.ast)
+  const sentinel = sentinels.find((s) => s.key === "_tag")
+  if (sentinel !== undefined && typeof sentinel.literal === "string") return sentinel.literal
+  throw new Error("No _tag literal found on schema member")
 }
 
-type TaggedUnionMap<Members extends readonly (S.Top & { fields: { _tag: S.tag<string> } })[]> = {
-  [Key in Members[number] as Key["fields"]["_tag"]["Type"]]: Key
-}
-
-export const taggedUnionMap = <
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Members extends readonly (S.Top & { fields: { _tag: S.tag<string> } })[]
->(
-  self: Members
-) => {
-  const out = {} as TaggedUnionMap<Members>
-  for (const key of self) {
-    const tag = getTagLiteral(key.fields._tag) as keyof TaggedUnionMap<Members>
-    out[tag] = key as TaggedUnionMap<Members>[typeof tag]
+function collectSentinelsFromAST(
+  ast: SchemaAST.AST
+): Array<{ key: PropertyKey; literal: SchemaAST.LiteralValue | symbol }> {
+  switch (ast._tag) {
+    case "Declaration": {
+      const s = ast.annotations?.["~sentinels"]
+      return Array.isArray(s) ? s : []
+    }
+    case "Objects":
+      return ast.propertySignatures.flatMap(
+        (ps): Array<{ key: PropertyKey; literal: SchemaAST.LiteralValue | symbol }> => {
+          const type = ps.type
+          if (!SchemaAST.isOptional(type)) {
+            if (SchemaAST.isLiteral(type)) return [{ key: ps.name, literal: type.literal }]
+            if (SchemaAST.isUniqueSymbol(type)) return [{ key: ps.name, literal: type.symbol }]
+          }
+          return []
+        }
+      )
+    case "Suspend":
+      return collectSentinelsFromAST(ast.thunk())
+    default:
+      return []
   }
-  return out
 }
 
 export const tags = <
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Members extends NonEmptyReadonlyArray<(S.Top & { fields: { _tag: S.tag<string> } })>
+  Members extends NonEmptyReadonlyArray<(S.Top & { readonly Type: { readonly _tag: string } })>
 >(
   self: Members
 ) =>
   S.Literals(
-    self.map((key) => getTagLiteral(key.fields._tag)) as {
-      [Index in keyof Members]: S.Schema.Type<Members[Index]["fields"]["_tag"]>
+    self.map(getTagFromAST) as {
+      [Index in keyof Members]: Members[Index]["Type"]["_tag"]
     }
   ) as S.Literals<
     {
-      [Index in keyof Members]: S.Schema.Type<Members[Index]["fields"]["_tag"]>
+      [Index in keyof Members]: Members[Index]["Type"]["_tag"]
     }
   >
 
-export const ExtendTaggedUnion = <A extends { readonly _tag: string }, I, R>(
-  schema: S.Codec<A, I, R>
-) =>
-  extendM(
-    schema,
-    (_) => ({
-      // is: S.is(schema), // only works with never DecodingServices
-      isA: makeIs(_),
-      isAnyOf: makeIsAnyOf(_) /*, map: taggedUnionMap(a) */
-    })
-  )
+type TaggedUnionMembers = NonEmptyReadonlyArray<
+  S.Top & { readonly Type: { readonly _tag: string } }
+>
+
+type TaggedUnionTags<Members extends TaggedUnionMembers> = S.Literals<
+  {
+    [Index in keyof Members]: Members[Index]["Type"]["_tag"]
+  }
+>
+
+type TaggedPropertyKeys<A, Members extends TaggedUnionMembers> = {
+  [K in keyof A & string]: A[K] extends Members[number]["Type"] ? K : never
+}[keyof A & string]
+
+type PropertyGuardsFor<
+  Members extends TaggedUnionMembers,
+  K extends string,
+  A
+> =
+  & {
+    readonly [M in Members[number] as `is${M["Type"]["_tag"]}`]: (
+      target: A
+    ) => target is A & { readonly [P in K]: M["Type"] }
+  }
+  & {
+    readonly isAnyOf: <const Tags extends ReadonlyArray<Members[number]["Type"]["_tag"]>>(
+      tags: Tags
+    ) => (
+      target: A
+    ) => target is A & { readonly [P in K]: Extract<Members[number]["Type"], { readonly _tag: Tags[number] }> }
+  }
+
+type PropertyGuards<
+  Members extends TaggedUnionMembers,
+  K extends string
+> =
+  & {
+    readonly [M in Members[number] as `is${M["Type"]["_tag"]}`]: <
+      T extends { readonly [P in K]: Members[number]["Type"] }
+    >(target: T) => target is T & { readonly [P in K]: M["Type"] }
+  }
+  & {
+    readonly isAnyOf: <const Tags extends ReadonlyArray<Members[number]["Type"]["_tag"]>>(
+      tags: Tags
+    ) => <T extends { readonly [P in K]: Members[number]["Type"] }>(
+      target: T
+    ) => target is T & { readonly [P in K]: Extract<Members[number]["Type"], { readonly _tag: Tags[number] }> }
+  }
+
+type TaggedUnionWithTags<Members extends TaggedUnionMembers> = S.toTaggedUnion<"_tag", Members> & {
+  readonly tags: TaggedUnionTags<Members>
+  readonly generateGuards: <K extends string>(property: K) => PropertyGuards<Members, K>
+  readonly generateGuardsFor: <A>() => <K extends TaggedPropertyKeys<A, Members>>(
+    property: K
+  ) => PropertyGuardsFor<Members, K, A>
+}
+
+const extendTaggedUnionWithTags = <Members extends TaggedUnionMembers>(
+  schema: S.Union<Members>
+): TaggedUnionWithTags<Members> =>
+  extendM(schema.pipe(S.toTaggedUnion("_tag")), (tagged) => {
+    const makeGuards = (property: string) => {
+      const result: any = {}
+      const guards: Record<string, (u: unknown) => boolean> = tagged.guards
+      for (const tag of Object.keys(guards)) {
+        const guard = guards[tag]!
+        result[`is${tag}`] = (target: any) => guard(target[property])
+      }
+      result.isAnyOf = (memberTags: Array<string>) => {
+        const check = tagged.isAnyOf(memberTags)
+        return (target: any) => check(target[property])
+      }
+      return result
+    }
+    return {
+      tags: tags(schema.members),
+      generateGuards: makeGuards,
+      generateGuardsFor: () => makeGuards
+    }
+  })
+
+export const ExtendTaggedUnion = <Members extends TaggedUnionMembers>(
+  schema: S.Union<Members>
+): TaggedUnionWithTags<Members> => extendTaggedUnionWithTags(schema)
 
 export const TaggedUnion = <
-  Members extends NonEmptyReadonlyArray<
-    S.Codec<{ readonly _tag: string }, any, any, any> & { fields: { _tag: S.tag<string> } }
-  >
->(...a: Members) =>
-  pipe(
-    S.Union(a),
-    (_) =>
-      extendM(_, (_) => ({
-        // is: S.is(_), // only works with never DecodingServices
-        isA: makeIs(_),
-        isAnyOf: makeIsAnyOf(_),
-        tagMap: taggedUnionMap(a),
-        tags: tags(a)
-      }))
-  )
+  Members extends TaggedUnionMembers
+>(members: Members): TaggedUnionWithTags<Members> => extendTaggedUnionWithTags(S.Union(members))