@strictly/define 0.0.31 → 0.0.32

package/.out/types/builders.js

@@ -1,3 +1,4 @@
+import { map, UnreachableError, } from '@strictly/base';
 import { isAnnotatedValidator, mergeAnnotations, validate, } from 'validation/validator';
 import { TypeDefType, } from './Type';
 import { typeOfType, } from './typeOfType';
@@ -97,10 +98,31 @@ class ObjectTypeDefBuilder extends TypeDefBuilder {
 }
 class UnionTypeDefBuilder extends TypeDefBuilder {
     or(k, { definition: typeDef, }) {
-        const { unions, } = this.definition;
+        const { unions, discriminator, } = this.definition;
+        // add the discriminator as a field to the underlying union type
+        const enhancedTypeDef = maybeAddDiscriminatorField(typeDef, discriminator, k);
         return new UnionTypeDefBuilder(Object.assign(Object.assign({}, this.definition), { 
             // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-            unions: Object.assign(Object.assign({}, unions), { [k]: typeDef }) }));
+            unions: Object.assign(Object.assign({}, unions), { [k]: enhancedTypeDef }) }));
+    }
+}
+function maybeAddDiscriminatorField(t, discriminatorKey, discriminatorLiteral) {
+    if (discriminatorKey == null) {
+        return t;
+    }
+    switch (t.type) {
+        case TypeDefType.List:
+        case TypeDefType.Literal:
+        case TypeDefType.Record:
+            return t;
+        case TypeDefType.Object:
+            return Object.assign(Object.assign({}, t), { fields: Object.assign(Object.assign({}, t.fields), { [discriminatorKey]: literal([discriminatorLiteral]).readonly().required().narrow.definition }) });
+        case TypeDefType.Union:
+            return Object.assign(Object.assign({}, t), { unions: map(t.unions, (_k, v) => {
+                    return maybeAddDiscriminatorField(v, discriminatorKey, discriminatorLiteral);
+                }) });
+        default:
+            throw new UnreachableError(t);
     }
 }
 export function literal(value) {

package/.out/types/flattened.d.ts

@@ -1,2 +1,2 @@
-export type StartingDepth = 7;
+export type StartingDepth = 5;
 export type Depths = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];

package/.turbo/turbo-build.log

@@ -7,12 +7,12 @@ $ tsup
 CLI Target: es6
 CJS Build start
 ESM Build start
-CJS dist/index.cjs 35.88 KB
-CJS ⚡️ Build success in 88ms
-ESM dist/index.js 33.29 KB
-ESM ⚡️ Build success in 89ms
+ESM dist/index.js 34.08 KB
+ESM ⚡️ Build success in 119ms
+CJS dist/index.cjs 36.67 KB
+CJS ⚡️ Build success in 126ms
 DTS Build start
-DTS ⚡️ Build success in 7960ms
-DTS dist/index.d.cts 41.80 KB
-DTS dist/index.d.ts  41.80 KB
-Done in 9.24s.
+DTS ⚡️ Build success in 5988ms
+DTS dist/index.d.cts 41.82 KB
+DTS dist/index.d.ts  41.82 KB
+Done in 7.55s.

package/.turbo/turbo-check-types.log

@@ -1,3 +1,3 @@
 yarn run v1.22.22
 $ tsc -b
-Done in 0.35s.
+Done in 0.29s.

package/dist/index.cjs

@@ -193,14 +193,7 @@ function copyUnion(typeDef, value, copier) {
   } = typeDef;
   if (discriminator != null) {
     const discriminatorValue = value[discriminator];
-    const discriminatingUnion = __spreadProps(__spreadValues({}, internalCopyTo(
-      unions[discriminatorValue],
-      value,
-      copier
-    )), {
-      [discriminator]: discriminatorValue
-    });
-    return copier(discriminatingUnion, typeDef);
+    return internalCopyTo(unions[discriminatorValue], value, copier);
   }
   const allTypeDefs = Object.values(unions);
   const variableTypeDefs = allTypeDefs.filter(function(typeDef2) {
@@ -417,7 +410,7 @@ function observeValue(v, def) {
         }
       );
     case 4 /* Object */:
-      return (0, import_mobx.makeObservable)(
+      return (0, import_mobx.observable)(
         v,
         (0, import_base4.reduce)(
           def.fields,
@@ -800,6 +793,9 @@ function internalJsonValuePathToTypePath(typeDef, qualifiers, valueSteps, allowM
   }
 }
 
+// types/builders.ts
+var import_base9 = require("@strictly/base");
+
 // validation/validators/CompositeValidator.ts
 var CompositeValidator = class {
   constructor(...validators) {
@@ -1066,18 +1062,45 @@ var UnionTypeDefBuilder = class _UnionTypeDefBuilder extends TypeDefBuilder {
     definition: typeDef
   }) {
     const {
-      unions
+      unions,
+      discriminator
     } = this.definition;
+    const enhancedTypeDef = maybeAddDiscriminatorField(typeDef, discriminator, k);
     return new _UnionTypeDefBuilder(
       __spreadProps(__spreadValues({}, this.definition), {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         unions: __spreadProps(__spreadValues({}, unions), {
-          [k]: typeDef
+          [k]: enhancedTypeDef
         })
       })
     );
   }
 };
+function maybeAddDiscriminatorField(t, discriminatorKey, discriminatorLiteral) {
+  if (discriminatorKey == null) {
+    return t;
+  }
+  switch (t.type) {
+    case 2 /* List */:
+    case 1 /* Literal */:
+    case 3 /* Record */:
+      return t;
+    case 4 /* Object */:
+      return __spreadProps(__spreadValues({}, t), {
+        fields: __spreadProps(__spreadValues({}, t.fields), {
+          [discriminatorKey]: literal([discriminatorLiteral]).readonly().required().narrow.definition
+        })
+      });
+    case 5 /* Union */:
+      return __spreadProps(__spreadValues({}, t), {
+        unions: (0, import_base9.map)(t.unions, (_k, v) => {
+          return maybeAddDiscriminatorField(v, discriminatorKey, discriminatorLiteral);
+        })
+      });
+    default:
+      throw new import_base9.UnreachableError(t);
+  }
+}
 function literal(value) {
   return new TypeDefBuilder({
     type: 1 /* Literal */,

package/dist/index.d.cts

@@ -149,7 +149,7 @@ declare function mobxCopy<T extends StrictType>(t: T, proto: ValueOfType<Readonl
 
 declare function equals<T extends Type>({ definition }: T, o1: ValueOfType<T>, o2: ValueOfType<T>): boolean;
 
-type StartingDepth = 7;
+type StartingDepth = 5;
 type Depths = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
 
 type PathOf<Prefix extends string, Accessor extends string | number | symbol, SegmentOverride extends string | null = null> = SegmentOverride extends string ? `${Prefix}.${SegmentOverride}` : Accessor extends string | number ? `${Prefix}.${Accessor}` : never;
@@ -189,7 +189,7 @@ type FlattenedAccessorsOfType<T extends Type, Flattened extends Readonly<Record<
 type AnyValueType = any;
 type Setter<V> = (v: V) => void;
 type Mapper<R> = (t: StrictTypeDef, v: AnyValueType, setter: Setter<AnyValueType>, typePath: string, valuePath: string) => R;
-declare function flattenValueTo<T extends StrictType, M, R extends Readonly<Record<string, M>>>({ definition }: T, v: ValueOfType<T>, setter: Setter<ValueOfType<T>>, mapper: Mapper<M>, listIndicesToKeys?: Record<string, number[]>): R;
+declare function flattenValueTo<T extends StrictType, M, R extends Readonly<Record<string, M>>>({ definition }: T, v: ValueOfType<ReadonlyTypeOfType<T>>, setter: Setter<ValueOfType<T>>, mapper: Mapper<M>, listIndicesToKeys?: Record<string, number[]>): R;
 declare function getUnionTypeDef<T extends UnionTypeDef>(typeDef: T, v: ValueOfType<ReadonlyTypeOfType<{
     definition: T;
 }>>): any;

package/dist/index.d.ts

@@ -149,7 +149,7 @@ declare function mobxCopy<T extends StrictType>(t: T, proto: ValueOfType<Readonl
 
 declare function equals<T extends Type>({ definition }: T, o1: ValueOfType<T>, o2: ValueOfType<T>): boolean;
 
-type StartingDepth = 7;
+type StartingDepth = 5;
 type Depths = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
 
 type PathOf<Prefix extends string, Accessor extends string | number | symbol, SegmentOverride extends string | null = null> = SegmentOverride extends string ? `${Prefix}.${SegmentOverride}` : Accessor extends string | number ? `${Prefix}.${Accessor}` : never;
@@ -189,7 +189,7 @@ type FlattenedAccessorsOfType<T extends Type, Flattened extends Readonly<Record<
 type AnyValueType = any;
 type Setter<V> = (v: V) => void;
 type Mapper<R> = (t: StrictTypeDef, v: AnyValueType, setter: Setter<AnyValueType>, typePath: string, valuePath: string) => R;
-declare function flattenValueTo<T extends StrictType, M, R extends Readonly<Record<string, M>>>({ definition }: T, v: ValueOfType<T>, setter: Setter<ValueOfType<T>>, mapper: Mapper<M>, listIndicesToKeys?: Record<string, number[]>): R;
+declare function flattenValueTo<T extends StrictType, M, R extends Readonly<Record<string, M>>>({ definition }: T, v: ValueOfType<ReadonlyTypeOfType<T>>, setter: Setter<ValueOfType<T>>, mapper: Mapper<M>, listIndicesToKeys?: Record<string, number[]>): R;
 declare function getUnionTypeDef<T extends UnionTypeDef>(typeDef: T, v: ValueOfType<ReadonlyTypeOfType<{
     definition: T;
 }>>): any;

package/dist/index.js

@@ -136,14 +136,7 @@ function copyUnion(typeDef, value, copier) {
   } = typeDef;
   if (discriminator != null) {
     const discriminatorValue = value[discriminator];
-    const discriminatingUnion = __spreadProps(__spreadValues({}, internalCopyTo(
-      unions[discriminatorValue],
-      value,
-      copier
-    )), {
-      [discriminator]: discriminatorValue
-    });
-    return copier(discriminatingUnion, typeDef);
+    return internalCopyTo(unions[discriminatorValue], value, copier);
   }
   const allTypeDefs = Object.values(unions);
   const variableTypeDefs = allTypeDefs.filter(function(typeDef2) {
@@ -174,7 +167,6 @@ import {
   UnreachableError as UnreachableError3
 } from "@strictly/base";
 import {
-  makeObservable,
   observable
 } from "mobx";
 
@@ -372,7 +364,7 @@ function observeValue(v, def) {
         }
       );
     case 4 /* Object */:
-      return makeObservable(
+      return observable(
         v,
         reduce3(
           def.fields,
@@ -767,6 +759,12 @@ function internalJsonValuePathToTypePath(typeDef, qualifiers, valueSteps, allowM
   }
 }
 
+// types/builders.ts
+import {
+  map as map3,
+  UnreachableError as UnreachableError8
+} from "@strictly/base";
+
 // validation/validators/CompositeValidator.ts
 var CompositeValidator = class {
   constructor(...validators) {
@@ -1036,18 +1034,45 @@ var UnionTypeDefBuilder = class _UnionTypeDefBuilder extends TypeDefBuilder {
     definition: typeDef
   }) {
     const {
-      unions
+      unions,
+      discriminator
     } = this.definition;
+    const enhancedTypeDef = maybeAddDiscriminatorField(typeDef, discriminator, k);
     return new _UnionTypeDefBuilder(
       __spreadProps(__spreadValues({}, this.definition), {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         unions: __spreadProps(__spreadValues({}, unions), {
-          [k]: typeDef
+          [k]: enhancedTypeDef
         })
       })
     );
   }
 };
+function maybeAddDiscriminatorField(t, discriminatorKey, discriminatorLiteral) {
+  if (discriminatorKey == null) {
+    return t;
+  }
+  switch (t.type) {
+    case 2 /* List */:
+    case 1 /* Literal */:
+    case 3 /* Record */:
+      return t;
+    case 4 /* Object */:
+      return __spreadProps(__spreadValues({}, t), {
+        fields: __spreadProps(__spreadValues({}, t.fields), {
+          [discriminatorKey]: literal([discriminatorLiteral]).readonly().required().narrow.definition
+        })
+      });
+    case 5 /* Union */:
+      return __spreadProps(__spreadValues({}, t), {
+        unions: map3(t.unions, (_k, v) => {
+          return maybeAddDiscriminatorField(v, discriminatorKey, discriminatorLiteral);
+        })
+      });
+    default:
+      throw new UnreachableError8(t);
+  }
+}
 function literal(value) {
   return new TypeDefBuilder({
     type: 1 /* Literal */,

package/package.json

@@ -38,7 +38,7 @@
     "test:watch": "vitest"
   },
   "type": "module",
-  "version": "0.0.31",
+  "version": "0.0.32",
   "exports": {
     ".": {
       "import": {

package/transformers/copies/copyTo.ts

@@ -195,15 +195,7 @@ function copyUnion<
   // is it a discriminated union with a struct?
   if (discriminator != null) {
     const discriminatorValue = value[discriminator]
-    const discriminatingUnion = {
-      ...internalCopyTo(
-        unions[discriminatorValue],
-        value,
-        copier,
-      ),
-      [discriminator]: discriminatorValue,
-    }
-    return copier(discriminatingUnion, typeDef)
+    return internalCopyTo(unions[discriminatorValue], value, copier)
   }
 
   // is it a `<constant1> | <constant2> | X`? We can handle that

package/transformers/copies/mobxCopy.ts

@@ -4,7 +4,6 @@ import {
 } from '@strictly/base'
 import {
   type IObservableFactory,
-  makeObservable,
   observable,
 } from 'mobx'
 import { getUnionTypeDef } from 'transformers/flatteners/flattenValueTo'
@@ -49,7 +48,7 @@ function observeValue(
       )
     case TypeDefType.Object:
       // `makeObservable` only observes the specified props
-      return makeObservable(
+      return observable(
         v,
         reduce(
           def.fields,

package/transformers/copies/specs/copyTo.tests.ts

@@ -134,7 +134,7 @@ describe('copyTo', function () {
         )
 
         expect(c).toEqual({
-          d: 'a',
+          d: '"a"',
           x: '1',
         })
       })

package/transformers/flatteners/flattenValueTo.ts

@@ -37,7 +37,7 @@ export function flattenValueTo<
   R extends Readonly<Record<string, M>>,
 >(
   { definition }: T,
-  v: ValueOfType<T>,
+  v: ValueOfType<ReadonlyTypeOfType<T>>,
   setter: Setter<ValueOfType<T>>,
   mapper: Mapper<M>,
   // used to maintain keys when changing lists, note that the format for a list of three elements is

package/transformers/flatteners/specs/flattenJsonValueToTypePathsOf.tests.ts

@@ -108,6 +108,7 @@ describe('flattenJsonValueToTypePathsOf', function () {
           $: '$',
           '$:x.a': '$:x.a',
           '$:x.b': '$:x.b',
+          '$:x.d': '$:x.d',
         })
       })
     })

package/transformers/flatteners/specs/flattenTypeTo.tests.ts

@@ -136,12 +136,14 @@ describe('flattenTypeDefTo', function () {
         expect(flattened).toEqual({
           $: TypeDefType.Union,
           '$:a.a': TypeDefType.Literal,
+          '$:a.d': TypeDefType.Literal,
           '$:b.b': TypeDefType.Literal,
+          '$:b.d': TypeDefType.Literal,
         })
       })
 
       it('calls the mapper function', function () {
-        expect(toTypeDefType).toHaveBeenCalledTimes(3)
+        expect(toTypeDefType).toHaveBeenCalledTimes(5)
       })
     })
   })

package/transformers/flatteners/specs/flattenValueTo.tests.ts

@@ -330,6 +330,7 @@ describe('flattenValueTo', function () {
           expect(flattened).toEqual({
             $: '{"d":"1","a":2}',
             ['$:1.a']: '2',
+            ['$:1.d']: '"1"',
           })
         })
       })

package/types/builders.ts

@@ -1,5 +1,7 @@
 import {
   type IsFieldReadonly,
+  map,
+  UnreachableError,
 } from '@strictly/base'
 import {
   isAnnotatedValidator,
@@ -343,20 +345,56 @@ class UnionTypeDefBuilder<
   ): UnionTypeDefBuilder<E, C, D, Readonly<Record<K, T>> & U> {
     const {
       unions,
+      discriminator,
     } = this.definition
+    // add the discriminator as a field to the underlying union type
+    const enhancedTypeDef = maybeAddDiscriminatorField(typeDef, discriminator, k)
     return new UnionTypeDefBuilder<E, C, D, Readonly<Record<K, T>> & U>(
       {
         ...this.definition,
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         unions: {
           ...unions,
-          [k]: typeDef,
+          [k]: enhancedTypeDef,
         } as Readonly<Record<K, T>> & U,
       },
     )
   }
 }
 
+function maybeAddDiscriminatorField<T extends TypeDef, K extends UnionKey>(
+  t: T,
+  discriminatorKey: string | null,
+  discriminatorLiteral: K,
+): T {
+  if (discriminatorKey == null) {
+    return t
+  }
+  switch (t.type) {
+    case TypeDefType.List:
+    case TypeDefType.Literal:
+    case TypeDefType.Record:
+      return t
+    case TypeDefType.Object:
+      return {
+        ...t,
+        fields: {
+          ...t.fields,
+          [discriminatorKey]: literal([discriminatorLiteral]).readonly().required().narrow.definition,
+        },
+      }
+    case TypeDefType.Union:
+      return {
+        ...t,
+        unions: map(t.unions, (_k, v) => {
+          return maybeAddDiscriminatorField(v, discriminatorKey, discriminatorLiteral)
+        }),
+      }
+    default:
+      throw new UnreachableError(t)
+  }
+}
+
 export function literal<T>(value?: [T]): TypeDefBuilder<ValidatingLiteralTypeDef<never, {}, T>> {
   return new TypeDefBuilder({
     type: TypeDefType.Literal,

package/types/flattened.ts

@@ -1,5 +1,5 @@
 // Unfortunately the TS compiler will infinitely loop if we don't give it a way of breaking out.
 // A starting depth of 10 (the maximum) will cause performance issues while developing
-export type StartingDepth = 7
+export type StartingDepth = 5
 // Going much above a depth of 10 will also blow up
 export type Depths = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]