effect-app 4.0.0-beta.7 → 4.0.0-beta.71

package/src/Schema/ext.ts

@@ -1,51 +1,84 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
-import { Effect, Option, pipe, Schema, type SchemaAST, SchemaGetter, SchemaIssue, SchemaParser, SchemaTransformation, type ServiceMap } from "effect"
+import { Effect, Option, pipe, type SchemaAST, SchemaIssue, SchemaTransformation } from "effect"
 import * as S from "effect/Schema"
+import { isDateValid } from "effect/Schema"
 import { type NonEmptyReadonlyArray } from "../Array.js"
+import * as Context from "../Context.js"
 import { extendM, typedKeysOf } from "../utils.js"
 import { type AST } from "./schema.js"
 
-// TODO: v4 migration — withConstructorDefault signature changed, propertySignature removed
-// Constraint relaxed from `Self extends S.Top & S.WithoutConstructorDefault` to `Self extends S.Top`
-// because `.pipe()` widens the schema type to `Top` which doesn't satisfy `WithoutConstructorDefault`.
-// The narrowing assertions below are safe — we're asserting "this schema hasn't had a default applied yet".
-export const withDefaultConstructor = <A>(
-  makeDefault: () => NoInfer<A>
-) =>
-<Self extends S.Top>(self: Self): S.withConstructorDefault<Self & S.WithoutConstructorDefault> => {
-  type Narrowed = Self & S.WithoutConstructorDefault
-  return S.withConstructorDefault<Narrowed>(
-    () => Option.some(makeDefault() as Narrowed["~type.make.in"])
-  )(self as Narrowed)
-}
+type ProvidedCodec<Self extends S.Top, R> = S.Codec<
+  Self["Type"],
+  Self["Encoded"],
+  Exclude<Self["DecodingServices"], R>,
+  Exclude<Self["EncodingServices"], R>
+>
 
 // TODO: v4 migration - Date is no longer by default encoded to string.
-const DateFromString = Schema.Date.pipe(
-  Schema.encodeTo(Schema.String, {
-    decode: SchemaGetter.Date(),
-    encode: SchemaGetter.transform((_) => _.toISOString())
-  })
-)
+
+const DateString = S.String.annotate({
+  identifier: "Date",
+  description: "a string in ISO 8601 format that will be decoded as a Date",
+  format: "date-time"
+})
+
+/**
+ * Schema type for {@link DateFromString}.
+ *
+ * @category Schemas
+ * @since 4.0.0
+ */
+export interface DateFromString extends S.decodeTo<S.Date, S.String> {}
+
+/**
+ * A transformation schema that parses an ISO 8601 string into a `Date`.
+ *
+ * Decoding:
+ * - A `string` is decoded as a `Date`.
+ *
+ * Encoding:
+ * - A `Date` is encoded as a `string`.
+ *
+ * @since 4.0.0
+ */
+export const DateFromString: DateFromString = DateString.pipe(S.decodeTo(S.Date, SchemaTransformation.dateFromString))
 
 /**
  * Like the default Schema `Date` but from String with `withDefault` => now
  */
 export const Date = Object.assign(DateFromString, {
-  withDefault: DateFromString.pipe(withDefaultConstructor(() => new global.Date()))
+  withDefault: DateFromString.pipe(S.withConstructorDefault(Effect.sync(() => new global.Date())))
+})
+
+/**
+ * Like the default Schema `DateValid` but from String with `withDefault` => now
+ */
+export const DateValid = Object.assign(Date.check(isDateValid()), {
+  withDefault: DateFromString.pipe(S.withConstructorDefault(Effect.sync(() => new global.Date())))
 })
 
 /**
  * Like the default Schema `Boolean` but with `withDefault` => false
  */
 export const Boolean = Object.assign(S.Boolean, {
-  withDefault: S.Boolean.pipe(withDefaultConstructor(() => false))
+  withDefault: S.Boolean.pipe(S.withConstructorDefault(Effect.succeed(false)))
 })
 
 /**
+ * You probably want to use `Finite` instead of this.
  * Like the default Schema `Number` but with `withDefault` => 0
  */
-export const Number = Object.assign(S.Number, { withDefault: S.Number.pipe(withDefaultConstructor(() => 0)) })
+export const Number = Object.assign(S.Number, {
+  withDefault: S.Number.pipe(S.withConstructorDefault(Effect.succeed(0)))
+})
+
+/**
+ * Like the default Schema `Finite` but with `withDefault` => 0
+ */
+export const Finite = Object.assign(S.Finite, {
+  withDefault: S.Finite.pipe(S.withConstructorDefault(Effect.succeed(0)))
+})
 
 /**
  * Like the default Schema `Literal` but with `withDefault` => literals[0]
@@ -58,79 +91,143 @@ export const Literal = <Literals extends NonEmptyReadonlyArray<AST.LiteralValue>
         changeDefault: <A extends Literals[number]>(a: A) => {
           return Object.assign(S.Literals(literals), {
             Default: a,
-            withDefault: s.pipe(withDefaultConstructor(() => a))
+            withDefault: s.pipe(S.withConstructorDefault(Effect.succeed(a)))
           }) // todo: copy annotations from original?
         },
         Default: literals[0] as typeof literals[0],
-        withDefault: s.pipe(withDefaultConstructor(() => literals[0]))
+        withDefault: s.pipe(S.withConstructorDefault(Effect.succeed(literals[0])))
       })
   )
 
 /**
  * Like the default Schema `Array` but with `withDefault` => []
  */
-export function Array<Value extends S.Top>(value: Value) {
+export function Array<ValueSchema extends S.Top>(value: ValueSchema) {
   return pipe(
     S.Array(value),
-    (s) => Object.assign(s, { withDefault: s.pipe(withDefaultConstructor(() => [])) })
+    (s) => Object.assign(s, { withDefault: s.pipe(S.withConstructorDefault(Effect.sync(() => []))) })
   )
 }
 
 /**
- * Like the default Schema `Map` but with `withDefault` => []
+ * An annotated `S.Array` of unique items that decodes to a `ReadonlySet`.
  */
-function Map_<Key extends S.Top, Value extends S.Top>(input: { key: Key; value: Value }) {
-  return pipe(
-    S.ReadonlyMap(input.key, input.value),
-    (s) => Object.assign(s, { withDefault: s.pipe(withDefaultConstructor(() => new global.Map())) })
+export const ReadonlySetFromArray = <ValueSchema extends S.Top>(value: ValueSchema): S.Codec<
+  ReadonlySet<ValueSchema["Type"]>,
+  readonly ValueSchema["Encoded"][],
+  ValueSchema["DecodingServices"],
+  ValueSchema["EncodingServices"]
+> => {
+  const from = S
+    .Array(value)
+    .annotate({ expected: "an array of unique items that will be decoded as a ReadonlySet" })
+  const to = S.instanceOf(Set) as S.instanceOf<ReadonlySet<S.Schema.Type<ValueSchema>>>
+  const schema = from.pipe(
+    S.decodeTo(
+      to,
+      SchemaTransformation.transform({
+        decode: (arr) => new Set(arr) as ReadonlySet<S.Schema.Type<ValueSchema>>,
+        encode: (set) => [...set]
+      })
+    )
   )
+  return S.revealCodec(schema)
 }
 
-export { Map_ as Map }
+/**
+ * An annotated `S.Array` of key-value tuples that decodes to a `ReadonlyMap`.
+ */
+export const ReadonlyMapFromArray = <KeySchema extends S.Top, ValueSchema extends S.Top>(pair: {
+  readonly key: KeySchema
+  readonly value: ValueSchema
+}): S.Codec<
+  ReadonlyMap<KeySchema["Type"], S.Schema.Type<ValueSchema>>,
+  readonly (readonly [KeySchema["Encoded"], ValueSchema["Encoded"]])[],
+  KeySchema["DecodingServices"] | ValueSchema["DecodingServices"],
+  KeySchema["EncodingServices"] | ValueSchema["EncodingServices"]
+> => {
+  const from = S
+    .Array(S.Tuple([pair.key, pair.value]))
+    .annotate({ expected: "an array of key-value tuples that will be decoded as a ReadonlyMap" })
+  const to = S.instanceOf(Map) as S.instanceOf<
+    ReadonlyMap<S.Schema.Type<KeySchema>, S.Schema.Type<ValueSchema>>
+  >
+  const schema = from.pipe(
+    S.decodeTo(
+      to,
+      SchemaTransformation.transform({
+        decode: (
+          arr
+        ) => new Map(arr) as ReadonlyMap<S.Schema.Type<KeySchema>, S.Schema.Type<ValueSchema>>,
+        encode: (
+          map
+        ) => [...map.entries()] as any // fu
+      })
+    )
+  )
+  return S.revealCodec(schema)
+}
 
 /**
- * Like the default Schema `ReadonlySet` but with `withDefault` => new Set()
+ * Like the default Schema `ReadonlySet` but from Array with `withDefault` => new Set()
  */
-export const ReadonlySet = <Value extends S.Top>(value: Value) =>
+export const ReadonlySet = <ValueSchema extends S.Top>(value: ValueSchema) =>
   pipe(
-    S.ReadonlySet(value),
-    (s) => Object.assign(s, { withDefault: s.pipe(withDefaultConstructor(() => new Set<S.Schema.Type<Value>>())) })
+    ReadonlySetFromArray(value),
+    (s) =>
+      Object.assign(s, {
+        withDefault: S.withConstructorDefault(Effect.sync(() => new Set<S.Schema.Type<ValueSchema>>()))(
+          s as typeof s & S.WithoutConstructorDefault
+        )
+      })
   )
 
 /**
- * Like the default Schema `ReadonlyMap` but with `withDefault` => new Map()
+ * Like the default Schema `ReadonlyMap` but from Array with `withDefault` => new Map()
  */
-export const ReadonlyMap = <K extends S.Top, V extends S.Top>(pair: {
-  readonly key: K
-  readonly value: V
+export const ReadonlyMap = <KeySchema extends S.Top, ValueSchema extends S.Top>(pair: {
+  readonly key: KeySchema
+  readonly value: ValueSchema
 }) =>
   pipe(
-    S.ReadonlyMap(pair.key, pair.value),
-    (s) => Object.assign(s, { withDefault: s.pipe(withDefaultConstructor(() => new Map())) })
+    ReadonlyMapFromArray(pair),
+    (s) =>
+      Object.assign(s, {
+        withDefault: S.withConstructorDefault(Effect.sync(() => new Map()))(
+          s as typeof s & S.WithoutConstructorDefault
+        )
+      })
   )
 
 /**
  * Like the default Schema `NullOr` but with `withDefault` => null
  */
-export const NullOr = <S extends S.Top>(self: S) =>
+export const NullOr = <Schema extends S.Top>(self: Schema) =>
   pipe(
     S.NullOr(self),
-    (s) => Object.assign(s, { withDefault: s.pipe(withDefaultConstructor(() => null)) })
+    (s) =>
+      Object.assign(s, {
+        withDefault: s.pipe(S.withConstructorDefault(Effect.succeed(null)))
+      })
   )
 
-export const defaultDate = (s: S.Top) => s.pipe(withDefaultConstructor(() => new global.Date()))
+export const defaultDate = <Schema extends S.Top & S.WithoutConstructorDefault>(schema: Schema) =>
+  schema.pipe(S.withConstructorDefault(Effect.sync(() => new global.Date())))
 
-export const defaultBool = (s: S.Top) => s.pipe(withDefaultConstructor(() => false))
+export const defaultBool = <Schema extends S.Top & S.WithoutConstructorDefault>(schema: Schema) =>
+  schema.pipe(S.withConstructorDefault(Effect.succeed(false)))
 
-export const defaultNullable = (
-  s: S.Top
-) => s.pipe(withDefaultConstructor(() => null))
+export const defaultNullable = <Schema extends S.Top & S.WithoutConstructorDefault>(schema: Schema) =>
+  schema.pipe(S.withConstructorDefault(Effect.succeed(null)))
 
-export const defaultArray = (s: S.Top) => s.pipe(withDefaultConstructor(() => []))
+export const defaultArray = <Schema extends S.Top & S.WithoutConstructorDefault>(schema: Schema) =>
+  schema.pipe(S.withConstructorDefault(Effect.sync(() => [])))
 
-export const defaultMap = (s: S.Top) => s.pipe(withDefaultConstructor(() => new Map()))
+export const defaultMap = <Schema extends S.Top & S.WithoutConstructorDefault>(schema: Schema) =>
+  schema.pipe(S.withConstructorDefault(Effect.sync(() => new Map())))
 
-export const defaultSet = (s: S.Top) => s.pipe(withDefaultConstructor(() => new Set()))
+export const defaultSet = <Schema extends S.Top & S.WithoutConstructorDefault>(schema: Schema) =>
+  schema.pipe(S.withConstructorDefault(Effect.sync(() => new Set())))
 
 export const withDefaultMake = <Self extends S.Top>(s: Self) => {
   const a = Object.assign(S.decodeSync(s as any) as WithDefaults<Self>, s)
@@ -160,8 +257,12 @@ export type WithDefaults<Self extends S.Top> = (
 //   : never
 
 export const inputDate = extendM(
-  S.Union([S.DateValid, S.Date]),
-  (s) => ({ withDefault: s.pipe(withDefaultConstructor(() => new globalThis.Date())) })
+  S.Union([S.DateValid, Date]).pipe(S.revealCodec),
+  (s) => ({
+    withDefault: S.withConstructorDefault(Effect.sync(() => new globalThis.Date()))(
+      s as typeof s & S.WithoutConstructorDefault
+    )
+  })
 )
 
 export interface UnionBrand {}
@@ -211,7 +312,7 @@ export const transformTo = <To extends S.Top, From extends S.Top>(
               { message: "One way schema transformation, encoding is not allowed" }
             )
           )
-      }) as any
+      })
     )
   )
 
@@ -228,7 +329,7 @@ export const transformToOrFail = <To extends S.Top, From extends S.Top, RD>(
     S.decodeTo(
       to,
       SchemaTransformation.transformOrFail({
-        decode: decode as any,
+        decode,
         encode: (i: any) =>
           Effect.fail(
             new SchemaIssue.Forbidden(
@@ -236,33 +337,34 @@ export const transformToOrFail = <To extends S.Top, From extends S.Top, RD>(
               { message: "One way schema transformation, encoding is not allowed" }
             )
           )
-      }) as any
+      })
     )
   )
 
-// TODO: v4 migration — S.declare API changed (no [self] + decode/encode pattern)
-// Need to find v4 equivalent for contextual schema wrapping
 export const provide = <Self extends S.Top, R>(
   self: Self,
-  context: ServiceMap.ServiceMap<R>
-): any => {
+  context: Context.Context<R>
+): ProvidedCodec<Self, R> => {
   const prov = Effect.provide(context)
-  return S
-    .declare((_u: unknown): _u is unknown => true) // placeholder — needs proper v4 declare
-    .pipe(
-      S.decodeTo(
-        self,
-        SchemaTransformation.transformOrFail({
-          decode: (n: any) => prov(SchemaParser.decodeUnknownEffect(self)(n)),
-          encode: (n: any) => prov(SchemaParser.encodeUnknownEffect(self)(n))
-        }) as any
-      ) as any
-    )
-}
-// TODO: v4 migration — ServiceMap.pick and S.declare pattern removed
-export const contextFromServices = <Self extends S.Top, Tags extends readonly any[]>(
-  _self: Self,
-  ..._services: Tags
-): any => {
-  throw new Error("contextFromServices: not yet migrated to v4")
+  return self.pipe(
+    S.middlewareDecoding((effect) => prov(effect)),
+    S.middlewareEncoding((effect) => prov(effect))
+  ) as ProvidedCodec<Self, R>
 }
+export const contextFromServices = <
+  Self extends S.Top,
+  Tags extends ReadonlyArray<Context.Key<any, any>>
+>(
+  self: Self,
+  ...services: Tags
+): Effect.Effect<
+  ProvidedCodec<Self, Context.Service.Identifier<Tags[number]>>,
+  never,
+  Context.Service.Identifier<Tags[number]>
+> =>
+  Effect.gen(function*() {
+    const context: Context.Context<Context.Service.Identifier<Tags[number]>> = Context.pick(...services)(
+      yield* Effect.context<Context.Service.Identifier<Tags[number]>>()
+    )
+    return provide(self, context)
+  })

package/src/Schema/moreStrings.ts

@@ -1,4 +1,4 @@
-import { pipe } from "effect"
+import { Effect, pipe } from "effect"
 import type { Refinement } from "effect-app/Function"
 import { extendM } from "effect-app/utils"
 import * as S from "effect/Schema"
@@ -6,7 +6,7 @@ import type { Simplify } from "effect/Types"
 import { customRandom, nanoid, urlAlphabet } from "nanoid"
 import validator from "validator"
 import { fromBrand, nominal } from "./brand.js"
-import { withDefaultConstructor, withDefaultMake, type WithDefaults } from "./ext.js"
+import { withDefaultMake, type WithDefaults } from "./ext.js"
 import { type B } from "./schema.js"
 import type { NonEmptyString255Brand, NonEmptyStringBrand } from "./strings.js"
 
@@ -140,10 +140,10 @@ const minLength = 6
 const maxLength = 50
 const size = 21
 const length = 10 * size
-const StringIdArb = (): S.LazyArbitrary<string> => (fc) =>
+const StringIdArb = (): S.LazyArbitrary<StringId> => (fc) =>
   fc
     .uint8Array({ minLength: length, maxLength: length })
-    .map((_) => customRandom(urlAlphabet, size, (size) => _.subarray(0, size))())
+    .map((_) => customRandom(urlAlphabet, size, (size) => _.subarray(0, size))() as StringId)
 /**
  * A string that is at least 6 characters long and a maximum of 50.
  */
@@ -154,13 +154,13 @@ export const StringId = extendM(
     fromBrand(nominal<StringId>(), {
       identifier: "StringId",
       title: "StringId",
-      arbitrary: StringIdArb,
+      toArbitrary: () => (fc) => StringIdArb()(fc),
       jsonSchema: {}
     })
   ),
   (s) => ({
     make: makeStringId,
-    withDefault: s.pipe(withDefaultConstructor(makeStringId))
+    withDefault: s.pipe(S.withConstructorDefault(Effect.sync(makeStringId)))
   })
 )
   .pipe(withDefaultMake)
@@ -185,11 +185,13 @@ export function prefixedStringId<Brand extends StringId>() {
     const s: S.Codec<string & Brand, string> = StringId
       .pipe(
         S.refine((x: string): x is string & Brand => x.startsWith(pref), {
-          arbitrary: arb,
           identifier: name,
           title: name
+        }),
+        S.annotate({
+          toArbitrary: () => (fc) => arb()(fc)
         })
-      ) as any
+      ) as S.Codec<string & Brand, string>
     const schema = s.pipe(withDefaultMake)
     const make = () => (pref + StringId.make().substring(0, 50 - pref.length)) as Brand
 
@@ -206,7 +208,9 @@ export function prefixedStringId<Brand extends StringId>() {
          */
         prefixSafe: <REST extends string>(str: `${Prefix}${Separator}${REST}`) => ex(str),
         prefix,
-        withDefault: schema.pipe(withDefaultConstructor(make))
+        withDefault: S.withConstructorDefault<S.Codec<Brand, string> & S.WithoutConstructorDefault>(
+          Effect.sync(make)
+        )(schema as S.Codec<Brand, string> & S.WithoutConstructorDefault)
       })
     )
   }
@@ -245,11 +249,17 @@ const isUrl: Refinement<string, Url> = (s: string): s is Url => {
 export const Url = S
   .String
   .pipe(
+    S.annotate({
+      title: "Url",
+      format: "uri"
+    }),
     S.refine(isUrl, {
-      arbitrary: (): S.LazyArbitrary<Url> => (fc) => fc.webUrl().map((_) => _ as Url),
       identifier: "Url",
       title: "Url",
       jsonSchema: { format: "uri" }
     }),
+    S.annotate({
+      toArbitrary: () => (fc) => fc.webUrl().map((_) => _ as Url)
+    }),
     withDefaultMake
   )

package/src/Schema/numbers.ts

@@ -1,8 +1,9 @@
+import { Effect } from "effect"
 import { extendM } from "effect-app/utils"
 import * as S from "effect/Schema"
 import type { Simplify } from "effect/Types"
 import { fromBrand, nominal } from "./brand.js"
-import { withDefaultConstructor, withDefaultMake } from "./ext.js"
+import { withDefaultMake } from "./ext.js"
 import { type B } from "./schema.js"
 
 export interface PositiveIntBrand
@@ -14,7 +15,7 @@ export const PositiveInt = extendM(
     fromBrand(nominal<PositiveInt>(), { identifier: "PositiveInt", title: "PositiveInt", jsonSchema: {} }),
     withDefaultMake
   ),
-  (s) => ({ withDefault: s.pipe(withDefaultConstructor(() => s(1))) })
+  (s) => ({ withDefault: s.pipe(S.withConstructorDefault(Effect.sync(() => s(1)))) })
 )
 export type PositiveInt = number & PositiveIntBrand
 
@@ -29,20 +30,20 @@ export const NonNegativeInt = extendM(
     }),
     withDefaultMake
   ),
-  (s) => ({ withDefault: s.pipe(withDefaultConstructor(() => s(0))) })
+  (s) => ({ withDefault: s.pipe(S.withConstructorDefault(Effect.sync(() => s(0)))) })
 )
 export type NonNegativeInt = number & NonNegativeIntBrand
 
 export interface IntBrand extends Simplify<B.Brand<"Int">> {}
 export const Int = extendM(
   S.Int.pipe(fromBrand(nominal<Int>(), { identifier: "Int", title: "Int", jsonSchema: {} }), withDefaultMake),
-  (s) => ({ withDefault: s.pipe(withDefaultConstructor(() => s(0))) })
+  (s) => ({ withDefault: s.pipe(S.withConstructorDefault(Effect.sync(() => s(0)))) })
 )
 export type Int = number & IntBrand
 
 export interface PositiveNumberBrand extends Simplify<B.Brand<"PositiveNumber"> & NonNegativeNumberBrand> {}
 export const PositiveNumber = extendM(
-  S.Number.pipe(
+  S.Finite.pipe(
     S.check(S.isGreaterThan(0)),
     fromBrand(nominal<PositiveNumber>(), {
       identifier: "PositiveNumber",
@@ -51,14 +52,14 @@ export const PositiveNumber = extendM(
     }),
     withDefaultMake
   ),
-  (s) => ({ withDefault: s.pipe(withDefaultConstructor(() => s(1))) })
+  (s) => ({ withDefault: s.pipe(S.withConstructorDefault(Effect.sync(() => s(1)))) })
 )
 export type PositiveNumber = number & PositiveNumberBrand
 
 export interface NonNegativeNumberBrand extends Simplify<B.Brand<"NonNegativeNumber">> {}
 export const NonNegativeNumber = extendM(
   S
-    .Number
+    .Finite
     .pipe(
       S.check(S.isGreaterThanOrEqualTo(0)),
       fromBrand(nominal<NonNegativeNumber>(), {
@@ -68,7 +69,7 @@ export const NonNegativeNumber = extendM(
       }),
       withDefaultMake
     ),
-  (s) => ({ withDefault: s.pipe(withDefaultConstructor(() => s(0))) })
+  (s) => ({ withDefault: s.pipe(S.withConstructorDefault(Effect.sync(() => s(0)))) })
 )
 export type NonNegativeNumber = number & NonNegativeNumberBrand
 

package/src/Schema/phoneNumber.ts

@@ -13,12 +13,19 @@ export type PhoneNumber = string & PhoneNumberBrand
 export const PhoneNumber = S
   .String
   .pipe(
+    S.annotate({
+      title: "PhoneNumber",
+      description: "a phone number with at least 7 digits",
+      format: "phone"
+    }),
     S.refine(isValidPhone as Refinement<string, PhoneNumber>, {
       identifier: "PhoneNumber",
       title: "PhoneNumber",
       description: "a phone number with at least 7 digits",
-      arbitrary: () => (fc: any) => Numbers(7, 10)(fc).map((_: any) => _ as PhoneNumber),
       jsonSchema: { format: "phone" }
     }),
+    S.annotate({
+      toArbitrary: () => (fc) => Numbers(7, 10)(fc).map((_) => _ as PhoneNumber)
+    }),
     withDefaultMake
   )