@strictly/define 0.0.1 → 0.0.2

package/transformers/flatteners/specs/{flatten_type_def_to.tests.ts → flatten_type_to.tests.ts}

@@ -1,4 +1,4 @@
-import { flattenTypeDefTo } from 'transformers/flatteners/flatten_type_def_to'
+import { flattenTypeTo } from 'transformers/flatteners/flatten_type_to'
 import {
   booleanType,
   list,
@@ -29,7 +29,7 @@ describe('flattenTypeDefTo', function () {
 
   describe('literal', function () {
     beforeEach(function () {
-      flattened = flattenTypeDefTo(numberType, toTypeDefType)
+      flattened = flattenTypeTo(numberType, toTypeDefType)
     })
 
     it('equals expected type', function () {
@@ -46,7 +46,7 @@ describe('flattenTypeDefTo', function () {
   describe('list', function () {
     const type = list(numberType)
     beforeEach(function () {
-      flattened = flattenTypeDefTo(type, toTypeDefType)
+      flattened = flattenTypeTo(type, toTypeDefType)
     })
 
     it('equals expected type', function () {
@@ -64,7 +64,7 @@ describe('flattenTypeDefTo', function () {
   describe('record', function () {
     const type = record<typeof numberType, 'a' | 'b'>(numberType)
     beforeEach(function () {
-      flattened = flattenTypeDefTo(type, toTypeDefType)
+      flattened = flattenTypeTo(type, toTypeDefType)
     })
 
     it('equals expected type', function () {
@@ -82,9 +82,11 @@ describe('flattenTypeDefTo', function () {
   })
 
   describe('object', function () {
-    const type = object().set('a', numberType).set('b', list(booleanType))
+    const type = object()
+      .field('a', numberType)
+      .field('b', list(booleanType))
     beforeEach(function () {
-      flattened = flattenTypeDefTo(type, toTypeDefType)
+      flattened = flattenTypeTo(type, toTypeDefType)
     })
 
     it('equals expected type', function () {
@@ -104,11 +106,11 @@ describe('flattenTypeDefTo', function () {
   describe('union', function () {
     describe('non-discriminated', function () {
       const type = union()
-        .add('a', nullType)
-        .add('b', booleanType)
-        .add('c', numberType)
+        .or('a', nullType)
+        .or('b', booleanType)
+        .or('c', numberType)
       beforeEach(function () {
-        flattened = flattenTypeDefTo(type, toTypeDefType)
+        flattened = flattenTypeTo(type, toTypeDefType)
       })
 
       it('equals expected type', function () {
@@ -124,10 +126,10 @@ describe('flattenTypeDefTo', function () {
 
     describe('discriminated', function () {
       const type = union('d')
-        .add('a', object().set('a', booleanType))
-        .add('b', object().set('b', numberType))
+        .or('a', object().field('a', booleanType))
+        .or('b', object().field('b', numberType))
       beforeEach(function () {
-        flattened = flattenTypeDefTo(type, toTypeDefType)
+        flattened = flattenTypeTo(type, toTypeDefType)
       })
 
       it('equals expected type', function () {

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

@@ -0,0 +1,27 @@
+import { flattenTypesOfType } from 'transformers/flatteners/flatten_types_of_type'
+import {
+  booleanType,
+  list,
+  numberType,
+  object,
+} from 'types/builders'
+
+describe('flattenTypeDefsOf', function () {
+  it('flattens', function () {
+    const listTypeDef = list(numberType)
+    const structTypeDef = object()
+      .field('a', listTypeDef)
+      .field('b', booleanType)
+      ._type
+    const flattened = flattenTypesOfType(
+      structTypeDef,
+    )
+
+    expect(flattened).toEqual({
+      $: structTypeDef,
+      '$.a': listTypeDef._type,
+      '$.a.*': numberType._type,
+      '$.b': booleanType._type,
+    })
+  })
+})

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

@@ -0,0 +1,48 @@
+import { flattenValidationErrorsOfType } from 'transformers/flatteners/flatten_validation_errors_of_type'
+import { literal } from 'types/builders'
+import { type ValueToTypePathsOfType } from 'types/value_to_type_paths_of_type'
+
+describe('flattenValidationsOfType', function () {
+  describe('literal', function () {
+    const type = literal<'a' | 'b' | 'c'>()
+    describe('failures', function () {
+      const validators = {
+        $: () => 'error',
+      }
+
+      const errors = flattenValidationErrorsOfType<
+        typeof type,
+        ValueToTypePathsOfType<typeof type>,
+        typeof validators
+      >(
+        type,
+        'a',
+        validators,
+      )
+
+      it('reports an error', function () {
+        expect(errors.$).toBe('error')
+      })
+    })
+
+    describe('success', function () {
+      const validators = {
+        $: () => null,
+      }
+
+      const errors = flattenValidationErrorsOfType<
+        typeof type,
+        ValueToTypePathsOfType<typeof type>,
+        typeof validators
+      >(
+        type,
+        'a',
+        validators,
+      )
+
+      it('reports no error', function () {
+        expect(errors.$).toBe(null)
+      })
+    })
+  })
+})

package/transformers/flatteners/specs/{flatten_value_type_to.tests.ts → flatten_value_to.tests.ts}

@@ -1,9 +1,9 @@
 import {
   type AnyValueType,
-  flattenValueTypeTo,
+  flattenValueTo,
   type Mapper,
   type Setter,
-} from 'transformers/flatteners/flatten_value_type_to'
+} from 'transformers/flatteners/flatten_value_to'
 import { type SimplifyDeep } from 'type-fest'
 import {
   booleanType,
@@ -19,22 +19,22 @@ import {
   type Type,
   type TypeDef,
 } from 'types/definitions'
-import { type FlattenedTypeDefsOf } from 'types/flattened_type_defs_of'
-import { type ValueTypeOf } from 'types/value_type_of'
+import { type FlattenedTypesOfType } from 'types/flattened_types_of_type'
+import { type ValueOfType } from 'types/value_of_type'
 import {
   type Mock,
   vi,
 } from 'vitest'
 
 type FlattenedSetters<R extends Record<string, Type>> = {
-  [K in keyof R]: Setter<ValueTypeOf<R[K]>>
+  [K in keyof R]: Setter<ValueOfType<R[K]>>
 }
 
 type FlattenedToStrings<R extends Record<string, Type>> = {
   [K in keyof R]: string
 }
 
-describe('flattenValueTypeTo', function () {
+describe('flattenValueTo', function () {
   let toStringMapper: Mock<Mapper<string>>
   let setMapper: Mock<Mapper<(v: AnyValueType) => void>>
   let setter: Mock<(v: AnyValueType) => void>
@@ -49,13 +49,13 @@ describe('flattenValueTypeTo', function () {
   })
 
   describe('literal', function () {
-    const typeDef = numberType
-    type F = FlattenedTypeDefsOf<typeof typeDef, null>
+    const type = numberType
+    type F = FlattenedTypesOfType<typeof type, null>
     describe('toString', function () {
       let flattened: FlattenedToStrings<F>
       beforeEach(function () {
-        flattened = flattenValueTypeTo(
-          typeDef,
+        flattened = flattenValueTo(
+          type,
           1,
           setter,
           toStringMapper,
@@ -76,8 +76,8 @@ describe('flattenValueTypeTo', function () {
     describe('setter', function () {
       let flattened: FlattenedSetters<F>
       beforeEach(function () {
-        flattened = flattenValueTypeTo(
-          typeDef,
+        flattened = flattenValueTo(
+          type,
           1,
           setter,
           setMapper,
@@ -95,8 +95,8 @@ describe('flattenValueTypeTo', function () {
 
   describe('list', function () {
     const typeDef = list(numberType)
-    type F = FlattenedTypeDefsOf<typeof typeDef, null>
-    let l: ValueTypeOf<typeof typeDef>
+    type F = FlattenedTypesOfType<typeof typeDef, null>
+    let l: ValueOfType<typeof typeDef>
     beforeEach(function () {
       l = [
         1,
@@ -108,7 +108,7 @@ describe('flattenValueTypeTo', function () {
     describe('toString', function () {
       let flattened: FlattenedToStrings<F>
       beforeEach(function () {
-        flattened = flattenValueTypeTo(
+        flattened = flattenValueTo(
           typeDef,
           l,
           setter,
@@ -133,7 +133,7 @@ describe('flattenValueTypeTo', function () {
     describe('setter', function () {
       let flattened: FlattenedSetters<F>
       beforeEach(function () {
-        flattened = flattenValueTypeTo(
+        flattened = flattenValueTo(
           typeDef,
           l,
           setter,
@@ -154,9 +154,9 @@ describe('flattenValueTypeTo', function () {
 
   describe('record', function () {
     const typeDef = record<typeof numberType, 'a' | 'b'>(numberType)
-    type F = FlattenedTypeDefsOf<typeof typeDef, null>
+    type F = FlattenedTypesOfType<typeof typeDef, null>
 
-    let m: ValueTypeOf<typeof typeDef>
+    let m: ValueOfType<typeof typeDef>
     beforeEach(function () {
       m = {
         a: 1,
@@ -167,7 +167,7 @@ describe('flattenValueTypeTo', function () {
     describe('toString', function () {
       let flattened: FlattenedToStrings<F>
       beforeEach(function () {
-        flattened = flattenValueTypeTo(
+        flattened = flattenValueTo(
           typeDef,
           m,
           setter,
@@ -187,7 +187,7 @@ describe('flattenValueTypeTo', function () {
     describe('setter', function () {
       let flattened: FlattenedSetters<F>
       beforeEach(function () {
-        flattened = flattenValueTypeTo(
+        flattened = flattenValueTo(
           typeDef,
           m,
           setter,
@@ -206,63 +206,96 @@ describe('flattenValueTypeTo', function () {
   })
 
   describe('object', function () {
-    const typeDef = object()
-      .set('a', numberType)
-      .set('b', booleanType)
-    type F = FlattenedTypeDefsOf<typeof typeDef, null>
+    describe('mandatory fields', function () {
+      const type = object()
+        .field('a', numberType)
+        .field('b', booleanType)
+      type F = FlattenedTypesOfType<typeof type, null>
 
-    let s: ValueTypeOf<typeof typeDef>
-    beforeEach(function () {
-      s = {
-        a: 1,
-        b: false,
-      }
-    })
-
-    describe('toString', function () {
-      let flattened: FlattenedToStrings<F>
+      let s: ValueOfType<typeof type>
       beforeEach(function () {
-        flattened = flattenValueTypeTo(
-          typeDef,
-          s,
-          setter,
-          toStringMapper,
-        )
+        s = {
+          a: 1,
+          b: false,
+        }
       })
 
-      it('equals expected type', function () {
-        expect(flattened).toEqual({
-          $: '{"a":1,"b":false}',
-          ['$.a']: '1',
-          ['$.b']: 'false',
+      describe('toString', function () {
+        let flattened: FlattenedToStrings<F>
+        beforeEach(function () {
+          flattened = flattenValueTo(
+            type,
+            s,
+            setter,
+            toStringMapper,
+          )
         })
-      })
-    })
 
-    describe('setter', function () {
-      let flattened: FlattenedSetters<F>
-      beforeEach(function () {
-        flattened = flattenValueTypeTo(
-          typeDef,
-          s,
-          setter,
-          setMapper,
-        )
+        it('equals expected type', function () {
+          expect(flattened).toEqual({
+            $: '{"a":1,"b":false}',
+            ['$.a']: '1',
+            ['$.b']: 'false',
+          })
+        })
       })
 
-      it('sets "a" in the object', function () {
-        flattened['$.a'](2)
-        expect(s).toEqual({
-          a: 2,
-          b: false,
+      describe('setter', function () {
+        let flattened: FlattenedSetters<F>
+        beforeEach(function () {
+          flattened = flattenValueTo(
+            type,
+            s,
+            setter,
+            setMapper,
+          )
+        })
+
+        it('sets "a" in the object', function () {
+          flattened['$.a'](2)
+          expect(s).toEqual({
+            a: 2,
+            b: false,
+          })
+        })
+
+        it('sets "b" in the object', function () {
+          flattened['$.b'](true)
+          expect(s).toEqual({
+            a: 1,
+            b: true,
+          })
         })
       })
+    })
 
-      it('sets "b" in the object', function () {
-        flattened['$.b'](true)
-        expect(s).toEqual({
-          a: 1,
-          b: true,
+    describe('nested optional field', function () {
+      const type = object()
+        .optionalField('a', object().optionalField('b', numberType))
+      type F = FlattenedTypesOfType<typeof type, null>
+
+      describe('empty', function () {
+        let s: ValueOfType<typeof type>
+        beforeEach(function () {
+          s = {}
+        })
+
+        describe('toString', function () {
+          let flattened: FlattenedToStrings<F>
+          beforeEach(function () {
+            flattened = flattenValueTo(
+              type,
+              s,
+              setter,
+              toStringMapper,
+            )
+          })
+
+          it('equals expected type', function () {
+            expect(flattened).toEqual({
+              $: '{}',
+            })
+          })
         })
       })
     })
@@ -271,10 +304,10 @@ describe('flattenValueTypeTo', function () {
   describe('union', function () {
     describe('discriminated', function () {
       const typeDef = union('d')
-        .add('1', object().set('a', numberType))
-        .add('2', object().set('b', booleanType))
-      type F = SimplifyDeep<FlattenedTypeDefsOf<typeof typeDef, null>>
-      let u: ValueTypeOf<typeof typeDef>
+        .or('1', object().field('a', numberType))
+        .or('2', object().field('b', booleanType))
+      type F = SimplifyDeep<FlattenedTypesOfType<typeof typeDef, null>>
+      let u: ValueOfType<typeof typeDef>
       beforeEach(function () {
         u = {
           d: '1',
@@ -285,7 +318,7 @@ describe('flattenValueTypeTo', function () {
       describe('toString', function () {
         let flattened: FlattenedToStrings<F>
         beforeEach(function () {
-          flattened = flattenValueTypeTo(
+          flattened = flattenValueTo(
             typeDef,
             u,
             setter,
@@ -305,7 +338,7 @@ describe('flattenValueTypeTo', function () {
         type G = SimplifyDeep<FlattenedSetters<F>>
         let flattened: G
         beforeEach(function () {
-          flattened = flattenValueTypeTo(
+          flattened = flattenValueTo(
             typeDef,
             u,
             setter,
@@ -334,11 +367,11 @@ describe('flattenValueTypeTo', function () {
       })
     })
     describe('non-discriminated', function () {
-      const typeDef = union()
-        .add('0', numberType)
-        .add('1', nullType)
-      type F = FlattenedTypeDefsOf<typeof typeDef, null>
-      let u: ValueTypeOf<typeof typeDef>
+      const type = union()
+        .or('0', numberType)
+        .or('1', nullType)
+      type F = FlattenedTypesOfType<typeof type, null>
+      let u: ValueOfType<typeof type>
 
       beforeEach(function () {
         u = null
@@ -347,8 +380,8 @@ describe('flattenValueTypeTo', function () {
       describe('toString', function () {
         let flattened: FlattenedToStrings<F>
         beforeEach(function () {
-          flattened = flattenValueTypeTo(
-            typeDef,
+          flattened = flattenValueTo(
+            type,
             u,
             setter,
             toStringMapper,
@@ -365,8 +398,8 @@ describe('flattenValueTypeTo', function () {
       describe('setter', function () {
         let flattened: FlattenedSetters<F>
         beforeEach(function () {
-          flattened = flattenValueTypeTo(
-            typeDef,
+          flattened = flattenValueTo(
+            type,
             u,
             setter,
             setMapper,
@@ -383,13 +416,13 @@ describe('flattenValueTypeTo', function () {
     })
 
     describe('complex non-discriminated', function () {
-      const typeDef = union()
-        .add('z', list(numberType))
-        .add('x', nullType)
-        .add('y', literal([false]))
-      type F = FlattenedTypeDefsOf<typeof typeDef, null>
+      const type = union()
+        .or('z', list(numberType))
+        .or('x', nullType)
+        .or('y', literal([false]))
+      type F = FlattenedTypesOfType<typeof type, null>
 
-      let u: ValueTypeOf<typeof typeDef>
+      let u: ValueOfType<typeof type>
       beforeEach(function () {
         u = [
           1,
@@ -401,8 +434,8 @@ describe('flattenValueTypeTo', function () {
       describe('toString', function () {
         let flattened: FlattenedToStrings<F>
         beforeEach(function () {
-          flattened = flattenValueTypeTo(
-            typeDef,
+          flattened = flattenValueTo(
+            type,
             u,
             setter,
             toStringMapper,
@@ -422,8 +455,8 @@ describe('flattenValueTypeTo', function () {
       describe('setter', function () {
         let flattened: FlattenedSetters<F>
         beforeEach(function () {
-          flattened = flattenValueTypeTo(
-            typeDef,
+          flattened = flattenValueTo(
+            type,
             u,
             setter,
             setMapper,

package/transformers/flatteners/specs/{flatten_value_types_of.tests.ts → flatten_values_of_type.tests.ts}

@@ -1,4 +1,4 @@
-import { flattenValueTypesOf } from 'transformers/flatteners/flatten_value_types_of'
+import { flattenValuesOfType } from 'transformers/flatteners/flatten_values_of_type'
 import {
   booleanType,
   list,
@@ -10,10 +10,10 @@ describe('flattenValueTypesOf', function () {
   // note that we already have tests for the type and the function that this calls, so
   // this is only a sanity check
   it('flattens', function () {
-    const flattened = flattenValueTypesOf(
+    const flattened = flattenValuesOfType(
       object()
-        .set('a', list(numberType))
-        .set('b', booleanType),
+        .field('a', list(numberType))
+        .field('b', booleanType),
       {
         a: [
           1,

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

@@ -8,14 +8,14 @@ import {
   stringType,
   union,
 } from 'types/builders'
-import { type ValueToTypePathsOf } from 'types/value_to_type_paths_of'
+import { type ValueToTypePathsOfType } from 'types/value_to_type_paths_of_type'
 
 describe('valuePathToTypePath', function () {
   describe('literal', function () {
     const typeDef = numberType
-    type JsonPaths = ValueToTypePathsOf<typeof typeDef>
+    type Paths = ValueToTypePathsOfType<typeof typeDef>
 
-    const typePath = valuePathToTypePath<JsonPaths, '$'>(typeDef, '$')
+    const typePath = valuePathToTypePath<Paths, '$'>(typeDef, '$')
 
     it('maps a value path to the expected type path', function () {
       expect(typePath).toEqual('$')
@@ -42,7 +42,7 @@ describe('valuePathToTypePath', function () {
 
   describe('list', function () {
     const typeDef = list(numberType)
-    type JsonPaths = ValueToTypePathsOf<typeof typeDef>
+    type Paths = ValueToTypePathsOfType<typeof typeDef>
 
     describe.each([
       [
@@ -54,7 +54,7 @@ describe('valuePathToTypePath', function () {
         '$.*',
       ],
     ] as const)('it maps "%s"', function (from, to) {
-      const typePath = valuePathToTypePath<JsonPaths, typeof from>(typeDef, from)
+      const typePath = valuePathToTypePath<Paths, typeof from>(typeDef, from)
 
       it('maps a value path to the expected type path', function () {
         expect(typePath).toEqual(to)
@@ -67,7 +67,7 @@ describe('valuePathToTypePath', function () {
 
     describe('fake subpath', function () {
       const fakeTypePath = valuePathToTypePath<
-        JsonPaths & {
+        Paths & {
           [_: `$.${number}.fake`]: '$.*.fake',
         },
         '$.0.fake'
@@ -86,7 +86,7 @@ describe('valuePathToTypePath', function () {
   describe('record', function () {
     type Key = 'a' | 'b'
     const typeDef = record<typeof numberType, Key>(numberType)
-    type JsonPaths = ValueToTypePathsOf<typeof typeDef>
+    type Paths = ValueToTypePathsOfType<typeof typeDef>
 
     describe.each([
       [
@@ -102,7 +102,7 @@ describe('valuePathToTypePath', function () {
         '$.*',
       ],
     ] as const)('it maps "%s"', function (from, to) {
-      const typePath = valuePathToTypePath<JsonPaths, typeof from>(typeDef, from)
+      const typePath = valuePathToTypePath<Paths, typeof from>(typeDef, from)
 
       it('maps a value path to the expected type path', function () {
         expect(typePath).toEqual(to)
@@ -115,7 +115,7 @@ describe('valuePathToTypePath', function () {
 
     describe('fake subpath', function () {
       const fakeTypePath = valuePathToTypePath<
-        JsonPaths & {
+        Paths & {
           '$.a.fake': '$.*.fake',
           '$.b.fake': '$.*.fake',
         },
@@ -133,8 +133,10 @@ describe('valuePathToTypePath', function () {
   })
 
   describe('object', function () {
-    const typeDef = object().set('a', numberType).set('b', booleanType)
-    type JsonPaths = ValueToTypePathsOf<typeof typeDef>
+    const typeDef = object()
+      .field('a', numberType)
+      .field('b', booleanType)
+    type Paths = ValueToTypePathsOfType<typeof typeDef>
 
     describe.each([
       [
@@ -150,7 +152,7 @@ describe('valuePathToTypePath', function () {
         '$.b',
       ],
     ] as const)('it maps %s', function (from, to) {
-      const typePath = valuePathToTypePath<JsonPaths, typeof from>(typeDef, from)
+      const typePath = valuePathToTypePath<Paths, typeof from>(typeDef, from)
 
       it('maps a value path to the expected type path', function () {
         expect(typePath).toEqual(to)
@@ -163,7 +165,7 @@ describe('valuePathToTypePath', function () {
 
     describe('fake field', function () {
       const fakeTypePath = valuePathToTypePath<
-        JsonPaths & {
+        Paths & {
           '$.fake': '$.fake',
         },
         '$.fake'
@@ -182,9 +184,9 @@ describe('valuePathToTypePath', function () {
   describe('union', function () {
     describe('discriminated', function () {
       const typeDef = union('w')
-        .add('x', object().set('a', numberType).set('b', booleanType))
-        .add('y', object().set('b', stringType).set('c', booleanType))
-      type JsonPaths = ValueToTypePathsOf<typeof typeDef>
+        .or('x', object().field('a', numberType).field('b', booleanType))
+        .or('y', object().field('b', stringType).field('c', booleanType))
+      type Paths = ValueToTypePathsOfType<typeof typeDef>
 
       describe.each([
         [
@@ -208,7 +210,7 @@ describe('valuePathToTypePath', function () {
           '$.y:c',
         ],
       ] as const)('it maps %s', function (from, to) {
-        const typePath = valuePathToTypePath<JsonPaths, typeof from>(typeDef, from)
+        const typePath = valuePathToTypePath<Paths, typeof from>(typeDef, from)
 
         it('maps a value path to the expected type path', function () {
           expect(typePath).toEqual(to)
@@ -221,7 +223,7 @@ describe('valuePathToTypePath', function () {
 
       describe('fake', function () {
         const fakeTypePath = valuePathToTypePath<
-          JsonPaths & {
+          Paths & {
             '$.fake': '$.fake',
           },
           '$.fake'