@expressive/mvc 0.35.5-alpha.0 → 0.35.6

package/dist/index.d.ts

@@ -6,21 +6,21 @@ declare namespace Model {
     /** Subset of `keyof T` which are not methods or defined by base Model U. **/
     type Field<T> = Exclude<keyof T, keyof Model>;
     type Key<T> = Field<T> | (string & {}) | number | symbol;
-    /** Actual value stored in state. */
-    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;
+    /** Export/Import compatible value for a given property in a Model. */
+    type Export<R> = R extends Ref<infer T> ? T : R extends Model ? State<R> : R;
     /**
      * Values from current state of given controller.
      * Differs from `Values` as values here will drill
      * into "real" values held by exotics like ref.
      */
     type State<T> = {
-        [P in Field<T>]: Actual<T[P]>;
+        [P in Field<T>]: Export<T[P]>;
     };
     /** Object comperable to data found in T. */
     type Values<T> = {
-        [P in Field<T>]?: Actual<T[P]>;
+        [P in Field<T>]?: Export<T[P]>;
     };
     /** Exotic value, where actual value is contained within. */
     type Ref<T = any> = {
@@ -28,7 +28,7 @@ declare namespace Model {
         current: T | null;
     };
     /** A callback function which is subscribed to parent and updates when values change. */
-    type Effect<T> = (this: T, argument: T) => (() => void) | Promise<void> | null | void;
+    type Effect<T> = (this: T, argument: T) => ((update: boolean | null) => void) | Promise<void> | null | void;
     type Event<T extends Model> = (this: T, key: unknown, source: T) => (() => void) | void | null;
     namespace Instruction {
         type Getter<T> = (source: Model) => T;
@@ -59,18 +59,18 @@ declare class Model {
     get(): Model.State<this>;
     /** Run a function which will run automatically when accessed values change. */
     get(effect: Model.Effect<this>): () => 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;
+    /** Check if model is expired. */
+    get(status: null): boolean;
+    /** Callback when model is to be destroyed. */
+    get(status: null, callback: () => void): () => void;
     /**
      * Get update in progress.
      *
      * @returns Promise which resolves object with updated values. Is `undefined` if there is no update.
      **/
-    set(): Promise<Model.Values<this>> | undefined;
+    set(): PromiseLike<Model.Key<this>[]> | undefined;
     /**
      * Call a function when update occurs.
      *
@@ -84,15 +84,21 @@ declare class Model {
     set(callback: Model.Event<this>): () => boolean;
     /**
      * Declare an end to updates. This event is final and will freeze state.
+     * This event can be watched for as well, to run cleanup logic and internally will remove all listeners.
      */
-    set(event: null): void;
+    set(status: null): void;
     /**
      * 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.
+     *
+     * You can also use this to dispatch arbitrary events as well. Symbols are generally
+     * recommended as non-property events, however you can use any string. If doing so,
+     * be sure to avoid collisions with property names - an easy way to do this will be to
+     * prefix your event with "!" and/or use dash-case. e.g. `set("!event")` or `set("my-event")`.
      */
-    set(key: Model.Key<this>): void;
+    set(key: Model.Key<this>): PromiseLike<Model.Key<this>[]>;
     /**
      * Update a property with value.
      *
@@ -100,7 +106,7 @@ 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.Value<this, K>, silent?: boolean): void;
+    set<K extends string>(key: K, value?: Model.Value<this, K>, silent?: boolean): PromiseLike<Model.Key<this>[]> | undefined;
     /** Iterate over managed properties in this instance of Model. */
     [Symbol.iterator](): Iterator<[string, unknown]>;
     /**
@@ -276,21 +282,19 @@ declare function use<T extends Model>(model: T, ready?: (i: T) => void): T;
 declare function use<T extends {}, O = use.Object<T>>(data: T, ready?: (object: O) => void): O;
 
 declare namespace Context {
-    type Inputs = {
-        [key: string | number]: Model | Model.New;
-    };
+    type Input = Model | Model.New<Model> | Record<string | number, Model | Model.New<Model>>;
 }
 declare class Context {
-    static resolve(from: Model, callback: (context: Context) => void): void;
-    constructor(inputs?: Context.Inputs);
+    static get(from: Model, callback: (context: Context) => void): void;
     key: string;
-    private table;
-    private layer;
-    private has;
+    protected table: WeakMap<Model.Type<Model>, symbol>;
+    protected layer: Map<string | number, Model | Model.Type<Model>>;
+    constructor(inputs?: Context.Input);
+    protected has(T: Model.Type): keyof this;
     get<T extends Model>(Type: Model.Type<T>): T | undefined;
-    include(inputs: Context.Inputs): Map<Model, boolean>;
+    include(inputs: Context.Input): Map<Model, boolean>;
     protected add<T extends Model>(input: T | Model.New<T>, implicit?: boolean): T;
-    push(): this;
+    push(inputs?: Context.Input): this;
     pop(): void;
 }
 

package/dist/index.js

@@ -102,7 +102,7 @@ function effect(target, callback) {
         return null;
       expired = true;
       if (refresh && unSet) {
-        unSet();
+        unSet(true);
         unSet = void 0;
       }
       return refresh;
@@ -129,9 +129,11 @@ function effect(target, callback) {
     else if (!refresh)
       return refresh;
     if (key === null && unSet)
-      unSet();
+      unSet(null);
   });
   return () => {
+    if (unSet)
+      unSet(false);
     refresh = null;
   };
 }
@@ -156,16 +158,19 @@ var Model = class _Model {
         break;
       Type = Object.getPrototypeOf(Type);
     }
-    addListener(this, () => {
-      for (const key in this) {
-        const desc = Object.getOwnPropertyDescriptor(this, key);
+    const remove = addListener(this, (key) => {
+      remove();
+      if (key !== true)
+        event(this, true);
+      for (const key2 in this) {
+        const desc = Object.getOwnPropertyDescriptor(this, key2);
         if ("value" in desc) {
-          state[key] = desc.value;
-          define(this, key, {
+          state[key2] = desc.value;
+          define(this, key2, {
             enumerable: true,
-            set: (x) => update(this, key, x),
+            set: (x) => update(this, key2, x),
             get() {
-              return watch(this, key, state[key]);
+              return watch(this, key2, state[key2]);
             }
           });
         }
@@ -176,43 +181,25 @@ var Model = class _Model {
             value.set(null);
         Object.freeze(state);
       }, null);
-      return null;
     });
   }
   get(arg1, arg2) {
     const self = this.is;
     if (typeof arg1 == "function")
       return effect(self, arg1);
-    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);
-    }
-    if (arg1 === null)
-      if (typeof arg2 == "function")
-        return addListener(self, arg2.bind(this, this), null);
-      else
-        return Object.isFrozen(STATE.get(self));
+    if (arg1 === void 0)
+      return extract(self);
     if (typeof arg2 == "function") {
+      if (arg1 === null)
+        return addListener(self, arg2.bind(this, this), null);
       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);
+    }
+    return arg1 === null ? Object.isFrozen(STATE.get(self)) : fetch(self, arg1, arg2);
   }
   set(arg1, arg2, arg3) {
     const self = this.is;
@@ -221,18 +208,24 @@ var Model = class _Model {
         if (typeof key == "string")
           return arg1.call(self, key, self);
       });
+    if (arg1 === null)
+      return event(this, null);
     if (arg1 !== void 0)
-      return 1 in arguments ? update(self, arg1, arg2, arg3) : update(self, arg1);
-    if (!PENDING.has(self))
-      return;
-    return new Promise((resolve) => {
-      const remove = addListener(this, (key) => {
-        if (key !== true) {
-          remove();
-          return resolve.bind(null, PENDING.get(self));
-        }
-      });
-    });
+      if (1 in arguments)
+        update(self, arg1, arg2, arg3);
+      else
+        push(self, arg1);
+    if (PENDING.has(self))
+      return {
+        then: (res) => new Promise((res2) => {
+          const remove = addListener(self, (key) => {
+            if (key !== true) {
+              remove();
+              return res2.bind(null, Array.from(PENDING.get(self)));
+            }
+          });
+        }).then(res)
+      };
   }
   /** Iterate over managed properties in this instance of Model. */
   [Symbol.iterator]() {
@@ -285,14 +278,14 @@ function fetch(subject, property, required) {
       return value;
   }
   const error = new Error(`${subject}.${property} is not yet available.`);
-  const promise = new Promise((resolve, reject) => {
+  const promise = new Promise((resolve, reject2) => {
     addListener(subject, (key) => {
       if (key === property) {
         resolve(state[key]);
         return null;
       }
       if (key === null)
-        reject(new Error(`${subject} is destroyed.`));
+        reject2(new Error(`${subject} is destroyed.`));
     });
   });
   throw Object.assign(promise, {
@@ -304,26 +297,42 @@ function fetch(subject, property, required) {
 }
 function update(subject, key, value, silent) {
   const state = STATE.get(subject);
+  if (Object.isFrozen(state))
+    throw new Error(`Tried to update ${String(key)} but ${subject} is destroyed.`);
+  const previous = state[key];
+  if (value === previous)
+    return true;
+  state[key] = value;
+  if (silent === true)
+    return;
+  push(subject, key);
+}
+function push(subject, key) {
   let pending = PENDING.get(subject);
-  if (typeof key == "string" && 2 in arguments) {
-    const previous = state[key];
-    if (value === previous)
-      return true;
-    state[key] = value;
-    if (silent === true)
-      return;
+  if (!pending) {
+    PENDING.set(subject, pending = /* @__PURE__ */ new Set());
+    queue(() => {
+      event(subject, false);
+      PENDING.delete(subject);
+    });
   }
-  if (key !== true && key) {
-    if (!pending) {
-      PENDING.set(subject, pending = {});
-      queue(() => {
-        event(subject, false);
-        PENDING.delete(subject);
-      });
+  pending.add(key);
+  event(subject, key);
+}
+function extract(from) {
+  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);
     }
-    pending[key] = key in state ? value : true;
+    return value;
   }
-  event(subject, key);
+  return get2(from);
 }
 function uid() {
   return (Math.random() * 0.722 + 0.278).toString(36).substring(2, 8).toUpperCase();
@@ -388,7 +397,7 @@ var Context = class {
     if (inputs)
       this.include(inputs);
   }
-  static resolve(from, callback) {
+  static get() {
     throw new Error(`Using context requires an adapter. If you are only testing, define \`get.context\` to simulate one.`);
   }
   has(T) {
@@ -407,6 +416,14 @@ var Context = class {
   }
   include(inputs) {
     const init = /* @__PURE__ */ new Map();
+    if (typeof inputs == "function" || inputs instanceof Model)
+      inputs = { [0]: inputs };
+    else if (!inputs)
+      reject(inputs);
+    Object.entries(inputs).forEach(([K, V]) => {
+      if (!(Model.is(V) || V instanceof Model))
+        reject(`${V} as ${K}`);
+    });
     for (const key in inputs) {
       const input = inputs[key];
       const exists = this.layer.get(key);
@@ -453,9 +470,11 @@ var Context = class {
     } while (T !== Model);
     return I;
   }
-  push() {
+  push(inputs) {
     const next = Object.create(this);
     next.layer = /* @__PURE__ */ new Map();
+    if (inputs)
+      next.include(inputs);
     return next;
   }
   pop() {
@@ -471,6 +490,9 @@ var Context = class {
     this.layer.clear();
   }
 };
+function reject(argument) {
+  throw new Error(`Context can only include Model or instance but got ${argument}.`);
+}
 
 // src/instruction/get.ts
 function get(arg0, arg1) {
@@ -487,7 +509,7 @@ function get(arg0, arg1) {
         if (arg1 === true)
           throw new Error(`${from} may only exist as a child of type ${arg0}.`);
         source = (resolve) => {
-          Context.resolve(from, (context) => {
+          Context.get(from, (context) => {
             const model = context.get(arg0);
             if (model)
               resolve(model);
@@ -519,9 +541,11 @@ function compute(subject, key, source, setter) {
         compute2(true);
       else if (STALE.delete(compute2))
         compute2();
-      return () => {
-        STALE.add(compute2);
-        subject.set(key);
+      return (reason) => {
+        if (reason) {
+          STALE.add(compute2);
+          subject.set(key);
+        }
       };
     });
   }
@@ -576,7 +600,7 @@ function ref(arg, arg2) {
     else {
       let unSet;
       const set2 = (value2) => {
-        if (subject.set(key, value2) || !arg)
+        if (!subject.set(key, value2) || !arg)
           return;
         if (unSet)
           unSet = void unSet(value2);

package/dist/index.mjs

@@ -69,7 +69,7 @@ function effect(target, callback) {
         return null;
       expired = true;
       if (refresh && unSet) {
-        unSet();
+        unSet(true);
         unSet = void 0;
       }
       return refresh;
@@ -96,9 +96,11 @@ function effect(target, callback) {
     else if (!refresh)
       return refresh;
     if (key === null && unSet)
-      unSet();
+      unSet(null);
   });
   return () => {
+    if (unSet)
+      unSet(false);
     refresh = null;
   };
 }
@@ -123,16 +125,19 @@ var Model = class _Model {
         break;
       Type = Object.getPrototypeOf(Type);
     }
-    addListener(this, () => {
-      for (const key in this) {
-        const desc = Object.getOwnPropertyDescriptor(this, key);
+    const remove = addListener(this, (key) => {
+      remove();
+      if (key !== true)
+        event(this, true);
+      for (const key2 in this) {
+        const desc = Object.getOwnPropertyDescriptor(this, key2);
         if ("value" in desc) {
-          state[key] = desc.value;
-          define(this, key, {
+          state[key2] = desc.value;
+          define(this, key2, {
             enumerable: true,
-            set: (x) => update(this, key, x),
+            set: (x) => update(this, key2, x),
             get() {
-              return watch(this, key, state[key]);
+              return watch(this, key2, state[key2]);
             }
           });
         }
@@ -143,43 +148,25 @@ var Model = class _Model {
             value.set(null);
         Object.freeze(state);
       }, null);
-      return null;
     });
   }
   get(arg1, arg2) {
     const self = this.is;
     if (typeof arg1 == "function")
       return effect(self, arg1);
-    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);
-    }
-    if (arg1 === null)
-      if (typeof arg2 == "function")
-        return addListener(self, arg2.bind(this, this), null);
-      else
-        return Object.isFrozen(STATE.get(self));
+    if (arg1 === void 0)
+      return extract(self);
     if (typeof arg2 == "function") {
+      if (arg1 === null)
+        return addListener(self, arg2.bind(this, this), null);
       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);
+    }
+    return arg1 === null ? Object.isFrozen(STATE.get(self)) : fetch(self, arg1, arg2);
   }
   set(arg1, arg2, arg3) {
     const self = this.is;
@@ -188,18 +175,24 @@ var Model = class _Model {
         if (typeof key == "string")
           return arg1.call(self, key, self);
       });
+    if (arg1 === null)
+      return event(this, null);
     if (arg1 !== void 0)
-      return 1 in arguments ? update(self, arg1, arg2, arg3) : update(self, arg1);
-    if (!PENDING.has(self))
-      return;
-    return new Promise((resolve) => {
-      const remove = addListener(this, (key) => {
-        if (key !== true) {
-          remove();
-          return resolve.bind(null, PENDING.get(self));
-        }
-      });
-    });
+      if (1 in arguments)
+        update(self, arg1, arg2, arg3);
+      else
+        push(self, arg1);
+    if (PENDING.has(self))
+      return {
+        then: (res) => new Promise((res2) => {
+          const remove = addListener(self, (key) => {
+            if (key !== true) {
+              remove();
+              return res2.bind(null, Array.from(PENDING.get(self)));
+            }
+          });
+        }).then(res)
+      };
   }
   /** Iterate over managed properties in this instance of Model. */
   [Symbol.iterator]() {
@@ -252,14 +245,14 @@ function fetch(subject, property, required) {
       return value;
   }
   const error = new Error(`${subject}.${property} is not yet available.`);
-  const promise = new Promise((resolve, reject) => {
+  const promise = new Promise((resolve, reject2) => {
     addListener(subject, (key) => {
       if (key === property) {
         resolve(state[key]);
         return null;
       }
       if (key === null)
-        reject(new Error(`${subject} is destroyed.`));
+        reject2(new Error(`${subject} is destroyed.`));
     });
   });
   throw Object.assign(promise, {
@@ -271,26 +264,42 @@ function fetch(subject, property, required) {
 }
 function update(subject, key, value, silent) {
   const state = STATE.get(subject);
+  if (Object.isFrozen(state))
+    throw new Error(`Tried to update ${String(key)} but ${subject} is destroyed.`);
+  const previous = state[key];
+  if (value === previous)
+    return true;
+  state[key] = value;
+  if (silent === true)
+    return;
+  push(subject, key);
+}
+function push(subject, key) {
   let pending = PENDING.get(subject);
-  if (typeof key == "string" && 2 in arguments) {
-    const previous = state[key];
-    if (value === previous)
-      return true;
-    state[key] = value;
-    if (silent === true)
-      return;
+  if (!pending) {
+    PENDING.set(subject, pending = /* @__PURE__ */ new Set());
+    queue(() => {
+      event(subject, false);
+      PENDING.delete(subject);
+    });
   }
-  if (key !== true && key) {
-    if (!pending) {
-      PENDING.set(subject, pending = {});
-      queue(() => {
-        event(subject, false);
-        PENDING.delete(subject);
-      });
+  pending.add(key);
+  event(subject, key);
+}
+function extract(from) {
+  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);
     }
-    pending[key] = key in state ? value : true;
+    return value;
   }
-  event(subject, key);
+  return get2(from);
 }
 function uid() {
   return (Math.random() * 0.722 + 0.278).toString(36).substring(2, 8).toUpperCase();
@@ -355,7 +364,7 @@ var Context = class {
     if (inputs)
       this.include(inputs);
   }
-  static resolve(from, callback) {
+  static get() {
     throw new Error(`Using context requires an adapter. If you are only testing, define \`get.context\` to simulate one.`);
   }
   has(T) {
@@ -374,6 +383,14 @@ var Context = class {
   }
   include(inputs) {
     const init = /* @__PURE__ */ new Map();
+    if (typeof inputs == "function" || inputs instanceof Model)
+      inputs = { [0]: inputs };
+    else if (!inputs)
+      reject(inputs);
+    Object.entries(inputs).forEach(([K, V]) => {
+      if (!(Model.is(V) || V instanceof Model))
+        reject(`${V} as ${K}`);
+    });
     for (const key in inputs) {
       const input = inputs[key];
       const exists = this.layer.get(key);
@@ -420,9 +437,11 @@ var Context = class {
     } while (T !== Model);
     return I;
   }
-  push() {
+  push(inputs) {
     const next = Object.create(this);
     next.layer = /* @__PURE__ */ new Map();
+    if (inputs)
+      next.include(inputs);
     return next;
   }
   pop() {
@@ -438,6 +457,9 @@ var Context = class {
     this.layer.clear();
   }
 };
+function reject(argument) {
+  throw new Error(`Context can only include Model or instance but got ${argument}.`);
+}
 
 // src/instruction/get.ts
 function get(arg0, arg1) {
@@ -454,7 +476,7 @@ function get(arg0, arg1) {
         if (arg1 === true)
           throw new Error(`${from} may only exist as a child of type ${arg0}.`);
         source = (resolve) => {
-          Context.resolve(from, (context) => {
+          Context.get(from, (context) => {
             const model = context.get(arg0);
             if (model)
               resolve(model);
@@ -486,9 +508,11 @@ function compute(subject, key, source, setter) {
         compute2(true);
       else if (STALE.delete(compute2))
         compute2();
-      return () => {
-        STALE.add(compute2);
-        subject.set(key);
+      return (reason) => {
+        if (reason) {
+          STALE.add(compute2);
+          subject.set(key);
+        }
       };
     });
   }
@@ -543,7 +567,7 @@ function ref(arg, arg2) {
     else {
       let unSet;
       const set2 = (value2) => {
-        if (subject.set(key, value2) || !arg)
+        if (!subject.set(key, value2) || !arg)
           return;
         if (unSet)
           unSet = void unSet(value2);

package/package.json

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