cx 25.11.1 → 26.0.2

package/src/data/ArrayElementView.spec.ts

@@ -0,0 +1,88 @@
+import assert from "assert";
+import { ArrayElementView } from "./ArrayElementView";
+import { getAccessor } from "./getAccessor";
+import { Store } from "./Store";
+
+describe("ArrayElementView", function () {
+   it("exposes the element as under the $record alias", function () {
+      let letters = [{ letter: "A" }, { letter: "B" }];
+      let store = new Store({ data: { letters } });
+      let elementView = new ArrayElementView({ store, itemIndex: 1, arrayAccessor: getAccessor({ bind: "letters" }) });
+      let record = elementView.get("$record");
+      assert.equal(record, letters[1]);
+   });
+
+   it("changes of the $record are propagated", function () {
+      let letters = [{ letter: "A" }, { letter: "B" }];
+      let store = new Store({ data: { letters } });
+      let elementView = new ArrayElementView({ store, itemIndex: 1, arrayAccessor: getAccessor({ bind: "letters" }) });
+      elementView.set("$record.letter", "C");
+      assert.deepEqual(store.get("letters"), [letters[0], { letter: "C" }]);
+   });
+
+   it("removes the element if the $record is deleted", function () {
+      let letters = [{ letter: "A" }, { letter: "B" }];
+      let store = new Store({ data: { letters } });
+      let elementView = new ArrayElementView({ store, itemIndex: 1, arrayAccessor: getAccessor({ bind: "letters" }) });
+      elementView.delete("$record");
+      assert.deepEqual(store.get("letters"), [letters[0]]);
+   });
+
+   it("exposes the element as under the given alias", function () {
+      let letters = [{ letter: "A" }, { letter: "B" }];
+      let store = new Store({ data: { letters } });
+      let elementView = new ArrayElementView({
+         store,
+         itemIndex: 1,
+         arrayAccessor: getAccessor({ bind: "letters" }),
+         recordAlias: "$letter",
+      });
+      let record = elementView.get("$letter");
+      assert.equal(record, letters[1]);
+   });
+
+   it("aliases allow nesting", function () {
+      let letters = [{ letter: "A" }, { letter: "B" }];
+      let store = new Store({ data: { letters } });
+      let elementView = new ArrayElementView({
+         store,
+         itemIndex: 1,
+         arrayAccessor: getAccessor({ bind: "letters" }),
+         recordAlias: "$iter.letter",
+         indexAlias: "$iter.index.letter",
+      });
+      let record = elementView.get("$iter.letter");
+      assert.equal(record, letters[1]);
+      assert.equal(elementView.get("$iter.index.letter"), 1);
+
+      elementView.set("$iter.letter.letter", "C");
+      assert.equal(store.get("letters.1.letter"), "C");
+   });
+
+   it("when immutable preserves the parent data object", function () {
+      let letters = [{ letter: "A" }, { letter: "B" }];
+      let store = new Store({ data: { letters } });
+      let elementView = new ArrayElementView({
+         store,
+         itemIndex: 1,
+         arrayAccessor: getAccessor({ bind: "letters" }),
+         immutable: true,
+      });
+      let record = elementView.get("$record");
+      assert.equal(record, letters[1]);
+      assert(!store.getData().hasOwnProperty("$record"));
+   });
+
+   it("respects the parent's store sealed flag", function () {
+      let letters = [{ letter: "A" }, { letter: "B" }];
+      let store = new Store({ data: { letters }, sealed: true });
+      let elementView = new ArrayElementView({
+         store,
+         itemIndex: 1,
+         arrayAccessor: getAccessor({ bind: "letters" }),
+      });
+      let record = elementView.get("$record");
+      assert.equal(record, letters[1]);
+      assert(!store.getData().hasOwnProperty("$record"));
+   });
+});

package/src/data/ArrayElementView.ts

@@ -0,0 +1,90 @@
+import { AugmentedViewBase } from "./AugmentedViewBase";
+import { isArray } from "../util/isArray";
+import { Binding } from "./Binding";
+import { View } from "./View";
+
+export interface ArrayElementViewConfig {
+   store: View;
+   arrayAccessor: any;
+   immutable?: boolean;
+   recordAlias?: string;
+   indexAlias?: string;
+   lengthAlias?: string;
+   hasNestedAliases?: boolean;
+   recordBinding?: any;
+   indexBinding?: any;
+   lengthBinding?: any;
+   itemIndex: number;
+   sealed?: boolean;
+}
+
+export class ArrayElementView extends AugmentedViewBase {
+   declare arrayAccessor: any;
+   declare recordAlias: string;
+   declare indexAlias: string;
+   declare lengthAlias: string;
+   declare hasNestedAliases?: boolean;
+   declare recordBinding?: any;
+   declare indexBinding?: any;
+   declare lengthBinding?: any;
+   declare itemIndex: number;
+
+   constructor(config: ArrayElementViewConfig) {
+      super(config);
+      this.hasNestedAliases =
+         this.recordAlias.indexOf(".") >= 0 || this.indexAlias.indexOf(".") >= 0 || this.lengthAlias.indexOf(".") >= 0;
+      this.recordBinding = Binding.get(this.recordAlias);
+      if (this.hasNestedAliases) {
+         this.indexBinding = Binding.get(this.indexAlias);
+         this.lengthBinding = Binding.get(this.lengthAlias);
+      }
+   }
+
+   getExtraKeyBinding(key: string): any {
+      if (!key.startsWith(this.recordAlias)) return null;
+      if (key.length == this.recordAlias.length || key[this.recordAlias.length] == ".") return this.recordBinding;
+      return null;
+   }
+
+   deleteExtraKeyValue(key: string): boolean {
+      if (key != this.recordAlias) throw new Error(`Field ${key} cannot be deleted.`);
+      const array = this.arrayAccessor.get(this.store.getData());
+      if (!array) return false;
+      const newArray = [...array.slice(0, this.itemIndex), ...array.slice(this.itemIndex + 1)];
+      return this.arrayAccessor.set(newArray, this.store);
+   }
+
+   setExtraKeyValue(key: string, value: any): boolean {
+      if (key != this.recordAlias) throw new Error(`Field ${key} is read-only.`);
+      const array = this.arrayAccessor.get(this.store.getData());
+      if (!array || value === array[this.itemIndex]) return false;
+      const newArray = [...array.slice(0, this.itemIndex), value, ...array.slice(this.itemIndex + 1)];
+      return this.arrayAccessor.set(newArray, this.store);
+   }
+
+   embedAugmentData(result: any, parentStoreData: any): void {
+      let array = this.arrayAccessor.get(parentStoreData);
+      if (!isArray(array)) return;
+      if (!this.hasNestedAliases) {
+         result[this.recordAlias] = array[this.itemIndex];
+         result[this.indexAlias] = this.itemIndex;
+         result[this.lengthAlias] = array.length;
+      } else {
+         let copy = result;
+         copy = this.recordBinding.set(copy, array[this.itemIndex]);
+         copy = this.indexBinding.set(copy, this.itemIndex);
+         copy = this.lengthBinding.set(copy, array.length);
+         result[this.recordBinding.parts[0]] = copy[this.recordBinding.parts[0]];
+         result[this.indexBinding.parts[0]] = copy[this.indexBinding.parts[0]];
+         result[this.lengthBinding.parts[0]] = copy[this.lengthBinding.parts[0]];
+      }
+   }
+
+   setIndex(itemIndex: number): void {
+      this.itemIndex = itemIndex;
+   }
+}
+
+ArrayElementView.prototype.recordAlias = "$record";
+ArrayElementView.prototype.indexAlias = "$index";
+ArrayElementView.prototype.lengthAlias = "$length";

package/src/data/ArrayRef.ts

@@ -0,0 +1,35 @@
+import {Ref} from "./Ref";
+import {append} from "./ops/append";
+import {moveElement} from "./ops/moveElement";
+import {insertElement} from "./ops/insertElement";
+
+export class ArrayRef<T = any> extends Ref<T[]> {
+   append(...args: T[]): void {
+      this.update(append, ...args);
+   }
+
+   insert(index: number, ...args: T[]): void {
+      this.update(insertElement, ...args)
+   }
+
+   filter(predicate: (item: T, index?: number) => boolean): void {
+      this.update(array => array.filter(a => predicate(a)));
+   }
+
+   move(fromIndex: number, toIndex: number): void {
+      this.update(moveElement, fromIndex, toIndex);
+   }
+
+   clear(): void {
+      this.set([]);
+   }
+
+   sort(compare: (a: T, b: T) => number): void {
+      let data = this.get();
+      if (!data)
+         return;
+      let x = [...data];
+      x.sort(compare);
+      this.set(x);
+   }
+}

package/src/data/AugmentedViewBase.ts

@@ -0,0 +1,88 @@
+import { View, ViewConfig } from "./View";
+import { Binding } from "./Binding";
+
+export interface AugmentedViewBaseConfig extends ViewConfig {
+   store: View<any>;
+}
+
+export class AugmentedViewBase<D = any> extends View<D> {
+   declare immutable: boolean;
+   declare store: View;
+
+   constructor(config: AugmentedViewBaseConfig) {
+      super(config);
+   }
+
+   getData() {
+      if (this.sealed && this.meta.version === this.cache.version && this.meta === this.store.meta)
+         return this.cache.result;
+      let parentStoreData = this.store.getData();
+      let result = this.getBaseData(parentStoreData);
+      this.embedAugmentData(result, parentStoreData);
+      this.cache.result = result;
+      this.cache.parentStoreData = parentStoreData;
+      this.cache.version = this.meta.version;
+      this.meta = this.store.meta;
+      return this.cache.result;
+   }
+
+   protected getBaseData(parentStoreData: any): any {
+      if (this.sealed || this.immutable || this.store.sealed) return { ...parentStoreData };
+      return parentStoreData;
+   }
+
+   protected embedAugmentData(result: any, parentStoreData: any): void {
+      throw new Error("abstract");
+   }
+
+   protected isExtraKey(key: string): boolean {
+      throw new Error("abstract");
+   }
+
+   // Stores which need to support nested aliases should override this method
+   protected getExtraKeyBinding(key: string): any {
+      let binding = Binding.get(key);
+      return this.isExtraKey(binding.parts[0]) ? Binding.get(binding.parts[0]) : null;
+   }
+
+   protected setExtraKeyValue(key: string, value: any): boolean {
+      throw new Error("abstract");
+   }
+
+   protected deleteExtraKeyValue(key: string): boolean {
+      throw new Error("abstract");
+   }
+
+   setItem(path: string, value: any): boolean {
+      let extraKeyBinding = this.getExtraKeyBinding(path);
+      if (extraKeyBinding) {
+         let binding = Binding.get(path);
+         let newValue = value;
+         if (binding.parts.length > extraKeyBinding.parts.length) {
+            let data = {};
+            this.embedAugmentData(data, this.store.getData());
+            let binding = Binding.get(path);
+            data = binding.set(data, value);
+            newValue = extraKeyBinding.value(data);
+         }
+         return this.setExtraKeyValue(extraKeyBinding.path, newValue);
+      }
+      return super.setItem(path, value);
+   }
+
+   deleteItem(path: string): boolean {
+      let extraKeyBinding = this.getExtraKeyBinding(path);
+      if (extraKeyBinding) {
+         if (path == extraKeyBinding.path) return this.deleteExtraKeyValue(extraKeyBinding.path);
+         let data = {};
+         this.embedAugmentData(data, this.store.getData());
+         let binding = Binding.get(path);
+         data = binding.delete(data);
+         let newValue = extraKeyBinding.value(data);
+         return this.setExtraKeyValue(extraKeyBinding.path, newValue);
+      }
+      return super.deleteItem(path);
+   }
+}
+
+AugmentedViewBase.prototype.immutable = false;

package/src/data/Binding.ts

@@ -0,0 +1,104 @@
+import { isString } from "../util/isString";
+import { isObject } from "../util/isObject";
+import { isAccessorChain } from "./createAccessorModelProxy";
+import { AccessorChain } from "./createAccessorModelProxy";
+import { hasStringAtKey, hasValueAtKey } from "../util/hasKey";
+
+let bindingCache: Record<string, Binding<any>> = {};
+
+export interface BindingObject {
+   bind: string;
+   defaultValue?: any;
+   throttle?: number;
+   debounce?: number;
+}
+
+export type BindingInput<T = any> = string | BindingObject | Binding<T> | AccessorChain<T>;
+
+export type ValueGetter<T> = (state: any) => T | undefined;
+
+export class Binding<T = any> {
+   public readonly path: string;
+   public readonly parts: readonly string[];
+   public readonly value: ValueGetter<T>;
+
+   constructor(path: string) {
+      this.path = path;
+      this.parts = path.split(".") as readonly string[];
+      let body = "return x";
+      for (let i = 0; i < this.parts.length; i++) body += '?.["' + this.parts[i] + '"]';
+      this.value = new Function("x", body) as ValueGetter<T>;
+   }
+
+   set<S extends Record<string, any> = any>(state: S, value: T): S {
+      const cv = this.value(state);
+      if (cv === value) return state;
+
+      const ns = Object.assign({}, state) as S;
+      let o: any = ns;
+
+      for (let i = 0; i < this.parts.length; i++) {
+         const part = this.parts[i];
+         const no = i === this.parts.length - 1 ? value : Object.assign({}, o[part]);
+         o[part] = no;
+         o = no;
+      }
+
+      return ns;
+   }
+
+   delete<S extends Record<string, any> = any>(state: S): S {
+      const ns = Object.assign({}, state) as S;
+      let o: any = ns;
+      let part: string;
+
+      for (let i = 0; i < this.parts.length - 1; i++) {
+         part = this.parts[i];
+         const no = Object.assign({}, o[part]);
+         o[part] = no;
+         o = no;
+      }
+
+      part = this.parts[this.parts.length - 1];
+      if (!o.hasOwnProperty(part)) return state;
+
+      delete o[part];
+
+      return ns;
+   }
+
+   static get<T = any>(path: BindingInput<T>): Binding<T> {
+      if (isString(path)) {
+         let b = bindingCache[path] as Binding<T> | undefined;
+         if (b) return b;
+
+         b = new Binding<T>(path);
+         bindingCache[path] = b;
+         return b;
+      }
+
+      if (isBindingObject(path)) return this.get<T>(path.bind);
+
+      if (path instanceof Binding) return path as Binding<T>;
+
+      if (isAccessorChain(path)) return this.get<T>((path as AccessorChain<T>).toString());
+
+      throw new Error("Invalid binding definition provided.");
+   }
+}
+
+export function isBinding(value: unknown): value is BindingInput {
+   if (isObject(value)) {
+      if (hasStringAtKey(value, "bind")) return true;
+      if (hasValueAtKey(value, "isAccessorChain", true)) return true;
+   }
+   return value instanceof Binding;
+}
+
+export type BindingValue<B> = B extends Binding<infer T> ? T : unknown;
+
+export function isBindingObject(value: unknown): value is BindingObject {
+   return isObject(value) && hasStringAtKey(value, "bind");
+}
+
+export { bindingCache };

package/src/data/ExposedRecordView.ts

@@ -0,0 +1,95 @@
+import { View } from "./View";
+import { Binding } from "./Binding";
+
+export interface ExposedRecordViewConfig {
+   store: View;
+   itemIndex: number;
+   immutable?: boolean;
+   collectionBinding: any;
+   recordName: string;
+   indexName: string;
+}
+
+export class ExposedRecordView<D = any> extends View<D> {
+   declare store: View;
+   itemIndex: number;
+   immutable: boolean;
+   collectionBinding: Binding;
+   recordName: string;
+   indexName: string;
+
+   constructor(config: ExposedRecordViewConfig) {
+      super(config);
+   }
+
+   getData(): any {
+      if (
+         this.sealed &&
+         this.meta.version === this.cache.version &&
+         this.cache.itemIndex === this.itemIndex &&
+         this.meta === this.store.meta
+      )
+         return this.cache.result;
+
+      this.cache.result = this.embed(this.store.getData());
+      this.cache.version = this.meta.version;
+      this.cache.itemIndex = this.itemIndex;
+      this.meta = this.store.meta;
+      return this.cache.result;
+   }
+
+   embed(data: any) {
+      const collection = this.collectionBinding.value(data);
+      const record = collection[this.itemIndex];
+      const copy = this.sealed || this.immutable || this.store.sealed ? { ...data } : data;
+      copy[this.recordName] = record;
+      if (this.indexName) copy[this.indexName] = this.itemIndex;
+      return copy;
+   }
+
+   setIndex(index: number) {
+      this.itemIndex = index;
+   }
+
+   setItem(path: string, value: any) {
+      if (path == this.recordName || path.indexOf(this.recordName + ".") == 0) {
+         const storeData = this.store.getData();
+         const collection = this.collectionBinding.value(storeData);
+         const data = this.embed(storeData);
+         const d = Binding.get(path).set(data, value);
+         if (d === data) return false;
+         const record = d[this.recordName];
+         const newCollection = [
+            ...collection.slice(0, this.itemIndex),
+            record,
+            ...collection.slice(this.itemIndex + 1),
+         ];
+         return this.store.setItem(this.collectionBinding.path, newCollection);
+      }
+      return this.store.setItem(path, value);
+   }
+
+   deleteItem(path: string) {
+      let storeData, collection, newCollection;
+
+      if (path == this.recordName) {
+         storeData = this.store.getData();
+         collection = this.collectionBinding.value(storeData);
+         newCollection = [...collection.slice(0, this.itemIndex), ...collection.slice(this.itemIndex + 1)];
+         return this.store.setItem(this.collectionBinding.path, newCollection);
+      } else if (path.indexOf(this.recordName + ".") == 0) {
+         storeData = this.store.getData();
+         collection = this.collectionBinding.value(storeData);
+         const data = this.embed(storeData);
+         const d = Binding.get(path).delete(data);
+         if (d === data) return false;
+         const record = d[this.recordName];
+         newCollection = [...collection.slice(0, this.itemIndex), record, ...collection.slice(this.itemIndex + 1)];
+         return this.store.setItem(this.collectionBinding.path, newCollection);
+      }
+
+      return this.store.deleteItem(path);
+   }
+}
+
+ExposedRecordView.prototype.immutable = false;

package/src/data/ExposedValueView.ts

@@ -0,0 +1,89 @@
+import { View, ViewConfig } from "./View";
+import { Binding } from "./Binding";
+
+export interface ExposedValueViewConfig extends ViewConfig {
+   containerBinding: Binding;
+   key?: string | null;
+   recordName?: string;
+}
+
+export class ExposedValueView extends View {
+   declare key: string;
+   declare containerBinding: Binding;
+   declare recordName: string;
+   declare immutable?: boolean;
+   declare store: View;
+
+   constructor(config: ExposedValueViewConfig) {
+      super(config);
+   }
+
+   getData(): any {
+      if (
+         this.sealed &&
+         this.meta.version === this.cache.version &&
+         this.cache.key === this.key &&
+         this.meta == this.store.meta
+      )
+         return this.cache.result;
+
+      let data = this.store.getData();
+      let container = this.containerBinding.value(data) || {};
+      let record = container[this.key];
+
+      this.cache.version = this.meta.version;
+      this.cache.key = this.key;
+      this.cache.result = this.sealed || this.immutable || this.store.sealed ? { ...data } : data;
+      this.cache.result[this.recordName] = record;
+      this.meta = this.store.meta;
+      return this.cache.result;
+   }
+
+   setKey(key: string) {
+      this.key = key;
+   }
+
+   getKey() {
+      return this.key;
+   }
+
+   setItem(path: string, value: any) {
+      if (path == this.recordName || path.indexOf(this.recordName + ".") == 0) {
+         var data = this.getData();
+         var d = Binding.get(path).set(data, value);
+         if (d === data) return false;
+         var container = this.containerBinding.value(d);
+         var record = d[this.recordName];
+         var newContainer = Object.assign({}, container);
+         newContainer[this.key] = record;
+         return this.store.setItem(this.containerBinding.path, newContainer);
+      }
+      return this.store.setItem(path, value);
+   }
+
+   deleteItem(path: string) {
+      var data, container, newContainer;
+
+      if (path == this.recordName) {
+         data = this.getData();
+         container = this.containerBinding.value(data);
+         if (!container || !container.hasOwnProperty(path)) return false;
+         newContainer = Object.assign({}, container);
+         delete newContainer[this.key];
+         this.store.set(this.containerBinding.path, newContainer);
+      } else if (path.indexOf(this.recordName + ".") == 0) {
+         data = this.getData();
+         var d = Binding.get(path).delete(data);
+         if (d === data) return false;
+         container = this.containerBinding.value(d);
+         var record = d[this.recordName];
+         newContainer = Object.assign({}, container);
+         newContainer[this.key] = record;
+         return this.store.setItem(this.containerBinding.path, newContainer);
+      }
+
+      return this.store.deleteItem(path);
+   }
+}
+
+ExposedValueView.prototype.immutable = false;