@strictly/react-form 0.0.13 → 0.0.15

package/.out/types/merge_validators.d.ts

@@ -3,5 +3,5 @@ import { type Simplify } from 'type-fest';
 export type MergedOfValidators<Validators1 extends Partial<Readonly<Record<Keys, Validator>>>, Validators2 extends Partial<Readonly<Record<Keys, Validator>>>, Keys extends string = Extract<keyof Validators1 | keyof Validators2, string>> = Simplify<{
     readonly [K in Keys]: undefined extends Validators1[K] ? undefined extends Validators2[K] ? never : Validators2[K] : undefined extends Validators2[K] ? Validators1[K] : MergedOfValidator<NonNullable<Validators1[K]>, NonNullable<Validators2[K]>>;
 }>;
-export type MergedOfValidator<Validator1 extends Validator, Validator2 extends Validator> = Validator1 extends Validator<infer V, infer E1, infer P, infer C> ? Validator2 extends Validator<V, infer E2, P, C> ? Validator<V, E1 | E2, P, C> : never : never;
+export type MergedOfValidator<Validator1 extends Validator, Validator2 extends Validator> = Validator1 extends Validator<infer V, infer E1, infer P, infer C1> ? Validator2 extends Validator<V, infer E2, P, infer C2> ? Validator<V, E1 | E2, P, C1 & C2> : never : never;
 export declare function mergeValidators<Validators1 extends Partial<Readonly<Record<Keys, Validator>>>, Validators2 extends Partial<Readonly<Record<Keys, Validator>>>, Keys extends string = Extract<keyof Validators1 | keyof Validators2, string>>(validators1: Validators1, validators2: Validators2): MergedOfValidators<Validators1, Validators2, Keys>;

package/.out/util/empty.d.ts

@@ -0,0 +1 @@
+export declare function Empty(): null;

package/.out/util/empty.js

@@ -0,0 +1,3 @@
+export function Empty() {
+    return null;
+}

package/.turbo/turbo-build.log

@@ -7,12 +7,12 @@ $ tsup
 CLI Target: es6
 CJS Build start
 ESM Build start
-ESM dist/index.js 55.38 KB
-ESM ⚡️ Build success in 141ms
-CJS dist/index.cjs 59.16 KB
-CJS ⚡️ Build success in 145ms
+ESM dist/index.js 55.85 KB
+ESM ⚡️ Build success in 136ms
+CJS dist/index.cjs 59.76 KB
+CJS ⚡️ Build success in 141ms
 DTS Build start
-DTS ⚡️ Build success in 9581ms
-DTS dist/index.d.cts 36.50 KB
-DTS dist/index.d.ts  36.50 KB
-Done in 10.72s.
+DTS ⚡️ Build success in 9792ms
+DTS dist/index.d.cts 37.63 KB
+DTS dist/index.d.ts  37.63 KB
+Done in 10.91s.

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

@@ -1,3 +1,3 @@
 yarn run v1.22.22
 $ tsc
-Done in 7.39s.
+Done in 7.51s.

package/core/mobx/field_adapter.ts

@@ -38,3 +38,12 @@ export type ValuePathOfFieldAdapter<C extends FieldAdapter> = C extends FieldAda
   infer ValuePath
 > ? ValuePath
   : never
+
+export type ContextOfFieldAdapter<F extends FieldAdapter> = F extends FieldAdapter<
+  infer _From,
+  infer _To,
+  infer _E,
+  infer _P,
+  infer Context
+> ? Context
+  : never

package/core/mobx/form_model.ts

@@ -35,6 +35,7 @@ import {
   type ReadonlyDeep,
   type SimplifyDeep,
   type StringKeyOf,
+  type UnionToIntersection,
   type ValueOf,
 } from 'type-fest'
 import {
@@ -45,6 +46,7 @@ import {
   UnreliableFieldConversionType,
 } from 'types/field_converters'
 import {
+  type ContextOfFieldAdapter,
   type ErrorOfFieldAdapter,
   type FieldAdapter,
   type ToOfFieldAdapter,
@@ -102,13 +104,21 @@ export type ValuePathsToAdaptersOf<
   }
   : never
 
-export class FormModel<
+export type ContextOf<TypePathsToAdapters extends Partial<Readonly<Record<string, FieldAdapter>>>> =
+  UnionToIntersection<{
+    readonly [
+      K in keyof TypePathsToAdapters
+    ]: TypePathsToAdapters[K] extends undefined ? undefined : ContextOfFieldAdapter<NonNullable<TypePathsToAdapters[K]>>
+  }[keyof TypePathsToAdapters]>
+
+export abstract class FormModel<
   T extends Type,
   ValueToTypePaths extends Readonly<Record<string, string>>,
   TypePathsToAdapters extends FlattenedTypePathsToAdaptersOf<
     FlattenedValuesOfType<T, '*'>,
-    ValueOfType<ReadonlyTypeOfType<T>>
+    ContextType
   >,
+  ContextType = ContextOf<TypePathsToAdapters>,
   ValuePathsToAdapters extends ValuePathsToAdaptersOf<TypePathsToAdapters, ValueToTypePaths> = ValuePathsToAdaptersOf<
     TypePathsToAdapters,
     ValueToTypePaths
@@ -130,6 +140,7 @@ export class FormModel<
   ) {
     this.value = mobxCopy(type, value)
     this.flattenedTypeDefs = flattenTypesOfType(type)
+    const contextValue = this.toContext(value)
     // pre-populate field overrides for consistent behavior when default information is overwritten
     // then returned to
     const conversions = flattenValueTo(
@@ -156,7 +167,8 @@ export class FormModel<
           // no need to store a temporary value if the value cannot be written back
           return
         }
-        return convert(value, valuePath, this.value)
+        // cannot call this.context yet as the "this" pointer has not been fully created
+        return convert(value, valuePath, contextValue)
       },
     )
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -165,6 +177,13 @@ export class FormModel<
     }) as FlattenedFieldOverrides<ValuePathsToAdapters>
   }
 
+  @computed.struct
+  get context() {
+    return this.toContext(this.value)
+  }
+
+  protected abstract toContext(value: ValueOfType<ReadonlyTypeOfType<T>>): ContextType
+
   @computed
   get fields(): SimplifyDeep<FlattenedConvertedFieldsOf<ValuePathsToAdapters>> {
     return new Proxy<SimplifyDeep<FlattenedConvertedFieldsOf<ValuePathsToAdapters>>>(
@@ -248,14 +267,14 @@ export class FormModel<
         ? mobxCopy(
           fieldTypeDef,
           // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          create(valuePath as string, this.value),
+          create(valuePath as string, this.context),
         )
         // fake values can't be copied
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        : create(valuePath as string, this.value),
+        : create(valuePath as string, this.context),
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       valuePath as string,
-      this.value,
+      this.context,
     )
     const error = this.errors[valuePath]
     return {
@@ -341,7 +360,7 @@ export class FormModel<
       : elementAdapter.create(
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         elementTypePath as string,
-        this.value,
+        this.context,
       )
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const originalList: any[] = accessor.value
@@ -486,7 +505,7 @@ export class FormModel<
     assertExists(revert, 'setting value not supported {}', valuePath)
 
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions, @typescript-eslint/no-explicit-any
-    const conversion = revert(value, valuePath as any, this.value)
+    const conversion = revert(value, valuePath as any, this.context)
     const accessor = this.getAccessorForValuePath(valuePath)
     return runInAction(() => {
       this.fieldOverrides[valuePath] = [value]
@@ -529,10 +548,10 @@ export class FormModel<
       convert,
       create,
     } = adapter
-    const value = create(valuePath, this.value)
+    const value = create(valuePath, this.context)
     const {
       value: displayValue,
-    } = convert(value, valuePath, this.value)
+    } = convert(value, valuePath, this.context)
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     const key = valuePath as unknown as keyof ValuePathsToAdapters
     runInAction(() => {
@@ -573,10 +592,10 @@ export class FormModel<
       accessor != null
         ? accessor.value
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        : create(valuePath as string, this.value),
+        : create(valuePath as string, this.context),
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       valuePath as string,
-      this.value,
+      this.context,
     )
     const value = fieldOverride != null
       ? fieldOverride[0]
@@ -586,13 +605,13 @@ export class FormModel<
     if (ignoreDefaultValue) {
       const {
         value: defaultDisplayValue,
-      } = convert(create(valuePath, this.value), valuePath, this.value)
+      } = convert(create(valuePath, this.context), valuePath, this.context)
       if (defaultDisplayValue === value) {
         return true
       }
     }
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const conversion = revert(value, valuePath as string, this.value)
+    const conversion = revert(value, valuePath as string, this.context)
     return runInAction(() => {
       switch (conversion.type) {
         case UnreliableFieldConversionType.Failure:
@@ -645,14 +664,14 @@ export class FormModel<
           const fieldOverride = this.fieldOverrides[adapterPath]
           const {
             value: storedValue,
-          } = convert(accessor.value, valuePath, this.value)
+          } = convert(accessor.value, valuePath, this.context)
           const value = fieldOverride != null
             ? fieldOverride[0]
             : storedValue
           // TODO more nuanced comparison
           const dirty = fieldOverride != null && fieldOverride[0] !== storedValue
 
-          const conversion = revert(value, valuePath, this.value)
+          const conversion = revert(value, valuePath, this.context)
           switch (conversion.type) {
             case UnreliableFieldConversionType.Failure:
               this.errors[adapterPath] = conversion.error

package/core/mobx/hooks.tsx

@@ -13,13 +13,13 @@ import {
 } from './types'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ValueOfModel<M extends FormModel<any, any, any, any>> = M extends FormModel<infer T, any, any, any>
+type ValueOfModel<M extends FormModel<any, any, any, any, any>> = M extends FormModel<infer T, any, any, any, any>
   ? ValueOfType<ReadonlyTypeOfType<T>>
   : never
 
 export function useDefaultMobxFormHooks<
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M extends FormModel<any, any, any, any>,
+  M extends FormModel<any, any, any, any, any>,
   F extends FormFieldsOfModel<M> = FormFieldsOfModel<M>,
 >(
   model: M,

package/core/mobx/merge_field_adapters_with_two_way_converter.ts

@@ -5,6 +5,7 @@ import {
 } from 'field_converters/chain_field_converter'
 import { type TwoWayFieldConverter } from 'types/field_converters'
 import {
+  type ContextOfFieldAdapter,
   type ErrorOfFieldAdapter,
   type FieldAdapter,
   type FromOfFieldAdapter,
@@ -22,7 +23,7 @@ export type MergedOfFieldAdaptersWithTwoWayConverter<
     ToOfFieldAdapter<FieldAdapters[K]>,
     ErrorOfFieldAdapter<FieldAdapters[K]> | E,
     ValuePathOfFieldAdapter<FieldAdapters[K]>,
-    Context
+    ContextOfFieldAdapter<FieldAdapters[K]> & Context
   >
 }
 

package/core/mobx/merge_field_adapters_with_validators.ts

@@ -28,7 +28,7 @@ type MergedOfFieldAdapterWithValidator<
   V extends Validator | undefined,
 > = undefined extends V ? A
   : A extends FieldAdapter<infer From, infer To, infer E1, infer P1, infer C1>
-    ? V extends Validator<From, infer E2, infer P2, infer C2> ? FieldAdapter<From, To, E1 | E2, P1 | P2, C1 | C2>
+    ? V extends Validator<From, infer E2, infer P2, infer C2> ? FieldAdapter<From, To, E1 | E2, P1 | P2, C1 & C2>
     : never
   : never
 

package/core/mobx/specs/form_model.tests.ts

@@ -8,6 +8,7 @@ import {
   object,
   record,
   stringType,
+  type Type,
   union,
   type ValueOfType,
   type ValueToTypePathsOfType,
@@ -45,6 +46,21 @@ const originalIntegerToStringAdapter = adapterFromTwoWayConverter(
 
 const originalBooleanToBooleanAdapter = identityAdapter(false)
 
+class TestFormModel<
+  T extends Type,
+  ValueToTypePaths extends Readonly<Record<string, string>>,
+  TypePathsToAdapters extends FlattenedTypePathsToAdaptersOf<
+    FlattenedValuesOfType<T, '*'>,
+    {}
+  >,
+> extends FormModel<T, ValueToTypePaths, TypePathsToAdapters, {}> {
+  override toContext() {
+    return {
+      ctx: true,
+    }
+  }
+}
+
 describe('all', function () {
   const integerToStringAdapter = createMockedAdapter(
     originalIntegerToStringAdapter,
@@ -171,7 +187,7 @@ describe('all', function () {
         >
         beforeEach(function () {
           originalValue = 5
-          model = new FormModel<
+          model = new TestFormModel<
             typeof typeDef,
             ValueToTypePathsOfType<typeof typeDef>,
             typeof adapters
@@ -231,7 +247,7 @@ describe('all', function () {
             readonly: false,
           })
           originalValue = 5
-          model = new FormModel<
+          model = new TestFormModel<
             typeof typeDef,
             ValueToTypePathsOfType<typeof typeDef>,
             typeof adapters
@@ -272,7 +288,7 @@ describe('all', function () {
           4,
           17,
         ]
-        model = new FormModel<
+        model = new TestFormModel<
           typeof typeDef,
           ValueToTypePathsOfType<typeof typeDef>,
           typeof adapters
@@ -350,7 +366,7 @@ describe('all', function () {
           a: 1,
           b: 2,
         }
-        model = new FormModel<
+        model = new TestFormModel<
           typeof typeDef,
           ValueToTypePathsOfType<typeof typeDef>,
           typeof converters
@@ -420,7 +436,7 @@ describe('all', function () {
           a: 1,
           b: true,
         }
-        model = new FormModel<
+        model = new TestFormModel<
           typeof typeDef,
           ValueToTypePathsOfType<typeof typeDef>,
           typeof converters
@@ -485,7 +501,7 @@ describe('all', function () {
         typeof adapters
       >
       beforeEach(function () {
-        model = new FormModel<
+        model = new TestFormModel<
           typeof typeDef,
           ValueToTypePathsOfType<typeof typeDef>,
           typeof adapters
@@ -611,7 +627,7 @@ describe('all', function () {
           3,
           7,
         ]
-        model = new FormModel<
+        model = new TestFormModel<
           typeof typeDef,
           ValueToTypePathsOfType<typeof typeDef>,
           typeof converters
@@ -727,7 +743,7 @@ describe('all', function () {
         let contextCopy: number[]
         beforeEach(function () {
           integerToStringAdapter.revert.mockImplementationOnce(function (_value, _path, context) {
-            contextCopy = [...context]
+            contextCopy = { ...context }
             return {
               type: UnreliableFieldConversionType.Success,
               value: 1,
@@ -742,17 +758,16 @@ describe('all', function () {
           expect(integerToStringAdapter.revert).toHaveBeenCalledWith(
             '4',
             '$.2',
-            // uses the same pointer
-            model.value,
+            {
+              ctx: true,
+            },
           )
         })
 
-        it('supplies the context as it is at the time call', function () {
-          expect(contextCopy).toEqual([
-            1,
-            3,
-            7,
-          ])
+        it('supplies the context', function () {
+          expect(contextCopy).toEqual({
+            ctx: true,
+          })
         })
       })
 
@@ -953,7 +968,7 @@ describe('all', function () {
         >
         beforeEach(function () {
           originalValue = null
-          model = new FormModel<
+          model = new TestFormModel<
             typeof type,
             ValueToTypePaths,
             typeof adapters
@@ -1018,7 +1033,7 @@ describe('all', function () {
 
         describe('isValuePathActive', function () {
           describe('discriminator x', function () {
-            const model = new FormModel<
+            const model = new TestFormModel<
               typeof type,
               ValueToTypePaths,
               typeof adapters
@@ -1050,7 +1065,7 @@ describe('all', function () {
           })
 
           describe('discriminator y', function () {
-            const model = new FormModel<
+            const model = new TestFormModel<
               typeof type,
               ValueToTypePaths,
               typeof adapters
@@ -1102,7 +1117,7 @@ describe('all', function () {
       >
       beforeEach(function () {
         originalValue = 1
-        model = new FormModel<
+        model = new TestFormModel<
           typeof typeDef,
           JsonPaths,
           typeof converters

package/core/mobx/specs/sub_form_field_adapters.tests.ts

@@ -1,9 +1,3 @@
-import {
-  list,
-  numberType,
-  object,
-  stringType,
-} from '@strictly/define'
 import { type FieldAdapter } from 'core/mobx/field_adapter'
 import {
   subFormFieldAdapters,
@@ -19,7 +13,6 @@ describe('subFormFieldAdapters', () => {
     const adapters = subFormFieldAdapters(
       {},
       '$.a',
-      stringType,
     )
 
     it('equals expected type', () => {
@@ -35,19 +28,16 @@ describe('subFormFieldAdapters', () => {
     const mockedFieldAdapter1 = mockDeep<Required<FieldAdapter<string, boolean, number, '$', string>>>()
     const fieldAdapter1: FieldAdapter<string, boolean, number, '$', string> = mockedFieldAdapter1
 
-    const type = object().field('a', stringType)
     const subAdapters = {
       $: fieldAdapter1,
     } as const
     const adapters = subFormFieldAdapters<
       typeof subAdapters,
       '$.a',
-      { '$.a': '$.a' },
-      typeof type
+      { '$.a': '$.a' }
     >(
       subAdapters,
       '$.a',
-      type,
     )
 
     beforeEach(() => {
@@ -58,9 +48,7 @@ describe('subFormFieldAdapters', () => {
       // TODO toEqualTypeOf (cannot reason about revert optionality, seems to be a TS issue as they
       // are both optional AFAICT)
       expectTypeOf(adapters).toMatchTypeOf<{
-        '$.a': FieldAdapter<string, boolean, number, '$.a', {
-          a: string,
-        }>,
+        '$.a': FieldAdapter<string, boolean, number, '$.a', string>,
       }>()
     })
 
@@ -76,7 +64,7 @@ describe('subFormFieldAdapters', () => {
       }
       mockedFieldAdapter1.convert.mockReturnValue(mockedReturnedValue)
 
-      const returnedValue = adapters['$.a'].convert('x', '$.a', { a: 'y' })
+      const returnedValue = adapters['$.a'].convert('x', '$.a', 'y')
       expect(fieldAdapter1.convert).toHaveBeenCalledWith('x', '$', 'y')
       expect(returnedValue).toEqual(mockedReturnedValue)
     })
@@ -88,7 +76,7 @@ describe('subFormFieldAdapters', () => {
       } as const
       mockedFieldAdapter1.revert.mockReturnValue(mockedReturnedValue)
 
-      const returnedValue = adapters['$.a'].revert?.(true, '$.a', { a: 'y' })
+      const returnedValue = adapters['$.a'].revert?.(true, '$.a', 'y')
       expect(fieldAdapter1.revert).toHaveBeenCalledWith(true, '$', 'y')
       expect(returnedValue).toEqual(mockedReturnedValue)
     })
@@ -97,7 +85,7 @@ describe('subFormFieldAdapters', () => {
       const mockedReturnedValue = 'x'
       mockedFieldAdapter1.create.mockReturnValue(mockedReturnedValue)
 
-      const returnedValue = adapters['$.a'].create('$.a', { a: 'y' })
+      const returnedValue = adapters['$.a'].create('$.a', 'y')
       expect(fieldAdapter1.create).toHaveBeenCalledWith('$', 'y')
       expect(returnedValue).toEqual(mockedReturnedValue)
     })
@@ -109,15 +97,12 @@ describe('subFormFieldAdapters', () => {
     const mockedFieldAdapter2 = mockDeep<FieldAdapter<number, boolean>>()
     const fieldAdapter2: FieldAdapter<number, boolean> = mockedFieldAdapter2
 
-    const type = object()
-      .field('a', object().field('x', stringType).field('y', numberType))
     const adapters = subFormFieldAdapters(
       {
         '$.x': fieldAdapter1,
         '$.y': fieldAdapter2,
       },
       '$.a',
-      type,
     )
 
     beforeEach(() => {
@@ -141,12 +126,11 @@ describe('subFormFieldAdapters', () => {
     })
 
     describe('calls convert with correct paths and values', () => {
-      const subContext = {
-        x: 'a',
-        y: 1,
-      } as const
       const context = {
-        a: subContext,
+        a: {
+          x: 'a',
+          y: 1,
+        },
       }
 
       it('calls $.a.x', () => {
@@ -158,7 +142,7 @@ describe('subFormFieldAdapters', () => {
         mockedFieldAdapter1.convert.mockReturnValue(mockedReturnedValue)
 
         const returnedValue = adapters['$.a.x'].convert('b', '$.a.x', context)
-        expect(fieldAdapter1.convert).toHaveBeenCalledWith('b', '$.x', subContext)
+        expect(fieldAdapter1.convert).toHaveBeenCalledWith('b', '$.x', context)
         expect(returnedValue).toEqual(mockedReturnedValue)
       })
 
@@ -171,7 +155,7 @@ describe('subFormFieldAdapters', () => {
         mockedFieldAdapter2.convert.mockReturnValue(mockedReturnedValue)
 
         const returnedValue = adapters['$.a.y'].convert(2, '$.a.y', context)
-        expect(fieldAdapter2.convert).toHaveBeenCalledWith(2, '$.y', subContext)
+        expect(fieldAdapter2.convert).toHaveBeenCalledWith(2, '$.y', context)
         expect(returnedValue).toEqual(mockedReturnedValue)
       })
     })
@@ -180,7 +164,6 @@ describe('subFormFieldAdapters', () => {
   describe('list adapter', () => {
     const mockedFieldAdapter1 = mockDeep<Required<FieldAdapter<string, boolean, number, '$', string>>>()
     const fieldAdapter1: FieldAdapter<string, boolean, number, '$', string> = mockedFieldAdapter1
-    const type = list(stringType)
     const subAdapters = {
       $: fieldAdapter1,
     }
@@ -189,12 +172,10 @@ describe('subFormFieldAdapters', () => {
       '$.*',
       {
         '$.*': `$.${number}`,
-      },
-      typeof type
+      }
     >(
       subAdapters,
       '$.*',
-      type,
     )
 
     beforeEach(() => {
@@ -204,7 +185,7 @@ describe('subFormFieldAdapters', () => {
     it('equals expected type', () => {
       // TODO toEqualTypeOf (seems to be a TS error)
       expectTypeOf(adapters).toMatchTypeOf<{
-        '$.*': FieldAdapter<string, boolean, number, `$.${number}`, string[]>,
+        '$.*': FieldAdapter<string, boolean, number, `$.${number}`, string>,
       }>()
     })
 
@@ -216,7 +197,6 @@ describe('subFormFieldAdapters', () => {
 
     describe('calls convert with correct paths and values', () => {
       const subContext = 'a'
-      const context = [subContext]
 
       it('calls $.*', () => {
         const mockedReturnedValue = {
@@ -226,7 +206,7 @@ describe('subFormFieldAdapters', () => {
         }
         mockedFieldAdapter1.convert.mockReturnValue(mockedReturnedValue)
 
-        const returnedValue = adapters['$.*'].convert('b', '$.0', context)
+        const returnedValue = adapters['$.*'].convert('b', '$.0', subContext)
         expect(fieldAdapter1.convert).toHaveBeenCalledWith('b', '$', subContext)
         expect(returnedValue).toEqual(mockedReturnedValue)
       })