@singularsystems/neo-core 1.3.9 → 1.4.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Neo core changelog
 
+## Version 1.4.1 (20 April 2026)
+
+- Navigation helper
+    - Changed `openWindow` and `readOpenerState` to store state as string.
+
+## Version 1.4.0 (16 April 2026)
+
+- Dates decorated with `TimeZoneFormat.None` will now correctly deserialise into `DateOnly` properties on the server.
+See [Breaking Changes](./BREAKING.md).
+- Can now specify the observable type using the `Observable` attribute. Useful for dictionaries.
+- Navigation helper
+    - Added `openWindow` and `readOpenerState` methods to allow opening a view in a new window, and to allow passing state to the new window.
+
 ## Version 1.3.9 (4 March 2026)
 
 - Made `IDataCacheEntry.expire` method awaitable.

package/dist/Components/ButtonOptions.d.ts

@@ -25,6 +25,8 @@ export interface IButtonOptions {
     menuItems?: IButtonDropDownItem[];
     /** True if the dropdown menu must be split from the button. Set this if you want the button to have its own click event. */
     splitMenu?: boolean;
+    /** Callback for the when the menu is opened. */
+    onMenuOpened?: () => void;
     /** Callback for the when the menu is closed without an item being selected. */
     onMenuClosed?: () => void;
     menuAlignment?: "left" | "right";
@@ -54,6 +56,8 @@ export interface IButtonOptions {
      * Set a custom variant for when a standard variant is not provided.
      */
     customVariant?: string;
+    /** Makes the button appear toggled. */
+    isActive?: boolean;
 }
 export interface IButtonDropDownItem {
     /** Menu item text or component */

package/dist/Data/Serialiser.d.ts

@@ -1,5 +1,5 @@
 import List from '../Model/List';
-import { IModelBase, IBindableBase } from '../Model/IModelBase';
+import { IBindableBase } from '../Model/IModelBase';
 import { IDeserialiseOptions } from './Deserialiser';
 export interface ISerialiseOptions {
     /**
@@ -16,7 +16,7 @@ export interface ISerialiseOptions {
     suppressChildren?: boolean;
 }
 export declare abstract class JSFormatter {
-    static serialise(object: IModelBase | IModelBase[] | List<IModelBase>, options?: ISerialiseOptions): any;
+    static serialise(object: IBindableBase | IBindableBase[] | List<IBindableBase>, options?: ISerialiseOptions): any;
     /**
      * Deserialises a plain javascript object into a NeoModel instance
      * @param from plain javascript object
@@ -25,13 +25,13 @@ export declare abstract class JSFormatter {
      * @param options Deserialise options
      * @param justCreated True if the object being deserialised was just created (for its onDeserialise method).
      */
-    static deserialise(from: any, to: IBindableBase | IBindableBase[] | List<IModelBase>, rootType?: any, options?: IDeserialiseOptions, justCreated?: boolean): void;
+    static deserialise(from: any, to: IBindableBase | IBindableBase[] | List<IBindableBase>, rootType?: any, options?: IDeserialiseOptions, justCreated?: boolean): void;
 }
 export declare class Serialiser {
     private objectRefs;
     private options;
     private currentID;
-    serialise(fromObject: IModelBase | IModelBase[] | List<IModelBase>, options?: ISerialiseOptions): any;
+    serialise(fromObject: IBindableBase | IBindableBase[] | List<IBindableBase>, options?: ISerialiseOptions): any;
     /**
      * removes the temporary ids from the from objects.
      */

package/dist/Data/Serialiser.js

@@ -88,27 +88,28 @@ var Serialiser = /** @class */ (function () {
             this.objectRefs[referenceId] = { from: from, to: to };
             to.$id = referenceId.toString();
         }
+        var typeInfo = from.constructor.neo;
+        if (!typeInfo && !isDictionary) {
+            throw "Object is not decorated with @NeoModel. Either add @NeoModel, suppress serialisation on the property, or add @Attributes.Raw() to the property.";
+        }
         //Set tracking state
-        if (!this.options.suppressTrackingState && !isDictionary) {
-            if (from.isSelfDeleting) {
+        var modelBase = from;
+        if (!isDictionary && typeInfo.inheritsModelBase && !this.options.suppressTrackingState) {
+            if (modelBase.isSelfDeleting) {
                 to.trackingState = TrackingState.Deleted;
             }
-            else if (from.isNew) {
+            else if (modelBase.isNew) {
                 to.trackingState = TrackingState.Added;
             }
-            else if (from.isSelfDirty) {
+            else if (modelBase.isSelfDirty) {
                 to.trackingState = TrackingState.Modified;
             }
             else {
                 to.trackingState = TrackingState.Unchanged;
             }
-            to.entityIdentifier = from.entityIdentifier;
+            to.entityIdentifier = modelBase.entityIdentifier;
         }
         //Loop through serialisable properties
-        var typeInfo = from.constructor.neo;
-        if (!typeInfo && !isDictionary) {
-            throw "Object is not decorated with @NeoModel. Either add @NeoModel, suppress serialisation on the property, or add @Attributes.Raw() to the property.";
-        }
         var propertyMap = isDictionary ? {} : typeInfo.propertyMap;
         for (var key in from) {
             if (from.hasOwnProperty(key) && key.indexOf("__") !== 0) {

package/dist/Dates/DateUtils.js

@@ -65,7 +65,7 @@ var DateUtils = /** @class */ (function () {
             return date.toISOString();
         }
         else {
-            return DateUtils.format(date, "yyyy-MM-dd") + "T00:00:00";
+            return DateUtils.format(date, "yyyy-MM-dd");
         }
     };
     DateUtils.pad = function (val, len) {

package/dist/Misc.d.ts

@@ -1,4 +1,4 @@
-export { DataType, RelationType, SerialiseType, TrackingState, RemoveItemBehavior, IDisposable, IAutoRunner, IAutoRunnerOptions, TimeZoneFormat } from './Model/Misc';
+export { DataType, RelationType, SerialiseType, TrackingState, RemoveItemBehavior, IDisposable, IAutoRunner, IAutoRunnerOptions, TimeZoneFormat, ObservableType } from './Model/Misc';
 export { default as Globals } from './Globals';
 export { NumberFormat } from './NumberUtils';
 export { Settings } from './Settings';

package/dist/Misc.js

@@ -1,4 +1,4 @@
-export { DataType, RelationType, SerialiseType, TrackingState, RemoveItemBehavior, TimeZoneFormat } from './Model/Misc';
+export { DataType, RelationType, SerialiseType, TrackingState, RemoveItemBehavior, TimeZoneFormat, ObservableType } from './Model/Misc';
 export { default as Globals } from './Globals';
 export { NumberFormat } from './NumberUtils';
 export { Settings } from './Settings';

package/dist/Model/Decorators.d.ts

@@ -1,4 +1,4 @@
-import { SerialiseType, DataType, TimeZoneFormat } from './Misc';
+import { SerialiseType, DataType, TimeZoneFormat, ObservableType } from './Misc';
 import { IObjectFactoryOptions, ItemConstructor } from './IModelBase';
 export declare function Display(name: string): (type: any, propertyKey: string) => void;
 /** Indicates that this is a date property. Json strings will be converted to date objects on deserialisation. */
@@ -16,7 +16,15 @@ export declare function Decimal(): (type: any, propertyKey: string) => void;
 export declare function NullableBoolean(): (type: any, propertyKey: string) => void;
 /** Indicates that this property accepts nulls from user input controls that do not normally accept nulls. E.g. numeric editors. */
 export declare function Nullable(dataType?: DataType): (type: any, propertyKey: string) => void;
-export declare function Observable(isObservable?: boolean): (type: any, propertyKey: string) => void;
+/** Indicates that the property should be observable.
+ * E.g. to make a property in a lookup class observable.
+ * Or to make a property in a model non-observable by passing `false`. */
+export declare function Observable(isObservable?: boolean): Function;
+/**
+ * Sets the observable type of this property.
+ * E.g. to make the values of a dictionary observable, use `@Attributes.Observable(Misc.ObservableType.Shallow)`
+ */
+export declare function Observable(observableType: ObservableType): Function;
 /** Indicates that changes to this property will not cause the object to become dirty. It will also not be serialised */
 export declare function NoTracking(serialisation?: SerialiseType): (type: any, propertyKey: string) => void;
 export declare function Serialisation(serialisation: SerialiseType): (type: any, propertyKey: string) => void;

package/dist/Model/Decorators.js

@@ -59,10 +59,18 @@ export function Nullable(dataType) {
     };
 }
 export function Observable(isObservable) {
-    if (isObservable === void 0) { isObservable = true; }
     return function (type, propertyKey) {
         var pi = getOrAddPropertyInfo(type, propertyKey);
-        pi.isObservable = isObservable;
+        if (isObservable === undefined) {
+            pi.isObservable = true;
+        }
+        else if (typeof isObservable === "boolean") {
+            pi.isObservable = isObservable;
+        }
+        else {
+            pi.isObservable = true;
+            pi.observableType = isObservable;
+        }
     };
 }
 /** Indicates that changes to this property will not cause the object to become dirty. It will also not be serialised */

package/dist/Model/Misc.d.ts

@@ -38,6 +38,20 @@ export declare enum DataType {
     NullableBoolean = 7,
     Decimal = 8
 }
+export declare enum ObservableType {
+    Default = 0,
+    /**
+     * Observers will only react when the value of this property changes by reference.
+     * E.g. `obj.Nested = newObject`. Not `obj.Nested.property1 = 1`.
+     */
+    Reference = 1,
+    /**
+     * Observers will react to reference changes, *and* to changes in the direct properties of this object.
+     * Use this for dictionaries, where you want to react to changes in the values.
+     * **Do not** use for regular child objects that extend ModelBase / BindableBase.
+     */
+    Shallow = 2
+}
 export declare class OnChangedOptions {
     onChangedFn: (oldValue: any, newValue: any) => void;
     requiresOldValue: boolean;

package/dist/Model/Misc.js

@@ -41,6 +41,21 @@ export var DataType;
     DataType[DataType["NullableBoolean"] = 7] = "NullableBoolean";
     DataType[DataType["Decimal"] = 8] = "Decimal";
 })(DataType || (DataType = {}));
+export var ObservableType;
+(function (ObservableType) {
+    ObservableType[ObservableType["Default"] = 0] = "Default";
+    /**
+     * Observers will only react when the value of this property changes by reference.
+     * E.g. `obj.Nested = newObject`. Not `obj.Nested.property1 = 1`.
+     */
+    ObservableType[ObservableType["Reference"] = 1] = "Reference";
+    /**
+     * Observers will react to reference changes, *and* to changes in the direct properties of this object.
+     * Use this for dictionaries, where you want to react to changes in the values.
+     * **Do not** use for regular child objects that extend ModelBase / BindableBase.
+     */
+    ObservableType[ObservableType["Shallow"] = 2] = "Shallow";
+})(ObservableType || (ObservableType = {}));
 var OnChangedOptions = /** @class */ (function () {
     function OnChangedOptions(onChangedFn, requiresOldValue, delayMs) {
         this.onChangedFn = onChangedFn;

package/dist/Model/PropertyInfo.d.ts

@@ -1,4 +1,4 @@
-import { SerialiseType, RelationType, OnChangedOptions, DataType, TimeZoneFormat } from './Misc';
+import { SerialiseType, RelationType, OnChangedOptions, DataType, TimeZoneFormat, ObservableType } from './Misc';
 import { Nullable } from '../Utils';
 import { INonObservableModelBase, ItemConstructor, ItemConstructorOptions, ObjectFactory } from './IModelBase';
 import { Rule } from '../Validation/Rules';
@@ -22,6 +22,7 @@ export default class PropertyInfo {
      * True when defining observables on types that don't extend ModelBase.
      */
     isObservable: Nullable<boolean>;
+    observableType: Nullable<ObservableType>;
     /** See SerialiseType */
     serialise: SerialiseType;
     timeZoneSerialisation: TimeZoneFormat;

package/dist/Model/PropertyInfo.js

@@ -15,6 +15,7 @@ var PropertyInfo = /** @class */ (function () {
          * True when defining observables on types that don't extend ModelBase.
          */
         this.isObservable = null;
+        this.observableType = null;
         /** See SerialiseType */
         this.serialise = SerialiseType.Always;
         /** Type of parent / child if this property is related to another model. 'type' property must be set if this is not 'none'. */

package/dist/Routing/INavigationHelper.d.ts

@@ -1,8 +1,28 @@
 export interface INavigationHelper {
     /**
      * Navigates to an internal url using the router.
+     * @param path The url to navigate to. This should be a relative url, and should not include the base path of the application. For example, use "/home" instead of "/myapp/home".
      * @param replace Replace the url instead of adding to the history. This prevents the back button returning the params to the current state.
      * @returns True if the navigation event occurred. False if it was blocked by the view / page leave handler.
      * */
-    navigateInternal(url: string, replace?: boolean): Promise<boolean>;
+    navigateInternal(path: string, replace?: boolean): Promise<boolean>;
+    /**
+     * Opens a new window with the base url of the current application.
+     * @param path The url to navigate to. This should be a relative url, and should not include the base path of the application. For example, use "/home" instead of "/myapp/home".
+     * @param state Optional state  to pass to the new window. This must be a serialized object, which can be read using `readOpenerState`.
+     * @param options Optional window features and target.
+     */
+    openWindow(path: string, state?: {
+        name: string;
+        value: any;
+    }, options?: {
+        target?: string;
+        features?: string;
+    }): Window | null;
+    /**
+     * Reads the state passed from the opener to the current window. If an object was passed to `openWindow`, you will need to parse the stored value using JSON.parse.
+     * @param name The name of the state to read. This should match the name provided in the state parameter of `openWindow`.
+     * @param reset Whether to remove the state after read. Defaults to true.
+     */
+    readOpenerState(name: string, reset?: boolean): string | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singularsystems/neo-core",
-  "version": "1.3.9",
+  "version": "1.4.1",
   "description": "Core functionality for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",