cx 26.3.10 → 26.4.1

package/src/ui/Repeater.spec.tsx

@@ -2,6 +2,7 @@ import { Store } from "../data/Store";
 import { Repeater } from "./Repeater";
 import { bind } from "./bind";
 import { createTestRenderer, act } from "../util/test/createTestRenderer";
+import { createAccessorModelProxy } from "../data/createAccessorModelProxy";
 
 import assert from "assert";
 
@@ -140,4 +141,41 @@ describe("Repeater", () => {
       assert.equal(divInstances[1].store.get("$item.value"), "B");
       assert.equal(divInstances[2].store.get("$item.value"), "C");
    });
+
+   it("infers T from AccessorChain<T[]> for onCreateFilter callback", () => {
+      interface Item {
+         name: string;
+         active: boolean;
+      }
+
+      interface AppModel {
+         items: Item[];
+         $item: Item;
+      }
+
+      const m = createAccessorModelProxy<AppModel>();
+
+      // onCreateFilter should receive (record: Item) => boolean when T is inferred from AccessorChain<Item[]>
+      const widget = (
+         <cx>
+            <div>
+               <Repeater
+                  records={m.items}
+                  recordAlias={m.$item}
+                  onCreateFilter={() => (record) => {
+                     // If T is correctly inferred as Item, record.name should be string
+                     const name: string = record.name;
+                     // @ts-expect-error - record.name should be string, not number
+                     const wrong: number = record.name;
+                     return record.active;
+                  }}
+               >
+                  <div text={m.$item.name} />
+               </Repeater>
+            </div>
+         </cx>
+      );
+
+      assert.ok(widget);
+   });
 });

package/src/ui/Rescope.ts

@@ -1,50 +1,50 @@
-import { Widget } from "./Widget";
-import { PureContainerBase, PureContainerConfig } from "./PureContainer";
-import { Binding } from "../data/Binding";
-import { ZoomIntoPropertyView } from "../data/ZoomIntoPropertyView";
-import { StructuredInstanceDataAccessor } from "./StructuredInstanceDataAccessor";
-import { isObject } from "../util/isObject";
-import { StructuredProp } from "./Prop";
-import { AccessorChain } from "../data/createAccessorModelProxy";
-
-export interface RescopeConfig extends PureContainerConfig {
-   bind: string | AccessorChain<any>;
-   rootName?: string | AccessorChain<any>;
-   rootAlias?: string | AccessorChain<any>;
-   data?: StructuredProp;
-}
-
-export class Rescope extends PureContainerBase<RescopeConfig> {
-   declare bind: string;
-   declare binding: any;
-   declare rootAlias?: string;
-   declare rootName: string;
-   declare data?: any;
-
-   init() {
-      this.binding = Binding.get(this.bind);
-      if (this.rootAlias) this.rootName = this.rootAlias;
-      super.init();
-   }
-
-   initInstance(context: any, instance: any) {
-      instance.store = new ZoomIntoPropertyView({
-         store: instance.parentStore,
-         binding: this.binding,
-         rootName: this.rootName,
-         nestedData: isObject(this.data)
-            ? new StructuredInstanceDataAccessor({ instance, data: this.data, useParentStore: true })
-            : undefined,
-      });
-      super.initInstance(context, instance);
-   }
-
-   applyParentStore(instance: any) {
-      instance.store.setStore(instance.parentStore);
-   }
-}
-
-Rescope.prototype.bind = "$page";
-Rescope.prototype.rootName = "$root";
-
-Widget.alias("rescope", Rescope);
+import { Widget } from "./Widget";
+import { PureContainerBase, PureContainerConfig } from "./PureContainer";
+import { Binding } from "../data/Binding";
+import { ZoomIntoPropertyView } from "../data/ZoomIntoPropertyView";
+import { StructuredInstanceDataAccessor } from "./StructuredInstanceDataAccessor";
+import { isObject } from "../util/isObject";
+import { StructuredProp } from "./Prop";
+import { AccessorChain } from "../data/createAccessorModelProxy";
+
+export interface RescopeConfig extends PureContainerConfig {
+   bind: string | AccessorChain<any>;
+   rootName?: string | AccessorChain<any>;
+   rootAlias?: string | AccessorChain<any>;
+   data?: StructuredProp;
+}
+
+export class Rescope extends PureContainerBase<RescopeConfig> {
+   declare bind: string;
+   declare binding: any;
+   declare rootAlias?: string;
+   declare rootName: string;
+   declare data?: any;
+
+   init() {
+      this.binding = Binding.get(this.bind);
+      if (this.rootAlias) this.rootName = this.rootAlias;
+      super.init();
+   }
+
+   initInstance(context: any, instance: any) {
+      instance.store = new ZoomIntoPropertyView({
+         store: instance.parentStore,
+         binding: this.binding,
+         rootName: this.rootName,
+         nestedData: isObject(this.data)
+            ? new StructuredInstanceDataAccessor({ instance, data: this.data, useParentStore: true })
+            : undefined,
+      });
+      super.initInstance(context, instance);
+   }
+
+   applyParentStore(instance: any) {
+      instance.store.setStore(instance.parentStore);
+   }
+}
+
+Rescope.prototype.bind = "$page";
+Rescope.prototype.rootName = "$root";
+
+Widget.alias("rescope", Rescope);

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;