@strictly/react-form 0.0.36 → 0.0.38

package/.out/core/mobx/FormModel.d.ts

@@ -31,16 +31,14 @@ export type ValuePathsToAdaptersOf<TypePathsToAdapters extends Partial<Readonly<
 export type ContextOf<TypePathsToAdapters extends Partial<Readonly<Record<string, FieldAdapter>>>> = UnionToIntersection<{
     readonly [K in keyof TypePathsToAdapters]: TypePathsToAdapters[K] extends undefined ? undefined : unknown extends ContextOfFieldAdapter<NonNullable<TypePathsToAdapters[K]>> ? never : ContextOfFieldAdapter<NonNullable<TypePathsToAdapters[K]>>;
 }[keyof TypePathsToAdapters] | {}>;
-export type FormMode = 'edit' | 'create';
 export type FormModelContextSource<ContextType, V, ValuePath extends string | number | symbol> = {
     forPath(value: V, valuePath: ValuePath): ContextType;
 };
-export declare abstract class FormModel<T extends Type, ValueToTypePaths extends Readonly<Record<string, string>>, TypePathsToAdapters extends FlattenedTypePathsToAdaptersOf<FlattenedValuesOfType<T, '*'>, ContextType>, ContextType = ContextOf<TypePathsToAdapters>, ValuePathsToAdapters extends ValuePathsToAdaptersOf<TypePathsToAdapters, ValueToTypePaths> = ValuePathsToAdaptersOf<TypePathsToAdapters, ValueToTypePaths>> {
+export declare abstract class FormModel<T extends Type, ValueToTypePaths extends Readonly<Record<string, string>>, TypePathsToAdapters extends FlattenedTypePathsToAdaptersOf<FlattenedValuesOfType<T, '*'>, ContextType>, ContextType = ContextOf<TypePathsToAdapters>, ContextSource extends FormModelContextSource<ContextType, ValueOfType<ReadonlyTypeOfType<T>>, keyof ValuePathsToAdapters> = FormModelContextSource<ContextType, ValueOfType<ReadonlyTypeOfType<T>>, string | number | symbol>, ValuePathsToAdapters extends ValuePathsToAdaptersOf<TypePathsToAdapters, ValueToTypePaths> = ValuePathsToAdaptersOf<TypePathsToAdapters, ValueToTypePaths>> {
     readonly type: T;
     private readonly originalValue;
     protected readonly adapters: TypePathsToAdapters;
-    protected readonly contextSource: FormModelContextSource<ContextType, ValueOfType<ReadonlyTypeOfType<T>>, keyof ValuePathsToAdapters>;
-    protected readonly mode: FormMode;
+    protected readonly contextSource: ContextSource;
     private accessor observableValue;
     accessor fieldOverrides: FlattenedFieldOverrides<ValuePathsToAdapters>;
     accessor errorOverrides: FlattenedErrorOverrides<ValuePathsToAdapters>;
@@ -48,8 +46,7 @@ export declare abstract class FormModel<T extends Type, ValueToTypePaths extends
     private readonly flattenedTypeDefs;
     private readonly originalValues;
     private readonly listIndicesToKeys;
-    constructor(type: T, originalValue: ValueOfType<ReadonlyTypeOfType<T>>, adapters: TypePathsToAdapters, contextSource: FormModelContextSource<ContextType, ValueOfType<ReadonlyTypeOfType<T>>, keyof ValuePathsToAdapters>, mode: FormMode);
-    get forceMutableFields(): boolean;
+    constructor(type: T, originalValue: ValueOfType<ReadonlyTypeOfType<T>>, adapters: TypePathsToAdapters, contextSource: ContextSource);
     get value(): ValueOfType<ReadonlyTypeOfType<T>>;
     get fields(): SimplifyDeep<FlattenedConvertedFieldsOf<ValuePathsToAdapters>>;
     private get knownFields();

package/.out/core/mobx/FormModel.js

@@ -87,7 +87,7 @@ let FormModel = (() => {
             set errorOverrides(value) { __classPrivateFieldSet(this, _FormModel_errorOverrides_accessor_storage, value, "f"); }
             get validation() { return __classPrivateFieldGet(this, _FormModel_validation_accessor_storage, "f"); }
             set validation(value) { __classPrivateFieldSet(this, _FormModel_validation_accessor_storage, value, "f"); }
-            constructor(type, originalValue, adapters, contextSource, mode) {
+            constructor(type, originalValue, adapters, contextSource) {
                 Object.defineProperty(this, "type", {
                     enumerable: true,
                     configurable: true,
@@ -112,12 +112,6 @@ let FormModel = (() => {
                     writable: true,
                     value: contextSource
                 });
-                Object.defineProperty(this, "mode", {
-                    enumerable: true,
-                    configurable: true,
-                    writable: true,
-                    value: mode
-                });
                 _FormModel_observableValue_accessor_storage.set(this, __runInitializers(this, _observableValue_initializers, void 0));
                 _FormModel_fieldOverrides_accessor_storage.set(this, (__runInitializers(this, _observableValue_extraInitializers), __runInitializers(this, _fieldOverrides_initializers, void 0)));
                 _FormModel_errorOverrides_accessor_storage.set(this, (__runInitializers(this, _fieldOverrides_extraInitializers), __runInitializers(this, _errorOverrides_initializers, {})));
@@ -169,16 +163,6 @@ let FormModel = (() => {
                     return v && [v.value];
                 });
             }
-            get forceMutableFields() {
-                switch (this.mode) {
-                    case 'create':
-                        return true;
-                    case 'edit':
-                        return false;
-                    default:
-                        throw new UnreachableError(this.mode);
-                }
-            }
             get value() {
                 // copy and strip out the mobx so this computed will fire every time anything changes
                 return copy(this.type, this.observableValue);
@@ -308,7 +292,7 @@ let FormModel = (() => {
                 return {
                     value: displayedValue,
                     error,
-                    readonly: readonly && !this.forceMutableFields,
+                    readonly,
                     required,
                     // make a copy of the index mapping and remove the final value (next id)
                     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions

package/.out/core/mobx/hooks.d.ts

@@ -1,6 +1,6 @@
 import { type ReadonlyTypeOfType, type Type, type ValueOfType } from '@strictly/define';
 import { type FormModel } from './FormModel';
-type FormModelInterface<T extends Type = any> = Pick<FormModel<T, any, any, any, any>, 'fields' | 'value' | 'getValidation' | 'validateField' | 'setFieldValue' | 'validateSubmit' | 'isFieldDirty' | 'isValuePathActive'>;
+type FormModelInterface<T extends Type = any> = Pick<FormModel<T, any, any, any, any, any>, 'fields' | 'value' | 'getValidation' | 'validateField' | 'setFieldValue' | 'validateSubmit' | 'isFieldDirty' | 'isValuePathActive'>;
 type ValueOfModel<M extends FormModelInterface> = M extends FormModelInterface<infer T> ? ValueOfType<ReadonlyTypeOfType<T>> : never;
 export declare function useDefaultMobxFormHooks<M extends FormModelInterface, F extends M['fields'] = M['fields']>(model: M, { onValidFieldSubmit, onValidFormSubmit, }?: {
     onValidFieldSubmit?: <Path extends keyof F>(valuePath: Path) => void;

package/.out/core/mobx/specs/FormModel.tests.js

@@ -1,5 +1,5 @@
 import { expectDefinedAndReturn } from '@strictly/base';
-import { booleanType, flattenValidatorsOfValidatingType, list, nullType, numberType, object, record, stringType, union, } from '@strictly/define';
+import { booleanType, flattenValidatorsOfValidatingTypeWithMutability, list, nullType, numberType, object, record, stringType, union, } from '@strictly/define';
 import { adapterFromTwoWayConverter, identityAdapter, } from 'core/mobx/fieldAdapterBuilder';
 import { FormModel, Validation, } from 'core/mobx/FormModel';
 import { mergeAdaptersWithValidators } from 'core/mobx/mergeFieldAdaptersWithValidators';
@@ -13,16 +13,25 @@ const IS_NAN_ERROR = 1;
 const originalIntegerToStringAdapter = adapterFromTwoWayConverter(new IntegerToStringConverter(IS_NAN_ERROR), prototypingFieldValueFactory(0));
 const originalBooleanToBooleanAdapter = identityAdapter(false);
 class TestFormContextSource {
+    constructor(forceMutable) {
+        Object.defineProperty(this, "forceMutable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: forceMutable
+        });
+    }
     forPath(value, valuePath) {
         return {
+            forceMutable: this.forceMutable,
             value,
             valuePath,
         };
     }
 }
 class TestFormModel extends FormModel {
-    constructor(type, originalValue, adapters, mode) {
-        super(type, originalValue, adapters, new TestFormContextSource(), mode);
+    constructor(type, originalValue, adapters, forceMutable = false) {
+        super(type, originalValue, adapters, new TestFormContextSource(forceMutable));
     }
     setFieldValueAndValidate(valuePath, value) {
         this.setFieldValue(valuePath, value, Validation.Always);
@@ -81,7 +90,7 @@ describe('all', function () {
                 let model;
                 beforeEach(function () {
                     originalValue = 5;
-                    model = new TestFormModel(typeDef, originalValue, adapters, 'create');
+                    model = new TestFormModel(typeDef, originalValue, adapters);
                 });
                 describe('accessors', function () {
                     it('gets the expected value', function () {
@@ -122,7 +131,7 @@ describe('all', function () {
                         readonly: false,
                     });
                     originalValue = 5;
-                    model = new TestFormModel(typeDef, originalValue, adapters, 'create');
+                    model = new TestFormModel(typeDef, originalValue, adapters);
                 });
                 it('reports required status', function () {
                     expect(model.fields).toEqual(expect.objectContaining({
@@ -147,7 +156,7 @@ describe('all', function () {
                     4,
                     17,
                 ];
-                model = new TestFormModel(typeDef, value, adapters, 'create');
+                model = new TestFormModel(typeDef, value, adapters);
             });
             describe('accessors', function () {
                 it.each([
@@ -209,7 +218,7 @@ describe('all', function () {
                     a: 1,
                     b: 2,
                 };
-                model = new TestFormModel(typeDef, value, converters, 'create');
+                model = new TestFormModel(typeDef, value, converters);
             });
             describe('accessors', function () {
                 it.each([
@@ -260,7 +269,7 @@ describe('all', function () {
                     a: 1,
                     b: true,
                 };
-                model = new TestFormModel(typeDef, value, converters, 'create');
+                model = new TestFormModel(typeDef, value, converters);
             });
             describe('accessors', function () {
                 it.each([
@@ -306,7 +315,7 @@ describe('all', function () {
             const originalValue = 2;
             let model;
             beforeEach(function () {
-                model = new TestFormModel(typeDef, originalValue, adapters, 'create');
+                model = new TestFormModel(typeDef, originalValue, adapters);
             });
             describe('setFieldValueAndValidate', function () {
                 describe('success', function () {
@@ -408,7 +417,7 @@ describe('all', function () {
                     3,
                     7,
                 ];
-                model = new TestFormModel(typeDef, originalValue, converters, 'create');
+                model = new TestFormModel(typeDef, originalValue, converters);
             });
             describe('setFieldValueAndValidate', function () {
                 describe('success', function () {
@@ -518,6 +527,7 @@ describe('all', function () {
                         // if the value has since changed
                         value: model.value,
                         valuePath: '$.2',
+                        forceMutable: false,
                     });
                 });
                 it('supplies the correct context value at the time it is being checked', function () {
@@ -529,6 +539,7 @@ describe('all', function () {
                             7,
                         ],
                         valuePath: '$.2',
+                        forceMutable: false,
                     });
                 });
             });
@@ -710,7 +721,7 @@ describe('all', function () {
                 let model;
                 beforeEach(function () {
                     originalValue = null;
-                    model = new TestFormModel(type, originalValue, adapters, 'create');
+                    model = new TestFormModel(type, originalValue, adapters);
                 });
                 it('has the expected fields', function () {
                     expect(model.fields).toEqual({
@@ -758,7 +769,7 @@ describe('all', function () {
                         const model = new TestFormModel(type, {
                             d: 'x',
                             a: 1,
-                        }, adapters, 'create');
+                        }, adapters);
                         it.each([
                             [
                                 '$',
@@ -781,7 +792,7 @@ describe('all', function () {
                         const model = new TestFormModel(type, {
                             d: 'y',
                             b: false,
-                        }, adapters, 'create');
+                        }, adapters);
                         it.each([
                             [
                                 '$',
@@ -813,7 +824,7 @@ describe('all', function () {
             let model;
             beforeEach(function () {
                 originalValue = 1;
-                model = new TestFormModel(typeDef, originalValue, converters, 'create');
+                model = new TestFormModel(typeDef, originalValue, converters);
             });
             it('returns the default value for the fake field', function () {
                 expect(model.fields['$.fake']).toEqual(expect.objectContaining({
@@ -834,12 +845,12 @@ describe('all', function () {
                 });
             });
         });
-        describe('interaction with create and edit modes', () => {
+        describe('interaction with mutability', () => {
             const typeDef = object().readonlyField('n', numberType.enforce(n => n < 10 ? 'err' : null));
             const adapters = mergeAdaptersWithValidators({
                 $: identityAdapter({ n: 0 }),
                 '$.n': integerToStringAdapter,
-            }, flattenValidatorsOfValidatingType(typeDef));
+            }, flattenValidatorsOfValidatingTypeWithMutability(typeDef));
             let originalValue;
             beforeEach(() => {
                 originalValue = {
@@ -849,7 +860,7 @@ describe('all', function () {
             describe('create mode', () => {
                 let model;
                 beforeEach(() => {
-                    model = new TestFormModel(typeDef, originalValue, adapters, 'create');
+                    model = new TestFormModel(typeDef, originalValue, adapters, true);
                 });
                 it('makes the field editable', () => {
                     expect(model.fields['$.n'].readonly).toBeFalsy();
@@ -862,26 +873,6 @@ describe('all', function () {
                     expect(model.validateAll()).toBeTruthy();
                 });
             });
-            describe('edit model', () => {
-                let model;
-                beforeEach(function () {
-                    model = new TestFormModel(typeDef, originalValue, adapters, 'edit');
-                });
-                it('respects the field being readonly', () => {
-                    expect(model.fields['$.n'].readonly).toBeTruthy();
-                });
-                it('fails validation with invalid, clean data', () => {
-                    expect(model.validateAll()).toBeFalsy();
-                });
-                it('fails validation with invalid, dirty data', () => {
-                    model.setFieldValue('$.n', '2');
-                    expect(model.validateAll()).toBeFalsy();
-                });
-                it('passes validation with valid, dirty data', () => {
-                    model.setFieldValue('$.n', '10');
-                    expect(model.validateAll()).toBeTruthy();
-                });
-            });
         });
     });
 });