effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/unstable/schema/Model.js

@@ -1,4 +1,22 @@
 /**
+ * Utilities for defining schema-backed domain models that need different shapes
+ * for database access and JSON APIs.
+ *
+ * A model defined with this module keeps one field declaration as the source of
+ * truth and derives the `select`, `insert`, `update`, `json`, `jsonCreate`, and
+ * `jsonUpdate` variants from it. This is useful for persistence models whose
+ * database representation differs from the public API, for example generated
+ * columns, application-generated identifiers, sensitive fields that must not be
+ * serialized to JSON, nullable database columns exposed as `Option`, SQLite
+ * booleans, JSON stored as text, date-time audit columns, and generated UUIDs.
+ *
+ * Each variant is a schema in its own right, so choose the variant that matches
+ * the boundary you are validating or encoding. Plain schemas are included in all
+ * variants, while `Field` helpers opt a property into only the variants they
+ * declare. Overrideable defaults such as timestamp helpers can still be provided
+ * explicitly with `Override`, and JSON variants may differ from database variants
+ * in both optionality and encoded representation.
+ *
  * @since 4.0.0
  */
 import * as Uuid from "uuid";
@@ -29,9 +47,10 @@ export {
  *
  * It supports common variants for database and JSON apis.
  *
- * @since 4.0.0
  * @category constructors
- * @example
+ * @since 4.0.0
+ * **Example** (Defining a variant model class)
+ *
  * ```ts
  * import { Schema } from "effect"
  * import { Model } from "effect/unstable/schema"
@@ -39,7 +58,7 @@ export {
  * export const GroupId = Schema.Number.pipe(Schema.brand("GroupId"))
  *
  * export class Group extends Model.Class<Group>("Group")({
- *   id: Model.Generated(GroupId),
+ *   id: Model.GeneratedByDb(GroupId),
  *   name: Schema.String,
  *   createdAt: Model.DateTimeInsertFromDate,
  *   updatedAt: Model.DateTimeUpdateFromDate
@@ -69,70 +88,75 @@ export {
  */
 Class,
 /**
- * @since 4.0.0
  * @category extraction
+ * @since 4.0.0
  */
 extract,
 /**
- * @since 4.0.0
  * @category fields
+ * @since 4.0.0
  */
 Field,
 /**
- * @since 4.0.0
  * @category fields
+ * @since 4.0.0
  */
 fieldEvolve,
 /**
- * @since 4.0.0
  * @category fields
+ * @since 4.0.0
  */
 FieldExcept,
 /**
- * @since 4.0.0
  * @category fields
+ * @since 4.0.0
  */
 FieldOnly,
 /**
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 Struct,
 /**
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 Union };
 /**
- * @since 4.0.0
+ * Returns the variant field definitions stored on a model or variant struct.
+ *
  * @category fields
+ * @since 4.0.0
  */
 export const fields = VariantSchema.fields;
 /**
- * @since 4.0.0
+ * Marks a value as an explicit override for fields that otherwise use an
+ * overrideable default.
+ *
  * @category overrideable
+ * @since 4.0.0
  */
 export const Override = VariantSchema.Override;
 /**
  * A field that represents a column that is generated by the database.
  *
- * It is available for selection and update, but not for insertion.
+ * It is available for reads only.
  *
- * @since 4.0.0
  * @category generated
+ * @since 4.0.0
  */
-export const Generated = schema => Field({
+export const GeneratedByDb = schema => Field({
   select: schema,
-  update: schema,
   json: schema
 });
 /**
- * A field that represents a column that is generated by the application.
+ * A field that represents a value generated by the application.
  *
- * It is required by the database, but not by the JSON variants.
+ * It is present in the database variants and read JSON variant, but omitted from
+ * the JSON create and update variants.
  *
- * @since 4.0.0
  * @category generated
+ * @since 4.0.0
  */
 export const GeneratedByApp = schema => Field({
   select: schema,
@@ -144,8 +168,8 @@ export const GeneratedByApp = schema => Field({
  * A field that represents a sensitive value that should not be exposed in the
  * JSON variants.
  *
- * @since 4.0.0
  * @category sensitive
+ * @since 4.0.0
  */
 export const Sensitive = schema => Field({
   select: schema,
@@ -153,8 +177,11 @@ export const Sensitive = schema => Field({
   update: schema
 });
 /**
- * @since 4.0.0
+ * 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
+ * @since 4.0.0
  */
 export const optionalOption = schema => Schema.optionalKey(Schema.NullOr(schema)).pipe(Schema.decodeTo(Schema.Option(Schema.toType(schema)), Transformation.transformOptional({
   decode: oe => oe.pipe(Option.filter(Predicate.isNotNull), Option.some),
@@ -166,8 +193,8 @@ export const optionalOption = schema => Schema.optionalKey(Schema.NullOr(schema)
  * For the database variants, it will accept `null`able values.
  * For the JSON variants, it will also accept missing keys.
  *
- * @since 4.0.0
  * @category optional
+ * @since 4.0.0
  */
 export const FieldOption = /*#__PURE__*/fieldEvolve({
   select: Schema.OptionFromNullOr,
@@ -181,8 +208,8 @@ export const FieldOption = /*#__PURE__*/fieldEvolve({
  * A schema for sqlite booleans that are represented as `0 | 1` in database
  * variants and `boolean` in JSON variants.
  *
- * @since 4.0.0
  * @category booleans
+ * @since 4.0.0
  */
 export const BooleanSqlite = /*#__PURE__*/Field({
   select: Schema.BooleanFromBit,
@@ -196,37 +223,49 @@ export const BooleanSqlite = /*#__PURE__*/Field({
  * A schema for a `DateTime.Utc` that is serialized as a date string in the
  * format `YYYY-MM-DD`.
  *
- * @since 4.0.0
  * @category date & time
+ * @since 4.0.0
  */
 export const Date = /*#__PURE__*/Schema.String.pipe(/*#__PURE__*/Schema.decodeTo(Schema.DateTimeUtc, {
   decode: /*#__PURE__*/Getter.dateTimeUtcFromInput().map(DateTime.removeTime),
   encode: /*#__PURE__*/Getter.transform(DateTime.formatIsoDate)
 }));
 /**
- * @since 4.0.0
+ * Overrideable date-only UTC schema whose constructor default is the current date
+ * with the time component removed.
+ *
  * @category date & time
+ * @since 4.0.0
  */
 export const DateWithNow = /*#__PURE__*/VariantSchema.Overrideable(Date, {
   defaultValue: /*#__PURE__*/Effect.map(DateTime.now, DateTime.removeTime)
 });
 /**
- * @since 4.0.0
+ * Overrideable UTC date-time schema encoded as a string, with a constructor
+ * default of the current `DateTime.Utc`.
+ *
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeWithNow = /*#__PURE__*/VariantSchema.Overrideable(Schema.DateTimeUtcFromString, {
   defaultValue: DateTime.now
 });
 /**
- * @since 4.0.0
+ * Overrideable UTC date-time schema encoded as a JavaScript `Date`, with a
+ * constructor default of the current `DateTime.Utc`.
+ *
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeFromDateWithNow = /*#__PURE__*/VariantSchema.Overrideable(Schema.DateTimeUtcFromDate, {
   defaultValue: DateTime.now
 });
 /**
- * @since 4.0.0
+ * Overrideable UTC date-time schema encoded as milliseconds, with a constructor
+ * default of the current `DateTime.Utc`.
+ *
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeFromNumberWithNow = /*#__PURE__*/VariantSchema.Overrideable(Schema.DateTimeUtcFromMillis, {
   defaultValue: DateTime.now
@@ -237,8 +276,8 @@ export const DateTimeFromNumberWithNow = /*#__PURE__*/VariantSchema.Overrideable
  *
  * It is omitted from updates and is available for selection.
  *
- * @since 4.0.0
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeInsert = /*#__PURE__*/Field({
   select: Schema.DateTimeUtcFromString,
@@ -251,8 +290,8 @@ export const DateTimeInsert = /*#__PURE__*/Field({
  *
  * It is omitted from updates and is available for selection.
  *
- * @since 4.0.0
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeInsertFromDate = /*#__PURE__*/Field({
   select: Schema.DateTimeUtcFromDate,
@@ -265,8 +304,8 @@ export const DateTimeInsertFromDate = /*#__PURE__*/Field({
  *
  * It is omitted from updates and is available for selection.
  *
- * @since 4.0.0
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeInsertFromNumber = /*#__PURE__*/Field({
   select: Schema.DateTimeUtcFromMillis,
@@ -280,8 +319,8 @@ export const DateTimeInsertFromNumber = /*#__PURE__*/Field({
  * It is set to the current `DateTime.Utc` on updates and inserts and is
  * available for selection.
  *
- * @since 4.0.0
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeUpdate = /*#__PURE__*/Field({
   select: Schema.DateTimeUtcFromString,
@@ -296,8 +335,8 @@ export const DateTimeUpdate = /*#__PURE__*/Field({
  * It is set to the current `DateTime.Utc` on updates and inserts and is
  * available for selection.
  *
- * @since 4.0.0
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeUpdateFromDate = /*#__PURE__*/Field({
   select: Schema.DateTimeUtcFromDate,
@@ -312,8 +351,8 @@ export const DateTimeUpdateFromDate = /*#__PURE__*/Field({
  * It is set to the current `DateTime.Utc` on updates and inserts and is
  * available for selection.
  *
- * @since 4.0.0
  * @category date & time
+ * @since 4.0.0
  */
 export const DateTimeUpdateFromNumber = /*#__PURE__*/Field({
   select: Schema.DateTimeUtcFromMillis,
@@ -326,8 +365,8 @@ export const DateTimeUpdateFromNumber = /*#__PURE__*/Field({
  *
  * The "json" variants will use the object schema directly.
  *
- * @since 4.0.0
  * @category json
+ * @since 4.0.0
  */
 export const JsonFromString = schema => {
   const parsed = Schema.fromJsonString(Schema.toCodecJson(schema));
@@ -341,20 +380,44 @@ export const JsonFromString = schema => {
   });
 };
 /**
- * @since 4.0.0
+ * Schema for binary `Uint8Array` values backed by an `ArrayBuffer`.
+ *
  * @category Uint8Array
+ * @since 4.0.0
  */
 export const Uint8Array = Schema.Uint8Array;
 /**
- * @since 4.0.0
+ * Adds a constructor default that generates a binary UUID v4 for a branded
+ * `Uint8Array` schema.
+ *
  * @category uuid
+ * @since 4.0.0
  */
-export const UuidV4WithGenerate = schema => schema.pipe(Schema.withConstructorDefault(Effect.sync(() => Uuid.v4({}, new globalThis.Uint8Array(16)))));
+export const UuidV4BytesWithGenerate = schema => schema.pipe(Schema.withConstructorDefault(Effect.sync(() => Uuid.v4({}, new globalThis.Uint8Array(16)))));
 /**
  * A field that represents a binary UUID v4 that is generated on inserts.
  *
+ * @category uuid
  * @since 4.0.0
+ */
+export const UuidV4BytesInsert = schema => Field({
+  select: schema,
+  insert: UuidV4BytesWithGenerate(schema),
+  update: schema,
+  json: schema
+});
+/**
+ * Adds a constructor default that generates a string UUID v4.
+ *
  * @category uuid
+ * @since 4.0.0
+ */
+export const UuidV4WithGenerate = schema => schema.pipe(Schema.withConstructorDefault(Effect.sync(() => Uuid.v4())));
+/**
+ * A field that represents a string UUID v4 that is generated on inserts.
+ *
+ * @category uuid
+ * @since 4.0.0
  */
 export const UuidV4Insert = schema => Field({
   select: schema,
@@ -362,4 +425,25 @@ export const UuidV4Insert = schema => Field({
   update: schema,
   json: schema
 });
+/**
+ * Adds a constructor default that generates a string UUID v7.
+ *
+ * @category uuid
+ * @since 4.0.0
+ */
+export const UuidV7WithGenerate = schema => schema.pipe(Schema.withConstructorDefault(Effect.clockWith(clock => Effect.succeed(Uuid.v7({
+  msecs: clock.currentTimeMillisUnsafe()
+})))));
+/**
+ * A field that represents a string UUID v7 that is generated on inserts.
+ *
+ * @category uuid
+ * @since 4.0.0
+ */
+export const UuidV7Insert = schema => Field({
+  select: schema,
+  insert: UuidV7WithGenerate(schema),
+  update: schema,
+  json: schema
+});
 //# sourceMappingURL=Model.js.map

package/dist/unstable/schema/Model.js.map

@@ -1 +1 @@
-{"version":3,"file":"Model.js","names":["Uuid","DateTime","Effect","Option","Predicate","Schema","Getter","Transformation","VariantSchema","Class","Field","FieldExcept","FieldOnly","Struct","Union","extract","fieldEvolve","make","variants","defaultVariant","fields","Override","Generated","schema","select","update","json","GeneratedByApp","insert","Sensitive","optionalOption","optionalKey","NullOr","pipe","decodeTo","toType","transformOptional","decode","oe","filter","isNotNull","some","encode","flatten","FieldOption","OptionFromNullOr","jsonCreate","jsonUpdate","BooleanSqlite","BooleanFromBit","Boolean","Date","String","DateTimeUtc","dateTimeUtcFromInput","map","removeTime","transform","formatIsoDate","DateWithNow","Overrideable","defaultValue","now","DateTimeWithNow","DateTimeUtcFromString","DateTimeFromDateWithNow","DateTimeUtcFromDate","DateTimeFromNumberWithNow","DateTimeUtcFromMillis","DateTimeInsert","DateTimeInsertFromDate","DateTimeInsertFromNumber","DateTimeUpdate","DateTimeUpdateFromDate","DateTimeUpdateFromNumber","JsonFromString","parsed","fromJsonString","toCodecJson","Uint8Array","UuidV4WithGenerate","withConstructorDefault","sync","v4","globalThis","UuidV4Insert"],"sources":["../../../src/unstable/schema/Model.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,IAAI,MAAM,MAAM;AAE5B,OAAO,KAAKC,QAAQ,MAAM,mBAAmB;AAC7C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAC/C,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAC/D,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD,MAAM;EACJC,KAAK;EACLC,KAAK;EACLC,WAAW;EACXC,SAAS;EACTC,MAAM;EACNC,KAAK;EACLC,OAAO;EACPC;AAAW,CACZ,gBAAGR,aAAa,CAACS,IAAI,CAAC;EACrBC,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC;EAC5EC,cAAc,EAAE;CACjB,CAAC;AA2BF;AACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CAV,KAAK;AACL;;;;AAIAM,OAAO;AACP;;;;AAIAL,KAAK;AACL;;;;AAIAM,WAAW;AACX;;;;AAIAL,WAAW;AACX;;;;AAIAC,SAAS;AACT;;;;AAIAC,MAAM;AACN;;;;AAIAC,KAAK;AAGP;;;;AAIA,OAAO,MAAMM,MAAM,GACjBZ,aAAa,CAACY,MAAM;AAEtB;;;;AAIA,OAAO,MAAMC,QAAQ,GAA2Cb,aAAa,CAACa,QAAQ;AActF;;;;;;;;AAQA,OAAO,MAAMC,SAAS,GACpBC,MAAS,IAETb,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdE,MAAM,EAAEF,MAAM;EACdG,IAAI,EAAEH;CACP,CAAC;AAeJ;;;;;;;;AAQA,OAAO,MAAMI,cAAc,GAA0BJ,MAAS,IAC5Db,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdK,MAAM,EAAEL,MAAM;EACdE,MAAM,EAAEF,MAAM;EACdG,IAAI,EAAEH;CACP,CAAC;AAcJ;;;;;;;AAOA,OAAO,MAAMM,SAAS,GAA0BN,MAAS,IACvDb,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdK,MAAM,EAAEL,MAAM;EACdE,MAAM,EAAEF;CACT,CAAC;AAUJ;;;;AAIA,OAAO,MAAMO,cAAc,GAA0BP,MAAS,IAC5DlB,MAAM,CAAC0B,WAAW,CAAC1B,MAAM,CAAC2B,MAAM,CAACT,MAAM,CAAC,CAAC,CAACU,IAAI,CAC5C5B,MAAM,CAAC6B,QAAQ,CACb7B,MAAM,CAACF,MAAM,CAACE,MAAM,CAAC8B,MAAM,CAACZ,MAAM,CAAC,CAAC,EACpChB,cAAc,CAAC6B,iBAAiB,CAA6C;EAC3EC,MAAM,EAAGC,EAAE,IAAKA,EAAE,CAACL,IAAI,CAAC9B,MAAM,CAACoC,MAAM,CAACnC,SAAS,CAACoC,SAAS,CAAC,EAAErC,MAAM,CAACsC,IAAI,CAAC;EACxEC,MAAM,EAAEvC,MAAM,CAACwC;CAChB,CAAQ,CACV,CACF;AAsBH;;;;;;;;;AASA,OAAO,MAAMC,WAAW,gBAUd5B,WAAW,CAAC;EAClBQ,MAAM,EAAEnB,MAAM,CAACwC,gBAAgB;EAC/BjB,MAAM,EAAEvB,MAAM,CAACwC,gBAAgB;EAC/BpB,MAAM,EAAEpB,MAAM,CAACwC,gBAAgB;EAC/BnB,IAAI,EAAEI,cAAc;EACpBgB,UAAU,EAAEhB,cAAc;EAC1BiB,UAAU,EAAEjB;CACb,CAAQ;AAiBX;;;;;;;AAOA,OAAO,MAAMkB,aAAa,gBAAkBtC,KAAK,CAAC;EAChDc,MAAM,EAAEnB,MAAM,CAAC4C,cAAc;EAC7BrB,MAAM,EAAEvB,MAAM,CAAC4C,cAAc;EAC7BxB,MAAM,EAAEpB,MAAM,CAAC4C,cAAc;EAC7BvB,IAAI,EAAErB,MAAM,CAAC6C,OAAO;EACpBJ,UAAU,EAAEzC,MAAM,CAAC6C,OAAO;EAC1BH,UAAU,EAAE1C,MAAM,CAAC6C;CACpB,CAAC;AAQF;;;;;;;AAOA,OAAO,MAAMC,IAAI,gBAAS9C,MAAM,CAAC+C,MAAM,CAACnB,IAAI,cAC1C5B,MAAM,CAAC6B,QAAQ,CAAC7B,MAAM,CAACgD,WAAW,EAAE;EAClChB,MAAM,eAAE/B,MAAM,CAACgD,oBAAoB,EAAE,CAACC,GAAG,CAACtD,QAAQ,CAACuD,UAAU,CAAC;EAC9Dd,MAAM,eAAEpC,MAAM,CAACmD,SAAS,CAACxD,QAAQ,CAACyD,aAAa;CAChD,CAAC,CACH;AAED;;;;AAIA,OAAO,MAAMC,WAAW,gBAAGnD,aAAa,CAACoD,YAAY,CAACT,IAAI,EAAE;EAC1DU,YAAY,eAAE3D,MAAM,CAACqD,GAAG,CAACtD,QAAQ,CAAC6D,GAAG,EAAE7D,QAAQ,CAACuD,UAAU;CAC3D,CAAC;AAEF;;;;AAIA,OAAO,MAAMO,eAAe,gBAAGvD,aAAa,CAACoD,YAAY,CAACvD,MAAM,CAAC2D,qBAAqB,EAAE;EACtFH,YAAY,EAAE5D,QAAQ,CAAC6D;CACxB,CAAC;AAEF;;;;AAIA,OAAO,MAAMG,uBAAuB,gBAAGzD,aAAa,CAACoD,YAAY,CAACvD,MAAM,CAAC6D,mBAAmB,EAAE;EAC5FL,YAAY,EAAE5D,QAAQ,CAAC6D;CACxB,CAAC;AAEF;;;;AAIA,OAAO,MAAMK,yBAAyB,gBAAG3D,aAAa,CAACoD,YAAY,CAACvD,MAAM,CAAC+D,qBAAqB,EAAE;EAChGP,YAAY,EAAE5D,QAAQ,CAAC6D;CACxB,CAAC;AAcF;;;;;;;;;AASA,OAAO,MAAMO,cAAc,gBAAmB3D,KAAK,CAAC;EAClDc,MAAM,EAAEnB,MAAM,CAAC2D,qBAAqB;EACpCpC,MAAM,EAAEmC,eAAe;EACvBrC,IAAI,EAAErB,MAAM,CAAC2D;CACd,CAAC;AAcF;;;;;;;;;AASA,OAAO,MAAMM,sBAAsB,gBAA2B5D,KAAK,CAAC;EAClEc,MAAM,EAAEnB,MAAM,CAAC6D,mBAAmB;EAClCtC,MAAM,EAAEqC,uBAAuB;EAC/BvC,IAAI,EAAErB,MAAM,CAAC2D;CACd,CAAC;AAcF;;;;;;;;;AASA,OAAO,MAAMO,wBAAwB,gBAA6B7D,KAAK,CAAC;EACtEc,MAAM,EAAEnB,MAAM,CAAC+D,qBAAqB;EACpCxC,MAAM,EAAEuC,yBAAyB;EACjCzC,IAAI,EAAErB,MAAM,CAAC+D;CACd,CAAC;AAeF;;;;;;;;;;AAUA,OAAO,MAAMI,cAAc,gBAAmB9D,KAAK,CAAC;EAClDc,MAAM,EAAEnB,MAAM,CAAC2D,qBAAqB;EACpCpC,MAAM,EAAEmC,eAAe;EACvBtC,MAAM,EAAEsC,eAAe;EACvBrC,IAAI,EAAErB,MAAM,CAAC2D;CACd,CAAC;AAeF;;;;;;;;;;AAUA,OAAO,MAAMS,sBAAsB,gBAA2B/D,KAAK,CAAC;EAClEc,MAAM,EAAEnB,MAAM,CAAC6D,mBAAmB;EAClCtC,MAAM,EAAEqC,uBAAuB;EAC/BxC,MAAM,EAAEwC,uBAAuB;EAC/BvC,IAAI,EAAErB,MAAM,CAAC2D;CACd,CAAC;AAeF;;;;;;;;;;AAUA,OAAO,MAAMU,wBAAwB,gBAA6BhE,KAAK,CAAC;EACtEc,MAAM,EAAEnB,MAAM,CAAC+D,qBAAqB;EACpCxC,MAAM,EAAEuC,yBAAyB;EACjC1C,MAAM,EAAE0C,yBAAyB;EACjCzC,IAAI,EAAErB,MAAM,CAAC+D;CACd,CAAC;AAiBF;;;;;;;;AAQA,OAAO,MAAMO,cAAc,GACzBpD,MAAS,IACY;EACrB,MAAMqD,MAAM,GAAGvE,MAAM,CAACwE,cAAc,CAACxE,MAAM,CAACyE,WAAW,CAACvD,MAAM,CAAC,CAAQ;EACvE,OAAOb,KAAK,CAAC;IACXc,MAAM,EAAEoD,MAAM;IACdhD,MAAM,EAAEgD,MAAM;IACdnD,MAAM,EAAEmD,MAAM;IACdlD,IAAI,EAAEH,MAAM;IACZuB,UAAU,EAAEvB,MAAM;IAClBwB,UAAU,EAAExB;GACb,CAAC;AACJ,CAAC;AAeD;;;;AAIA,OAAO,MAAMwD,UAAU,GAA+C1E,MAAM,CAAC0E,UAE5E;AAED;;;;AAIA,OAAO,MAAMC,kBAAkB,GAC7BzD,MAAmE,IAEnEA,MAAM,CAACU,IAAI,CAAC5B,MAAM,CAAC4E,sBAAsB,CAAC/E,MAAM,CAACgF,IAAI,CAAC,MAAMlF,IAAI,CAACmF,EAAE,CAAC,EAAE,EAAE,IAAIC,UAAU,CAACL,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3G;;;;;;AAMA,OAAO,MAAMM,YAAY,GACvB9D,MAAmE,IAEnEb,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdK,MAAM,EAAEoD,kBAAkB,CAACzD,MAAM,CAAC;EAClCE,MAAM,EAAEF,MAAM;EACdG,IAAI,EAAEH;CACP,CAAC","ignoreList":[]}
+{"version":3,"file":"Model.js","names":["Uuid","DateTime","Effect","Option","Predicate","Schema","Getter","Transformation","VariantSchema","Class","Field","FieldExcept","FieldOnly","Struct","Union","extract","fieldEvolve","make","variants","defaultVariant","fields","Override","GeneratedByDb","schema","select","json","GeneratedByApp","insert","update","Sensitive","optionalOption","optionalKey","NullOr","pipe","decodeTo","toType","transformOptional","decode","oe","filter","isNotNull","some","encode","flatten","FieldOption","OptionFromNullOr","jsonCreate","jsonUpdate","BooleanSqlite","BooleanFromBit","Boolean","Date","String","DateTimeUtc","dateTimeUtcFromInput","map","removeTime","transform","formatIsoDate","DateWithNow","Overrideable","defaultValue","now","DateTimeWithNow","DateTimeUtcFromString","DateTimeFromDateWithNow","DateTimeUtcFromDate","DateTimeFromNumberWithNow","DateTimeUtcFromMillis","DateTimeInsert","DateTimeInsertFromDate","DateTimeInsertFromNumber","DateTimeUpdate","DateTimeUpdateFromDate","DateTimeUpdateFromNumber","JsonFromString","parsed","fromJsonString","toCodecJson","Uint8Array","UuidV4BytesWithGenerate","withConstructorDefault","sync","v4","globalThis","UuidV4BytesInsert","UuidV4WithGenerate","UuidV4Insert","UuidV7WithGenerate","clockWith","clock","succeed","v7","msecs","currentTimeMillisUnsafe","UuidV7Insert"],"sources":["../../../src/unstable/schema/Model.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKA,IAAI,MAAM,MAAM;AAE5B,OAAO,KAAKC,QAAQ,MAAM,mBAAmB;AAC7C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAC/C,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAC/D,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD,MAAM;EACJC,KAAK;EACLC,KAAK;EACLC,WAAW;EACXC,SAAS;EACTC,MAAM;EACNC,KAAK;EACLC,OAAO;EACPC;AAAW,CACZ,gBAAGR,aAAa,CAACS,IAAI,CAAC;EACrBC,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC;EAC5EC,cAAc,EAAE;CACjB,CAAC;AAkCF;AACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CAV,KAAK;AACL;;;;AAIAM,OAAO;AACP;;;;AAIAL,KAAK;AACL;;;;AAIAM,WAAW;AACX;;;;AAIAL,WAAW;AACX;;;;AAIAC,SAAS;AACT;;;;AAIAC,MAAM;AACN;;;;AAIAC,KAAK;AAGP;;;;;;AAMA,OAAO,MAAMM,MAAM,GACjBZ,aAAa,CAACY,MAAM;AAEtB;;;;;;;AAOA,OAAO,MAAMC,QAAQ,GAA2Cb,aAAa,CAACa,QAAQ;AAgBtF;;;;;;;;AAQA,OAAO,MAAMC,aAAa,GACxBC,MAAS,IAETb,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdE,IAAI,EAAEF;CACP,CAAC;AAmBJ;;;;;;;;;AASA,OAAO,MAAMG,cAAc,GAA0BH,MAAS,IAC5Db,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdI,MAAM,EAAEJ,MAAM;EACdK,MAAM,EAAEL,MAAM;EACdE,IAAI,EAAEF;CACP,CAAC;AAiBJ;;;;;;;AAOA,OAAO,MAAMM,SAAS,GAA0BN,MAAS,IACvDb,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdI,MAAM,EAAEJ,MAAM;EACdK,MAAM,EAAEL;CACT,CAAC;AAaJ;;;;;;;AAOA,OAAO,MAAMO,cAAc,GAA0BP,MAAS,IAC5DlB,MAAM,CAAC0B,WAAW,CAAC1B,MAAM,CAAC2B,MAAM,CAACT,MAAM,CAAC,CAAC,CAACU,IAAI,CAC5C5B,MAAM,CAAC6B,QAAQ,CACb7B,MAAM,CAACF,MAAM,CAACE,MAAM,CAAC8B,MAAM,CAACZ,MAAM,CAAC,CAAC,EACpChB,cAAc,CAAC6B,iBAAiB,CAA6C;EAC3EC,MAAM,EAAGC,EAAE,IAAKA,EAAE,CAACL,IAAI,CAAC9B,MAAM,CAACoC,MAAM,CAACnC,SAAS,CAACoC,SAAS,CAAC,EAAErC,MAAM,CAACsC,IAAI,CAAC;EACxEC,MAAM,EAAEvC,MAAM,CAACwC;CAChB,CAAQ,CACV,CACF;AAsBH;;;;;;;;;AASA,OAAO,MAAMC,WAAW,gBAUd5B,WAAW,CAAC;EAClBQ,MAAM,EAAEnB,MAAM,CAACwC,gBAAgB;EAC/BlB,MAAM,EAAEtB,MAAM,CAACwC,gBAAgB;EAC/BjB,MAAM,EAAEvB,MAAM,CAACwC,gBAAgB;EAC/BpB,IAAI,EAAEK,cAAc;EACpBgB,UAAU,EAAEhB,cAAc;EAC1BiB,UAAU,EAAEjB;CACb,CAAQ;AAoBX;;;;;;;AAOA,OAAO,MAAMkB,aAAa,gBAAkBtC,KAAK,CAAC;EAChDc,MAAM,EAAEnB,MAAM,CAAC4C,cAAc;EAC7BtB,MAAM,EAAEtB,MAAM,CAAC4C,cAAc;EAC7BrB,MAAM,EAAEvB,MAAM,CAAC4C,cAAc;EAC7BxB,IAAI,EAAEpB,MAAM,CAAC6C,OAAO;EACpBJ,UAAU,EAAEzC,MAAM,CAAC6C,OAAO;EAC1BH,UAAU,EAAE1C,MAAM,CAAC6C;CACpB,CAAC;AAWF;;;;;;;AAOA,OAAO,MAAMC,IAAI,gBAAS9C,MAAM,CAAC+C,MAAM,CAACnB,IAAI,cAC1C5B,MAAM,CAAC6B,QAAQ,CAAC7B,MAAM,CAACgD,WAAW,EAAE;EAClChB,MAAM,eAAE/B,MAAM,CAACgD,oBAAoB,EAAE,CAACC,GAAG,CAACtD,QAAQ,CAACuD,UAAU,CAAC;EAC9Dd,MAAM,eAAEpC,MAAM,CAACmD,SAAS,CAACxD,QAAQ,CAACyD,aAAa;CAChD,CAAC,CACH;AAED;;;;;;;AAOA,OAAO,MAAMC,WAAW,gBAAGnD,aAAa,CAACoD,YAAY,CAACT,IAAI,EAAE;EAC1DU,YAAY,eAAE3D,MAAM,CAACqD,GAAG,CAACtD,QAAQ,CAAC6D,GAAG,EAAE7D,QAAQ,CAACuD,UAAU;CAC3D,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMO,eAAe,gBAAGvD,aAAa,CAACoD,YAAY,CAACvD,MAAM,CAAC2D,qBAAqB,EAAE;EACtFH,YAAY,EAAE5D,QAAQ,CAAC6D;CACxB,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMG,uBAAuB,gBAAGzD,aAAa,CAACoD,YAAY,CAACvD,MAAM,CAAC6D,mBAAmB,EAAE;EAC5FL,YAAY,EAAE5D,QAAQ,CAAC6D;CACxB,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMK,yBAAyB,gBAAG3D,aAAa,CAACoD,YAAY,CAACvD,MAAM,CAAC+D,qBAAqB,EAAE;EAChGP,YAAY,EAAE5D,QAAQ,CAAC6D;CACxB,CAAC;AAiBF;;;;;;;;;AASA,OAAO,MAAMO,cAAc,gBAAmB3D,KAAK,CAAC;EAClDc,MAAM,EAAEnB,MAAM,CAAC2D,qBAAqB;EACpCrC,MAAM,EAAEoC,eAAe;EACvBtC,IAAI,EAAEpB,MAAM,CAAC2D;CACd,CAAC;AAiBF;;;;;;;;;AASA,OAAO,MAAMM,sBAAsB,gBAA2B5D,KAAK,CAAC;EAClEc,MAAM,EAAEnB,MAAM,CAAC6D,mBAAmB;EAClCvC,MAAM,EAAEsC,uBAAuB;EAC/BxC,IAAI,EAAEpB,MAAM,CAAC2D;CACd,CAAC;AAiBF;;;;;;;;;AASA,OAAO,MAAMO,wBAAwB,gBAA6B7D,KAAK,CAAC;EACtEc,MAAM,EAAEnB,MAAM,CAAC+D,qBAAqB;EACpCzC,MAAM,EAAEwC,yBAAyB;EACjC1C,IAAI,EAAEpB,MAAM,CAAC+D;CACd,CAAC;AAkBF;;;;;;;;;;AAUA,OAAO,MAAMI,cAAc,gBAAmB9D,KAAK,CAAC;EAClDc,MAAM,EAAEnB,MAAM,CAAC2D,qBAAqB;EACpCrC,MAAM,EAAEoC,eAAe;EACvBnC,MAAM,EAAEmC,eAAe;EACvBtC,IAAI,EAAEpB,MAAM,CAAC2D;CACd,CAAC;AAmBF;;;;;;;;;;AAUA,OAAO,MAAMS,sBAAsB,gBAA2B/D,KAAK,CAAC;EAClEc,MAAM,EAAEnB,MAAM,CAAC6D,mBAAmB;EAClCvC,MAAM,EAAEsC,uBAAuB;EAC/BrC,MAAM,EAAEqC,uBAAuB;EAC/BxC,IAAI,EAAEpB,MAAM,CAAC2D;CACd,CAAC;AAkBF;;;;;;;;;;AAUA,OAAO,MAAMU,wBAAwB,gBAA6BhE,KAAK,CAAC;EACtEc,MAAM,EAAEnB,MAAM,CAAC+D,qBAAqB;EACpCzC,MAAM,EAAEwC,yBAAyB;EACjCvC,MAAM,EAAEuC,yBAAyB;EACjC1C,IAAI,EAAEpB,MAAM,CAAC+D;CACd,CAAC;AAoBF;;;;;;;;AAQA,OAAO,MAAMO,cAAc,GACzBpD,MAAS,IACY;EACrB,MAAMqD,MAAM,GAAGvE,MAAM,CAACwE,cAAc,CAACxE,MAAM,CAACyE,WAAW,CAACvD,MAAM,CAAC,CAAQ;EACvE,OAAOb,KAAK,CAAC;IACXc,MAAM,EAAEoD,MAAM;IACdjD,MAAM,EAAEiD,MAAM;IACdhD,MAAM,EAAEgD,MAAM;IACdnD,IAAI,EAAEF,MAAM;IACZuB,UAAU,EAAEvB,MAAM;IAClBwB,UAAU,EAAExB;GACb,CAAC;AACJ,CAAC;AAkBD;;;;;;AAMA,OAAO,MAAMwD,UAAU,GAA+C1E,MAAM,CAAC0E,UAE5E;AAED;;;;;;;AAOA,OAAO,MAAMC,uBAAuB,GAClCzD,MAAmE,IAEnEA,MAAM,CAACU,IAAI,CAAC5B,MAAM,CAAC4E,sBAAsB,CAAC/E,MAAM,CAACgF,IAAI,CAAC,MAAMlF,IAAI,CAACmF,EAAE,CAAC,EAAE,EAAE,IAAIC,UAAU,CAACL,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3G;;;;;;AAMA,OAAO,MAAMM,iBAAiB,GAC5B9D,MAAmE,IAEnEb,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdI,MAAM,EAAEqD,uBAAuB,CAACzD,MAAM,CAAC;EACvCK,MAAM,EAAEL,MAAM;EACdE,IAAI,EAAEF;CACP,CAAC;AAkBJ;;;;;;AAMA,OAAO,MAAM+D,kBAAkB,GAC7B/D,MAAsC,IAEtCA,MAAM,CAACU,IAAI,CAAC5B,MAAM,CAAC4E,sBAAsB,CAAC/E,MAAM,CAACgF,IAAI,CAAC,MAAMlF,IAAI,CAACmF,EAAE,EAAE,CAAC,CAAC,CAAC;AAE1E;;;;;;AAMA,OAAO,MAAMI,YAAY,GACvBhE,MAAsC,IAEtCb,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdI,MAAM,EAAE2D,kBAAkB,CAAC/D,MAAM,CAAC;EAClCK,MAAM,EAAEL,MAAM;EACdE,IAAI,EAAEF;CACP,CAAC;AAkBJ;;;;;;AAMA,OAAO,MAAMiE,kBAAkB,GAC7BjE,MAAsC,IAEtCA,MAAM,CAACU,IAAI,CAAC5B,MAAM,CAAC4E,sBAAsB,CAAC/E,MAAM,CAACuF,SAAS,CAAEC,KAAK,IAC/DxF,MAAM,CAACyF,OAAO,CAAC3F,IAAI,CAAC4F,EAAE,CAAC;EACrBC,KAAK,EAAEH,KAAK,CAACI,uBAAuB;CACrC,CAAC,CAAC,CACJ,CAAC,CAAC;AAEL;;;;;;AAMA,OAAO,MAAMC,YAAY,GACvBxE,MAAsC,IAEtCb,KAAK,CAAC;EACJc,MAAM,EAAED,MAAM;EACdI,MAAM,EAAE6D,kBAAkB,CAACjE,MAAM,CAAC;EAClCK,MAAM,EAAEL,MAAM;EACdE,IAAI,EAAEF;CACP,CAAC","ignoreList":[]}

package/dist/unstable/schema/VariantSchema.d.ts

@@ -1,4 +1,23 @@
 /**
+ * Build families of related struct schemas from one field definition.
+ *
+ * `VariantSchema` is useful when the same domain object needs several schema
+ * views, such as database select / insert / update shapes, JSON read / write
+ * shapes, public versus private API views, or constructor schemas with
+ * generated defaults. {@link make} fixes a closed set of variant names and a
+ * default variant, then returns helpers for defining shared `Struct` values,
+ * per-variant `Field` values, schema classes, unions, and extracted
+ * `Schema.Struct` projections.
+ *
+ * A plain schema in a variant struct is present in every variant, a `Field`
+ * contributes a property only to the variants named in its config, and nested
+ * variant structs are extracted recursively. Variants are projections, not
+ * discriminated alternatives: this module does not add a tag field, so include
+ * an explicit literal tag when a decoded union needs runtime discrimination.
+ * Also remember that the default variant is the schema used by generated
+ * classes and ordinary variant unions; per-variant schemas are exposed
+ * separately on those generated values.
+ *
  * @since 4.0.0
  */
 import type { Brand } from "../../Brand.ts";
@@ -8,44 +27,60 @@ import * as Schema from "../../Schema.ts";
 import type * as AST from "../../SchemaAST.ts";
 import * as Struct_ from "../../Struct.ts";
 /**
+ * Runtime type identifier attached to variant schema structs.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export declare const TypeId = "~effect/schema/VariantSchema";
 /**
- * @since 4.0.0
+ * Pipeable container of schema fields that can be extracted into per-variant
+ * `Schema.Struct` schemas.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Struct<in out A extends Field.Fields> extends Pipeable {
     readonly [TypeId]: A;
 }
 /**
- * @since 4.0.0
+ * Returns `true` when a value is a variant schema struct.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export declare const isStruct: (u: unknown) => u is Struct<any>;
 /**
+ * Type-level helpers for variant schema structs.
+ *
  * @since 4.0.0
- * @category models
  */
 export declare namespace Struct {
     /**
-     * @since 4.0.0
+     * Minimal structural type for any variant schema struct.
+     *
      * @category models
+     * @since 4.0.0
      */
     type Any = {
         readonly [TypeId]: any;
     };
     /**
-     * @since 4.0.0
+     * Field map accepted by a variant struct, where each property may be a schema, a
+     * variant field, a nested struct, or `undefined`.
+     *
      * @category models
+     * @since 4.0.0
      */
     type Fields = {
         readonly [key: string]: Schema.Top | Field<any> | Struct<any> | undefined;
     };
     /**
-     * @since 4.0.0
+     * Type-level validation that every variant field in a struct only uses variants
+     * from the configured variant set.
+     *
      * @category models
+     * @since 4.0.0
      */
     type Validate<A, Variant extends string> = {
         readonly [K in keyof A]: A[K] extends {
@@ -55,74 +90,100 @@ export declare namespace Struct {
 }
 declare const FieldTypeId = "~effect/schema/VariantSchema/Field";
 /**
- * @since 4.0.0
+ * Pipeable collection of variant-specific schemas for a single logical field.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Field<in out A extends Field.Config> extends Pipeable {
     readonly [FieldTypeId]: typeof FieldTypeId;
     readonly schemas: A;
 }
 /**
- * @since 4.0.0
+ * Returns `true` when a value is a variant schema field.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export declare const isField: (u: unknown) => u is Field<any>;
 /**
+ * Type-level helpers for variant schema fields.
+ *
  * @since 4.0.0
- * @category models
  */
 export declare namespace Field {
     /**
-     * @since 4.0.0
+     * Minimal structural type for any variant schema field.
+     *
      * @category models
+     * @since 4.0.0
      */
     type Any = {
         readonly [FieldTypeId]: typeof FieldTypeId;
     };
     /**
-     * @since 4.0.0
+     * Map from variant name to the schema used for a field in that variant.
+     *
      * @category models
+     * @since 4.0.0
      */
     type Config = {
         readonly [key: string]: Schema.Top | undefined;
     };
     /**
-     * @since 4.0.0
+     * Variant field configuration restricted to an optional subset of the supplied
+     * variant keys.
+     *
      * @category models
+     * @since 4.0.0
      */
     type ConfigWithKeys<K extends string> = {
         readonly [P in K]?: Schema.Top;
     };
     /**
-     * @since 4.0.0
+     * Field map whose properties may be schemas, variant fields, nested structs, or
+     * `undefined`.
+     *
      * @category models
+     * @since 4.0.0
      */
     type Fields = {
         readonly [key: string]: Schema.Top | Field<any> | Struct<any> | undefined;
     };
 }
 /**
- * @since 4.0.0
+ * Computes the `Schema.Struct` field map for a variant by selecting matching
+ * field schemas and recursively extracting nested structs.
+ *
  * @category extractors
+ * @since 4.0.0
  */
 export type ExtractFields<V extends string, Fields extends Struct.Fields, IsDefault = false> = {
     readonly [K in keyof Fields as [Fields[K]] extends [Field<infer Config>] ? V extends keyof Config ? K : never : K]: [Fields[K]] extends [Struct<infer _>] ? Extract<V, Fields[K], IsDefault> : [Fields[K]] extends [Field<infer Config>] ? [Config[V]] extends [Schema.Top] ? Config[V] : never : [Fields[K]] extends [Schema.Top] ? Fields[K] : never;
 };
 /**
- * @since 4.0.0
+ * Computes the schema type produced by extracting a single variant from a variant
+ * schema struct.
+ *
  * @category extractors
+ * @since 4.0.0
  */
 export type Extract<V extends string, A extends Struct<any>, IsDefault = false> = [A] extends [
     Struct<infer Fields>
 ] ? IsDefault extends true ? [A] extends [Schema.Top] ? A : Schema.Struct<Struct_.Simplify<ExtractFields<V, Fields>>> : Schema.Struct<Struct_.Simplify<ExtractFields<V, Fields>>> : never;
 /**
+ * Returns the original field definitions stored on a variant schema struct.
+ *
  * @category accessors
  * @since 4.0.0
  */
 export declare const fields: <A extends Struct<any>>(self: A) => A[typeof TypeId];
 /**
- * @since 4.0.0
+ * Schema class type returned by variant class constructors, combining the default
+ * variant schema with access to the original variant fields.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Class<Self, Fields extends Struct.Fields, S extends Schema.Top & {
     readonly fields: Schema.Struct.Fields;
@@ -137,21 +198,26 @@ export interface Class<Self, Fields extends Struct.Fields, S extends Schema.Top
 }
 type MissingSelfGeneric<Params extends string = ""> = `Missing \`Self\` generic - use \`class Self extends Class<Self>()(${Params}{ ... })\``;
 /**
- * @since 4.0.0
+ * Union schema over the default schemas of a list of variant schema structs.
+ *
  * @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;
 }> {
 }
 /**
+ * Type-level helpers for unions of variant schema structs.
+ *
  * @since 4.0.0
- * @category models
  */
 export declare namespace Union {
     /**
-     * @since 4.0.0
+     * Computes a union schema for each variant from a list of variant schema structs.
+     *
      * @category models
+     * @since 4.0.0
      */
     type Variants<Members extends ReadonlyArray<Struct<any>>, Variants extends string> = {
         readonly [Variant in Variants]: Schema.Union<{
@@ -160,8 +226,11 @@ export declare namespace Union {
     };
 }
 /**
- * @since 4.0.0
+ * Creates a variant schema toolkit for a fixed set of variant names and a default
+ * variant.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const make: <const Variants extends ReadonlyArray<string>, const Default extends Variants[number]>(options: {
     readonly variants: Variants;
@@ -183,19 +252,27 @@ export declare const make: <const Variants extends ReadonlyArray<string>, const
     };
 };
 /**
- * @since 4.0.0
+ * Brands a value as an explicit override for an `Overrideable` schema default.
+ *
  * @category overrideable
+ * @since 4.0.0
  */
 export declare const Override: <A>(value: A) => A & Brand<"Override">;
 /**
- * @since 4.0.0
+ * Schema type whose constructor can use an effectful default unless a value is
+ * explicitly branded with `Override`.
+ *
  * @category overrideable
+ * @since 4.0.0
  */
 export interface Overrideable<S extends Schema.Top & Schema.WithoutConstructorDefault> extends Schema.Bottom<S["Type"] & Brand<"Override">, S["Encoded"], S["DecodingServices"], S["EncodingServices"], S["ast"], Overrideable<S>, S["~type.make.in"], (S["Type"] & Brand<"Override">) | undefined, S["~type.parameters"], (S["Type"] & Brand<"Override">) | undefined, S["~type.mutability"], "required", "with-default", S["~encoded.mutability"], S["~encoded.optionality"]> {
 }
 /**
- * @since 4.0.0
+ * Wraps a schema with an effectful constructor default while allowing explicit
+ * values to be marked with `Override`.
+ *
  * @category overrideable
+ * @since 4.0.0
  */
 export declare const Overrideable: <S extends Schema.Top & Schema.WithoutConstructorDefault>(schema: S, options: {
     readonly defaultValue: Effect.Effect<S["~type.make.in"]>;