cx 24.4.3 → 24.4.4

package/src/ui/Repeater.d.ts

@@ -1,60 +1,60 @@
-import {
-   RecordsProp,
-   RecordAlias,
-   StringProp,
-   SortersProp,
-   StructuredProp,
-   CollatorOptions,
-   Widget,
-   PureContainerProps,
-   Prop,
-   SortDirection,
-} from "../core";
-import { Instance } from "./Instance";
-
-interface RepeaterProps<T = unknown> extends PureContainerProps {
-   records: Prop<T[]>;
-   recordName?: RecordAlias;
-   recordAlias?: RecordAlias;
-   indexName?: RecordAlias;
-   indexAlias?: RecordAlias;
-   cached?: boolean;
-
-   /** Indicate that parent store data should not be mutated. */
-   immutable?: boolean;
-
-   /** Indicate that record stores should not be mutated. */
-   sealed?: boolean;
-
-   sorters?: SortersProp;
-
-   /** A binding used to store the name of the field used for sorting the collection. Available only if `sorters` are not used. */
-   sortField?: StringProp;
-
-   /** A binding used to store the sort direction. Available only if `sorters` are not used. Possible values are `"ASC"` and `"DESC"`. Defaults to `"ASC"`. */
-   sortDirection?: Prop<SortDirection>;
-
-   /** Parameters that affect filtering */
-   filterParams?: StructuredProp;
-
-   /** Callback to create a filter function for given filter params. */
-   onCreateFilter?: (filterParams: any, instance: Instance) => (record: T) => boolean;
-
-   /**
-    * Callback function to track and retrieve displayed records.
-    * Accepts new records as a first argument.
-    * If onCreateFilter callback is defined, filtered records can be retrieved using this callback.
-    */
-   onTrackMappedRecords?: string | ((records: T[], instance: Instance) => void);
-
-   /** Options for data sorting. See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator */
-   sortOptions?: CollatorOptions;
-
-   /** A field used to get the unique identifier of the record. Setting keyField improves performance on sort operations as the widget is able to movement of records inside the collection.  */
-   keyField?: StringProp;
-
-   /** Data adapter used to convert data in the list of records. Used for manipulation of records, e.g flattening the tree records. */
-   dataAdapter?: any;
-}
-
-export class Repeater<T = unknown> extends Widget<RepeaterProps<T>> {}
+import {
+   RecordsProp,
+   RecordAlias,
+   StringProp,
+   SortersProp,
+   StructuredProp,
+   CollatorOptions,
+   Widget,
+   PureContainerProps,
+   Prop,
+   SortDirection,
+} from "../core";
+import { Instance } from "./Instance";
+
+interface RepeaterProps<T = unknown> extends PureContainerProps {
+   records: Prop<T[]>;
+   recordName?: RecordAlias;
+   recordAlias?: RecordAlias;
+   indexName?: RecordAlias;
+   indexAlias?: RecordAlias;
+   cached?: boolean;
+
+   /** Indicate that parent store data should not be mutated. */
+   immutable?: boolean;
+
+   /** Indicate that record stores should not be mutated. */
+   sealed?: boolean;
+
+   sorters?: SortersProp;
+
+   /** A binding used to store the name of the field used for sorting the collection. Available only if `sorters` are not used. */
+   sortField?: StringProp;
+
+   /** A binding used to store the sort direction. Available only if `sorters` are not used. Possible values are `"ASC"` and `"DESC"`. Defaults to `"ASC"`. */
+   sortDirection?: Prop<SortDirection>;
+
+   /** Parameters that affect filtering */
+   filterParams?: StructuredProp;
+
+   /** Callback to create a filter function for given filter params. */
+   onCreateFilter?: (filterParams: any, instance: Instance) => (record: T) => boolean;
+
+   /**
+    * Callback function to track and retrieve displayed records.
+    * Accepts new records as a first argument.
+    * If onCreateFilter callback is defined, filtered records can be retrieved using this callback.
+    */
+   onTrackMappedRecords?: string | ((records: T[], instance: Instance) => void);
+
+   /** Options for data sorting. See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator */
+   sortOptions?: CollatorOptions;
+
+   /** A field used to get the unique identifier of the record. Setting keyField improves performance on sort operations as the widget is able to movement of records inside the collection.  */
+   keyField?: StringProp;
+
+   /** Data adapter used to convert data in the list of records. Used for manipulation of records, e.g flattening the tree records. */
+   dataAdapter?: any;
+}
+
+export class Repeater<T = unknown> extends Widget<RepeaterProps<T>> {}

package/src/ui/Repeater.js

@@ -1,102 +1,102 @@
-import { Widget } from "./Widget";
-import { PureContainer } from "./PureContainer";
-import { Container } from "./Container";
-import { ArrayAdapter } from "./adapter/ArrayAdapter";
-import { UseParentLayout } from "./layout/UseParentLayout";
-import { getAccessor } from "../data/getAccessor";
-
-export class Repeater extends Container {
-   declareData() {
-      super.declareData(
-         {
-            records: undefined,
-            sorters: undefined,
-            sortField: undefined,
-            sortDirection: undefined,
-            filterParams: {
-               structured: true,
-            },
-         },
-         ...arguments
-      );
-   }
-
-   init() {
-      this.recordsAccessor = getAccessor(this.records);
-
-      if (this.recordAlias) this.recordName = this.recordAlias;
-
-      if (this.indexAlias) this.indexName = this.indexAlias;
-
-      this.dataAdapter = ArrayAdapter.create({
-         ...this.dataAdapter,
-         recordName: this.recordName,
-         indexName: this.indexName,
-         keyField: this.keyField,
-         immutable: this.immutable,
-         sealed: this.sealed,
-         recordsAccessor: this.recordsAccessor,
-         sortOptions: this.sortOptions,
-      });
-
-      this.item = PureContainer.create({
-         children: this.items || this.children,
-         layout: UseParentLayout,
-      });
-
-      delete this.children;
-      delete this.items;
-
-      super.init();
-   }
-
-   initInstance(context, instance) {
-      this.dataAdapter.initInstance(context, instance);
-   }
-
-   prepareData(context, instance) {
-      let { data } = instance;
-      if (data.sortField)
-         data.sorters = [
-            {
-               field: data.sortField,
-               direction: data.sortDirection || "ASC",
-            },
-         ];
-      this.dataAdapter.sort(data.sorters);
-      let filter = null;
-      if (this.onCreateFilter) filter = instance.invoke("onCreateFilter", data.filterParams, instance);
-      else if (this.filter) filter = (item) => this.filter(item, data.filterParams);
-      this.dataAdapter.setFilter(filter);
-      instance.mappedRecords = this.dataAdapter.getRecords(context, instance, data.records, instance.store);
-
-      if (this.onTrackMappedRecords) {
-         instance.invoke("onTrackMappedRecords", instance.mappedRecords, instance);
-      }
-
-      super.prepareData(context, instance);
-   }
-
-   explore(context, instance, data) {
-      let instances = [];
-      instance.mappedRecords.forEach((record) => {
-         let subInstance = instance.getChild(context, this.item, record.key, record.store);
-         let changed = subInstance.cache("recordData", record.data) || subInstance.cache("key", record.key);
-         subInstance.record = record;
-         if (this.cached && !changed && subInstance.visible && !subInstance.childStateDirty) {
-            instances.push(subInstance);
-            subInstance.shouldUpdate = false;
-         } else if (subInstance.scheduleExploreIfVisible(context)) instances.push(subInstance);
-      });
-      instance.children = instances;
-   }
-}
-
-Repeater.prototype.recordName = "$record";
-Repeater.prototype.indexName = "$index";
-Repeater.prototype.cached = false;
-Repeater.prototype.immutable = false;
-Repeater.prototype.sealed = false;
-Repeater.prototype.isPureContainer = true;
-
-Widget.alias("repeater", Repeater);
+import { Widget } from "./Widget";
+import { PureContainer } from "./PureContainer";
+import { Container } from "./Container";
+import { ArrayAdapter } from "./adapter/ArrayAdapter";
+import { UseParentLayout } from "./layout/UseParentLayout";
+import { getAccessor } from "../data/getAccessor";
+
+export class Repeater extends Container {
+   declareData() {
+      super.declareData(
+         {
+            records: undefined,
+            sorters: undefined,
+            sortField: undefined,
+            sortDirection: undefined,
+            filterParams: {
+               structured: true,
+            },
+         },
+         ...arguments
+      );
+   }
+
+   init() {
+      this.recordsAccessor = getAccessor(this.records);
+
+      if (this.recordAlias) this.recordName = this.recordAlias;
+
+      if (this.indexAlias) this.indexName = this.indexAlias;
+
+      this.dataAdapter = ArrayAdapter.create({
+         ...this.dataAdapter,
+         recordName: this.recordName,
+         indexName: this.indexName,
+         keyField: this.keyField,
+         immutable: this.immutable,
+         sealed: this.sealed,
+         recordsAccessor: this.recordsAccessor,
+         sortOptions: this.sortOptions,
+      });
+
+      this.item = PureContainer.create({
+         children: this.items || this.children,
+         layout: UseParentLayout,
+      });
+
+      delete this.children;
+      delete this.items;
+
+      super.init();
+   }
+
+   initInstance(context, instance) {
+      this.dataAdapter.initInstance(context, instance);
+   }
+
+   prepareData(context, instance) {
+      let { data } = instance;
+      if (data.sortField)
+         data.sorters = [
+            {
+               field: data.sortField,
+               direction: data.sortDirection || "ASC",
+            },
+         ];
+      this.dataAdapter.sort(data.sorters);
+      let filter = null;
+      if (this.onCreateFilter) filter = instance.invoke("onCreateFilter", data.filterParams, instance);
+      else if (this.filter) filter = (item) => this.filter(item, data.filterParams);
+      this.dataAdapter.setFilter(filter);
+      instance.mappedRecords = this.dataAdapter.getRecords(context, instance, data.records, instance.store);
+
+      if (this.onTrackMappedRecords) {
+         instance.invoke("onTrackMappedRecords", instance.mappedRecords, instance);
+      }
+
+      super.prepareData(context, instance);
+   }
+
+   explore(context, instance, data) {
+      let instances = [];
+      instance.mappedRecords.forEach((record) => {
+         let subInstance = instance.getChild(context, this.item, record.key, record.store);
+         let changed = subInstance.cache("recordData", record.data) || subInstance.cache("key", record.key);
+         subInstance.record = record;
+         if (this.cached && !changed && subInstance.visible && !subInstance.childStateDirty) {
+            instances.push(subInstance);
+            subInstance.shouldUpdate = false;
+         } else if (subInstance.scheduleExploreIfVisible(context)) instances.push(subInstance);
+      });
+      instance.children = instances;
+   }
+}
+
+Repeater.prototype.recordName = "$record";
+Repeater.prototype.indexName = "$index";
+Repeater.prototype.cached = false;
+Repeater.prototype.immutable = false;
+Repeater.prototype.sealed = false;
+Repeater.prototype.isPureContainer = true;
+
+Widget.alias("repeater", Repeater);

package/src/ui/Repeater.spec.js

@@ -1,143 +1,143 @@
-import { Cx } from "./Cx";
-import { VDOM } from "./Widget";
-import { HtmlElement } from "../widgets/HtmlElement";
-import { Store } from "../data/Store";
-import { Repeater } from "./Repeater";
-
-import renderer from "react-test-renderer";
-import assert from "assert";
-
-describe("Repeater", () => {
-   it("allows sorting", () => {
-      let data = [
-         {
-            value: "C",
-         },
-         {
-            value: "B",
-         },
-         {
-            value: "A",
-         },
-      ];
-
-      let widget = (
-         <cx>
-            <div>
-               <Repeater records={data} sorters={[{ field: "value", direction: "ASC" }]} recordAlias="$item">
-                  <div text:bind="$item.value" />
-               </Repeater>
-            </div>
-         </cx>
-      );
-
-      let store = new Store();
-
-      const component = renderer.create(<Cx widget={widget} store={store} subscribe immediate />);
-
-      let tree = component.toJSON();
-      assert.deepEqual(tree, {
-         type: "div",
-         props: {},
-         children: [
-            {
-               type: "div",
-               props: {},
-               children: ["A"],
-            },
-            {
-               type: "div",
-               props: {},
-               children: ["B"],
-            },
-            {
-               type: "div",
-               props: {},
-               children: ["C"],
-            },
-         ],
-      });
-   });
-
-   it("changes are properly updated", () => {
-      let divInstances = [];
-      let widget = (
-         <cx>
-            <div>
-               <Repeater records-bind="data" sorters={[{ field: "value", direction: "ASC" }]} recordAlias="$item">
-                  <div
-                     text:bind="$item.value"
-                     onExplore={(context, instance) => {
-                        divInstances.push(instance);
-                     }}
-                  />
-               </Repeater>
-            </div>
-         </cx>
-      );
-
-      let store = new Store({
-         data: {
-            data: [
-               {
-                  value: "C",
-               },
-               {
-                  value: "B",
-               },
-            ],
-         },
-      });
-
-      const component = renderer.create(<Cx widget={widget} store={store} subscribe immediate />);
-
-      let tree = component.toJSON();
-      assert.deepEqual(tree, {
-         type: "div",
-         props: {},
-         children: [
-            {
-               type: "div",
-               props: {},
-               children: ["B"],
-            },
-            {
-               type: "div",
-               props: {},
-               children: ["C"],
-            },
-         ],
-      });
-
-      divInstances = [];
-
-      store.update("data", (data) => [{ value: "A" }, ...data]);
-
-      assert.deepEqual(component.toJSON(), {
-         type: "div",
-         props: {},
-         children: [
-            {
-               type: "div",
-               props: {},
-               children: ["A"],
-            },
-            {
-               type: "div",
-               props: {},
-               children: ["B"],
-            },
-            {
-               type: "div",
-               props: {},
-               children: ["C"],
-            },
-         ],
-      });
-
-      assert.equal(divInstances.length, 3);
-      assert.equal(divInstances[0].store.get("$item.value"), "A");
-      assert.equal(divInstances[1].store.get("$item.value"), "B");
-      assert.equal(divInstances[2].store.get("$item.value"), "C");
-   });
-});
+import { Cx } from "./Cx";
+import { VDOM } from "./Widget";
+import { HtmlElement } from "../widgets/HtmlElement";
+import { Store } from "../data/Store";
+import { Repeater } from "./Repeater";
+
+import renderer from "react-test-renderer";
+import assert from "assert";
+
+describe("Repeater", () => {
+   it("allows sorting", () => {
+      let data = [
+         {
+            value: "C",
+         },
+         {
+            value: "B",
+         },
+         {
+            value: "A",
+         },
+      ];
+
+      let widget = (
+         <cx>
+            <div>
+               <Repeater records={data} sorters={[{ field: "value", direction: "ASC" }]} recordAlias="$item">
+                  <div text:bind="$item.value" />
+               </Repeater>
+            </div>
+         </cx>
+      );
+
+      let store = new Store();
+
+      const component = renderer.create(<Cx widget={widget} store={store} subscribe immediate />);
+
+      let tree = component.toJSON();
+      assert.deepEqual(tree, {
+         type: "div",
+         props: {},
+         children: [
+            {
+               type: "div",
+               props: {},
+               children: ["A"],
+            },
+            {
+               type: "div",
+               props: {},
+               children: ["B"],
+            },
+            {
+               type: "div",
+               props: {},
+               children: ["C"],
+            },
+         ],
+      });
+   });
+
+   it("changes are properly updated", () => {
+      let divInstances = [];
+      let widget = (
+         <cx>
+            <div>
+               <Repeater records-bind="data" sorters={[{ field: "value", direction: "ASC" }]} recordAlias="$item">
+                  <div
+                     text:bind="$item.value"
+                     onExplore={(context, instance) => {
+                        divInstances.push(instance);
+                     }}
+                  />
+               </Repeater>
+            </div>
+         </cx>
+      );
+
+      let store = new Store({
+         data: {
+            data: [
+               {
+                  value: "C",
+               },
+               {
+                  value: "B",
+               },
+            ],
+         },
+      });
+
+      const component = renderer.create(<Cx widget={widget} store={store} subscribe immediate />);
+
+      let tree = component.toJSON();
+      assert.deepEqual(tree, {
+         type: "div",
+         props: {},
+         children: [
+            {
+               type: "div",
+               props: {},
+               children: ["B"],
+            },
+            {
+               type: "div",
+               props: {},
+               children: ["C"],
+            },
+         ],
+      });
+
+      divInstances = [];
+
+      store.update("data", (data) => [{ value: "A" }, ...data]);
+
+      assert.deepEqual(component.toJSON(), {
+         type: "div",
+         props: {},
+         children: [
+            {
+               type: "div",
+               props: {},
+               children: ["A"],
+            },
+            {
+               type: "div",
+               props: {},
+               children: ["B"],
+            },
+            {
+               type: "div",
+               props: {},
+               children: ["C"],
+            },
+         ],
+      });
+
+      assert.equal(divInstances.length, 3);
+      assert.equal(divInstances[0].store.get("$item.value"), "A");
+      assert.equal(divInstances[1].store.get("$item.value"), "B");
+      assert.equal(divInstances[2].store.get("$item.value"), "C");
+   });
+});

package/src/ui/Rescope.d.ts

@@ -1,10 +1,10 @@
-import * as Cx from "../core";
-
-interface RescopeProps extends Cx.PureContainerProps {
-   bind: string;
-   rootName?: string;
-   rootAlias?: string;
-   data?: Cx.StructuredProp;
-}
-
-export class Rescope extends Cx.Widget<RescopeProps> {}
+import * as Cx from "../core";
+
+interface RescopeProps extends Cx.PureContainerProps {
+   bind: string;
+   rootName?: string;
+   rootAlias?: string;
+   data?: Cx.StructuredProp;
+}
+
+export class Rescope extends Cx.Widget<RescopeProps> {}