cx 26.4.3 → 26.5.1

package/src/data/View.ts

@@ -42,9 +42,7 @@ export interface ViewMethods<D = Record<string, any>> {
    delete(paths: Path[]): boolean;
    delete(...paths: Path[]): boolean;
    delete<V>(path: AccessorChain<V>): boolean;
-   delete<T extends any[]>(
-      ...paths: { [K in keyof T]: AccessorChain<T[K]> }
-   ): boolean;
+   delete<T extends any[]>(...paths: { [K in keyof T]: AccessorChain<T[K]> }): boolean;
    delete<T extends any[]>(paths: {
       [K in keyof T]: AccessorChain<T[K]>;
    }): boolean;
@@ -58,28 +56,14 @@ export interface ViewMethods<D = Record<string, any>> {
       updateFn: (currentValue: V, ...args: A) => V,
       ...args: A
    ): boolean;
-   update<A extends any[]>(
-      updateFn: (currentValue: D, ...args: A) => D,
-      ...args: any
-   ): boolean;
-   update<A extends any[]>(
-      path: Path,
-      updateFn: (currentValue: any, ...args: A) => any,
-      ...args: A
-   ): boolean;
+   update<A extends any[]>(updateFn: (currentValue: D, ...args: A) => D, ...args: any): boolean;
+   update<A extends any[]>(path: Path, updateFn: (currentValue: any, ...args: A) => any, ...args: A): boolean;
 
    /**
     *  Mutates the content of the store using Immer
     */
-   mutate(
-      updateFn: (currentValue: D, ...args: any[]) => void,
-      ...args: any[]
-   ): boolean;
-   mutate<A extends any[]>(
-      path: Path,
-      updateFn: (currentValue: any, ...args: A) => void,
-      ...args: A
-   ): boolean;
+   mutate(updateFn: (currentValue: D, ...args: any[]) => void, ...args: any[]): boolean;
+   mutate<A extends any[]>(path: Path, updateFn: (currentValue: any, ...args: A) => void, ...args: A): boolean;
    mutate<V, A extends any[]>(
       path: AccessorChain<V>,
       updateFn: (currentValue: V, ...args: A) => void,
@@ -99,7 +83,6 @@ export class View<D = any> implements ViewMethods<D> {
       result?: any;
       itemIndex?: number;
       key?: string;
-      parentStoreData?: any;
    };
    notificationsSuspended: number = 0;
    dirty: boolean = false;
@@ -123,17 +106,11 @@ export class View<D = any> implements ViewMethods<D> {
       if (typeof path == "object" && path != null) {
          let changed = false;
          for (let key in path)
-            if (
-               path.hasOwnProperty(key) &&
-               this.get(key) === undefined &&
-               this.setItem(key, path[key])
-            )
-               changed = true;
+            if (path.hasOwnProperty(key) && this.get(key) === undefined && this.setItem(key, path[key])) changed = true;
          return changed;
       }
       let binding = Binding.get(path);
-      if (this.get(binding.path) === undefined)
-         return this.setItem(binding.path, value);
+      if (this.get(binding.path) === undefined) return this.setItem(binding.path, value);
       return false;
    }
 
@@ -143,9 +120,7 @@ export class View<D = any> implements ViewMethods<D> {
    set(path: any, value?: any): boolean {
       if (typeof path == "object" && path != null) {
          let changed = false;
-         for (let key in path)
-            if (path.hasOwnProperty(key) && this.setItem(key, path[key]))
-               changed = true;
+         for (let key in path) if (path.hasOwnProperty(key) && this.setItem(key, path[key])) changed = true;
          return changed;
       }
       let binding = Binding.get(path);
@@ -178,16 +153,13 @@ export class View<D = any> implements ViewMethods<D> {
    delete(paths: Path[]): boolean;
    delete(...paths: Path[]): boolean;
    delete<V>(path: AccessorChain<V>): boolean;
-   delete<T extends any[]>(
-      ...paths: { [K in keyof T]: AccessorChain<T[K]> }
-   ): boolean;
+   delete<T extends any[]>(...paths: { [K in keyof T]: AccessorChain<T[K]> }): boolean;
    delete<T extends any[]>(paths: {
       [K in keyof T]: AccessorChain<T[K]>;
    }): boolean;
    delete(path?: any): boolean {
       if (arguments.length > 1) path = Array.from(arguments);
-      if (isArray(path))
-         return path.map((arg) => this.delete(arg as Path)).some(Boolean);
+      if (isArray(path)) return path.map((arg) => this.delete(arg as Path)).some(Boolean);
 
       let binding = Binding.get(path);
       return this.deleteItem(binding.path);
@@ -217,8 +189,7 @@ export class View<D = any> implements ViewMethods<D> {
 
       if (arguments.length > 1) path = Array.from(arguments);
 
-      if (isArray(path))
-         return path.map((arg) => Binding.get(arg as any).value(storeData));
+      if (isArray(path)) return path.map((arg) => Binding.get(arg as any).value(storeData));
 
       return Binding.get(path).value(storeData);
    }
@@ -235,32 +206,16 @@ export class View<D = any> implements ViewMethods<D> {
       updateFn: (currentValue: V, ...args: A) => V,
       ...args: A
    ): boolean;
-   update(
-      updateFn: (currentValue: D, ...args: any[]) => any,
-      ...args: any
-   ): boolean;
-   update<A extends any[]>(
-      path: Path,
-      updateFn: (currentValue: any, ...args: A) => any,
-      ...args: A
-   ): boolean;
+   update(updateFn: (currentValue: D, ...args: any[]) => any, ...args: any): boolean;
+   update<A extends any[]>(path: Path, updateFn: (currentValue: any, ...args: A) => any, ...args: A): boolean;
    update(path: any, updateFn?: any, ...args: any[]): boolean {
       if (arguments.length == 1 && isFunction(path))
-         return this.load(
-            path.apply(null, [this.getData(), updateFn, ...args]),
-         );
+         return this.load(path.apply(null, [this.getData(), updateFn, ...args]));
       return this.set(path, updateFn.apply(null, [this.get(path), ...args]));
    }
 
-   mutate(
-      updateFn: (currentValue: D, ...args: any[]) => void,
-      ...args: any[]
-   ): boolean;
-   mutate<A extends any[]>(
-      path: Path,
-      updateFn: (currentValue: any, ...args: A) => void,
-      ...args: A
-   ): boolean;
+   mutate(updateFn: (currentValue: D, ...args: any[]) => void, ...args: any[]): boolean;
+   mutate<A extends any[]>(path: Path, updateFn: (currentValue: any, ...args: A) => void, ...args: A): boolean;
    mutate<V, A extends any[]>(
       path: AccessorChain<V>,
       updateFn: (currentValue: V, ...args: A) => void,

package/src/ui/DataProxy.ts

@@ -1,55 +1,55 @@
-import { AccessorChain } from "../data";
-import { NestedDataView } from "../data/NestedDataView";
-import { StructuredProp, WritableProp } from "./Prop";
-import { PureContainerBase, PureContainerConfig } from "./PureContainer";
-import { StructuredInstanceDataAccessor } from "./StructuredInstanceDataAccessor";
-
-export interface DataProxyConfig extends PureContainerConfig {
-   /** Data object with computed values to be exposed in the local store. */
-   data?: StructuredProp;
-
-   /** Binding to a value to be exposed under the `alias` name. */
-   value?: WritableProp<any>;
-
-   /** Alias name under which `value` is exposed in the local store. */
-   alias?: string | AccessorChain<any>;
-
-   /** Indicate that parent store data should not be mutated. */
-   immutable?: boolean;
-
-   /** Indicate that local store data should not be mutated. */
-   sealed?: boolean;
-}
-
-export class DataProxy extends PureContainerBase<DataProxyConfig> {
-   declare data?: any;
-   declare alias?: string;
-   declare value?: any;
-   declare immutable: boolean;
-   declare sealed: boolean;
-
-   init() {
-      if (!this.data) this.data = {};
-
-      if (this.alias) this.data[this.alias] = this.value;
-
-      super.init();
-   }
-
-   initInstance(context: any, instance: any) {
-      instance.store = new NestedDataView({
-         store: instance.parentStore,
-         nestedData: new StructuredInstanceDataAccessor({ instance, data: this.data, useParentStore: true }),
-         immutable: this.immutable,
-         sealed: this.sealed,
-      });
-      super.initInstance(context, instance);
-   }
-
-   applyParentStore(instance: any) {
-      instance.store.setStore(instance.parentStore);
-   }
-}
-
-DataProxy.prototype.immutable = false;
-DataProxy.prototype.sealed = false;
+import { AccessorChain } from "../data";
+import { NestedDataView } from "../data/NestedDataView";
+import { StructuredProp, WritableProp } from "./Prop";
+import { PureContainerBase, PureContainerConfig } from "./PureContainer";
+import { StructuredInstanceDataAccessor } from "./StructuredInstanceDataAccessor";
+
+export interface DataProxyConfig extends PureContainerConfig {
+   /** Data object with computed values to be exposed in the local store. */
+   data?: StructuredProp;
+
+   /** Binding to a value to be exposed under the `alias` name. */
+   value?: WritableProp<any>;
+
+   /** Alias name under which `value` is exposed in the local store. */
+   alias?: string | AccessorChain<any>;
+
+   /** Indicate that parent store data should not be mutated. */
+   immutable?: boolean;
+
+   /** Indicate that local store data should not be mutated. */
+   sealed?: boolean;
+}
+
+export class DataProxy extends PureContainerBase<DataProxyConfig> {
+   declare data?: any;
+   declare alias?: string;
+   declare value?: any;
+   declare immutable: boolean;
+   declare sealed: boolean;
+
+   init() {
+      if (!this.data) this.data = {};
+
+      if (this.alias) this.data[this.alias] = this.value;
+
+      super.init();
+   }
+
+   initInstance(context: any, instance: any) {
+      instance.store = new NestedDataView({
+         store: instance.parentStore,
+         nestedData: new StructuredInstanceDataAccessor({ instance, data: this.data, useParentStore: true }),
+         immutable: this.immutable,
+         sealed: this.sealed,
+      });
+      super.initInstance(context, instance);
+   }
+
+   applyParentStore(instance: any) {
+      instance.store.setStore(instance.parentStore);
+   }
+}
+
+DataProxy.prototype.immutable = false;
+DataProxy.prototype.sealed = false;

package/src/ui/Format.spec.ts

@@ -0,0 +1,32 @@
+import assert from "assert";
+import { Format } from "./Format";
+
+// The `quarter` formatter is registered eagerly when ui/Format is imported,
+// so these tests do not need enableCultureSensitiveFormatting().
+describe("Format - quarter", function () {
+   it("renders the calendar quarter with the default pattern", function () {
+      assert.equal(Format.value(new Date(2020, 0, 15), "quarter"), "Q1 2020");
+      assert.equal(Format.value(new Date(2020, 5, 1), "quarter"), "Q2 2020");
+      assert.equal(Format.value(new Date(2020, 11, 31), "quarter"), "Q4 2020");
+   });
+
+   it("supports custom patterns and the {yy} token", function () {
+      assert.equal(Format.value(new Date(2020, 0, 1), "quarter;{yy}Q{q}"), "20Q1");
+      assert.equal(Format.value(new Date(2020, 8, 1), "quarter;{q}Q{yyyy}"), "3Q2020");
+   });
+
+   it("accepts both lowercase and uppercase placeholders", function () {
+      assert.equal(Format.value(new Date(2020, 0, 1), "quarter;{YY}Q{Q}"), "20Q1");
+      assert.equal(Format.value(new Date(2020, 0, 1), "quarter;Q{Q} {YYYY}"), "Q1 2020");
+   });
+
+   it("treats the input as an exclusive range end with the exclusive flag", function () {
+      assert.equal(Format.value(new Date(2021, 0, 1), "quarter;{yy}Q{q};exclusive"), "20Q4");
+      assert.equal(Format.value(new Date(2021, 0, 1), "quarter;{yy}Q{q};ex"), "20Q4");
+   });
+
+   it("falls back to the default pattern when the pattern argument is empty (quarter;;e)", function () {
+      assert.equal(Format.value(new Date(2021, 0, 1), "quarter;;e"), "Q4 2020");
+      assert.equal(Format.value(new Date(2020, 0, 1), "quarter;;e"), "Q4 2019");
+   });
+});

package/src/ui/Format.ts

@@ -1,12 +1,31 @@
 import { Culture, getCurrentCultureCache } from "./Culture";
 import { Format as Fmt, resolveMinMaxFractionDigits, setGetFormatCacheCallback } from "../util/Format";
 import { setGetExpressionCacheCallback } from "../data/Expression";
-import { setGetStringTemplateCacheCallback } from "../data/StringTemplate";
-import { parseDateInvariant } from "../util";
+import { setGetStringTemplateCacheCallback, StringTemplate } from "../data/StringTemplate";
+import { dateQuarter, dayBefore, parseDateInvariant } from "../util";
 import { GlobalCacheIdentifier } from "../util/GlobalCacheIdentifier";
 
 export const Format = Fmt;
 
+// The `quarter` formatter renders a calendar quarter via a string-template
+// pattern with `{q}` (quarter number), `{yyyy}` and `{yy}` (year) placeholders.
+// Placeholders are case-insensitive (`{Q}`, `{YYYY}`, `{YY}` work too). It lives
+// here rather than in util/Format because it depends on StringTemplate from the
+// data layer, which util/ cannot import. It is registered eagerly since it does
+// not depend on culture settings.
+Fmt.registerFactory("quarter", (fmt: any, pattern?: string, mode?: string) => {
+   let exclusive = mode === "exclusive" || mode === "ex" || mode === "e";
+   let template = StringTemplate.get(pattern || "Q{q} {yyyy}");
+   return (value: any) => {
+      let date = parseDateInvariant(value);
+      if (exclusive) date = dayBefore(date);
+      let q = dateQuarter(date);
+      let yyyy = date.getFullYear();
+      let yy = String(yyyy % 100).padStart(2, "0");
+      return template({ q, Q: q, yyyy, YYYY: yyyy, yy, YY: yy });
+   };
+});
+
 let cultureSensitiveFormatsRegistered = false;
 
 export function resolveNumberFormattingFlags(flags?: string): any {
@@ -86,6 +105,12 @@ export function enableCultureSensitiveFormatting() {
       return (value: any) => formatter.format(parseDateInvariant(value));
    });
 
+   Fmt.registerFactory(["dayBefore", "daybefore"], (fmt: any, format = "yyyyMd hhmm") => {
+      let culture = Culture.getDateTimeCulture();
+      let formatter = culture.getFormatter(format);
+      return (value: any) => formatter.format(dayBefore(parseDateInvariant(value)));
+   });
+
    setGetFormatCacheCallback(() => {
       let cache = getCurrentCultureCache();
       if (!cache.formatCache) cache.formatCache = {};

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);