cx 26.1.13 → 26.2.1

package/src/ui/adapter/ArrayAdapter.ts

@@ -1,229 +1,229 @@
-import { DataAdapter, DataAdapterRecord, DataAdapterConfig } from "./DataAdapter";
-import { ReadOnlyDataView } from "../../data/ReadOnlyDataView";
-import { sorter } from "../../data/comparer";
-import { isArray } from "../../util/isArray";
-import { ArrayElementView } from "../../data/ArrayElementView";
-import { Accessor, getAccessor } from "../../data/getAccessor";
-import { Culture } from "../Culture";
-import { isDefined, isObject } from "../../util";
-import { RenderingContext } from "../RenderingContext";
-import { Instance } from "../Instance";
-import { View } from "../../data/View";
-import { Prop, Sorter, CollatorOptions } from "../Prop";
-
-export interface RecordStoreCache {
-   recordStoreCache: WeakMap<any, View>;
-   cacheByKey: Record<string | number, View>;
-   recordsAccessor?: Accessor;
-}
-
-export interface ArrayAdapterConfig extends DataAdapterConfig {
-   recordsBinding?: Prop<any[]>;
-   recordsAccessor?: Accessor | string;
-   keyField?: string;
-   cacheByKeyField?: boolean;
-   sortOptions?: CollatorOptions;
-   preserveOrder?: boolean;
-}
-
-export interface ExtendedSorter extends Sorter {
-   comparer?: (a: any, b: any) => number;
-   sortOptions?: CollatorOptions;
-}
-
-export interface ResolvedSorter {
-   getter: (x: any) => any;
-   factor: number;
-   compare: (a: any, b: any) => number;
-}
-
-export class ArrayAdapter<T = any> extends DataAdapter<T> {
-   declare public recordsAccessor: Accessor;
-   declare public recordsBinding?: Prop<T[]>;
-   declare public keyField: string | null;
-   declare public cacheByKeyField: boolean;
-   declare public sortOptions?: CollatorOptions;
-   declare public preserveOrder?: boolean;
-   declare isTreeAdapter: boolean;
-
-   declare protected sorter?: (data: DataAdapterRecord<T>[]) => DataAdapterRecord<T>[];
-
-   constructor(config?: ArrayAdapterConfig) {
-      super(config);
-   }
-
-   public init(): void {
-      this.recordsAccessor = this.recordsBinding ? getAccessor(this.recordsBinding) : getAccessor(this.recordsAccessor);
-      this.recordName = this.recordName?.toString() || "$record";
-      this.indexName = this.indexName?.toString() || "$index";
-   }
-
-   public initInstance(context: RenderingContext, instance: Instance & Partial<RecordStoreCache>): void {
-      if (!instance.recordStoreCache) {
-         instance.recordStoreCache = new WeakMap();
-         instance.cacheByKey = {};
-      }
-
-      if (!instance.recordsAccessor && this.recordsAccessor) {
-         instance.recordsAccessor = this.recordsAccessor.bindInstance
-            ? this.recordsAccessor.bindInstance(instance)
-            : this.recordsAccessor;
-      }
-   }
-
-   public getRecords(
-      context: RenderingContext,
-      instance: Instance & Partial<RecordStoreCache>,
-      records: T[],
-      parentStore: View,
-   ): DataAdapterRecord<T>[] {
-      if (!instance.recordStoreCache) {
-         this.initInstance(context, instance);
-      }
-
-      return this.mapRecords(context, instance, records, parentStore, instance.recordsAccessor);
-   }
-
-   public mapRecords(
-      context: RenderingContext,
-      instance: Instance & Partial<RecordStoreCache>,
-      records: T[],
-      parentStore: View,
-      recordsAccessor?: Accessor,
-   ): DataAdapterRecord<T>[] {
-      let result: DataAdapterRecord<T>[] = [];
-
-      if (!instance.recordStoreCache) {
-         this.initInstance(context, instance);
-      }
-
-      if (isArray(records)) {
-         records.forEach((data, index) => {
-            if (this.filterFn && !this.filterFn(data)) return;
-
-            const record = this.mapRecord(context, instance, data, parentStore, recordsAccessor, index);
-            result.push(record);
-         });
-      }
-
-      if (this.sorter && !this.preserveOrder) {
-         result = this.sorter(result);
-      }
-
-      return result;
-   }
-
-   public mapRecord(
-      context: RenderingContext,
-      instance: Instance & Partial<RecordStoreCache>,
-      data: T,
-      parentStore: View,
-      recordsAccessor: Accessor | undefined,
-      index: number,
-   ): DataAdapterRecord<T> {
-      const key = this.cacheByKeyField && this.keyField && isObject(data) ? (data as any)[this.keyField] : null;
-      let recordStore = key != null ? instance.cacheByKey![key] : instance.recordStoreCache!.get(data);
-
-      if (recordsAccessor) {
-         if (!recordStore) {
-            recordStore = new ArrayElementView({
-               store: parentStore,
-               arrayAccessor: recordsAccessor,
-               itemIndex: index,
-               recordAlias: this.recordName,
-               indexAlias: this.indexName,
-               immutable: this.immutable,
-               sealed: this.sealed,
-            });
-         } else {
-            (recordStore as ArrayElementView).setStore(parentStore);
-            (recordStore as ArrayElementView).setIndex(index);
-         }
-      } else {
-         if (!recordStore) {
-            recordStore = new ReadOnlyDataView({
-               store: parentStore,
-               data: {
-                  [this.recordName]: data,
-                  [this.indexName]: index,
-               },
-               immutable: this.immutable,
-               sealed: this.sealed,
-            });
-         } else {
-            (recordStore as ReadOnlyDataView).setStore(parentStore);
-            (recordStore as ReadOnlyDataView).setData({
-               [this.recordName]: data,
-               [this.indexName]: index,
-            });
-         }
-      }
-
-      if (key != null) {
-         instance.cacheByKey![key] = recordStore;
-      } else if (isObject(data)) {
-         instance.recordStoreCache!.set(data, recordStore);
-      }
-
-      return {
-         store: recordStore,
-         index: index,
-         data: data,
-         type: "data",
-         key: this.keyField && isObject(data) ? (data as any)[this.keyField] : index,
-      };
-   }
-
-   public setFilter(filterFn?: (data: T) => boolean): void {
-      this.filterFn = filterFn;
-   }
-
-   public getComparer(sortOptions?: CollatorOptions): ((a: any, b: any) => number) | undefined {
-      return sortOptions ? Culture.getComparer(sortOptions) : undefined;
-   }
-
-   public buildSorter(sorters: ExtendedSorter[]): void {
-      if (isArray(sorters) && sorters.length > 0) {
-         let dataAccessor: (x: DataAdapterRecord<T>) => any;
-         let fieldValueMapper: (x: ExtendedSorter) => Prop<any>;
-
-         if (sorters.every((x) => x.field && x.value == null)) {
-            dataAccessor = (x) => x.data;
-            fieldValueMapper = (x) => ({ bind: x.field! });
-         } else {
-            dataAccessor = (x) => x.store.getData();
-            fieldValueMapper = (x) => ({ bind: this.recordName + "." + x.field });
-         }
-
-         this.sorter = sorter(
-            sorters.map((x) => {
-               const s: ExtendedSorter = Object.assign({}, x);
-               if (s.field && s.value == null) {
-                  s.value = fieldValueMapper(s);
-               }
-               if (!s.comparer) {
-                  s.comparer = this.getComparer(isDefined(s.sortOptions) ? s.sortOptions : this.sortOptions);
-               }
-               return s;
-            }),
-            dataAccessor,
-         );
-      } else {
-         this.sorter = undefined;
-      }
-   }
-
-   public sort(sorters?: Sorter[] | ExtendedSorter[]): void {
-      if (sorters) {
-         this.buildSorter(sorters as ExtendedSorter[]);
-      }
-   }
-}
-
-ArrayAdapter.prototype.immutable = false;
-ArrayAdapter.prototype.sealed = false;
-ArrayAdapter.prototype.keyField = null;
-ArrayAdapter.prototype.cacheByKeyField = true;
-ArrayAdapter.prototype.isTreeAdapter = false;
-
-ArrayAdapter.autoInit = true;
+import { DataAdapter, DataAdapterRecord, DataAdapterConfig } from "./DataAdapter";
+import { ReadOnlyDataView } from "../../data/ReadOnlyDataView";
+import { sorter } from "../../data/comparer";
+import { isArray } from "../../util/isArray";
+import { ArrayElementView } from "../../data/ArrayElementView";
+import { Accessor, getAccessor } from "../../data/getAccessor";
+import { Culture } from "../Culture";
+import { isDefined, isObject } from "../../util";
+import { RenderingContext } from "../RenderingContext";
+import { Instance } from "../Instance";
+import { View } from "../../data/View";
+import { Prop, Sorter, CollatorOptions } from "../Prop";
+
+export interface RecordStoreCache {
+   recordStoreCache: WeakMap<any, View>;
+   cacheByKey: Record<string | number, View>;
+   recordsAccessor?: Accessor;
+}
+
+export interface ArrayAdapterConfig extends DataAdapterConfig {
+   recordsBinding?: Prop<any[]>;
+   recordsAccessor?: Accessor | string;
+   keyField?: string;
+   cacheByKeyField?: boolean;
+   sortOptions?: CollatorOptions;
+   preserveOrder?: boolean;
+}
+
+export interface ExtendedSorter extends Sorter {
+   comparer?: (a: any, b: any) => number;
+   sortOptions?: CollatorOptions;
+}
+
+export interface ResolvedSorter {
+   getter: (x: any) => any;
+   factor: number;
+   compare: (a: any, b: any) => number;
+}
+
+export class ArrayAdapter<T = any> extends DataAdapter<T> {
+   declare public recordsAccessor: Accessor;
+   declare public recordsBinding?: Prop<T[]>;
+   declare public keyField: string | null;
+   declare public cacheByKeyField: boolean;
+   declare public sortOptions?: CollatorOptions;
+   declare public preserveOrder?: boolean;
+   declare isTreeAdapter: boolean;
+
+   declare protected sorter?: (data: DataAdapterRecord<T>[]) => DataAdapterRecord<T>[];
+
+   constructor(config?: ArrayAdapterConfig) {
+      super(config);
+   }
+
+   public init(): void {
+      this.recordsAccessor = this.recordsBinding ? getAccessor(this.recordsBinding) : getAccessor(this.recordsAccessor);
+      this.recordName = this.recordName?.toString() || "$record";
+      this.indexName = this.indexName?.toString() || "$index";
+   }
+
+   public initInstance(context: RenderingContext, instance: Instance & Partial<RecordStoreCache>): void {
+      if (!instance.recordStoreCache) {
+         instance.recordStoreCache = new WeakMap();
+         instance.cacheByKey = {};
+      }
+
+      if (!instance.recordsAccessor && this.recordsAccessor) {
+         instance.recordsAccessor = this.recordsAccessor.bindInstance
+            ? this.recordsAccessor.bindInstance(instance)
+            : this.recordsAccessor;
+      }
+   }
+
+   public getRecords(
+      context: RenderingContext,
+      instance: Instance & Partial<RecordStoreCache>,
+      records: T[],
+      parentStore: View,
+   ): DataAdapterRecord<T>[] {
+      if (!instance.recordStoreCache) {
+         this.initInstance(context, instance);
+      }
+
+      return this.mapRecords(context, instance, records, parentStore, instance.recordsAccessor);
+   }
+
+   public mapRecords(
+      context: RenderingContext,
+      instance: Instance & Partial<RecordStoreCache>,
+      records: T[],
+      parentStore: View,
+      recordsAccessor?: Accessor,
+   ): DataAdapterRecord<T>[] {
+      let result: DataAdapterRecord<T>[] = [];
+
+      if (!instance.recordStoreCache) {
+         this.initInstance(context, instance);
+      }
+
+      if (isArray(records)) {
+         records.forEach((data, index) => {
+            if (this.filterFn && !this.filterFn(data)) return;
+
+            const record = this.mapRecord(context, instance, data, parentStore, recordsAccessor, index);
+            result.push(record);
+         });
+      }
+
+      if (this.sorter && !this.preserveOrder) {
+         result = this.sorter(result);
+      }
+
+      return result;
+   }
+
+   public mapRecord(
+      context: RenderingContext,
+      instance: Instance & Partial<RecordStoreCache>,
+      data: T,
+      parentStore: View,
+      recordsAccessor: Accessor | undefined,
+      index: number,
+   ): DataAdapterRecord<T> {
+      const key = this.cacheByKeyField && this.keyField && isObject(data) ? (data as any)[this.keyField] : null;
+      let recordStore = key != null ? instance.cacheByKey![key] : instance.recordStoreCache!.get(data);
+
+      if (recordsAccessor) {
+         if (!recordStore) {
+            recordStore = new ArrayElementView({
+               store: parentStore,
+               arrayAccessor: recordsAccessor,
+               itemIndex: index,
+               recordAlias: this.recordName,
+               indexAlias: this.indexName,
+               immutable: this.immutable,
+               sealed: this.sealed,
+            });
+         } else {
+            (recordStore as ArrayElementView).setStore(parentStore);
+            (recordStore as ArrayElementView).setIndex(index);
+         }
+      } else {
+         if (!recordStore) {
+            recordStore = new ReadOnlyDataView({
+               store: parentStore,
+               data: {
+                  [this.recordName]: data,
+                  [this.indexName]: index,
+               },
+               immutable: this.immutable,
+               sealed: this.sealed,
+            });
+         } else {
+            (recordStore as ReadOnlyDataView).setStore(parentStore);
+            (recordStore as ReadOnlyDataView).setData({
+               [this.recordName]: data,
+               [this.indexName]: index,
+            });
+         }
+      }
+
+      if (key != null) {
+         instance.cacheByKey![key] = recordStore;
+      } else if (isObject(data)) {
+         instance.recordStoreCache!.set(data, recordStore);
+      }
+
+      return {
+         store: recordStore,
+         index: index,
+         data: data,
+         type: "data",
+         key: this.keyField && isObject(data) ? (data as any)[this.keyField] : index,
+      };
+   }
+
+   public setFilter(filterFn?: (data: T) => boolean): void {
+      this.filterFn = filterFn;
+   }
+
+   public getComparer(sortOptions?: CollatorOptions): ((a: any, b: any) => number) | undefined {
+      return sortOptions ? Culture.getComparer(sortOptions) : undefined;
+   }
+
+   public buildSorter(sorters: ExtendedSorter[]): void {
+      if (isArray(sorters) && sorters.length > 0) {
+         let dataAccessor: (x: DataAdapterRecord<T>) => any;
+         let fieldValueMapper: (x: ExtendedSorter) => Prop<any>;
+
+         if (sorters.every((x) => x.field && x.value == null)) {
+            dataAccessor = (x) => x.data;
+            fieldValueMapper = (x) => ({ bind: x.field! });
+         } else {
+            dataAccessor = (x) => x.store.getData();
+            fieldValueMapper = (x) => ({ bind: this.recordName + "." + x.field });
+         }
+
+         this.sorter = sorter(
+            sorters.map((x) => {
+               const s: ExtendedSorter = Object.assign({}, x);
+               if (s.field && s.value == null) {
+                  s.value = fieldValueMapper(s);
+               }
+               if (!s.comparer) {
+                  s.comparer = this.getComparer(isDefined(s.sortOptions) ? s.sortOptions : this.sortOptions);
+               }
+               return s;
+            }),
+            dataAccessor,
+         );
+      } else {
+         this.sorter = undefined;
+      }
+   }
+
+   public sort(sorters?: Sorter[] | ExtendedSorter[]): void {
+      if (sorters) {
+         this.buildSorter(sorters as ExtendedSorter[]);
+      }
+   }
+}
+
+ArrayAdapter.prototype.immutable = false;
+ArrayAdapter.prototype.sealed = false;
+ArrayAdapter.prototype.keyField = null;
+ArrayAdapter.prototype.cacheByKeyField = true;
+ArrayAdapter.prototype.isTreeAdapter = false;
+
+ArrayAdapter.autoInit = true;

package/src/ui/adapter/GroupAdapter.ts

@@ -1,17 +1,15 @@
-import { ArrayAdapter, ArrayAdapterConfig, RecordStoreCache } from "./ArrayAdapter";
-import { DataAdapterRecord } from "./DataAdapter";
-import { ReadOnlyDataView } from "../../data/ReadOnlyDataView";
+import { getComparer } from "../../data/comparer";
 import { Grouper } from "../../data/Grouper";
+import { ReadOnlyDataView } from "../../data/ReadOnlyDataView";
+import { View } from "../../data/View";
+import { isDataRecord } from "../../util";
 import { isArray } from "../../util/isArray";
-import { isDefined } from "../../util/isDefined";
-import { getComparer } from "../../data/comparer";
 import { Culture } from "../Culture";
-import { isObject } from "../../util/isObject";
-import { RenderingContext } from "../RenderingContext";
 import { Instance } from "../Instance";
-import { View } from "../../data/View";
-import { Prop, Sorter, SortDirection, StructuredProp } from "../Prop";
-import { isDataRecord } from "../../util";
+import { Prop, SortDirection, Sorter, StructuredProp } from "../Prop";
+import { RenderingContext } from "../RenderingContext";
+import { ArrayAdapter, ArrayAdapterConfig, RecordStoreCache } from "./ArrayAdapter";
+import { DataAdapterRecord } from "./DataAdapter";
 
 export interface GroupKey {
    [field: string]: Prop<any> | { value: Prop<any>; direction: SortDirection };

package/src/ui/adapter/TreeAdapter.ts

@@ -1,13 +1,17 @@
 import { Accessor, getAccessor } from "../../data/getAccessor";
 import { isArray } from "../../util/isArray";
-import { ArrayAdapter, ArrayAdapterConfig, RecordStoreCache } from "./ArrayAdapter";
+import {
+   ArrayAdapter,
+   ArrayAdapterConfig,
+   RecordStoreCache,
+} from "./ArrayAdapter";
 import { DataAdapterRecord } from "./DataAdapter";
 import { RenderingContext } from "../RenderingContext";
 import { Instance } from "../Instance";
 import { View } from "../../data/View";
 import { Sorter } from "../Prop";
 
-export interface TreeNode {
+export interface DefaultTreeNode {
    $level?: number;
    $expanded?: boolean;
    $leaf?: boolean;
@@ -31,10 +35,21 @@ export interface TreeAdapterConfig extends ArrayAdapterConfig {
    foldersFirst?: boolean;
    hideRootNodes?: boolean;
    restoreExpandedNodesOnLoad?: boolean;
-   load?: (context: RenderingContext, instance: Instance, data: TreeNode) => Promise<any[]> | any[];
+   load?: (
+      context: RenderingContext,
+      instance: Instance,
+      node: any,
+   ) => Promise<any[] | null | undefined> | any[] | null | undefined;
+   onLoad?: (
+      context: RenderingContext,
+      instance: Instance,
+      node: any,
+   ) => Promise<any[] | null | undefined> | any[] | null | undefined;
 }
 
-export class TreeAdapter<T extends TreeNode = TreeNode> extends ArrayAdapter<T> {
+export class TreeAdapter<
+   T extends object = DefaultTreeNode,
+> extends ArrayAdapter<T> {
    declare public childrenField: string;
    declare public expandedField: string;
    declare public leafField: string;
@@ -44,7 +59,17 @@ export class TreeAdapter<T extends TreeNode = TreeNode> extends ArrayAdapter<T>
    declare public foldersFirst: boolean;
    declare public hideRootNodes: boolean;
    declare public restoreExpandedNodesOnLoad?: boolean;
-   declare public load?: (context: RenderingContext, instance: Instance, data: T) => Promise<any[]> | any[];
+   declare public load?: (
+      context: RenderingContext,
+      instance: Instance,
+      data: T,
+   ) => Promise<any[]> | any[];
+
+   declare public onLoad?: (
+      context: RenderingContext,
+      instance: Instance,
+      data: T,
+   ) => Promise<any[]> | any[];
 
    declare protected childrenAccessor?: Accessor;
    declare protected expandedState?: ExpandedState;
@@ -55,7 +80,9 @@ export class TreeAdapter<T extends TreeNode = TreeNode> extends ArrayAdapter<T>
 
    public init(): void {
       super.init();
-      this.childrenAccessor = getAccessor({ bind: `${this.recordName}.${this.childrenField}` });
+      this.childrenAccessor = getAccessor({
+         bind: `${this.recordName}.${this.childrenField}`,
+      });
 
       if (this.restoreExpandedNodesOnLoad) {
          if (!this.keyField) {
@@ -68,6 +95,8 @@ export class TreeAdapter<T extends TreeNode = TreeNode> extends ArrayAdapter<T>
             next: new Set(),
          };
       }
+
+      if (this.load) this.onLoad = this.load;
    }
 
    public mapRecords(
@@ -77,7 +106,13 @@ export class TreeAdapter<T extends TreeNode = TreeNode> extends ArrayAdapter<T>
       parentStore: View,
       recordsAccessor?: Accessor,
    ): DataAdapterRecord<T>[] {
-      const nodes = super.mapRecords(context, instance, data, parentStore, recordsAccessor);
+      const nodes = super.mapRecords(
+         context,
+         instance,
+         data,
+         parentStore,
+         recordsAccessor,
+      );
       const result: DataAdapterRecord<T>[] = [];
 
       if (this.restoreExpandedNodesOnLoad) {
@@ -123,8 +158,13 @@ export class TreeAdapter<T extends TreeNode = TreeNode> extends ArrayAdapter<T>
       dataRecord.$level = this.hideRootNodes ? level - 1 : level;
 
       if (!dataRecord[this.leafField]) {
-         if (this.restoreExpandedNodesOnLoad && dataRecord[this.expandedField] == null) {
-            dataRecord[this.expandedField] = this.expandedState!.current!.has(dataRecord[this.keyField!]);
+         if (
+            this.restoreExpandedNodesOnLoad &&
+            dataRecord[this.expandedField] == null
+         ) {
+            dataRecord[this.expandedField] = this.expandedState!.current!.has(
+               dataRecord[this.keyField!],
+            );
          }
 
          if (dataRecord[this.expandedField] || isHiddenRootNode) {
@@ -140,18 +180,38 @@ export class TreeAdapter<T extends TreeNode = TreeNode> extends ArrayAdapter<T>
                   store,
                   this.childrenAccessor,
                );
-               this.processList(context, instance, level + 1, record.key + ":", childNodes, result);
-            } else if (this.load && !dataRecord[this.loadedField] && !dataRecord[this.loadingField]) {
+               this.processList(
+                  context,
+                  instance,
+                  level + 1,
+                  record.key + ":",
+                  childNodes,
+                  result,
+               );
+            } else if (
+               this.onLoad &&
+               !dataRecord[this.loadedField] &&
+               !dataRecord[this.loadingField]
+            ) {
                store.set(`${this.recordName}.${this.loadingField}`, true);
-               const response = this.load(context, instance, data);
+               const response = this.onLoad(context, instance, data);
                Promise.resolve(response)
                   .then((children) => {
-                     store.set(`${this.recordName}.${this.childrenField}`, children);
+                     store.set(
+                        `${this.recordName}.${this.childrenField}`,
+                        children,
+                     );
                      store.set(`${this.recordName}.${this.loadedField}`, true);
-                     store.set(`${this.recordName}.${this.loadingField}`, false);
+                     store.set(
+                        `${this.recordName}.${this.loadingField}`,
+                        false,
+                     );
                   })
                   .catch((response) => {
-                     store.set(`${this.recordName}.${this.loadingField}`, false);
+                     store.set(
+                        `${this.recordName}.${this.loadingField}`,
+                        false,
+                     );
                      if (this.onLoadError) {
                         this.onLoadError(response);
                      }

package/src/ui/app/Url.spec.ts

@@ -1,5 +1,5 @@
 import { Url } from "./Url";
-import Route from "route-parser";
+import Route from "route-parser-ts";
 import assert from "assert";
 describe("Url", function () {
    describe(".unresolve", function () {