@strictly/react-form 0.0.15 → 0.0.16

package/.turbo/turbo-build.log

@@ -7,12 +7,12 @@ $ tsup
 CLI Target: es6
 CJS Build start
 ESM Build start
-ESM dist/index.js 55.85 KB
-ESM ⚡️ Build success in 136ms
-CJS dist/index.cjs 59.76 KB
-CJS ⚡️ Build success in 141ms
+ESM dist/index.js 57.40 KB
+ESM ⚡️ Build success in 138ms
+CJS dist/index.cjs 61.39 KB
+CJS ⚡️ Build success in 139ms
 DTS Build start
-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.
+DTS ⚡️ Build success in 9840ms
+DTS dist/index.d.cts 37.86 KB
+DTS dist/index.d.ts  37.86 KB
+Done in 10.97s.

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

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

package/core/mobx/field_adapter_builder.ts

@@ -336,8 +336,8 @@ export function trimmingStringAdapter<
 
 export function listAdapter<
   E,
-  ValuePath extends string,
-  Context,
+  ValuePath extends string = string,
+  Context = unknown,
 >() {
   return new FieldAdapterBuilder<readonly E[], readonly E[], never, ValuePath, Context>(
     annotatedIdentityConverter<readonly E[], ValuePath, Context>(false),

package/core/mobx/form_model.ts

@@ -105,11 +105,18 @@ export type ValuePathsToAdaptersOf<
   : never
 
 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]>
+  UnionToIntersection<
+    | {
+      readonly [
+        K in keyof TypePathsToAdapters
+      ]: TypePathsToAdapters[K] extends undefined ? undefined
+        // ignore unspecified values
+        : unknown extends ContextOfFieldAdapter<NonNullable<TypePathsToAdapters[K]>> ? never
+        : ContextOfFieldAdapter<NonNullable<TypePathsToAdapters[K]>>
+    }[keyof TypePathsToAdapters]
+    // ensure we have at least one thing to intersect (can end up with a `never` context otherwise)
+    | {}
+  >
 
 export abstract class FormModel<
   T extends Type,
@@ -140,7 +147,6 @@ export abstract 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(
@@ -149,11 +155,14 @@ export abstract class FormModel<
       () => {},
       (
         _t: StrictTypeDef,
-        value: AnyValueType,
+        fieldValue: AnyValueType,
         _setter,
         typePath,
         valuePath,
       ): AnnotatedFieldConversion<FieldOverride> | undefined => {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        const contextValue = this.toContext(value, valuePath as keyof ValuePathsToAdapters)
+
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const adapter = this.adapters[typePath as keyof TypePathsToAdapters]
         if (adapter == null) {
@@ -168,7 +177,7 @@ export abstract class FormModel<
           return
         }
         // cannot call this.context yet as the "this" pointer has not been fully created
-        return convert(value, valuePath, contextValue)
+        return convert(fieldValue, valuePath, contextValue)
       },
     )
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -177,12 +186,10 @@ export abstract class FormModel<
     }) as FlattenedFieldOverrides<ValuePathsToAdapters>
   }
 
-  @computed.struct
-  get context() {
-    return this.toContext(this.value)
-  }
-
-  protected abstract toContext(value: ValueOfType<ReadonlyTypeOfType<T>>): ContextType
+  protected abstract toContext(
+    value: ValueOfType<ReadonlyTypeOfType<T>>,
+    valuePath: keyof ValuePathsToAdapters,
+  ): ContextType
 
   @computed
   get fields(): SimplifyDeep<FlattenedConvertedFieldsOf<ValuePathsToAdapters>> {
@@ -256,6 +263,7 @@ export abstract class FormModel<
     const accessor = this.getAccessorForValuePath(valuePath)
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     const fieldTypeDef = this.flattenedTypeDefs[typePath as string]
+    const context = this.toContext(this.value, valuePath)
     const {
       value,
       required,
@@ -267,14 +275,14 @@ export abstract class FormModel<
         ? mobxCopy(
           fieldTypeDef,
           // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          create(valuePath as string, this.context),
+          create(valuePath as string, context),
         )
         // fake values can't be copied
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        : create(valuePath as string, this.context),
+        : create(valuePath as string, context),
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       valuePath as string,
-      this.context,
+      context,
     )
     const error = this.errors[valuePath]
     return {
@@ -360,7 +368,9 @@ export abstract class FormModel<
       : elementAdapter.create(
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         elementTypePath as string,
-        this.context,
+        // TODO what can we use for the value path here?
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        this.toContext(this.value, valuePath as unknown as keyof ValuePathsToAdapters),
       )
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const originalList: any[] = accessor.value
@@ -505,7 +515,7 @@ export abstract 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.context)
+    const conversion = revert(value, valuePath as any, this.toContext(this.value, valuePath))
     const accessor = this.getAccessorForValuePath(valuePath)
     return runInAction(() => {
       this.fieldOverrides[valuePath] = [value]
@@ -548,10 +558,12 @@ export abstract class FormModel<
       convert,
       create,
     } = adapter
-    const value = create(valuePath, this.context)
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    const context = this.toContext(this.value, valuePath as unknown as keyof ValuePathsToAdapters)
+    const value = create(valuePath, context)
     const {
       value: displayValue,
-    } = convert(value, valuePath, this.context)
+    } = convert(value, valuePath, context)
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     const key = valuePath as unknown as keyof ValuePathsToAdapters
     runInAction(() => {
@@ -586,16 +598,18 @@ export abstract class FormModel<
     } = this.getAdapterForValuePath(valuePath)
     const fieldOverride = this.fieldOverrides[valuePath]
     const accessor = this.getAccessorForValuePath(valuePath)
+    const context = this.toContext(this.value, valuePath)
+
     const {
       value: storedValue,
     } = convert(
       accessor != null
         ? accessor.value
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        : create(valuePath as string, this.context),
+        : create(valuePath as string, context),
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       valuePath as string,
-      this.context,
+      context,
     )
     const value = fieldOverride != null
       ? fieldOverride[0]
@@ -605,13 +619,13 @@ export abstract class FormModel<
     if (ignoreDefaultValue) {
       const {
         value: defaultDisplayValue,
-      } = convert(create(valuePath, this.context), valuePath, this.context)
+      } = convert(create(valuePath, context), valuePath, context)
       if (defaultDisplayValue === value) {
         return true
       }
     }
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const conversion = revert(value, valuePath as string, this.context)
+    const conversion = revert(value, valuePath as string, context)
     return runInAction(() => {
       switch (conversion.type) {
         case UnreliableFieldConversionType.Failure:
@@ -662,16 +676,18 @@ export abstract class FormModel<
             return success
           }
           const fieldOverride = this.fieldOverrides[adapterPath]
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+          const context = this.toContext(this.value, valuePath as keyof ValuePathsToAdapters)
           const {
             value: storedValue,
-          } = convert(accessor.value, valuePath, this.context)
+          } = convert(accessor.value, valuePath, 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.context)
+          const conversion = revert(value, valuePath, context)
           switch (conversion.type) {
             case UnreliableFieldConversionType.Failure:
               this.errors[adapterPath] = conversion.error

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

@@ -13,7 +13,9 @@ import {
   type ValueOfType,
   type ValueToTypePathsOfType,
 } from '@strictly/define'
-import { type FieldAdapter } from 'core/mobx/field_adapter'
+import {
+  type FieldAdapter,
+} from 'core/mobx/field_adapter'
 import {
   adapterFromTwoWayConverter,
   identityAdapter,
@@ -27,7 +29,9 @@ import { IntegerToStringConverter } from 'field_converters/integer_to_string_con
 import { NullableToBooleanConverter } from 'field_converters/nullable_to_boolean_converter'
 import { SelectDiscriminatedUnionConverter } from 'field_converters/select_value_type_converter'
 import { prototypingFieldValueFactory } from 'field_value_factories/prototyping_field_value_factory'
-import { type Simplify } from 'type-fest'
+import {
+  type Simplify,
+} from 'type-fest'
 import { type Field } from 'types/field'
 import {
   UnreliableFieldConversionType,
@@ -54,9 +58,13 @@ class TestFormModel<
     {}
   >,
 > extends FormModel<T, ValueToTypePaths, TypePathsToAdapters, {}> {
-  override toContext() {
+  override toContext(
+    value: ValueOfType<T>,
+    valuePath: keyof ValuePathsToAdaptersOf<TypePathsToAdapters, ValueToTypePaths>,
+  ) {
     return {
-      ctx: true,
+      value,
+      valuePath,
     }
   }
 }
@@ -740,10 +748,10 @@ describe('all', function () {
 
       // no longer passes context, but will pass context eventually again
       describe('passes context', function () {
-        let contextCopy: number[]
+        let contextCopy: string
         beforeEach(function () {
           integerToStringAdapter.revert.mockImplementationOnce(function (_value, _path, context) {
-            contextCopy = { ...context }
+            contextCopy = JSON.stringify(context)
             return {
               type: UnreliableFieldConversionType.Success,
               value: 1,
@@ -751,7 +759,7 @@ describe('all', function () {
           })
         })
 
-        it('supplies the full, previous context when converting', function () {
+        it('supplies the context when converting', function () {
           model.setFieldValueAndValidate('$.2', '4')
 
           expect(integerToStringAdapter.revert).toHaveBeenCalledOnce()
@@ -759,14 +767,23 @@ describe('all', function () {
             '4',
             '$.2',
             {
-              ctx: true,
+              // the supplied value isn't a copy, so it will be the model value, even
+              // if the value has since changed
+              value: model.value,
+              valuePath: '$.2',
             },
           )
         })
 
-        it('supplies the context', function () {
-          expect(contextCopy).toEqual({
-            ctx: true,
+        it('supplies the correct context value at the time it is being checked', function () {
+          // the copy will show the supplied value however
+          expect(JSON.parse(contextCopy)).toEqual({
+            value: [
+              1,
+              3,
+              7,
+            ],
+            valuePath: '$.2',
           })
         })
       })

package/core/mobx/types.ts

@@ -6,7 +6,7 @@ import {
 } from './form_model'
 
 /**
- * Used to extract the supported value paths from a presenter
+ * Used to extract the supported value paths from a model
  */
 export type ValuePathsOfModel<
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -22,7 +22,7 @@ export type ValuePathsOfModel<
 
 /**
  * Used to extract the render type (so the value that is passed to the view) of a given value path
- * from a presenter
+ * from a model
  */
 export type ToValueOfModelValuePath<
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -38,9 +38,9 @@ export type ToValueOfModelValuePath<
   : never
 
 /**
- * Extracts the form fields from the presenter. The recommended way is to
+ * Extracts the form fields from a form model. The recommended way is to
  * define the form fields explicitly and use that type to enforce the types
- * of your converters, but generating the FormFields from your presenter
+ * of your converters, but generating the FormFields from your model
  * is less typing, albeit at the cost of potentially getting type errors
  * reported a long way away from the source
  */