@expressive/mvc 0.51.0 → 0.51.1

package/dist/index.d.ts

@@ -17,7 +17,7 @@ declare namespace Model {
     type Field<T> = Exclude<keyof T, keyof Model>;
     /** Any valid key for controller, including but not limited to Field<T>. */
     type Event<T> = Field<T> | (string & {}) | number | symbol;
-    /** Object overlay which may be used to override values and methods on a model. */
+    /** Object overlay to override values and methods on a model. */
     type Assign<T> = {
         [K in Exclude<keyof T, keyof Model>]?: T[K] extends (...args: infer A) => infer R ? (this: T, ...args: A) => R : T[K];
     } & Record<string, unknown>;
@@ -67,12 +67,13 @@ declare namespace Model {
      * Property initializer, will run upon instance creation.
      * Optional returned callback will run when once upon first access.
      */
-    type Instruction<T = any, M extends Model = any> = (this: M, key: Field<M> & string, thisArg: M, state: State<M>) => Descriptor<T> | Getter<T> | void;
+    type Instruction<T = any, M extends Model = any> = (this: M, key: Extract<Field<M>, string>, thisArg: M, state: State<M>) => Descriptor<T> | ((source: M) => T) | void;
+    type VoidInstruction<M extends Model = any> = (this: M, key: Extract<Field<M>, string>, thisArg: M, state: State<M>) => ((source: Model) => void) | void;
     type Getter<T> = (source: Model) => T;
     type Setter<T> = (value: T, previous: T) => boolean | void | (() => T);
     type Descriptor<T = any> = {
         get?: Getter<T> | boolean;
-        set?: Setter<T> | false;
+        set?: Setter<T> | boolean;
         enumerable?: boolean;
         value?: T;
     };
@@ -177,12 +178,15 @@ declare abstract class Model {
      * @param silent - if true, will not notify listeners of an update
      */
     set<K extends string>(key: K, value?: Model.Value<this, K>, silent?: boolean): PromiseLike<Model.Event<this>[]> | undefined;
-    /** Iterate over managed properties in this instance of Model. */
+    /**
+     * Iterate over managed properties in this instance of Model.
+     * Yeilds the key and underlying value for each property.
+     */
     [Symbol.iterator](): Iterator<[string, unknown]>;
     /**
-     * Creates a new instance of this controller.
+     * Create and activate a new instance of this controller.
      *
-     * **Important** - Use instead of `new this(...)` as this method also activates state.
+     * **Important** - Unlike `new this(...)` - this method also activates state.
      *
      * @param args - arguments sent to constructor
      */
@@ -343,7 +347,8 @@ declare function set<T>(factory: set.Factory<T> | Promise<T>, required?: boolean
  */
 declare function set<T>(value: T | undefined, onUpdate: set.Callback<T>): T;
 
-declare function use<T = any>(instruction: Model.Instruction): T;
+declare function use(instruction: Model.VoidInstruction): unknown;
+declare function use<T>(instruction: Model.Instruction<T>): T;
 declare function use<T extends Model>(Type: Model.Init<T>, required: false): T | undefined;
 declare function use<T extends Model>(Type: Model.Init<T>, ready?: (i: T) => void): T;
 

package/dist/index.js

@@ -271,8 +271,10 @@ var Model = class _Model {
         if (typeof key2 == "string")
           return arg1.call(self, key2, self);
       });
-    if (arg1 === null)
-      return emit(this, null);
+    if (arg1 === null) {
+      emit(this, null);
+      return;
+    }
     if (typeof arg1 == "object")
       assign(self, arg1);
     else if (arg1 == void 0)
@@ -293,14 +295,17 @@ var Model = class _Model {
         }).then(res)
       };
   }
-  /** Iterate over managed properties in this instance of Model. */
+  /**
+   * Iterate over managed properties in this instance of Model.
+   * Yeilds the key and underlying value for each property.
+   */
   [Symbol.iterator]() {
     return Object.entries(STATE.get(this.is))[Symbol.iterator]();
   }
   /**
-   * Creates a new instance of this controller.
+   * Create and activate a new instance of this controller.
    * 
-   * **Important** - Use instead of `new this(...)` as this method also activates state.
+   * **Important** - Unlike `new this(...)` - this method also activates state.
    * 
    * @param args - arguments sent to constructor
    */

package/dist/index.mjs

@@ -237,8 +237,10 @@ var Model = class _Model {
         if (typeof key2 == "string")
           return arg1.call(self, key2, self);
       });
-    if (arg1 === null)
-      return emit(this, null);
+    if (arg1 === null) {
+      emit(this, null);
+      return;
+    }
     if (typeof arg1 == "object")
       assign(self, arg1);
     else if (arg1 == void 0)
@@ -259,14 +261,17 @@ var Model = class _Model {
         }).then(res)
       };
   }
-  /** Iterate over managed properties in this instance of Model. */
+  /**
+   * Iterate over managed properties in this instance of Model.
+   * Yeilds the key and underlying value for each property.
+   */
   [Symbol.iterator]() {
     return Object.entries(STATE.get(this.is))[Symbol.iterator]();
   }
   /**
-   * Creates a new instance of this controller.
+   * Create and activate a new instance of this controller.
    * 
-   * **Important** - Use instead of `new this(...)` as this method also activates state.
+   * **Important** - Unlike `new this(...)` - this method also activates state.
    * 
    * @param args - arguments sent to constructor
    */

package/package.json

@@ -28,6 +28,10 @@
     "prebuild": "rm -rf dist",
     "preversion": "npm run test && npm run build"
   },
-  "version": "0.51.0",
-  "gitHead": "9f020cb09a146bcb14e9deb765c07beab345ea95"
+  "devDependencies": {
+    "jest": "^27.0.6",
+    "tsup": "^8.0.2"
+  },
+  "version": "0.51.1",
+  "gitHead": "b5169ea695a97e020e0266f84db55ab4a12fa3b5"
 }