@expressive/mvc 0.35.2 → 0.35.5-alpha.0

package/dist/index.d.ts

@@ -4,23 +4,23 @@ declare namespace Model {
     /** A type of Model which may be created without constructor arguments. */
     type New<T extends Model = Model> = (new () => T) & typeof Model;
     /** Subset of `keyof T` which are not methods or defined by base Model U. **/
-    type Key<T> = Exclude<keyof T, keyof Model> & string;
-    type Any<T> = Exclude<keyof T, keyof Model> | (string & {});
+    type Field<T> = Exclude<keyof T, keyof Model>;
+    type Key<T> = Field<T> | (string & {}) | number | symbol;
     /** Actual value stored in state. */
-    type Value<R> = R extends Ref<infer T> ? T : R extends Model ? Export<R> : R;
-    type ValueOf<T extends Model, K extends Any<T>> = K extends keyof T ? T[K] extends Ref<infer V> ? V : T[K] : unknown;
-    type ValueCallback<T extends Model, K extends Any<T>> = (this: T, value: Model.ValueOf<T, K>, key: K, thisArg: K) => void;
+    type Actual<R> = R extends Ref<infer T> ? T : R extends Model ? State<R> : R;
+    type Value<T extends Model, K extends Key<T>> = K extends keyof T ? T[K] extends Ref<infer V> ? V : T[K] : unknown;
+    type OnUpdate<T extends Model, K extends Key<T>> = (this: T, value: Value<T, K>, key: K, thisArg: K) => void;
     /**
      * Values from current state of given controller.
      * Differs from `Values` as values here will drill
      * into "real" values held by exotics like ref.
      */
-    type Export<T> = {
-        [P in Key<T>]: Value<T[P]>;
+    type State<T> = {
+        [P in Field<T>]: Actual<T[P]>;
     };
     /** Object comperable to data found in T. */
     type Values<T> = {
-        [P in Key<T>]?: Value<T[P]>;
+        [P in Field<T>]?: Actual<T[P]>;
     };
     /** Exotic value, where actual value is contained within. */
     type Ref<T = any> = {
@@ -44,7 +44,7 @@ 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: Model.Key<M>, thisArg: M, state: Model.Export<M>) => Instruction.Descriptor<T> | Instruction.Getter<T> | void;
+    type Instruction<T = any, M extends Model = any> = (this: M, key: Model.Field<M> & string, thisArg: M, state: Model.State<M>) => Instruction.Descriptor<T> | Instruction.Getter<T> | void;
 }
 interface Model {
     /**
@@ -55,40 +55,44 @@ interface Model {
 }
 declare class Model {
     constructor(id?: string | number);
-    /** Pull current values from state. Flattens all models and exotic values amongst properties. */
-    get(): Model.Export<this>;
+    /** Pull current values from state. Flattens all models and exotic values recursively. */
+    get(): Model.State<this>;
     /** Run a function which will run automatically when accessed values change. */
     get(effect: Model.Effect<this>): () => void;
-    get<T extends string>(key: T, required?: boolean): Model.ValueOf<this, T>;
-    get<T extends string>(key: T, callback: Model.ValueCallback<this, T>): () => void;
+    /** Check if model is expired. */
+    get(event: null): boolean;
+    /** Callback when model is to be destroyed. */
+    get(event: null, callback: () => void): () => void;
+    get<T extends Model.Key<this>>(key: T, required?: boolean): Model.Value<this, T>;
+    get<T extends Model.Key<this>>(key: T, callback: Model.OnUpdate<this, T>): () => void;
     /**
      * Get update in progress.
      *
-     * @returns a promise which resolves object with updated values. Is `undefined` if no update.
+     * @returns Promise which resolves object with updated values. Is `undefined` if there is no update.
      **/
     set(): Promise<Model.Values<this>> | undefined;
     /**
-     * Call a function whenever an update occurs.
+     * Call a function when update occurs.
      *
-     * @param callback
-     *   Note: This will be called for every assignment which changes the value.
-     *   To run logic on final value only, this callback may return a function.
-     *   Returning the same function for one or more will ensure it is only called once.
+     * Given function is called for every assignment (which changes value) or explicit `set`.
+     * To run logic on final value only, callback itself may return a function.
+     * Returning the same function for one or more events will ensure a side-effect is called only when settled.
      *
-     * @returns a function to remove listener. Will return `true` if removed, `false` if inactive already.
+     * @param callback - Function to call when update occurs.
+     * @returns Function to remove listener. Will return `true` if removed, `false` if inactive already.
     */
     set(callback: Model.Event<this>): () => boolean;
     /**
-     * Push an update without changing the value of associated property.
-     *
-     * This is useful where a property value internally has changed, but the object remains the same.
-     * For example: An array which has pushed a new value, or a change to nested property.
+     * Declare an end to updates. This event is final and will freeze state.
      */
-    set(key: string | symbol): void;
+    set(event: null): void;
     /**
-     * Declare an end to updates. This event will freeze state.
+     * Push an update. This will not change the value of associated property.
+     *
+     * Useful where a property value internally has changed, but the object is the same.
+     * For example: An array has pushed a new value, or a nested property is updated.
      */
-    set(key: null): void;
+    set(key: Model.Key<this>): void;
     /**
      * Update a property with value.
      *
@@ -96,13 +100,13 @@ declare class Model {
      * @param value - value to update property with (if the same as current, no update will occur)
      * @param silent - if true, will not notify listeners of an update
      */
-    set<K extends string>(key: K, value?: Model.ValueOf<this, K>, silent?: boolean): void;
+    set<K extends string>(key: K, value?: Model.Value<this, K>, silent?: boolean): void;
     /** Iterate over managed properties in this instance of Model. */
     [Symbol.iterator](): Iterator<[string, unknown]>;
     /**
      * Creates a new instance of this controller.
      *
-     * Beyond `new this(...)`, method will activate managed-state.
+     * **Important** - Use instead of `new this(...)` as this method also activates state.
      *
      * @param args - arguments sent to constructor
      */
@@ -172,10 +176,10 @@ declare namespace ref {
     }
     /** Object with references to all managed values of `T`. */
     type Proxy<T extends Model> = {
-        [P in Model.Key<T>]-?: Model.Ref<T[P]>;
+        [P in Model.Field<T>]-?: Model.Ref<T[P]>;
     };
     type CustomProxy<T extends Model, R> = {
-        [P in Model.Key<T>]-?: R;
+        [P in Model.Field<T>]-?: R;
     };
 }
 /**
@@ -195,7 +199,7 @@ declare function ref<T extends Model>(target: T): ref.Proxy<T>;
  * @param target - Source model from which to reference values.
  * @param mapper - Function producing the placeholder value for any given property.
  */
-declare function ref<O extends Model, R>(target: O, mapper: (key: Model.Key<O>) => R): ref.CustomProxy<O, R>;
+declare function ref<O extends Model, R>(target: O, mapper: (key: Model.Field<O>) => R): ref.CustomProxy<O, R>;
 /**
  * Creates a ref-compatible property.
  * Will persist value, and updates to this are made part of controller event-stream.

package/dist/index.js

@@ -38,13 +38,14 @@ var LISTENER = /* @__PURE__ */ new WeakMap();
 function onReady() {
   return null;
 }
-function addListener(to, fn) {
+function addListener(to, fn, select) {
   let subs = LISTENER.get(to);
   if (!subs)
-    LISTENER.set(to, subs = (/* @__PURE__ */ new Map()).set(onReady, void 0));
-  if (!subs.has(onReady))
+    LISTENER.set(to, subs = (/* @__PURE__ */ new Map()).set(onReady, false));
+  const filter = 2 in arguments && /* @__PURE__ */ new Set([select]);
+  if (!filter && !subs.has(onReady))
     fn(true, to);
-  subs.set(fn, void 0);
+  subs.set(fn, filter);
   return () => subs.delete(fn);
 }
 function watch(from, key, value) {
@@ -148,11 +149,7 @@ var Model = class _Model {
     const state = {};
     define(this, "is", { value: this });
     STATE.set(this, state);
-    ID.set(this, `${Type}-${id ? String(id) : uid()}`);
-    function onNull(key) {
-      if (key === null)
-        Object.freeze(state);
-    }
+    ID.set(this, id ? String(id) : `${Type}-${uid()}`);
     while (true) {
       new Set(NOTIFY.get(Type)).forEach((x) => addListener(this, x));
       if (Type === _Model)
@@ -173,38 +170,49 @@ var Model = class _Model {
           });
         }
       }
-      addListener(this, onNull);
+      addListener(this, () => {
+        for (const [_, value] of this)
+          if (value instanceof _Model && PARENT.get(value) === this)
+            value.set(null);
+        Object.freeze(state);
+      }, null);
       return null;
     });
   }
   get(arg1, arg2) {
     const self = this.is;
-    if (typeof arg1 == "string")
-      if (typeof arg2 == "function") {
-        const state = STATE.get(self);
-        if (arg1 in state)
-          arg2.call(this, state[arg1], arg1, this);
-        return addListener(self, (key) => {
-          if (key === arg1)
-            arg2.call(this, arg1 in state ? state[key] : key, key, this);
-        });
-      } else
-        return fetch(self, arg1, arg2);
-    if (arg1)
+    if (typeof arg1 == "function")
       return effect(self, arg1);
-    const cache = /* @__PURE__ */ new WeakMap();
-    function get2(value) {
-      if (value instanceof _Model) {
-        if (cache.has(value))
-          return cache.get(value);
-        const model = value;
-        cache.set(value, value = {});
-        for (const [key, val] of model)
-          value[key] = get2(val);
-      }
-      return value;
+    if (arg1 === void 0) {
+      let get3 = function(value) {
+        if (value instanceof _Model) {
+          if (cache.has(value))
+            return cache.get(value);
+          const model = value;
+          cache.set(value, value = {});
+          for (const [key, val] of model)
+            value[key] = get3(val);
+        }
+        return value;
+      };
+      var get2 = get3;
+      const cache = /* @__PURE__ */ new WeakMap();
+      return get3(self);
     }
-    return get2(self);
+    if (arg1 === null)
+      if (typeof arg2 == "function")
+        return addListener(self, arg2.bind(this, this), null);
+      else
+        return Object.isFrozen(STATE.get(self));
+    if (typeof arg2 == "function") {
+      const state = STATE.get(self);
+      if (arg1 in state)
+        arg2.call(this, state[arg1], arg1, this);
+      return addListener(self, () => {
+        arg2.call(this, arg1 in state ? state[arg1] : arg1, arg1, this);
+      }, arg1);
+    } else
+      return fetch(self, arg1, arg2);
   }
   set(arg1, arg2, arg3) {
     const self = this.is;
@@ -233,7 +241,7 @@ var Model = class _Model {
   /**
    * Creates a new instance of this controller.
    * 
-   * Beyond `new this(...)`, method will activate managed-state.
+   * **Important** - Use instead of `new this(...)` as this method also activates state.
    * 
    * @param args - arguments sent to constructor
    */
@@ -662,6 +670,8 @@ function attempt(fn) {
 
 // src/instruction/use.ts
 function use(value, argument) {
+  if (typeof value === "function")
+    value = new value();
   return add((property, subject) => {
     function set2(next) {
       if (value instanceof Model && !(next instanceof value.constructor))
@@ -687,8 +697,6 @@ function use(value, argument) {
       if (typeof argument == "function")
         argument(next);
     }
-    if (typeof value === "function")
-      value = new value();
     const output = { set: set2, value };
     set2(value);
     return output;

package/dist/index.mjs

@@ -5,13 +5,14 @@ var LISTENER = /* @__PURE__ */ new WeakMap();
 function onReady() {
   return null;
 }
-function addListener(to, fn) {
+function addListener(to, fn, select) {
   let subs = LISTENER.get(to);
   if (!subs)
-    LISTENER.set(to, subs = (/* @__PURE__ */ new Map()).set(onReady, void 0));
-  if (!subs.has(onReady))
+    LISTENER.set(to, subs = (/* @__PURE__ */ new Map()).set(onReady, false));
+  const filter = 2 in arguments && /* @__PURE__ */ new Set([select]);
+  if (!filter && !subs.has(onReady))
     fn(true, to);
-  subs.set(fn, void 0);
+  subs.set(fn, filter);
   return () => subs.delete(fn);
 }
 function watch(from, key, value) {
@@ -115,11 +116,7 @@ var Model = class _Model {
     const state = {};
     define(this, "is", { value: this });
     STATE.set(this, state);
-    ID.set(this, `${Type}-${id ? String(id) : uid()}`);
-    function onNull(key) {
-      if (key === null)
-        Object.freeze(state);
-    }
+    ID.set(this, id ? String(id) : `${Type}-${uid()}`);
     while (true) {
       new Set(NOTIFY.get(Type)).forEach((x) => addListener(this, x));
       if (Type === _Model)
@@ -140,38 +137,49 @@ var Model = class _Model {
           });
         }
       }
-      addListener(this, onNull);
+      addListener(this, () => {
+        for (const [_, value] of this)
+          if (value instanceof _Model && PARENT.get(value) === this)
+            value.set(null);
+        Object.freeze(state);
+      }, null);
       return null;
     });
   }
   get(arg1, arg2) {
     const self = this.is;
-    if (typeof arg1 == "string")
-      if (typeof arg2 == "function") {
-        const state = STATE.get(self);
-        if (arg1 in state)
-          arg2.call(this, state[arg1], arg1, this);
-        return addListener(self, (key) => {
-          if (key === arg1)
-            arg2.call(this, arg1 in state ? state[key] : key, key, this);
-        });
-      } else
-        return fetch(self, arg1, arg2);
-    if (arg1)
+    if (typeof arg1 == "function")
       return effect(self, arg1);
-    const cache = /* @__PURE__ */ new WeakMap();
-    function get2(value) {
-      if (value instanceof _Model) {
-        if (cache.has(value))
-          return cache.get(value);
-        const model = value;
-        cache.set(value, value = {});
-        for (const [key, val] of model)
-          value[key] = get2(val);
-      }
-      return value;
+    if (arg1 === void 0) {
+      let get3 = function(value) {
+        if (value instanceof _Model) {
+          if (cache.has(value))
+            return cache.get(value);
+          const model = value;
+          cache.set(value, value = {});
+          for (const [key, val] of model)
+            value[key] = get3(val);
+        }
+        return value;
+      };
+      var get2 = get3;
+      const cache = /* @__PURE__ */ new WeakMap();
+      return get3(self);
     }
-    return get2(self);
+    if (arg1 === null)
+      if (typeof arg2 == "function")
+        return addListener(self, arg2.bind(this, this), null);
+      else
+        return Object.isFrozen(STATE.get(self));
+    if (typeof arg2 == "function") {
+      const state = STATE.get(self);
+      if (arg1 in state)
+        arg2.call(this, state[arg1], arg1, this);
+      return addListener(self, () => {
+        arg2.call(this, arg1 in state ? state[arg1] : arg1, arg1, this);
+      }, arg1);
+    } else
+      return fetch(self, arg1, arg2);
   }
   set(arg1, arg2, arg3) {
     const self = this.is;
@@ -200,7 +208,7 @@ var Model = class _Model {
   /**
    * Creates a new instance of this controller.
    * 
-   * Beyond `new this(...)`, method will activate managed-state.
+   * **Important** - Use instead of `new this(...)` as this method also activates state.
    * 
    * @param args - arguments sent to constructor
    */
@@ -629,6 +637,8 @@ function attempt(fn) {
 
 // src/instruction/use.ts
 function use(value, argument) {
+  if (typeof value === "function")
+    value = new value();
   return add((property, subject) => {
     function set2(next) {
       if (value instanceof Model && !(next instanceof value.constructor))
@@ -654,8 +664,6 @@ function use(value, argument) {
       if (typeof argument == "function")
         argument(next);
     }
-    if (typeof value === "function")
-      value = new value();
     const output = { set: set2, value };
     set2(value);
     return output;

package/package.json

@@ -28,6 +28,6 @@
     "prebuild": "rm -rf dist",
     "preversion": "npm run test && npm run build"
   },
-  "version": "0.35.2",
-  "gitHead": "3ea5cde2819a66601be642a9befd8e4477caa0b8"
+  "version": "0.35.5-alpha.0",
+  "gitHead": "9626c3d85bd2fa7a8e5368c845ff8d889843be0b"
 }