effect 4.0.0-beta.102 → 4.0.0-beta.104

package/src/unstable/schema/Model.ts

@@ -74,7 +74,7 @@ export {
    *
    * **Example** (Defining a variant model class)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Schema } from "effect"
    * import { Model } from "effect/unstable/schema"
    *
@@ -107,6 +107,8 @@ export {
    *     return this.name.toUpperCase()
    *   }
    * }
+   *
+   * [Schema.isSchema(Group), Schema.isSchema(Group.insert), Schema.isSchema(Group.json)] // => [true, true, true]
    * ```
    *
    * @category constructors
@@ -116,21 +118,21 @@ export {
   /**
    * Extracts a generated variant schema from a model or variant struct.
    *
-   * @category extraction
+   * @category converting
    * @since 4.0.0
    */
   extract,
   /**
    * Creates a variant field from schemas keyed by variant name.
    *
-   * @category fields
+   * @category constructors
    * @since 4.0.0
    */
   Field,
   /**
    * Transforms schemas inside a variant field or plain schema by variant name.
    *
-   * @category fields
+   * @category transforming
    * @since 4.0.0
    */
   fieldEvolve,
@@ -138,14 +140,14 @@ export {
    * Creates a variant field that applies a schema to every variant except the
    * supplied keys.
    *
-   * @category fields
+   * @category constructors
    * @since 4.0.0
    */
   FieldExcept,
   /**
    * Creates a variant field that applies a schema only to the supplied variants.
    *
-   * @category fields
+   * @category constructors
    * @since 4.0.0
    */
   FieldOnly,
@@ -169,7 +171,7 @@ export {
 /**
  * Returns the variant field definitions stored on a model or variant struct.
  *
- * @category fields
+ * @category getters
  * @since 4.0.0
  */
 export const fields: <A extends VariantSchema.Struct<any>>(self: A) => A[typeof VariantSchema.TypeId] =
@@ -179,7 +181,7 @@ export const fields: <A extends VariantSchema.Struct<any>>(self: A) => A[typeof
  * Marks a value as an explicit override for fields that otherwise use an
  * overrideable default.
  *
- * @category overrideable
+ * @category constructors
  * @since 4.0.0
  */
 export const Override: <A>(value: A) => A & Brand<"Override"> = VariantSchema.Override
@@ -196,7 +198,7 @@ export const Override: <A>(value: A) => A & Brand<"Override"> = VariantSchema.Ov
  * @see {@link Field} for generated columns that need a custom variant set, such
  * as primary keys used in update payloads.
  *
- * @category generated
+ * @category schemas
  * @since 4.0.0
  */
 export interface GeneratedByDb<S extends Schema.Top> extends
@@ -218,7 +220,7 @@ export interface GeneratedByDb<S extends Schema.Top> extends
  * @see {@link Field} for generated columns that need a custom variant set, such
  * as primary keys used in update payloads.
  *
- * @category generated
+ * @category schemas
  * @since 4.0.0
  */
 export const GeneratedByDb = <S extends Schema.Top>(
@@ -234,7 +236,7 @@ export const GeneratedByDb = <S extends Schema.Top>(
  * database variants and read JSON, but omitted from JSON create and update
  * variants.
  *
- * @category generated
+ * @category schemas
  * @since 4.0.0
  */
 export interface GeneratedByApp<S extends Schema.Top> extends
@@ -251,7 +253,7 @@ export interface GeneratedByApp<S extends Schema.Top> extends
  * variants and the read JSON variant, but omitted from JSON create and update
  * variants.
  *
- * @category generated
+ * @category schemas
  * @since 4.0.0
  */
 export const GeneratedByApp = <S extends Schema.Top>(schema: S): GeneratedByApp<S> =>
@@ -266,7 +268,7 @@ export const GeneratedByApp = <S extends Schema.Top>(schema: S): GeneratedByApp<
  * Variant field type for a sensitive value that is available to database variants
  * and omitted from all JSON variants.
  *
- * @category sensitive
+ * @category schemas
  * @since 4.0.0
  */
 export interface Sensitive<S extends Schema.Top> extends
@@ -281,7 +283,7 @@ export interface Sensitive<S extends Schema.Top> extends
  * A field that represents a sensitive value that should not be exposed in the
  * JSON variants.
  *
- * @category sensitive
+ * @category schemas
  * @since 4.0.0
  */
 export const Sensitive = <S extends Schema.Top>(schema: S): Sensitive<S> =>
@@ -295,7 +297,7 @@ export const Sensitive = <S extends Schema.Top>(schema: S): Sensitive<S> =>
  * Schema type for an optional object key whose encoded value may be missing or
  * null and whose decoded value is an `Option`.
  *
- * @category optional
+ * @category schemas
  * @since 4.0.0
  */
 export interface optionalOption<S extends Schema.Constraint>
@@ -306,7 +308,7 @@ export interface optionalOption<S extends Schema.Constraint>
  * Creates a schema for optional keys that decodes missing or null encoded values
  * through `Option` and encodes `Option` values back to optional nullable keys.
  *
- * @category optional
+ * @category schemas
  * @since 4.0.0
  */
 export const optionalOption = <S extends Schema.Constraint>(schema: S): optionalOption<S> =>
@@ -328,7 +330,7 @@ export const optionalOption = <S extends Schema.Constraint>(schema: S): optional
  * For the database variants, it will accept `null`able values.
  * For the JSON variants, it will also accept missing keys.
  *
- * @category optional
+ * @category schemas
  * @since 4.0.0
  */
 export interface FieldOption<S extends Schema.Top> extends
@@ -350,7 +352,7 @@ export interface FieldOption<S extends Schema.Top> extends
  * For the database variants, it will accept `null`able values.
  * For the JSON variants, it will also accept missing keys.
  *
- * @category optional
+ * @category schemas
  * @since 4.0.0
  */
 export const FieldOption: <Field extends VariantSchema.Field<any> | Schema.Top>(
@@ -376,7 +378,7 @@ export const FieldOption: <Field extends VariantSchema.Field<any> | Schema.Top>(
  * Variant field type for SQLite booleans stored as `0 | 1` in database variants
  * and exposed as `boolean` in JSON variants.
  *
- * @category booleans
+ * @category schemas
  * @since 4.0.0
  */
 export interface BooleanSqlite extends
@@ -394,7 +396,7 @@ export interface BooleanSqlite extends
  * Schema for sqlite booleans that are represented as `0 | 1` in database
  * variants and `boolean` in JSON variants.
  *
- * @category booleans
+ * @category schemas
  * @since 4.0.0
  */
 export const BooleanSqlite: BooleanSqlite = Field({
@@ -410,7 +412,7 @@ export const BooleanSqlite: BooleanSqlite = Field({
  * Schema type for a `DateTime.Utc` date-only value encoded as a `YYYY-MM-DD`
  * string.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export interface Date extends Schema.decodeTo<Schema.instanceOf<DateTime.Utc>, Schema.String> {}
@@ -419,7 +421,7 @@ export interface Date extends Schema.decodeTo<Schema.instanceOf<DateTime.Utc>, S
  * Schema for a `DateTime.Utc` that is serialized as a date string in the
  * format `YYYY-MM-DD`.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const Date: Date = Schema.String.pipe(
@@ -433,7 +435,7 @@ export const Date: Date = Schema.String.pipe(
  * Schema for an overrideable UTC date-only field whose constructor default is
  * the current date with the time component removed.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateWithNow = VariantSchema.Overrideable(Date, {
@@ -444,7 +446,7 @@ export const DateWithNow = VariantSchema.Overrideable(Date, {
  * Schema for an overrideable UTC date-time field encoded as a string and
  * defaulted to the current `DateTime.Utc`.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeWithNow = VariantSchema.Overrideable(Schema.DateTimeUtcFromString, {
@@ -455,7 +457,7 @@ export const DateTimeWithNow = VariantSchema.Overrideable(Schema.DateTimeUtcFrom
  * Schema for an overrideable UTC date-time field encoded as a JavaScript `Date`
  * and defaulted to the current `DateTime.Utc`.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeFromDateWithNow = VariantSchema.Overrideable(Schema.DateTimeUtcFromDate, {
@@ -466,7 +468,7 @@ export const DateTimeFromDateWithNow = VariantSchema.Overrideable(Schema.DateTim
  * Schema for an overrideable UTC date-time field encoded as milliseconds and
  * defaulted to the current `DateTime.Utc`.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeFromNumberWithNow = VariantSchema.Overrideable(Schema.DateTimeUtcFromMillis, {
@@ -477,7 +479,7 @@ export const DateTimeFromNumberWithNow = VariantSchema.Overrideable(Schema.DateT
  * Variant field type for a UTC date-time stored as a string, defaulted to the
  * current time on insert, available for selection, and omitted from updates.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export interface DateTimeInsert extends
@@ -496,7 +498,7 @@ export interface DateTimeInsert extends
  *
  * It is omitted from updates and is available for selection.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeInsert: DateTimeInsert = Field({
@@ -509,7 +511,7 @@ export const DateTimeInsert: DateTimeInsert = Field({
  * Variant field type for a UTC date-time stored as a JavaScript `Date` in
  * database variants, encoded as a string for JSON, and defaulted on insert.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export interface DateTimeInsertFromDate extends
@@ -528,7 +530,7 @@ export interface DateTimeInsertFromDate extends
  *
  * It is omitted from updates and is available for selection.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeInsertFromDate: DateTimeInsertFromDate = Field({
@@ -541,7 +543,7 @@ export const DateTimeInsertFromDate: DateTimeInsertFromDate = Field({
  * Variant field type for a UTC date-time encoded as milliseconds and defaulted to
  * the current time on insert.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export interface DateTimeInsertFromNumber extends
@@ -560,7 +562,7 @@ export interface DateTimeInsertFromNumber extends
  *
  * It is omitted from updates and is available for selection.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeInsertFromNumber: DateTimeInsertFromNumber = Field({
@@ -573,7 +575,7 @@ export const DateTimeInsertFromNumber: DateTimeInsertFromNumber = Field({
  * Variant field type for a UTC date-time stored as a string and defaulted to the
  * current time on both inserts and updates.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export interface DateTimeUpdate extends
@@ -594,7 +596,7 @@ export interface DateTimeUpdate extends
  * It is set to the current `DateTime.Utc` on updates and inserts and is
  * available for selection.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeUpdate: DateTimeUpdate = Field({
@@ -609,7 +611,7 @@ export const DateTimeUpdate: DateTimeUpdate = Field({
  * database variants, encoded as a string for JSON, and defaulted on inserts and
  * updates.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export interface DateTimeUpdateFromDate extends
@@ -630,7 +632,7 @@ export interface DateTimeUpdateFromDate extends
  * It is set to the current `DateTime.Utc` on updates and inserts and is
  * available for selection.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeUpdateFromDate: DateTimeUpdateFromDate = Field({
@@ -644,7 +646,7 @@ export const DateTimeUpdateFromDate: DateTimeUpdateFromDate = Field({
  * Variant field type for a UTC date-time encoded as milliseconds and defaulted to
  * the current time on both inserts and updates.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export interface DateTimeUpdateFromNumber extends
@@ -665,7 +667,7 @@ export interface DateTimeUpdateFromNumber extends
  * It is set to the current `DateTime.Utc` on updates and inserts and is
  * available for selection.
  *
- * @category DateTime
+ * @category schemas
  * @since 4.0.0
  */
 export const DateTimeUpdateFromNumber: DateTimeUpdateFromNumber = Field({
@@ -679,7 +681,7 @@ export const DateTimeUpdateFromNumber: DateTimeUpdateFromNumber = Field({
  * Variant field type for a JSON value stored as text in database variants and
  * exposed through the supplied schema in JSON variants.
  *
- * @category models
+ * @category schemas
  * @since 4.0.0
  */
 export interface JsonFromString<S extends Schema.Top> extends
@@ -700,7 +702,7 @@ export interface JsonFromString<S extends Schema.Top> extends
  *
  * The "json" variants will use the object schema directly.
  *
- * @category constructors
+ * @category schemas
  * @since 4.0.0
  */
 export const JsonFromString = <S extends Schema.Top>(
@@ -721,7 +723,7 @@ export const JsonFromString = <S extends Schema.Top>(
  * Variant field type for a branded binary UUID v4 value whose insert variant
  * generates a UUID by default.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export interface UuidV4BytesInsert<B extends string> extends
@@ -736,7 +738,7 @@ export interface UuidV4BytesInsert<B extends string> extends
 /**
  * Schema for binary `Uint8Array` values backed by an `ArrayBuffer`.
  *
- * @category Uint8Array
+ * @category schemas
  * @since 4.0.0
  */
 export const Uint8Array: Schema.instanceOf<Uint8Array<ArrayBuffer>> = Schema.Uint8Array as Schema.instanceOf<
@@ -747,7 +749,7 @@ export const Uint8Array: Schema.instanceOf<Uint8Array<ArrayBuffer>> = Schema.Uin
  * Adds a constructor default that generates a binary UUID v4 for a branded
  * `Uint8Array` schema.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export const UuidV4BytesWithGenerate = <B extends string>(
@@ -758,7 +760,7 @@ export const UuidV4BytesWithGenerate = <B extends string>(
 /**
  * A field that represents a binary UUID v4 that is generated on inserts.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export const UuidV4BytesInsert = <const B extends string>(
@@ -775,7 +777,7 @@ export const UuidV4BytesInsert = <const B extends string>(
  * Variant field type for a branded string UUID v4 value whose insert variant
  * generates a UUID by default.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export interface UuidV4Insert<B extends string> extends
@@ -790,7 +792,7 @@ export interface UuidV4Insert<B extends string> extends
 /**
  * Adds a constructor default that generates a string UUID v4.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export const UuidV4WithGenerate = <B extends string>(
@@ -801,7 +803,7 @@ export const UuidV4WithGenerate = <B extends string>(
 /**
  * A field that represents a string UUID v4 that is generated on inserts.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export const UuidV4Insert = <const B extends string>(
@@ -818,7 +820,7 @@ export const UuidV4Insert = <const B extends string>(
  * Variant field type for a branded string UUID v7 value whose insert variant
  * generates a UUID by default.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export interface UuidV7Insert<B extends string> extends
@@ -833,7 +835,7 @@ export interface UuidV7Insert<B extends string> extends
 /**
  * Adds a constructor default that generates a string UUID v7.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export const UuidV7WithGenerate = <B extends string>(
@@ -848,7 +850,7 @@ export const UuidV7WithGenerate = <B extends string>(
 /**
  * A field that represents a string UUID v7 that is generated on inserts.
  *
- * @category uuid
+ * @category schemas
  * @since 4.0.0
  */
 export const UuidV7Insert = <const B extends string>(

package/src/unstable/schema/VariantSchema.ts

@@ -26,6 +26,7 @@ import * as Struct_ from "../../Struct.ts"
 export const TypeId = "~effect/schema/VariantSchema"
 
 const cacheSymbol = Symbol.for(`${TypeId}/cache`)
+const defaultCacheSymbol = Symbol.for(`${TypeId}/defaultCache`)
 
 /**
  * Pipeable container of schema fields that can be extracted into per-variant
@@ -38,6 +39,8 @@ export interface Struct<in out A extends Field.Fields> extends Pipeable {
   readonly [TypeId]: A
   /** @internal */
   [cacheSymbol]?: Record<string, Schema.Top>
+  /** @internal */
+  [defaultCacheSymbol]?: Record<string, Schema.Top>
 }
 
 /**
@@ -87,7 +90,7 @@ export declare namespace Struct {
   export type Validate<A, Variant extends string> = {
     readonly [K in keyof A]: A[K] extends { readonly [TypeId]: infer _ } ? Validate<A[K], Variant> :
       A[K] extends Field<infer Config> ? [keyof Config] extends [Variant] ? {} : "field must have valid variants"
-      : {}
+      : unknown
   }
 }
 
@@ -144,7 +147,7 @@ export declare namespace Field {
    * @since 4.0.0
    */
   export type ConfigWithKeys<K extends string> = {
-    readonly [P in K]?: Schema.Top
+    readonly [P in K]?: Schema.Top | undefined
   }
 
   /**
@@ -167,7 +170,7 @@ export declare namespace Field {
  * Computes the `Schema.Struct` field map for a variant by selecting matching
  * field schemas and recursively extracting nested structs.
  *
- * @category extractors
+ * @category utility types
  * @since 4.0.0
  */
 export type ExtractFields<V extends string, Fields extends Struct.Fields, IsDefault = false> = {
@@ -186,7 +189,7 @@ export type ExtractFields<V extends string, Fields extends Struct.Fields, IsDefa
  * Computes the schema type produced by extracting a single variant from a variant
  * schema struct.
  *
- * @category extractors
+ * @category utility types
  * @since 4.0.0
  */
 export type Extract<V extends string, A extends Struct<any>, IsDefault = false> = [A] extends [
@@ -214,14 +217,18 @@ const extract: {
       readonly isDefault?: boolean | undefined
     }
   ): Extract<V, A> => {
-    const cache = self[cacheSymbol] ?? (self[cacheSymbol] = Object.create(null))
-    const cacheKey = options?.isDefault === true ? "__default" : variant
-    if (Object.hasOwn(cache, cacheKey)) {
-      return cache[cacheKey] as any
+    const cache = options?.isDefault === true
+      ? self[defaultCacheSymbol] ?? (self[defaultCacheSymbol] = Object.create(null))
+      : self[cacheSymbol] ?? (self[cacheSymbol] = Object.create(null))
+    if (Object.hasOwn(cache, variant)) {
+      return cache[variant] as any
     }
     const fields: Record<string, any> = {}
     for (const key of Object.keys(self[TypeId])) {
       const value = self[TypeId][key]
+      if (value === undefined) {
+        continue
+      }
       if (TypeId in value) {
         if (options?.isDefault === true && Schema.isSchema(value)) {
           InternalRecord.assignProperty(fields, key, value)
@@ -230,14 +237,17 @@ const extract: {
         }
       } else if (FieldTypeId in value) {
         if (Object.hasOwn(value.schemas, variant)) {
-          InternalRecord.assignProperty(fields, key, value.schemas[variant])
+          const schema = value.schemas[variant]
+          if (schema !== undefined) {
+            InternalRecord.assignProperty(fields, key, schema)
+          }
         }
       } else {
         InternalRecord.assignProperty(fields, key, value)
       }
     }
     const schema = Schema.Struct(fields)
-    cache[cacheKey] = schema
+    cache[variant] = schema
     return schema as any
   }
 )
@@ -296,12 +306,13 @@ type MissingSelfGeneric<Params extends string = ""> =
  * @category models
  * @since 4.0.0
  */
-export interface Union<Members extends ReadonlyArray<Struct<any>>> extends
-  Schema.Union<
-    {
-      readonly [K in keyof Members]: [Members[K]] extends [Schema.Top] ? Members[K] : never
-    }
-  >
+export interface Union<Members extends ReadonlyArray<Struct<any>>, Default extends string = string>
+  extends
+    Schema.Union<
+      {
+        readonly [K in keyof Members]: Extract<Default, Members[K], true>
+      }
+    >
 {}
 
 /**
@@ -410,7 +421,7 @@ export const make = <
       }
   readonly Union: <const Members extends ReadonlyArray<Struct<any>>>(
     members: Members
-  ) => Union<Members> & Union.Variants<Members, Variants[number]>
+  ) => Union<Members, Default> & Union.Variants<Members, Variants[number]>
   readonly extract: {
     <V extends Variants[number]>(
       variant: V
@@ -469,7 +480,7 @@ export const make = <
     }
   }
   function UnionVariants(members: ReadonlyArray<Struct<any>>) {
-    return Union(members, options.variants)
+    return Union(members, options.defaultVariant, options.variants)
   }
   const fieldEvolve = dual(
     2,
@@ -506,7 +517,7 @@ export const make = <
 /**
  * Marks a value as an explicit override for an `Overrideable` schema default.
  *
- * @category overrideable
+ * @category constructors
  * @since 4.0.0
  */
 export const Override = <A>(value: A): A & Brand<"Override"> => value as any
@@ -515,7 +526,7 @@ export const Override = <A>(value: A): A & Brand<"Override"> => value as any
  * Schema type whose constructor can use an effectful default unless a value is
  * explicitly branded with `Override`.
  *
- * @category overrideable
+ * @category schemas
  * @since 4.0.0
  */
 export interface Overrideable<S extends Schema.Top & Schema.WithoutConstructorDefault> extends
@@ -543,7 +554,7 @@ export interface Overrideable<S extends Schema.Top & Schema.WithoutConstructorDe
  * Wraps a schema with an effectful constructor default while allowing explicit
  * values to be marked with `Override`.
  *
- * @category overrideable
+ * @category schemas
  * @since 4.0.0
  */
 export const Overrideable = <S extends Schema.Top & Schema.WithoutConstructorDefault>(
@@ -582,11 +593,18 @@ const Field = <const A extends Field.Config>(schemas: A): Field<A> => {
   return self
 }
 
-const Union = <Members extends ReadonlyArray<Struct<any>>, Variants extends ReadonlyArray<string>>(
+const Union = <
+  Members extends ReadonlyArray<Struct<any>>,
+  Default extends string,
+  Variants extends ReadonlyArray<string>
+>(
   members: Members,
+  defaultVariant: Default,
   variants: Variants
 ) => {
-  const VariantUnion = Schema.Union(members.filter((member) => Schema.isSchema(member))) as any
+  const VariantUnion = Schema.Union(
+    members.map((member) => Schema.isSchema(member) ? member : extract(member, defaultVariant, { isDefault: true }))
+  ) as any
   for (const variant of variants) {
     Object.defineProperty(VariantUnion, variant, {
       value: Schema.Union(members.map((member) => extract(member, variant)))