cx 25.11.1 → 26.0.2

package/src/ui/adapter/DataAdapter.ts

@@ -0,0 +1,52 @@
+import { Component } from "../../util/Component";
+import { Instance } from "../Instance";
+import { View } from "../../data/View";
+import { RenderingContext } from "../RenderingContext";
+import { Sorter } from "../Prop";
+
+export type DataAdapterRecordType = "data" | "group-header" | "group-footer";
+
+export interface DataAdapterRecord<T = any> {
+   data: T;
+   index?: number;
+   key: string;
+   store: View;
+   type?: DataAdapterRecordType;
+}
+
+export interface DataAdapterConfig {
+   recordName?: string;
+   indexName?: string;
+   immutable?: boolean;
+   sealed?: boolean;
+}
+
+export abstract class DataAdapter<T = any> extends Component {
+   declare public recordName: string;
+   declare public indexName: string;
+   declare public immutable: boolean;
+   declare public sealed?: boolean;
+
+   declare protected filterFn?: (data: T) => boolean;
+
+   constructor(config?: DataAdapterConfig) {
+      super(config);
+   }
+
+   public abstract getRecords(
+      context: RenderingContext,
+      instance: Instance,
+      records: T[],
+      parentStore: View,
+   ): DataAdapterRecord<T>[];
+
+   public setFilter(filterFn?: (data: T) => boolean): void {
+      this.filterFn = filterFn;
+   }
+
+   public sort(sorters?: Sorter[]): void {}
+}
+
+DataAdapter.prototype.recordName = "$record";
+DataAdapter.prototype.indexName = "$index";
+DataAdapter.prototype.immutable = false;

package/src/ui/adapter/GroupAdapter.ts

@@ -0,0 +1,235 @@
+import { ArrayAdapter, ArrayAdapterConfig, RecordStoreCache } from "./ArrayAdapter";
+import { DataAdapterRecord } from "./DataAdapter";
+import { ReadOnlyDataView } from "../../data/ReadOnlyDataView";
+import { Grouper } from "../../data/Grouper";
+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";
+
+export interface GroupKey {
+   [field: string]: Prop<any> | { value: Prop<any>; direction: SortDirection };
+}
+
+export interface GroupingConfig {
+   key: GroupKey;
+   aggregates?: StructuredProp;
+   text?: Prop<string>;
+   includeHeader?: boolean;
+   includeFooter?: boolean;
+   comparer?: ((a: any, b: any) => number) | null;
+   header?: any;
+   footer?: any;
+}
+
+export interface ResolvedGrouping extends GroupingConfig {
+   grouper: Grouper;
+}
+
+export interface GroupData {
+   $name: string;
+   $level: number;
+   $records: DataAdapterRecord<any>[];
+   $key: string;
+   [key: string]: any;
+}
+
+export interface GroupAdapterRecord<T = any> extends DataAdapterRecord<T> {
+   group?: GroupData;
+   grouping?: ResolvedGrouping;
+   level?: number;
+}
+
+export interface GroupAdapterConfig extends ArrayAdapterConfig {
+   aggregates?: StructuredProp;
+   groupRecordsAlias?: string;
+   groupRecordsName?: string;
+   groupings?: GroupingConfig[] | null;
+   groupName?: string;
+}
+
+export class GroupAdapter<T = any> extends ArrayAdapter<T> {
+   declare public aggregates?: StructuredProp;
+   declare public groupRecordsAlias?: string;
+   declare public groupRecordsName?: string;
+   declare public groupings?: ResolvedGrouping[] | null;
+   declare public groupName: string;
+
+   constructor(config?: GroupAdapterConfig) {
+      super(config);
+   }
+
+   public init(): void {
+      super.init();
+
+      if (this.groupRecordsAlias) {
+         this.groupRecordsName = this.groupRecordsAlias;
+      }
+
+      if (this.groupings) {
+         this.groupBy(this.groupings);
+      }
+   }
+
+   public getRecords(
+      context: RenderingContext,
+      instance: Instance & Partial<RecordStoreCache>,
+      records: T[],
+      parentStore: View,
+   ): DataAdapterRecord<T>[] {
+      let result = super.getRecords(context, instance, records, parentStore);
+
+      if (this.groupings) {
+         const groupedResults: DataAdapterRecord<T>[] = [];
+         this.processLevel([], result, groupedResults, parentStore);
+         result = groupedResults;
+      }
+
+      return result;
+   }
+
+   protected processLevel(
+      keys: any[],
+      records: DataAdapterRecord<T>[],
+      result: DataAdapterRecord<T>[],
+      parentStore: View,
+   ): void {
+      const level = keys.length;
+      const inverseLevel = this.groupings!.length - level;
+
+      if (inverseLevel === 0) {
+         if (this.preserveOrder && this.sorter) records = this.sorter(records);
+         for (let i = 0; i < records.length; i++) {
+            (records[i].store as ReadOnlyDataView).setStore(parentStore);
+            result.push(records[i]);
+         }
+         return;
+      }
+
+      const grouping = this.groupings![level];
+      const { grouper } = grouping;
+      grouper.reset();
+      grouper.processAll(records);
+      let results = grouper.getResults();
+
+      if (grouping.comparer && !this.preserveOrder) {
+         results.sort(grouping.comparer);
+      }
+
+      results.forEach((gr) => {
+         keys.push(gr.key);
+
+         const key = keys.map(serializeKey).join("|");
+
+         const $group: GroupData = {
+            ...gr.key,
+            ...gr.aggregates,
+            $name: gr.name,
+            $level: inverseLevel,
+            $records: gr.records || [],
+            $key: key,
+         };
+
+         const data = {
+            [this.recordName]: gr.records.length > 0 ? gr.records[0].data : null,
+            [this.groupName]: $group,
+         };
+
+         const groupStore = new ReadOnlyDataView({
+            store: parentStore,
+            data,
+            immutable: this.immutable,
+         });
+
+         const group: GroupAdapterRecord<T> = {
+            key,
+            data: data as T,
+            group: $group,
+            grouping,
+            store: groupStore,
+            level: inverseLevel,
+         };
+
+         if (grouping.includeHeader !== false) {
+            result.push({
+               ...group,
+               type: "group-header",
+               key: "header:" + group.key,
+            });
+         }
+
+         this.processLevel(keys, gr.records, result, groupStore);
+
+         if (grouping.includeFooter !== false) {
+            result.push({
+               ...group,
+               type: "group-footer",
+               key: "footer:" + group.key,
+            });
+         }
+
+         keys.pop();
+      });
+   }
+
+   public groupBy(groupings: GroupingConfig[] | null): void {
+      if (!groupings) {
+         this.groupings = null;
+      } else if (isArray(groupings)) {
+         this.groupings = groupings as unknown as ResolvedGrouping[];
+         this.groupings.forEach((g) => {
+            const groupSorters: Sorter[] = [];
+            const key: Record<string, Prop<any>> = {};
+
+            for (const name in g.key) {
+               const keyConfig = g.key[name];
+               if (!keyConfig || typeof keyConfig !== "object" || !("value" in keyConfig)) {
+                  g.key[name] = { value: keyConfig as Prop<any>, direction: "ASC" };
+               }
+
+               const resolvedKey = g.key[name] as { value: Prop<any>; direction: SortDirection };
+               key[name] = resolvedKey.value;
+               groupSorters.push({
+                  field: name,
+                  direction: resolvedKey.direction,
+               });
+            }
+
+            g.grouper = new Grouper(
+               key,
+               { ...this.aggregates, ...g.aggregates },
+               (r: DataAdapterRecord<T>) => r.store.getData(),
+               g.text,
+            );
+
+            if (g.comparer == null && groupSorters.length > 0) {
+               g.comparer = getComparer(
+                  groupSorters,
+                  (x: any) => x.key,
+                  this.sortOptions ? Culture.getComparer(this.sortOptions) : undefined,
+               );
+            }
+         });
+      } else {
+         throw new Error("Invalid grouping provided.");
+      }
+   }
+}
+
+GroupAdapter.prototype.groupName = "$group";
+GroupAdapter.prototype.preserveOrder = false;
+
+function serializeKey(data: any): string {
+   if (isDataRecord(data)) {
+      return Object.keys(data)
+         .map((k) => serializeKey(data[k]))
+         .join(":");
+   }
+   return data?.toString() ?? "";
+}

package/src/ui/adapter/TreeAdapter.spec.ts

@@ -0,0 +1,76 @@
+import { RenderingContext } from "../RenderingContext";
+import { Instance } from "../Instance";
+import { TreeAdapter } from "./TreeAdapter";
+import assert from "assert";
+import { Store } from "../../data";
+
+describe("TreeAdapter", () => {
+   it("properly expands records", () => {
+      let tree = new TreeAdapter({
+         childrenField: "children",
+         expandedField: "expanded",
+      });
+
+      let data = [
+         {
+            id: 1,
+            text: "1",
+            expanded: false,
+            children: [
+               {
+                  id: 4,
+                  text: "4",
+               },
+            ],
+         },
+         {
+            id: 2,
+            text: "2",
+            expanded: true,
+            children: [
+               {
+                  id: 3,
+                  text: "3",
+                  expanded: true,
+                  children: [
+                     {
+                        id: 5,
+                        text: "5",
+                        expanded: true,
+                        children: [
+                           {
+                              id: 6,
+                              text: "6",
+                           },
+                        ],
+                     },
+                  ],
+               },
+            ],
+         },
+         {
+            id: 7,
+            text: "7",
+            expanded: false,
+         },
+      ];
+
+      let store = new Store();
+
+      let records = tree.mapRecords(new RenderingContext(), new Instance(null!, "1", null!, store), data, store);
+
+      assert.equal(records.length, 6);
+      assert.equal(records[0].data.id, 1);
+      assert.equal(records[1].data.id, 2);
+      assert.equal(records[2].data.id, 3);
+      assert.equal(records[3].data.id, 5);
+      assert.equal(records[4].data.id, 6);
+      assert.equal(records[5].data.id, 7);
+      assert.equal(records[5].store.get("$record.id"), 7);
+      assert.equal(records[2].store.get("$record.id"), 3);
+      assert.equal(records[3].store.get("$record.id"), 5);
+      assert.equal(records[2].store.get("$record.id"), 3);
+      assert.equal(records[0].store.get("$record.id"), 1);
+      assert.equal(records[1].store.get("$record.id"), 2);
+   });
+});

package/src/ui/adapter/TreeAdapter.ts

@@ -0,0 +1,185 @@
+import { Accessor, getAccessor } from "../../data/getAccessor";
+import { isArray } from "../../util/isArray";
+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 {
+   $level?: number;
+   $expanded?: boolean;
+   $leaf?: boolean;
+   $loading?: boolean;
+   $loaded?: boolean;
+   [key: string]: any;
+}
+
+export interface ExpandedState {
+   current?: Set<string | number>;
+   next: Set<string | number>;
+}
+
+export interface TreeAdapterConfig extends ArrayAdapterConfig {
+   childrenField?: string;
+   expandedField?: string;
+   leafField?: string;
+   loadingField?: string;
+   loadedField?: string;
+   onLoadError?: (response: any) => void;
+   foldersFirst?: boolean;
+   hideRootNodes?: boolean;
+   restoreExpandedNodesOnLoad?: boolean;
+   load?: (context: RenderingContext, instance: Instance, data: TreeNode) => Promise<any[]> | any[];
+}
+
+export class TreeAdapter<T extends TreeNode = TreeNode> extends ArrayAdapter<T> {
+   declare public childrenField: string;
+   declare public expandedField: string;
+   declare public leafField: string;
+   declare public loadingField: string;
+   declare public loadedField: string;
+   declare public onLoadError?: (response: any) => void;
+   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 protected childrenAccessor?: Accessor;
+   declare protected expandedState?: ExpandedState;
+
+   constructor(config?: TreeAdapterConfig) {
+      super(config);
+   }
+
+   public init(): void {
+      super.init();
+      this.childrenAccessor = getAccessor({ bind: `${this.recordName}.${this.childrenField}` });
+
+      if (this.restoreExpandedNodesOnLoad) {
+         if (!this.keyField) {
+            throw new Error(
+               "Stateful tree adapter requires keyField property to be specified on either Grid or data adapter.",
+            );
+         }
+
+         this.expandedState = {
+            next: new Set(),
+         };
+      }
+   }
+
+   public mapRecords(
+      context: RenderingContext,
+      instance: Instance & Partial<RecordStoreCache>,
+      data: T[],
+      parentStore: View,
+      recordsAccessor?: Accessor,
+   ): DataAdapterRecord<T>[] {
+      const nodes = super.mapRecords(context, instance, data, parentStore, recordsAccessor);
+      const result: DataAdapterRecord<T>[] = [];
+
+      if (this.restoreExpandedNodesOnLoad) {
+         this.expandedState = {
+            current: this.expandedState!.next,
+            next: new Set(),
+         };
+      }
+
+      this.processList(context, instance, 0, "", nodes, result);
+
+      return result;
+   }
+
+   protected processList(
+      context: RenderingContext,
+      instance: Instance & Partial<RecordStoreCache>,
+      level: number,
+      parentKey: string,
+      nodes: DataAdapterRecord<T>[],
+      result: DataAdapterRecord<T>[],
+   ): void {
+      nodes.forEach((record) => {
+         record.key = parentKey + record.key;
+         this.processNode(context, instance, level, result, record);
+      });
+   }
+
+   protected processNode(
+      context: RenderingContext,
+      instance: Instance & Partial<RecordStoreCache>,
+      level: number,
+      result: DataAdapterRecord<T>[],
+      record: DataAdapterRecord<T>,
+   ): void {
+      const isHiddenRootNode = level === 0 && this.hideRootNodes;
+      if (!isHiddenRootNode) {
+         result.push(record);
+      }
+
+      const { data, store } = record;
+      const dataRecord = data as any;
+      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 (dataRecord[this.expandedField] || isHiddenRootNode) {
+            if (this.restoreExpandedNodesOnLoad) {
+               this.expandedState!.next.add(dataRecord[this.keyField!]);
+            }
+
+            if (dataRecord[this.childrenField]) {
+               const childNodes = super.mapRecords(
+                  context,
+                  instance,
+                  dataRecord[this.childrenField],
+                  store,
+                  this.childrenAccessor,
+               );
+               this.processList(context, instance, level + 1, record.key + ":", childNodes, result);
+            } else if (this.load && !dataRecord[this.loadedField] && !dataRecord[this.loadingField]) {
+               store.set(`${this.recordName}.${this.loadingField}`, true);
+               const response = this.load(context, instance, data);
+               Promise.resolve(response)
+                  .then((children) => {
+                     store.set(`${this.recordName}.${this.childrenField}`, children);
+                     store.set(`${this.recordName}.${this.loadedField}`, true);
+                     store.set(`${this.recordName}.${this.loadingField}`, false);
+                  })
+                  .catch((response) => {
+                     store.set(`${this.recordName}.${this.loadingField}`, false);
+                     if (this.onLoadError) {
+                        this.onLoadError(response);
+                     }
+                  });
+            }
+         } else {
+            dataRecord[this.expandedField] = false;
+         }
+      }
+   }
+
+   public sort(sorters?: Sorter[]): void {
+      if (this.foldersFirst) {
+         if (!sorters || !isArray(sorters)) {
+            sorters = [];
+         }
+         sorters = [{ field: this.leafField, direction: "ASC" }, ...sorters];
+      }
+      super.sort(sorters);
+   }
+}
+
+TreeAdapter.prototype.childrenField = "$children";
+TreeAdapter.prototype.expandedField = "$expanded";
+TreeAdapter.prototype.leafField = "$leaf";
+TreeAdapter.prototype.loadingField = "$loading";
+TreeAdapter.prototype.loadedField = "$loaded";
+TreeAdapter.prototype.foldersFirst = true;
+TreeAdapter.prototype.isTreeAdapter = true;
+TreeAdapter.prototype.hideRootNodes = false;
+TreeAdapter.prototype.cacheByKeyField = false;

package/src/ui/app/History.ts

@@ -0,0 +1,133 @@
+import { Url } from "./Url";
+import { batchUpdatesAndNotify } from "../batchUpdates";
+import { SubscriberList } from "../../util/SubscriberList";
+import { View } from "../../data/View";
+
+interface Transition {
+   url: string;
+   state: any;
+   title: string | null;
+   replace: boolean;
+   completed?: boolean;
+}
+
+type NavigateConfirmationCallback = (state: any) => boolean | Promise<boolean>;
+
+let last = 0;
+let next = 1;
+let transitions: Record<number, Transition> = {};
+let subscribers: SubscriberList | null = null;
+let reload = false;
+let navigateConfirmationCallback: NavigateConfirmationCallback | null = null;
+let permanentNavigateConfirmation = false;
+
+export class History {
+   static store: View;
+   static urlBinding: string;
+   static hashBinding?: string;
+
+   static connect(store: View, urlBinding: string, hashBinding?: string): void {
+      this.store = store;
+      this.urlBinding = urlBinding;
+      this.hashBinding = hashBinding;
+      this.updateStore();
+      window.onpopstate = () => {
+         this.updateStore();
+      };
+   }
+
+   static pushState(state: any, title: string | null, url: string): boolean {
+      return this.confirmAndNavigate(state, title, url);
+   }
+
+   static replaceState(state: any, title: string | null, url: string): boolean {
+      return this.navigate(state, title, url, true);
+   }
+
+   static reloadOnNextChange(): void {
+      reload = true;
+   }
+
+   static addNavigateConfirmation(callback: NavigateConfirmationCallback, permanent = false): void {
+      navigateConfirmationCallback = callback;
+      permanentNavigateConfirmation = permanent;
+   }
+
+   static confirm(continueCallback: () => boolean, state: any): boolean {
+      if (!navigateConfirmationCallback) return continueCallback();
+
+      let result = navigateConfirmationCallback(state);
+      Promise.resolve(result).then((value) => {
+         if (value) {
+            if (!permanentNavigateConfirmation) navigateConfirmationCallback = null;
+            continueCallback();
+         }
+      });
+
+      return false;
+   }
+
+   static confirmAndNavigate(state: any, title: string | null, url: string, replace?: boolean): boolean {
+      return this.confirm(() => this.navigate(state, title, url, replace), url);
+   }
+
+   static navigate(state: any, title: string | null, url: string, replace = false): boolean {
+      url = Url.resolve(url);
+
+      if (!window.history.pushState || reload) {
+         window.location[replace ? "replace" : "assign"](url);
+         return true;
+      }
+
+      let transition: Transition | undefined;
+      let changed = false;
+      batchUpdatesAndNotify(
+         () => {
+            changed = this.updateStore(url);
+            if (changed)
+               transitions[++last] = transition = {
+                  url,
+                  state,
+                  title,
+                  replace,
+               };
+         },
+         () => {
+            if (transition) transition.completed = true;
+
+            //update history once the page is rendered and the title is set
+            while (transitions[next] && transitions[next].completed) {
+               let tr = transitions[next];
+               delete transitions[next];
+               next++;
+               if (tr.replace) {
+                  window.history.replaceState(tr.state, tr.title ?? "", tr.url);
+                  if (subscribers) subscribers.notify(tr.url, "replaceState");
+               } else {
+                  window.history.pushState(tr.state, tr.title ?? "", tr.url);
+                  if (subscribers) subscribers.notify(tr.url, "pushState");
+               }
+            }
+         },
+      );
+
+      return changed;
+   }
+
+   static updateStore(href?: string): boolean {
+      let url = Url.unresolve(href || document.location.href);
+      let hash: string | null = null;
+      let hashIndex = url.indexOf("#");
+      if (hashIndex !== -1) {
+         hash = url.substring(hashIndex);
+         url = url.substring(0, hashIndex);
+      }
+      if (this.hashBinding) this.store.set(this.hashBinding, hash);
+      return this.store.set(this.urlBinding, url);
+   }
+
+   static subscribe(callback: (url: string, op: string) => void): () => void {
+      if (!subscribers) subscribers = new SubscriberList();
+      return subscribers.subscribe(callback);
+   }
+}