@expressive/mvc 0.29.2 → 0.31.0

package/lib/index.d.ts

@@ -58,18 +58,20 @@ declare global {
   }
 }
 
-type OnValue<T, P extends Model.Key<T>> = (this: T, value: T[P], updated: Model.Event<T>[]) => void;
-type OnValues<T, P extends Model.Key<T>> = (this: T, value: Model.Export<T, P>, updated: Model.Event<T>[]) => void;
+type SelectOne<T, K extends Model.Key<T>> = K;
+type SelectFew<T, K extends Model.Key<T>> = K[];
+type Select<T, K extends Model.Key<T> = Model.Key<T>> = K | K[];
+type Export<T, S> = S extends SelectOne<T, infer P> ? T[P] : S extends SelectFew<T, infer P> ? Model.Export<T, P> : never;
+type OnUpdate<T, S> = (this: T, value: Export<T, S>, updated: Model.Event<T>[]) => void;
 interface Observable {
     get(): Model.Export<this>;
+    get<P extends Select<this>>(select: P): Export<this, P>;
+    get<P extends Select<this>>(select: P, onUpdate: OnUpdate<this, P>, once?: true): Callback;
+    get<P extends Select<this>>(select: P, onUpdate: OnUpdate<this, P>, initial?: false): Callback;
     get(effect: Model.Effect<this>): Callback;
-    get<P extends Model.Key<this>>(select: P): this[P];
-    get<P extends Model.Key<this>>(select: P, onUpdate: OnValue<this, P>, once?: boolean): Callback;
-    get<P extends Model.Key<this>>(select: P[]): Model.Export<this, P>;
-    get<P extends Model.Key<this>>(select: P[], onUpdate: OnValues<this, P>, once?: boolean): Callback;
     set(): Promise<Model.Event<this>[]>;
     set(timeout: number): Promise<Model.Event<this>[] | false>;
-    set<T extends Model.Values<this>>(source: T, only?: (keyof T)[]): Promise<Model.Event<T>[] | false>;
+    set<T extends Model.Values<this>>(from: T, only?: (keyof T)[]): Promise<Model.Event<T>[] | false>;
     set<K extends Model.Key<this>>(key: K, value: Model.Value<this[K]>): Promise<Model.Event<this>[] | false>;
     set<K extends Model.Event<this>>(key: K): Promise<Model.Event<this>[] | false>;
 }
@@ -82,34 +84,23 @@ declare namespace Model {
     type Type<T extends Model = Model> = abstract new (...args: any[]) => T;
     /** A typeof Model, specifically one which can be created without any arguments. */
     type New<T extends Model = Model> = (new () => T) & typeof Model;
-    type Effect<T> = (this: T, argument: T) => Callback | Promise<any> | void;
-    /** Exotic value, actual value is contained. */
-    type Ref<T = any> = {
-        (next: T): void;
-        current: T | null;
-    };
-    /**
-     * Subset of `keyof T` which are not methods or defined by base Model U.
-     **/
-    type Key<T, U = Model> = Extract<Exclude<keyof T, keyof U>, string>;
+    /** A callback function which is subscribed to parent and updates when values change. */
+    type Effect<T> = (this: T, argument: T) => Callback | Promise<void> | void;
+    /** Subset of `keyof T` which are not methods or defined by base Model U. **/
+    type Key<T, U = Observable> = Extract<Exclude<keyof T, keyof U>, string>;
     /** Including but not limited to `keyof T` which are not methods or defined by base Model. */
     type Event<T> = Key<T> | (string & {});
-    /** Actual value stored in state. */
-    type Value<R> = R extends Ref<infer T> ? T : R extends Observable ? Export<R> : R;
     /** Object comperable to data found in T. */
     type Values<T> = {
         [P in Key<T>]?: Value<T[P]>;
     };
     /**
      * Values from current state of given controller.
-     *
-     * Differs from `Entries` as values here will drill into "real" values held by exotics like ref.
+     * Differs from `Values` as values here will drill into "real" values held by exotics like ref.
      */
     type Export<T, K extends Key<T> = Key<T>> = {
         [P in K]: Value<T[P]>;
     };
-    /** Promise thrown by something which is not yet ready. */
-    type Suspense = Promise<void> & Error;
     /**
      * Reference to `this` without a subscription.
      * Use to obtain full reference from a destructure.
@@ -117,6 +108,13 @@ declare namespace Model {
     type Focus<T> = T & {
         is: T;
     };
+    /** Exotic value, actual value is contained. */
+    type Ref<T = any> = {
+        (next: T): void;
+        current: T | null;
+    };
+    /** Actual value stored in state. */
+    type Value<R> = R extends Ref<infer T> ? T : R extends Observable ? Export<R> : R;
 }
 interface Model extends Observable {
 }
@@ -344,9 +342,9 @@ declare class Control<T extends {} = any> {
     static use: Control.UseHook;
     static has: Control.GetContext;
     static for: typeof control;
-    static apply: typeof apply;
+    static does: typeof does;
     static watch: typeof watch;
-    id?: string | number;
+    id: string | number | false;
     subject: T;
     state: {
         [key: string]: any;
@@ -355,8 +353,8 @@ declare class Control<T extends {} = any> {
     frame: Set<string>;
     followers: Set<Observer<any>>;
     observers: Map<string, Set<Observer<any>>>;
-    constructor(subject: T, id?: string | number | false);
-    add(key: Extract<keyof T, string>): void;
+    constructor(subject: T, id: string | number | false);
+    add(key: string): void;
     watch(key: string, output: Control.PropertyDescriptor<any>): void;
     ref<K extends Model.Key<T>>(key: K, callback?: (this: T, value: T[K]) => boolean | void): (value: any) => void;
     update(key: string): void;
@@ -369,7 +367,7 @@ type Focus<T extends {}> = T & {
     is: T;
 };
 declare function watch<T extends {}>(value: T, cb: Observer): Focus<T>;
-declare function apply<T = any>(instruction: Control.Instruction<T>): T;
+declare function does<T = any>(instruction: Control.Instruction<T>): T;
 
 declare const STATE = "__state";
 declare const UPDATE = "__update";

package/lib/index.esm.js

@@ -292,6 +292,7 @@ function getMethod(argument, callback, once) {
     if (typeof callback != "function")
         return extract();
     const select = typeof argument == "string" ? [argument] : argument;
+    const invoke = () => callback(extract(), self.latest || []);
     if (select)
         for (const key of select)
             try {
@@ -302,11 +303,13 @@ function getMethod(argument, callback, once) {
             catch (e) {
                 // TODO: should this be caught?
             }
+    if (once === undefined)
+        invoke();
     const remove = self.addListener(key => {
         if (!select || select.includes(key)) {
             if (once)
                 remove();
-            return () => callback(extract(), self.latest);
+            return invoke;
         }
     });
     return remove;
@@ -351,7 +354,7 @@ function setMethod(arg1, arg2) {
 
 class Model {
     constructor(id) {
-        new Control(this, id);
+        new Control(this, id === undefined ? uid() : id);
     }
     /** Mark this instance for garbage collection. */
     null() {
@@ -416,7 +419,11 @@ defineProperties(Model.prototype, {
             throw new Error("Model.on() is deprecated. Use Model.get or Model.set instead.");
         }
     }
-});
+});
+/** Random alphanumberic of length 6. Will always start with a letter. */
+function uid() {
+    return (Math.random() * 0.722 + 0.278).toString(36).substring(2, 8).toUpperCase();
+}
 
 const Oops$4 = issues({
     BadAssignment: (parent, expected, got) => `${parent} expected Model of type ${expected} but got ${got}.`,
@@ -432,12 +439,11 @@ class Control {
         this.frame = new Set();
         this.followers = new Set();
         this.observers = new Map([["", this.followers]]);
+        this.id = id;
         this.subject = subject;
         REGISTER.set(subject, this);
-        if (id !== false) {
-            this.id = id === undefined ? uid() : id;
+        if (id !== false)
             PENDING$1.set(this, new Set(Control.ready));
-        }
     }
     add(key) {
         const { value } = getOwnPropertyDescriptor(this.subject, key);
@@ -534,7 +540,7 @@ Control.after = new Set();
 Control.before = new Set();
 Control.pending = new Set();
 Control.for = control;
-Control.apply = apply;
+Control.does = does;
 Control.watch = watch;
 function control(subject, ready) {
     const control = REGISTER.get(subject);
@@ -599,7 +605,7 @@ function watch(value, cb) {
     OBSERVER.set(value, cb);
     return value;
 }
-function apply(instruction) {
+function does(instruction) {
     const placeholder = Symbol("instruction");
     INSTRUCT.set(placeholder, (onto, key) => {
         delete onto.subject[key];
@@ -608,17 +614,13 @@ function apply(instruction) {
             onto.watch(key, typeof output == "function" ? { get: output } : output);
     });
     return placeholder;
-}
-/** Random alphanumberic of length 6; will always start with a letter. */
-function uid() {
-    return (Math.random() * 0.722 + 0.278).toString(36).substring(2, 8).toUpperCase();
 }
 
 const Oops$3 = issues({
     DuplicatePending: (key) => `Invoked action ${key} but one is already active.`
 });
 function run(task) {
-    return apply((key, control) => {
+    return does((key, control) => {
         let pending = false;
         const invoke = (...args) => __awaiter(this, void 0, void 0, function* () {
             if (pending)
@@ -652,7 +654,7 @@ const Oops$2 = issues({
     AmbientRequired: (requested, requester) => `Attempted to find an instance of ${requested} in context. It is required by ${requester}, but one could not be found.`
 });
 function get(arg0, arg1) {
-    return apply((key, control) => {
+    return does((key, control) => {
         let { subject } = control;
         if (typeof arg0 == "symbol")
             throw Oops$2.PeerNotAllowed(subject, key);
@@ -778,7 +780,7 @@ function flushComputed() {
 Control.before.add(flushComputed);
 
 function ref(arg, arg2) {
-    return apply((key, source) => {
+    return does((key, source) => {
         let value = {};
         if (typeof arg == "object")
             for (const key in control(arg, true).state)
@@ -813,7 +815,7 @@ const Oops$1 = issues({
     NotReady: (model, key) => `Value ${model}.${key} value is not yet available.`
 });
 function set(value, argument) {
-    return apply((key, control) => {
+    return does((key, control) => {
         const { state, subject } = control;
         if (typeof value == "function" || value instanceof Promise) {
             const output = {};
@@ -883,7 +885,7 @@ function set(value, argument) {
 }
 
 function use(input, argument) {
-    return apply((key, source) => {
+    return does((key, source) => {
         const { state, subject } = source;
         if (typeof input === "function")
             input = new input();

package/lib/index.js

@@ -296,6 +296,7 @@ function getMethod(argument, callback, once) {
     if (typeof callback != "function")
         return extract();
     const select = typeof argument == "string" ? [argument] : argument;
+    const invoke = () => callback(extract(), self.latest || []);
     if (select)
         for (const key of select)
             try {
@@ -306,11 +307,13 @@ function getMethod(argument, callback, once) {
             catch (e) {
                 // TODO: should this be caught?
             }
+    if (once === undefined)
+        invoke();
     const remove = self.addListener(key => {
         if (!select || select.includes(key)) {
             if (once)
                 remove();
-            return () => callback(extract(), self.latest);
+            return invoke;
         }
     });
     return remove;
@@ -355,7 +358,7 @@ function setMethod(arg1, arg2) {
 
 class Model {
     constructor(id) {
-        new Control(this, id);
+        new Control(this, id === undefined ? uid() : id);
     }
     /** Mark this instance for garbage collection. */
     null() {
@@ -420,7 +423,11 @@ defineProperties(Model.prototype, {
             throw new Error("Model.on() is deprecated. Use Model.get or Model.set instead.");
         }
     }
-});
+});
+/** Random alphanumberic of length 6. Will always start with a letter. */
+function uid() {
+    return (Math.random() * 0.722 + 0.278).toString(36).substring(2, 8).toUpperCase();
+}
 
 const Oops$4 = issues({
     BadAssignment: (parent, expected, got) => `${parent} expected Model of type ${expected} but got ${got}.`,
@@ -436,12 +443,11 @@ class Control {
         this.frame = new Set();
         this.followers = new Set();
         this.observers = new Map([["", this.followers]]);
+        this.id = id;
         this.subject = subject;
         REGISTER.set(subject, this);
-        if (id !== false) {
-            this.id = id === undefined ? uid() : id;
+        if (id !== false)
             PENDING$1.set(this, new Set(Control.ready));
-        }
     }
     add(key) {
         const { value } = getOwnPropertyDescriptor(this.subject, key);
@@ -538,7 +544,7 @@ Control.after = new Set();
 Control.before = new Set();
 Control.pending = new Set();
 Control.for = control;
-Control.apply = apply;
+Control.does = does;
 Control.watch = watch;
 function control(subject, ready) {
     const control = REGISTER.get(subject);
@@ -603,7 +609,7 @@ function watch(value, cb) {
     OBSERVER.set(value, cb);
     return value;
 }
-function apply(instruction) {
+function does(instruction) {
     const placeholder = Symbol("instruction");
     INSTRUCT.set(placeholder, (onto, key) => {
         delete onto.subject[key];
@@ -612,17 +618,13 @@ function apply(instruction) {
             onto.watch(key, typeof output == "function" ? { get: output } : output);
     });
     return placeholder;
-}
-/** Random alphanumberic of length 6; will always start with a letter. */
-function uid() {
-    return (Math.random() * 0.722 + 0.278).toString(36).substring(2, 8).toUpperCase();
 }
 
 const Oops$3 = issues({
     DuplicatePending: (key) => `Invoked action ${key} but one is already active.`
 });
 function run(task) {
-    return apply((key, control) => {
+    return does((key, control) => {
         let pending = false;
         const invoke = (...args) => __awaiter(this, void 0, void 0, function* () {
             if (pending)
@@ -656,7 +658,7 @@ const Oops$2 = issues({
     AmbientRequired: (requested, requester) => `Attempted to find an instance of ${requested} in context. It is required by ${requester}, but one could not be found.`
 });
 function get(arg0, arg1) {
-    return apply((key, control) => {
+    return does((key, control) => {
         let { subject } = control;
         if (typeof arg0 == "symbol")
             throw Oops$2.PeerNotAllowed(subject, key);
@@ -782,7 +784,7 @@ function flushComputed() {
 Control.before.add(flushComputed);
 
 function ref(arg, arg2) {
-    return apply((key, source) => {
+    return does((key, source) => {
         let value = {};
         if (typeof arg == "object")
             for (const key in control(arg, true).state)
@@ -817,7 +819,7 @@ const Oops$1 = issues({
     NotReady: (model, key) => `Value ${model}.${key} value is not yet available.`
 });
 function set(value, argument) {
-    return apply((key, control) => {
+    return does((key, control) => {
         const { state, subject } = control;
         if (typeof value == "function" || value instanceof Promise) {
             const output = {};
@@ -887,7 +889,7 @@ function set(value, argument) {
 }
 
 function use(input, argument) {
-    return apply((key, source) => {
+    return does((key, source) => {
         const { state, subject } = source;
         if (typeof input === "function")
             input = new input();

package/package.json

@@ -26,6 +26,6 @@
     "prebuild": "rm -rf lib/",
     "preversion": "npm run test && npm run build"
   },
-  "version": "0.29.2",
-  "gitHead": "a10efcc0deba6e634d9b194ceda506573e981719"
+  "version": "0.31.0",
+  "gitHead": "63fd9a26371cb53d00ff2e3f5f2673660c6213de"
 }