cx 25.10.1 → 26.0.1

package/src/data/StructuredSelector.spec.ts

@@ -0,0 +1,113 @@
+import { StructuredSelector } from "./StructuredSelector";
+import assert from "assert";
+import { createAccessorModelProxy } from "./createAccessorModelProxy";
+
+describe("StructuredSelector", function () {
+   describe("#create()", function () {
+      it("constants", function () {
+         var x = {};
+         var s = new StructuredSelector({
+            props: {
+               a: undefined,
+               b: undefined,
+            },
+            values: {
+               a: 1,
+               b: 2,
+            },
+         }).create();
+
+         assert.deepEqual(s(x), { a: 1, b: 2 });
+      });
+
+      it("bindings", function () {
+         var x = { a: 1, b: 2 };
+         var s = new StructuredSelector({
+            props: {
+               a: undefined,
+               b: undefined,
+            },
+            values: {
+               a: { bind: "b" },
+               b: { bind: "a" },
+            },
+         }).create();
+
+         assert.deepEqual(s(x), { a: 2, b: 1 });
+      });
+
+      it("templates", function () {
+         var x = { a: 1, b: 2 };
+         var s = new StructuredSelector({
+            props: {
+               a: undefined,
+               b: undefined,
+            },
+            values: {
+               a: { tpl: "b{a}" },
+               b: { tpl: "a{b}" },
+            },
+         }).create();
+
+         assert.deepEqual(s(x), { a: "b1", b: "a2" });
+      });
+
+      it("structured", function () {
+         var x = { a: 1, b: 2 };
+         var s = new StructuredSelector({
+            props: {
+               a: {
+                  structured: true,
+               },
+               b: undefined,
+            },
+            values: {
+               a: {
+                  x: { expr: "{a} == 1" },
+                  y: { expr: "{b} == 1" },
+               },
+               b: { tpl: "a{b}" },
+            },
+         }).create();
+
+         assert.deepEqual(s(x), { a: { x: true, y: false }, b: "a2" });
+      });
+   });
+
+   it("structures do not change if data doesn't change", function () {
+      var x = { a: 1, b: 2 };
+      var s = new StructuredSelector({
+         props: {
+            a: {
+               structured: true,
+            },
+         },
+         values: {
+            a: {
+               x: { expr: "{a} == 1" },
+               y: { expr: "{b} == 1" },
+            },
+            b: { tpl: "a{b}" },
+         },
+      }).create();
+
+      let r1 = s(x);
+      let r2 = s(x);
+
+      assert.equal(r1, r2);
+   });
+
+   it("accessor model proxy works", function () {
+      var x = { a: { b: 2 } };
+      var m = createAccessorModelProxy<typeof x>();
+      var s = new StructuredSelector({
+         props: {
+            b: undefined,
+         },
+         values: {
+            b: m.a.b,
+         },
+      }).create();
+      assert.deepEqual(s(x), { b: 2 });
+   });
+});

package/src/data/StructuredSelector.ts

@@ -0,0 +1,146 @@
+import { Binding } from "./Binding";
+import { Expression } from "./Expression";
+import { StringTemplate } from "./StringTemplate";
+import { createStructuredSelector } from "../data/createStructuredSelector";
+import { getSelector } from "../data/getSelector";
+import { isFunction } from "../util/isFunction";
+import { isUndefined } from "../util/isUndefined";
+import { isDefined } from "../util/isDefined";
+import { isArray } from "../util/isArray";
+import { isAccessorChain } from "./createAccessorModelProxy";
+import { isString } from "../util/isString";
+import { View } from "./View";
+
+function defaultValue(pv: any) {
+   if (typeof pv == "object" && pv && pv.structured) return pv.defaultValue;
+
+   return pv;
+}
+
+function getSelectorConfig(props: any, values: any, nameMap: any) {
+   let functions: Record<string, any> = {},
+      structures: Record<string, any> = {},
+      defaultValues: Record<string, any> = {},
+      constants: Record<string, any> | undefined,
+      p: string,
+      v: any,
+      pv: any,
+      constant = true;
+
+   for (p in props) {
+      v = values[p];
+      pv = props[p];
+
+      if (isUndefined(v) && pv && (pv.bind || pv.tpl || pv.expr)) v = pv;
+
+      if (v === null) {
+         if (!constants) constants = {};
+         constants[p] = null;
+      } else if (typeof v == "object") {
+         if (v.bind) {
+            if (isUndefined(v.defaultValue) && v != pv) v.defaultValue = defaultValue(pv);
+            if (isDefined(v.defaultValue)) defaultValues[v.bind] = v.defaultValue;
+            nameMap[p] = v.bind;
+            functions[p] = Binding.get(v.bind).value;
+            constant = false;
+         } else if (v.expr) {
+            functions[p] = Expression.get(v.expr);
+            constant = false;
+         } else if (v.get) {
+            functions[p] = v.get;
+            constant = false;
+         } else if (isString(v.tpl)) {
+            functions[p] = StringTemplate.get(v.tpl);
+            constant = false;
+         } else if (pv && typeof pv == "object" && pv.structured) {
+            if (isArray(v)) functions[p] = getSelector(v);
+            else {
+               let s = getSelectorConfig(v, v, {});
+               structures[p] = s;
+               Object.assign(defaultValues, s.defaultValues);
+            }
+            constant = false;
+         } else {
+            if (!constants) constants = {};
+            constants[p] = v;
+         }
+      } else if (isFunction(v)) {
+         if (isAccessorChain(v)) {
+            let path = v.toString();
+            nameMap[p] = path;
+            functions[p] = Binding.get(path).value;
+         } else functions[p] = v;
+         constant = false;
+      } else {
+         if (isUndefined(v)) {
+            if (isUndefined(pv)) continue;
+            v = defaultValue(pv);
+         }
+
+         if (isUndefined(v)) continue;
+
+         if (!constants) constants = {};
+
+         constants[p] = v;
+      }
+   }
+
+   return {
+      functions,
+      structures,
+      defaultValues,
+      constants,
+      constant,
+   };
+}
+
+function createSelector({
+   functions,
+   structures,
+   constants,
+   defaultValues,
+}: {
+   functions: any;
+   structures: any;
+   constants: any;
+   defaultValues: any;
+}) {
+   let selector: Record<string, any> = {};
+
+   for (let n in functions) {
+      selector[n] = functions[n];
+   }
+
+   for (let n in structures) selector[n] = createSelector(structures[n]);
+
+   return createStructuredSelector(selector, constants);
+}
+
+export class StructuredSelector {
+   nameMap: Record<string, string>;
+   config: any;
+
+   constructor({ props, values }: { props: any; values: any }) {
+      this.nameMap = {};
+      this.config = getSelectorConfig(props, values, this.nameMap);
+   }
+
+   init(store: View) {
+      store.init(this.config.defaultValues);
+   }
+
+   create(memoize = true) {
+      let selector = createSelector(this.config);
+      if (memoize && selector.memoize) return selector.memoize();
+      return selector;
+   }
+
+   createStoreSelector() {
+      if (this.config.constant) {
+         let result = { ...this.config.constants };
+         return () => result;
+      }
+      let selector = this.create();
+      return (store: View) => selector(store.getData());
+   }
+}

package/src/data/SubscribableView.ts

@@ -0,0 +1,63 @@
+import { View, ViewConfig } from "./View";
+import { SubscriberList } from "../util/SubscriberList";
+
+export interface SubscribableViewConfig extends ViewConfig {
+   async?: boolean;
+}
+
+export class SubscribableView<D> extends View<D> {
+   subscribers?: any;
+   changes: string[];
+   declare async: boolean;
+   scheduled: boolean;
+
+   constructor(config?: SubscribableViewConfig) {
+      super(config);
+      this.subscribers = new SubscriberList();
+      this.changes = [];
+   }
+
+   subscribe(callback: () => void) {
+      return this.subscribers.subscribe(callback);
+   }
+
+   unsubscribeAll() {
+      this.subscribers.clear();
+   }
+
+   doNotify(path: string) {
+      if (this.notificationsSuspended) return;
+
+      if (!this.async) {
+         this.subscribers.notify([path]);
+      } else {
+         this.changes.push(path || "");
+         if (!this.scheduled) {
+            this.scheduled = true;
+            setTimeout(() => {
+               this.scheduled = false;
+               let changes = this.changes;
+               this.changes = [];
+               this.subscribers.notify(changes);
+            }, 0);
+         }
+      }
+   }
+
+   silently(callback: (store?: View) => void) {
+      this.notificationsSuspended = (this.notificationsSuspended || 0) + 1;
+      let wasDirty = this.dirty,
+         dirty;
+      this.dirty = false;
+      try {
+         callback(this);
+      } finally {
+         this.notificationsSuspended--;
+         dirty = this.dirty;
+         this.dirty = wasDirty;
+      }
+      return dirty;
+   }
+}
+
+SubscribableView.prototype.async = false;

package/src/data/View.ts

@@ -0,0 +1,289 @@
+import { Binding } from "./Binding";
+import { isArray } from "../util/isArray";
+import { isDefined } from "../util/isDefined";
+import { StoreRef } from "./StoreRef";
+import { isObject } from "../util/isObject";
+import { isFunction } from "../util/isFunction";
+import { AccessorChain } from "./createAccessorModelProxy";
+import { Ref } from "./Ref";
+
+type Path = string | Binding;
+
+export interface ViewConfig {
+   store?: View;
+   immutable?: boolean;
+   sealed?: boolean;
+}
+
+export interface ViewMethods<D = Record<string, any>> {
+   getData(): D;
+
+   init(path: Path, value: unknown): boolean;
+   init<V>(path: AccessorChain<V>, value: V): boolean;
+   init<T extends Record<string, unknown>>(initObject: T): boolean;
+
+   set(path: Path, value: any): boolean;
+   set<T extends Record<string, any>>(changes: T): boolean;
+   set<V>(path: AccessorChain<V>, value: V): boolean;
+
+   get(path: Path): any;
+   get(paths: Path[]): any[];
+   get(...paths: Path[]): any[];
+   get<V>(path: AccessorChain<V>): V;
+   get<T extends any[]>(...paths: { [K in keyof T]: AccessorChain<T[K]> }): T;
+   get<T extends any[]>(paths: { [K in keyof T]: AccessorChain<T[K]> }): T;
+
+   /**
+    * Removes data from the Store.
+    * @param paths - One or more paths to be deleted.
+    * @return {boolean}
+    */
+   delete(path: Path): boolean;
+   delete(paths: Path[]): boolean;
+   delete(...paths: Path[]): boolean;
+   delete<V>(path: AccessorChain<V>): boolean;
+   delete<T extends any[]>(...paths: { [K in keyof T]: AccessorChain<T[K]> }): boolean;
+   delete<T extends any[]>(paths: { [K in keyof T]: AccessorChain<T[K]> }): boolean;
+
+   toggle(path: Path): boolean;
+   toggle(path: AccessorChain<boolean>): boolean;
+
+   update(updateFn: (currentValue: D, ...args: any[]) => any, ...args: any): boolean;
+   update<A extends any[]>(path: Path, updateFn: (currentValue: any, ...args: A) => any, ...args: A): boolean;
+   update<V, A extends any[]>(
+      path: AccessorChain<V>,
+      updateFn: (currentValue: V, ...args: A) => V,
+      ...args: A
+   ): boolean;
+
+   /**
+    *  Mutates the content of the store using Immer
+    */
+   mutate(updateFn: (currentValue: D, ...args: any[]) => void, ...args: any[]): boolean;
+   mutate<A extends any[]>(path: Path, updateFn: (currentValue: any, ...args: A) => void, ...args: A): boolean;
+   mutate<V, A extends any[]>(
+      path: AccessorChain<V>,
+      updateFn: (currentValue: V, ...args: A) => void,
+      ...args: A
+   ): boolean;
+
+   ref<T = any>(path: string | AccessorChain<T>, defaultValue?: T): Ref<T>;
+}
+
+export class View<D = any> implements ViewMethods<D> {
+   declare store?: View;
+   declare meta: any;
+   declare sealed: boolean;
+   cache: { version: number; data?: any; result?: any; itemIndex?: number; key?: string; parentStoreData?: any };
+   notificationsSuspended: number = 0;
+   dirty: boolean = false;
+
+   constructor(config?: ViewConfig) {
+      Object.assign(this, config);
+      this.cache = {
+         version: -1,
+      };
+      if (this.store) this.setStore(this.store);
+   }
+
+   getData(): D {
+      throw new Error("abstract method");
+   }
+
+   init(path: Path, value: unknown): boolean;
+   init<V>(path: AccessorChain<V>, value: V): boolean;
+   init<T extends Record<string, unknown>>(initObject: T): boolean;
+   init(path: any, value?: any): boolean {
+      if (typeof path == "object" && path != null) {
+         let changed = false;
+         for (let key in path)
+            if (path.hasOwnProperty(key) && this.get(key) === undefined && this.setItem(key, path[key])) changed = true;
+         return changed;
+      }
+      let binding = Binding.get(path);
+      if (this.get(binding.path) === undefined) return this.setItem(binding.path, value);
+      return false;
+   }
+
+   set(path: Path, value: any): boolean;
+   set<T extends Record<string, any>>(changes: T): boolean;
+   set<V>(path: AccessorChain<V>, value: V): boolean;
+   set(path: any, value?: any): boolean {
+      if (typeof path == "object" && path != null) {
+         let changed = false;
+         for (let key in path) if (path.hasOwnProperty(key) && this.setItem(key, path[key])) changed = true;
+         return changed;
+      }
+      let binding = Binding.get(path);
+      return this.setItem(binding.path, value);
+   }
+
+   copy(from: Path, to: Path): boolean;
+   copy<V>(from: AccessorChain<V>, to: AccessorChain<V>): boolean;
+   copy(from: any, to: any): boolean {
+      let value = this.get(from);
+      return this.set(to, value);
+   }
+
+   move(from: Path, to: Path): boolean;
+   move<V>(from: AccessorChain<V>, to: AccessorChain<V>): boolean;
+   move(from: any, to: any): boolean {
+      return this.batch(() => {
+         this.copy(from, to);
+         this.delete(from);
+      });
+   }
+
+   //protected
+   setItem(path: string, value: any): boolean {
+      if (this.store) return this.store.setItem(path, value);
+      throw new Error("abstract method");
+   }
+
+   delete(path: Path): boolean;
+   delete(paths: Path[]): boolean;
+   delete(...paths: Path[]): boolean;
+   delete<V>(path: AccessorChain<V>): boolean;
+   delete<T extends any[]>(...paths: { [K in keyof T]: AccessorChain<T[K]> }): boolean;
+   delete<T extends any[]>(paths: { [K in keyof T]: AccessorChain<T[K]> }): boolean;
+   delete(path?: any): boolean {
+      if (arguments.length > 1) path = Array.from(arguments);
+      if (isArray(path)) return path.map((arg) => this.delete(arg as Path)).some(Boolean);
+
+      let binding = Binding.get(path);
+      return this.deleteItem(binding.path);
+   }
+
+   //protected
+   deleteItem(path: string): boolean {
+      if (this.store) return this.store.deleteItem(path);
+
+      throw new Error("abstract method");
+   }
+
+   clear(): void {
+      if (this.store) return this.store.clear();
+
+      throw new Error("abstract method");
+   }
+
+   get(path: Path): any;
+   get(paths: Path[]): any[];
+   get(...paths: Path[]): any[];
+   get<V>(path: AccessorChain<V>): V;
+   get<T extends any[]>(...paths: { [K in keyof T]: AccessorChain<T[K]> }): T;
+   get<T extends any[]>(paths: { [K in keyof T]: AccessorChain<T[K]> }): T;
+   get(path?: any, ...args: any[]): any {
+      let storeData = this.getData();
+
+      if (arguments.length > 1) path = Array.from(arguments);
+
+      if (isArray(path)) return path.map((arg) => Binding.get(arg as any).value(storeData));
+
+      return Binding.get(path).value(storeData);
+   }
+
+   toggle(path: Path): boolean;
+   toggle(path: AccessorChain<boolean>): boolean;
+   toggle(path: any): boolean {
+      return this.set(path, !this.get(path));
+   }
+
+   update(updateFn: (currentValue: D, ...args: any[]) => any, ...args: any): boolean;
+   update<A extends any[]>(path: Path, updateFn: (currentValue: any, ...args: A) => any, ...args: A): boolean;
+   update<V, A extends any[]>(
+      path: AccessorChain<V>,
+      updateFn: (currentValue: V, ...args: A) => V,
+      ...args: A
+   ): boolean;
+   update(path: any, updateFn?: any, ...args: any[]): boolean {
+      if (arguments.length == 1 && isFunction(path))
+         return this.load(path.apply(null, [this.getData(), updateFn, ...args]));
+      return this.set(path, updateFn.apply(null, [this.get(path), ...args]));
+   }
+
+   mutate(updateFn: (currentValue: D, ...args: any[]) => void, ...args: any[]): boolean;
+   mutate<A extends any[]>(path: Path, updateFn: (currentValue: any, ...args: A) => void, ...args: A): boolean;
+   mutate<V, A extends any[]>(
+      path: AccessorChain<V>,
+      updateFn: (currentValue: V, ...args: A) => void,
+      ...args: A
+   ): boolean;
+   mutate(path?: any, updateFn?: any, ...args: any[]): boolean {
+      throw new Error(
+         "Mutate requires Immer. Please install 'immer' and 'cx-immer' packages and enable store mutation by calling enableImmerMutate().",
+      );
+   }
+
+   batch(callback: (store?: View) => void): boolean {
+      let dirty = this.silently(callback);
+      if (dirty) this.notify();
+      return dirty;
+   }
+
+   silently(callback: (store?: View) => void): boolean {
+      if (this.store) return this.store.silently(callback);
+
+      throw new Error("abstract method");
+   }
+
+   notify(path?: string): void {
+      if (this.notificationsSuspended) this.dirty = true;
+      else this.doNotify(path);
+   }
+
+   doNotify(path?: string): void {
+      if (this.store) return this.store.notify(path);
+
+      throw new Error("abstract method");
+   }
+
+   subscribe(callback: (changes?: any) => void): () => void {
+      if (this.store) return this.store.subscribe(callback);
+
+      throw new Error("abstract method");
+   }
+
+   load(data: Record<string, any>): boolean {
+      return this.set(data);
+   }
+
+   dispatch(action: any): void {
+      if (this.store) return this.store.dispatch(action);
+
+      throw new Error("The underlying store doesn't support dispatch.");
+   }
+
+   getMeta() {
+      return this.meta;
+   }
+
+   setStore(store: View) {
+      this.store = store;
+      this.meta = store.getMeta();
+   }
+
+   ref<T = any>(path: string | AccessorChain<T>, defaultValue?: T): Ref<T> {
+      if (isDefined(defaultValue)) this.init(path as any, defaultValue);
+      return StoreRef.create({
+         store: this,
+         path,
+      }) as Ref<T>;
+   }
+
+   getMethods(): ViewMethods<D> {
+      return {
+         getData: this.getData.bind(this),
+         set: this.set.bind(this),
+         get: this.get.bind(this),
+         update: this.update.bind(this),
+         delete: this.delete.bind(this),
+         toggle: this.toggle.bind(this),
+         init: this.init.bind(this),
+         ref: this.ref.bind(this),
+         mutate: this.mutate.bind(this),
+      };
+   }
+}
+
+View.prototype.sealed = false; //indicate that data should be copied before virtual items are added

package/src/data/ZoomIntoPropertyView.spec.ts

@@ -0,0 +1,64 @@
+import assert from "assert";
+
+import { Binding } from "./Binding";
+import { Store } from "./Store";
+import { ZoomIntoPropertyView } from "./ZoomIntoPropertyView";
+
+describe("ZoomIntoPropertyView", () => {
+   const getZoom = () => {
+      let store = new Store({
+         data: {
+            a: 3,
+            item: {
+               firstName: "Jack",
+            },
+         },
+      });
+
+      return new ZoomIntoPropertyView({
+         store: store,
+         binding: Binding.get("item"),
+      });
+   };
+
+   it("allows direct access to properties of zoomed object", () => {
+      let zoom = getZoom();
+      assert.equal(zoom.get("firstName"), "Jack");
+   });
+
+   it("allows access to outside data through $root", () => {
+      let zoom = getZoom();
+      assert.equal(zoom.get("$root.a"), 3);
+   });
+
+   it("correctly sets zoomed object", () => {
+      let zoom = getZoom();
+      zoom.set("firstName", "Joe");
+      assert.equal(zoom.get("firstName"), "Joe");
+   });
+
+   it("correctly sets zoomed values", () => {
+      let zoom = getZoom();
+      zoom.set("firstName", "Joe");
+      assert.equal(zoom.get("firstName"), "Joe");
+      assert.equal(zoom.get("$root.item.firstName"), "Joe");
+   });
+
+   it("correctly sets outside values", () => {
+      let zoom = getZoom();
+      zoom.set("$root.a", 6);
+      assert.equal(zoom.get("$root.a"), 6);
+   });
+
+   it("correctly deletes zoomed values", () => {
+      let zoom = getZoom();
+      zoom.delete("firstName");
+      assert.equal(zoom.get("firstName"), undefined);
+   });
+
+   it("correctly deletes outside values", () => {
+      let zoom = getZoom();
+      zoom.delete("$root.a");
+      assert.equal(zoom.get("$root.a"), undefined);
+   });
+});