Allow properties to be configurable (#32)

* Fix audit

* Allow properties to be configurable

Author: jgoz

package-lock.json

@@ -290,26 +290,35 @@ describe('BaseImmutable', () => {
     ).toEqual({ fuel: 'electric', name: 'ford', passengers: [] });
   });
 
-  it('should fail to construct if property defined without "delcare"', () => {
-    expect(() =>
-      Bicycle.fromJS({
-        fuel: 'potato',
-        name: 'riva',
-      }),
-    ).toThrow('Cannot redefine property: name');
+  it('should not fail to construct if property defined without "declare"', () => {
+    expect(() => Bicycle.fromJS({ fuel: 'potato', name: 'riva' })).not.toThrow();
+    expect(() => Bicycle.fromJS({ fuel: 'potato', name: 'RIVA' })).toThrow(
+      'Bicycle.name must be lowercase',
+    );
   });
 
-  it('should fail on get() if getter defined without "delcare"', () => {
+  it('should fail on get() if getter defined without "declare"', () => {
     const pope = Rider.fromJS({ name: 'pope' });
     expect(() => pope.get('name')).toThrowErrorMatchingInlineSnapshot(
       `"No getter was found for \\"name\\" but it is defined as a property. This might indicate that you are using \\"useDefineForClassFields\\" and forgot to use \\"declare\\" on an auto-generated getter property."`,
     );
   });
 
-  it('should fail on change() if changer defined without "delcare"', () => {
+  it('should fail on change() if changer defined without "declare"', () => {
     const pope = Rider.fromJS({ name: 'pope' });
     expect(() => pope.change('name', 'papa')).toThrowErrorMatchingInlineSnapshot(
       `"No changer was found for \\"name\\" but it is defined as a property. This might indicate that you are using \\"useDefineForClassFields\\" and forgot to use \\"declare\\" on an auto-generated getter property."`,
     );
   });
+
+  it('allows values to be set in the constructor', () => {
+    let car = Car.fromJS({ name: 'ford', fuel: 'electric', range: 150 });
+
+    expect(car.get('name')).toEqual('ford');
+    expect(car.get('fuel')).toEqual('electric');
+    expect(car.getRange()).toEqual(200);
+
+    car = car.changeRange(0);
+    expect(car.getRange()).toEqual(0);
+  });
 });

packages/immutable-class/src/base-immutable/base-immutable.spec.ts

@@ -118,10 +118,7 @@ export abstract class BaseImmutable<ValueType, JSType>
         if (property.type === PropertyType.DATE) {
           pv = new Date(pv);
         } else if (property.immutableClass) {
-          pv = (property.immutableClass as any).fromJS(
-            pv,
-            context ? contextTransform(context) : undefined,
-          );
+          pv = property.immutableClass.fromJS(pv, context ? contextTransform(context) : undefined);
         } else if (property.immutableClassArray) {
           if (!Array.isArray(pv)) throw new Error(`expected ${propertyName} to be an array`);
           const propertyImmutableClassArray: any = property.immutableClassArray;
@@ -178,7 +175,7 @@ export abstract class BaseImmutable<ValueType, JSType>
     for (const property of properties) {
       const propertyName = property.name;
       const propertyType = hasOwnProp(property, 'isDate') ? PropertyType.DATE : property.type;
-      const pv = (value as any)[propertyName];
+      const pv = value[propertyName];
 
       if (pv == null) {
         if (propertyType === PropertyType.ARRAY) {
@@ -202,7 +199,7 @@ export abstract class BaseImmutable<ValueType, JSType>
         }
 
         if (property.type === PropertyType.DATE) {
-          if (isNaN(pv)) {
+          if (isNaN(pv as any)) {
             throw new Error(`${this.constructor.name}.${propertyName} must be a Date`);
           }
         }
@@ -226,7 +223,7 @@ export abstract class BaseImmutable<ValueType, JSType>
 
       Object.defineProperty(this, propertyName, {
         value: pv,
-        configurable: false,
+        configurable: true,
         enumerable: true,
         writable: false,
       });

packages/immutable-class/src/base-immutable/base-immutable.ts

@@ -72,9 +72,10 @@ export class Bicycle extends BaseImmutable<BicycleValue, BicycleJS> {
 
   constructor(params: BicycleValue) {
     super(params);
+    this.name = params.name;
   }
 
-  public name!: string; // This will cause a constructor error
+  public readonly name: string;
   public declare fuel: string;
 }
 BaseImmutable.finalize(Bicycle);

packages/immutable-class/src/base-immutable/bicycle.mock.ts

@@ -139,11 +139,16 @@ export class Car extends BaseImmutable<CarValue, CarJS> {
   public declare name: string;
   public declare fuel: string;
   public declare subCar: Car;
-  public declare range: number;
+  public readonly range: number | undefined;
   public declare createdOn: Date;
 
   constructor(properties: CarValue) {
     super(properties);
+
+    if (properties.range != null) this.range = properties.range;
+    if (this.fuel === 'electric' && this.range && this.range < 200) {
+      this.range = 200;
+    }
   }
 
   public declare changeFuel: (fuel: string) => this;