@strictly/define 0.0.1 → 0.0.3

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

@@ -1,7 +1,7 @@
-import { flattenValueTypeTo, } from 'transformers/flatteners/flatten_value_type_to';
+import { flattenValueTo, } from 'transformers/flatteners/flatten_value_to';
 import { booleanType, list, literal, nullType, numberType, object, record, union, } from 'types/builders';
 import { vi, } from 'vitest';
-describe('flattenValueTypeTo', function () {
+describe('flattenValueTo', function () {
     let toStringMapper;
     let setMapper;
     let setter;
@@ -15,11 +15,11 @@ describe('flattenValueTypeTo', function () {
         setter = vi.fn();
     });
     describe('literal', function () {
-        const typeDef = numberType;
+        const type = numberType;
         describe('toString', function () {
             let flattened;
             beforeEach(function () {
-                flattened = flattenValueTypeTo(typeDef, 1, setter, toStringMapper);
+                flattened = flattenValueTo(type, 1, setter, toStringMapper);
             });
             it('equals expected type', function () {
                 expect(flattened).toEqual({
@@ -33,7 +33,7 @@ describe('flattenValueTypeTo', function () {
         describe('setter', function () {
             let flattened;
             beforeEach(function () {
-                flattened = flattenValueTypeTo(typeDef, 1, setter, setMapper);
+                flattened = flattenValueTo(type, 1, setter, setMapper);
             });
             it('calls the top level setter', function () {
                 const value = 3;
@@ -56,7 +56,7 @@ describe('flattenValueTypeTo', function () {
         describe('toString', function () {
             let flattened;
             beforeEach(function () {
-                flattened = flattenValueTypeTo(typeDef, l, setter, toStringMapper);
+                flattened = flattenValueTo(typeDef, l, setter, toStringMapper);
             });
             it('equals expected type', function () {
                 expect(flattened).toEqual({
@@ -73,7 +73,7 @@ describe('flattenValueTypeTo', function () {
         describe('setter', function () {
             let flattened;
             beforeEach(function () {
-                flattened = flattenValueTypeTo(typeDef, l, setter, setMapper);
+                flattened = flattenValueTo(typeDef, l, setter, setMapper);
             });
             it('sets a value in the list', function () {
                 flattened['$.1'](4);
@@ -97,7 +97,7 @@ describe('flattenValueTypeTo', function () {
         describe('toString', function () {
             let flattened;
             beforeEach(function () {
-                flattened = flattenValueTypeTo(typeDef, m, setter, toStringMapper);
+                flattened = flattenValueTo(typeDef, m, setter, toStringMapper);
             });
             it('equals expected type', function () {
                 expect(flattened).toEqual({
@@ -110,7 +110,7 @@ describe('flattenValueTypeTo', function () {
         describe('setter', function () {
             let flattened;
             beforeEach(function () {
-                flattened = flattenValueTypeTo(typeDef, m, setter, setMapper);
+                flattened = flattenValueTo(typeDef, m, setter, setMapper);
             });
             it('sets a value in the record', function () {
                 flattened['$.a'](4);
@@ -122,46 +122,69 @@ describe('flattenValueTypeTo', function () {
         });
     });
     describe('object', function () {
-        const typeDef = object()
-            .set('a', numberType)
-            .set('b', booleanType);
-        let s;
-        beforeEach(function () {
-            s = {
-                a: 1,
-                b: false,
-            };
-        });
-        describe('toString', function () {
-            let flattened;
+        describe('mandatory fields', function () {
+            const type = object()
+                .field('a', numberType)
+                .field('b', booleanType);
+            let s;
             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;
+                beforeEach(function () {
+                    flattened = flattenValueTo(type, s, setter, toStringMapper);
+                });
+                it('equals expected type', function () {
+                    expect(flattened).toEqual({
+                        $: '{"a":1,"b":false}',
+                        ['$.a']: '1',
+                        ['$.b']: 'false',
+                    });
                 });
             });
-        });
-        describe('setter', function () {
-            let flattened;
-            beforeEach(function () {
-                flattened = flattenValueTypeTo(typeDef, s, setter, setMapper);
-            });
-            it('sets "a" in the object', function () {
-                flattened['$.a'](2);
-                expect(s).toEqual({
-                    a: 2,
-                    b: false,
+            describe('setter', function () {
+                let flattened;
+                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));
+            describe('empty', function () {
+                let s;
+                beforeEach(function () {
+                    s = {};
+                });
+                describe('toString', function () {
+                    let flattened;
+                    beforeEach(function () {
+                        flattened = flattenValueTo(type, s, setter, toStringMapper);
+                    });
+                    it('equals expected type', function () {
+                        expect(flattened).toEqual({
+                            $: '{}',
+                        });
+                    });
                 });
             });
         });
@@ -169,8 +192,8 @@ 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));
+                .or('1', object().field('a', numberType))
+                .or('2', object().field('b', booleanType));
             let u;
             beforeEach(function () {
                 u = {
@@ -181,7 +204,7 @@ describe('flattenValueTypeTo', function () {
             describe('toString', function () {
                 let flattened;
                 beforeEach(function () {
-                    flattened = flattenValueTypeTo(typeDef, u, setter, toStringMapper);
+                    flattened = flattenValueTo(typeDef, u, setter, toStringMapper);
                 });
                 it('equals expected type', function () {
                     expect(flattened).toEqual({
@@ -193,7 +216,7 @@ describe('flattenValueTypeTo', function () {
             describe('setter', function () {
                 let flattened;
                 beforeEach(function () {
-                    flattened = flattenValueTypeTo(typeDef, u, setter, setMapper);
+                    flattened = flattenValueTo(typeDef, u, setter, setMapper);
                 });
                 it('sets a value', function () {
                     const value = {
@@ -213,9 +236,9 @@ describe('flattenValueTypeTo', function () {
             });
         });
         describe('non-discriminated', function () {
-            const typeDef = union()
-                .add('0', numberType)
-                .add('1', nullType);
+            const type = union()
+                .or('0', numberType)
+                .or('1', nullType);
             let u;
             beforeEach(function () {
                 u = null;
@@ -223,7 +246,7 @@ describe('flattenValueTypeTo', function () {
             describe('toString', function () {
                 let flattened;
                 beforeEach(function () {
-                    flattened = flattenValueTypeTo(typeDef, u, setter, toStringMapper);
+                    flattened = flattenValueTo(type, u, setter, toStringMapper);
                 });
                 it('equals expected type', function () {
                     expect(flattened).toEqual({
@@ -234,7 +257,7 @@ describe('flattenValueTypeTo', function () {
             describe('setter', function () {
                 let flattened;
                 beforeEach(function () {
-                    flattened = flattenValueTypeTo(typeDef, u, setter, setMapper);
+                    flattened = flattenValueTo(type, u, setter, setMapper);
                 });
                 it('sets a value', function () {
                     const value = 2;
@@ -244,10 +267,10 @@ describe('flattenValueTypeTo', function () {
             });
         });
         describe('complex non-discriminated', function () {
-            const typeDef = union()
-                .add('z', list(numberType))
-                .add('x', nullType)
-                .add('y', literal([false]));
+            const type = union()
+                .or('z', list(numberType))
+                .or('x', nullType)
+                .or('y', literal([false]));
             let u;
             beforeEach(function () {
                 u = [
@@ -259,7 +282,7 @@ describe('flattenValueTypeTo', function () {
             describe('toString', function () {
                 let flattened;
                 beforeEach(function () {
-                    flattened = flattenValueTypeTo(typeDef, u, setter, toStringMapper);
+                    flattened = flattenValueTo(type, u, setter, toStringMapper);
                 });
                 it('equals expected type', function () {
                     expect(flattened).toEqual({
@@ -273,7 +296,7 @@ describe('flattenValueTypeTo', function () {
             describe('setter', function () {
                 let flattened;
                 beforeEach(function () {
-                    flattened = flattenValueTypeTo(typeDef, u, setter, setMapper);
+                    flattened = flattenValueTo(type, u, setter, setMapper);
                 });
                 it('sets the top level value', function () {
                     const value = [100];

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

@@ -1,12 +1,12 @@
-import { flattenValueTypesOf } from 'transformers/flatteners/flatten_value_types_of';
+import { flattenValuesOfType } from 'transformers/flatteners/flatten_values_of_type';
 import { booleanType, list, numberType, object, } from 'types/builders';
 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(object()
-            .set('a', list(numberType))
-            .set('b', booleanType), {
+        const flattened = flattenValuesOfType(object()
+            .field('a', list(numberType))
+            .field('b', booleanType), {
             a: [
                 1,
                 2,

package/.out/transformers/flatteners/specs/value_path_to_type_path.tests.js

@@ -85,7 +85,9 @@ describe('valuePathToTypePath', function () {
         });
     });
     describe('object', function () {
-        const typeDef = object().set('a', numberType).set('b', booleanType);
+        const typeDef = object()
+            .field('a', numberType)
+            .field('b', booleanType);
         describe.each([
             [
                 '$',
@@ -121,8 +123,8 @@ 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));
+                .or('x', object().field('a', numberType).field('b', booleanType))
+                .or('y', object().field('b', stringType).field('c', booleanType));
             describe.each([
                 [
                     '$',

package/.out/transformers/flatteners/value_path_to_type_path.d.ts

@@ -1,2 +1,2 @@
 import { type Type } from 'types/definitions';
-export declare function valuePathToTypePath<JsonPaths extends Record<string, string>, ValuePath extends keyof JsonPaths>({ definition: typeDef }: Type, valuePath: ValuePath, allowMissingPaths?: boolean): JsonPaths[ValuePath];
+export declare function valuePathToTypePath<ValuePathsToTypePaths extends Record<string, string>, ValuePath extends keyof ValuePathsToTypePaths>({ definition: typeDef }: Type, valuePath: ValuePath, allowMissingPaths?: boolean): ValuePathsToTypePaths[ValuePath];