breeze-client 2.2.1 → 3.0.0

package/core/event.js

@@ -0,0 +1,338 @@
+import { core } from './core.js';
+import { assertParam, paramError } from './assert-param.js';
+function publishCore(that, data, errorCallback) {
+    let subscribers = that._subscribers;
+    if (!subscribers)
+        return true;
+    // subscribers from outer scope.
+    subscribers.forEach(function (s) {
+        try {
+            s.callback(data);
+        }
+        catch (e) {
+            e.context = "unable to publish on topic: " + that.name;
+            if (errorCallback) {
+                errorCallback(e);
+            }
+            else if (that._defaultErrorCallback) {
+                that._defaultErrorCallback(e);
+            }
+            else {
+                fallbackErrorHandler(e);
+            }
+        }
+    });
+}
+/**
+ * Where a subscriber's exception goes when neither the `publish` call nor the event itself
+ * supplies an error callback.
+ *
+ * It used to go nowhere at all. That is the worst thing it could do: a bug in a handler leaves no
+ * trace, and the symptom is an event that looks as though it was never published. Reporting it
+ * costs nothing on the path that matters, because it only runs when a subscriber has thrown.
+ *
+ * It is still not rethrown. Subscribers are independent, and one that fails must not stop the
+ * others from being notified.
+ */
+function fallbackErrorHandler(e) {
+    const handler = BreezeEvent.unhandledErrorCallback;
+    if (handler)
+        handler(e);
+}
+/**
+Class to support basic event publication and subscription semantics.
+*/
+export class BreezeEvent {
+    /**
+     * Names of every event constructed so far. A Set: it is membership, not mapping.
+     * @hidden @internal
+     */
+    static __eventNameMap = new Set();
+    /** @hidden @internal */
+    static __nextUnsubKey = 1;
+    /**
+     * Called with any exception a subscriber throws that nothing else has handled - that is, when
+     * neither `publish` nor the event was given an error callback.
+     *
+     * It logs to `console.error` by default. Set your own to route it into a logger, or `null` to
+     * go back to discarding these silently (which is what Breeze did before 3.0, and why handler
+     * bugs were so hard to find).
+     *
+     * ```ts
+     * BreezeEvent.unhandledErrorCallback = e => myLogger.error(e);
+     * BreezeEvent.unhandledErrorCallback = null;   // say nothing
+     * ```
+     */
+    static unhandledErrorCallback = (e) => {
+        // `context` is set by publishCore and names the event.
+        const where = e.context || 'an event subscriber';
+        console.error(`breeze: ${where} threw and nothing handled it.`, e);
+    };
+    /** The name of this Event */
+    name;
+    /** The object doing the publication. i.e. the object to which this event is attached. */
+    publisher;
+    /**
+     * Whether anything is listening. Lets a caller skip building event arguments it would only
+     * throw away - `publish` on an unsubscribed event still walks the `_getEventParent` chain via
+     * `_isEnabled` before discovering there is nobody to tell.
+     * @hidden @internal
+     */
+    get hasSubscribers() {
+        const subs = this._subscribers;
+        return subs != null && subs.length > 0;
+    }
+    /**
+    Constructor for an Event
+    ```ts
+    salaryEvent = new BreezeEvent("salaryEvent", person);
+    ```
+    @param name - The name of the event.
+    @param publisher - The object that will be doing the publication. i.e. the object to which this event is attached.
+    @param defaultErrorCallback - Function to call when an error occurs during subscription execution.
+    If omitted then subscriber notification failures will be ignored.
+    */
+    constructor(name, publisher, defaultErrorCallback) {
+        // Checked inline rather than with assertParam: every entity constructs two of these,
+        // and the chain allocates several objects to answer what is one typeof. Same wording.
+        if (typeof name !== 'string' || name.length === 0) {
+            throw paramError('eventName', "must be a nonEmpty string");
+        }
+        if (publisher == null || typeof publisher !== 'object') {
+            throw paramError('publisher', "must be a 'object'");
+        }
+        this.name = name;
+        // register the name
+        BreezeEvent.__eventNameMap.add(name);
+        this.publisher = publisher;
+        if (defaultErrorCallback) {
+            this._defaultErrorCallback = defaultErrorCallback;
+        }
+    }
+    /**
+    Publish data for this event.
+    ```ts
+    // Assume 'salaryEvent' is previously constructed Event
+    salaryEvent.publish( { eventType: "payRaise", amount: 100 });
+    ```
+  
+    This event can also be published asychronously
+    ```ts
+    salaryEvent.publish( { eventType: "payRaise", amount: 100 }, true);
+    ```
+  
+    And we can add a handler in case the subscriber 'mishandles' the event.
+    ```ts
+    salaryEvent.publish( { eventType: "payRaise", amount: 100 }, true, function(error) {
+        // do something with the 'error' object
+    });
+    ```
+    @param data - Data to publish
+    @param publishAsync - (default=false) Whether to publish asynchonously or not.
+    @param errorCallback - Function to be called for any errors that occur during publication. If omitted,
+    errors will be eaten.
+    @returns false if event is disabled; true otherwise.
+    */
+    publish(data, publishAsync = false, errorCallback) {
+        if (!BreezeEvent._isEnabled(this.name, this.publisher))
+            return false;
+        if (publishAsync === true) {
+            setTimeout(publishCore, 0, this, data, errorCallback);
+        }
+        else {
+            publishCore(this, data, errorCallback);
+        }
+        return true;
+    }
+    /**
+    Publish data for this event asynchronously.
+    ```ts
+    // Assume 'salaryEvent' is previously constructed Event
+    salaryEvent.publishAsync( { eventType: "payRaise", amount: 100 });
+    ```
+  
+    And we can add a handler in case the subscriber 'mishandles' the event.
+    ```ts
+    salaryEvent.publishAsync( { eventType: "payRaise", amount: 100 }, function(error) {
+        // do something with the 'error' object
+    });
+    ```
+    @param data - Data to publish
+    @param errorCallback - Function to be called for any errors that occur during publication. If omitted,
+    errors will be eaten.
+    */
+    publishAsync(data, errorCallback) {
+        this.publish(data, true, errorCallback);
+    }
+    /**
+    Subscribe to this event.
+    ```ts
+    // Assume 'salaryEvent' is previously constructed Event
+    salaryEvent.subscribe(function (eventArgs) {
+        if (eventArgs.eventType === "payRaise") {
+            // do something
+        }
+    });
+    ```
+  
+    There are several built in Breeze events, such as {@link EntityAspect.propertyChanged}, {@link EntityAspect.validationErrorsChanged} as well.
+    ```ts
+    // Assume order is a preexisting 'order' entity
+    order.entityAspect.propertyChanged.subscribe(function (pcEvent) {
+        if ( pcEvent.propertyName === "OrderDate") {
+            // do something
+        }
+    });
+    ```
+    @param callback - Called whenever data is published for this event, with that data as its argument. What is published is documented on each specific event.
+    @returns This is a key for 'unsubscription'.  It can be passed to the 'unsubscribe' method.
+    */
+    subscribe(callback) {
+        if (!this._subscribers) {
+            this._subscribers = [];
+        }
+        let unsubKey = BreezeEvent.__nextUnsubKey;
+        this._subscribers.push({ unsubKey: unsubKey, callback: callback });
+        ++BreezeEvent.__nextUnsubKey;
+        return unsubKey;
+    }
+    /**
+    Unsubscribe from this event.
+    ```ts
+    // Assume order is a preexisting 'order' entity
+    let token = order.entityAspect.propertyChanged.subscribe(function (pcEvent) {
+            // do something
+    });
+    // sometime later
+    order.entityAspect.propertyChanged.unsubscribe(token);
+    ```
+    @param unsubKey - The value returned from the 'subscribe' method may be used to unsubscribe here.
+    @returns Whether unsubscription occured. This will return false if already unsubscribed or if the key simply
+    cannot be found.
+    */
+    // A method, not a field holding a function: written as a field, every event carried its own
+    // copy of it rather than sharing one on the prototype.
+    unsubscribe(unsubKey) {
+        if (!this._subscribers)
+            return false;
+        let subs = this._subscribers;
+        let ix = core.arrayIndexOf(subs, function (s) {
+            return s.unsubKey === unsubKey;
+        });
+        if (ix !== -1) {
+            subs.splice(ix, 1);
+            if (subs.length === 0) {
+                this._subscribers = null;
+            }
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    /** remove all subscribers */
+    clear() {
+        this._subscribers = null;
+    }
+    /** event bubbling - document later. */
+    // null or undefined 'getParentFn' means Event does not need to bubble i.e. that it is always enabled - .
+    static bubbleEvent(target, getParentFn) {
+        target._getEventParent = getParentFn || null;
+    }
+    /**
+    Enables or disables the named event for an object and all of its children.
+    ```ts
+    BreezeEvent.enable(“propertyChanged”, myEntityManager, false)
+    ```
+  
+    will disable all EntityAspect.propertyChanged events within a EntityManager.
+    ```ts
+    BreezeEvent.enable(“propertyChanged”, myEntityManager, true)
+    ```
+  
+    will enable all EntityAspect.propertyChanged events within a EntityManager.
+    ```ts
+    BreezeEvent.enable(“propertyChanged”, myEntity.entityAspect, false)
+    ```
+  
+    will disable EntityAspect.propertyChanged events for a specific entity.
+    ```ts
+    BreezeEvent.enable(“propertyChanged”, myEntity.entityAspect, null)
+    ```
+  
+    will removes any enabling / disabling at the entity aspect level so now any 'Event.enable' calls at the EntityManager level,
+    made either previously or in the future, will control notification.
+    ```ts
+    BreezeEvent.enable(“validationErrorsChanged”, myEntityManager, function(em) {
+        return em.customTag === “blue”;
+    })
+    ```
+  
+  
+    will either enable or disable myEntityManager based on the current value of a ‘customTag’ property on myEntityManager.
+    Note that this is dynamic, changing the customTag value will cause events to be enabled or disabled immediately.
+    @param eventName - The name of the event.
+    @param obj - The object at which enabling or disabling will occur.  All event notifications that occur to this object or
+    children of this object will be enabled or disabled.
+    @param isEnabled - A boolean, a null or a function that returns either a boolean or a null.
+    */
+    static enable(eventName, obj, isEnabled) {
+        assertParam(eventName, "eventName").isNonEmptyString().check();
+        assertParam(obj, "obj").isObject().check();
+        assertParam(isEnabled, "isEnabled").isBoolean().isOptional().or().isFunction().check();
+        let ob = obj;
+        if (!ob._$eventMap) {
+            ob._$eventMap = {};
+        }
+        ob._$eventMap[eventName] = isEnabled;
+    }
+    /**
+    Returns whether for a specific event and a specific object and its children, notification is enabled or disabled or not set.
+    ```ts
+    BreezeEvent.isEnabled(“propertyChanged”, myEntityManager)
+  
+    ```
+    @param eventName - The name of the event.
+    @param obj - The object for which we want to know if notifications are enabled.
+    @returns Whether notifications are enabled. If nothing is set on the object, the answer comes from its parent chain, and defaults to true.
+    */
+    static isEnabled(eventName, obj) {
+        assertParam(eventName, "eventName").isNonEmptyString().check();
+        assertParam(obj, "obj").isObject().check();
+        // null is ok - it just means that the object is at the top level.
+        if (obj._getEventParent === undefined) {
+            throw new Error("This object does not support event enabling/disabling");
+        }
+        return BreezeEvent._isEnabled(eventName, obj);
+    }
+    /** @hidden @internal */
+    static _isEnabled = function (eventName, obj) {
+        let isEnabled = null;
+        let ob = obj;
+        let eventMap = ob._$eventMap;
+        if (eventMap) {
+            isEnabled = eventMap[eventName];
+        }
+        if (isEnabled != null) {
+            if (typeof isEnabled === 'function') {
+                return !!isEnabled(obj);
+            }
+            else {
+                return !!isEnabled;
+            }
+        }
+        else {
+            let parent = ob._getEventParent && ob._getEventParent();
+            if (parent) {
+                return !!this._isEnabled(eventName, parent);
+            }
+            else {
+                // default if not explicitly disabled.
+                return true;
+            }
+        }
+    };
+}
+// legacy support - deliberately not typed
+core.Event = BreezeEvent;
+//# sourceMappingURL=event.js.map

package/core/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../src/core/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE5D,SAAS,WAAW,CAAI,IAAoB,EAAE,IAAO,EAAE,aAAiC;IACtF,IAAI,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;IACpC,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAC9B,gCAAgC;IAChC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC;QAC7B,IAAI,CAAC;YACH,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,CAAC,CAAC,OAAO,GAAG,8BAA8B,GAAG,IAAI,CAAC,IAAI,CAAC;YACvD,IAAI,aAAa,EAAE,CAAC;gBAClB,aAAa,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC;iBAAM,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBACtC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,oBAAoB,CAAC,CAAC,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,oBAAoB,CAAC,CAAQ;IACpC,MAAM,OAAO,GAAG,WAAW,CAAC,sBAAsB,CAAC;IACnD,IAAI,OAAO;QAAE,OAAO,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC;AASD;;EAEE;AACF,MAAM,OAAO,WAAW;IACtB;;;OAGG;IACH,MAAM,CAAC,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IAC1C,wBAAwB;IACxB,MAAM,CAAC,cAAc,GAAG,CAAC,CAAC;IAE1B;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,sBAAsB,GAAgC,CAAC,CAAQ,EAAE,EAAE;QACxE,uDAAuD;QACvD,MAAM,KAAK,GAAI,CAAS,CAAC,OAAO,IAAI,qBAAqB,CAAC;QAC1D,OAAO,CAAC,KAAK,CAAC,WAAW,KAAK,gCAAgC,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC;IACF,6BAA6B;IAC7B,IAAI,CAAS;IACb,yFAAyF;IACzF,SAAS,CAAS;IAUlB;;;;;OAKG;IACH,IAAI,cAAc;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC;QAC/B,OAAO,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IACzC,CAAC;IAGD;;;;;;;;;MASE;IACF,YAAY,IAAY,EAAE,SAAiB,EAAE,oBAAwC;QACnF,qFAAqF;QACrF,sFAAsF;QACtF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClD,MAAM,UAAU,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YACvD,MAAM,UAAU,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,oBAAoB;QACpB,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAC;QACpD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;MAuBE;IACF,OAAO,CAAC,IAAO,EAAE,eAAwB,KAAK,EAAE,aAAiC;QAE/E,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QAErE,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YAC1B,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;MAgBE;IACF,YAAY,CAAC,IAAO,EAAE,aAAgC;QACpD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;MAsBE;IACF,SAAS,CAAC,QAA0B;QAClC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACzB,CAAC;QAED,IAAI,QAAQ,GAAG,WAAW,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACnE,EAAE,WAAW,CAAC,cAAc,CAAC;QAC7B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;MAaE;IACF,4FAA4F;IAC5F,uDAAuD;IACvD,WAAW,CAAC,QAAgB;QAC1B,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,OAAO,KAAK,CAAC;QACrC,IAAI,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7B,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC;YAC1C,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YACnB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtB,IAAI,CAAC,YAAY,GAAQ,IAAI,CAAC;YAChC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,6BAA6B;IAC7B,KAAK;QACH,IAAI,CAAC,YAAY,GAAQ,IAAI,CAAC;IAChC,CAAC;IAED,uCAAuC;IAEvC,yGAAyG;IACzG,MAAM,CAAC,WAAW,CAAC,MAAW,EAAE,WAAyB;QACvD,MAAM,CAAC,eAAe,GAAG,WAAW,IAAI,IAAI,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAoCE;IACH,MAAM,CAAC,MAAM,CAAC,SAAiB,EAAE,GAAW,EAAE,SAA0C;QACrF,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC,KAAK,EAAE,CAAC;QAC/D,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC;QAC3C,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;QACvF,IAAI,EAAE,GAAQ,GAAG,CAAC;QAClB,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;YACnB,EAAE,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,CAAC;QACD,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IACvC,CAAC;IAED;;;;;;;;;MASE;IACF,MAAM,CAAC,SAAS,CAAC,SAAiB,EAAE,GAAW;QAC7C,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC,KAAK,EAAE,CAAC;QAC/D,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC;QAC3C,kEAAkE;QAClE,IAAU,GAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,WAAW,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAChD,CAAC;IAED,wBAAwB;IACxB,MAAM,CAAC,UAAU,GAAG,UAAU,SAAiB,EAAE,GAAW;QAC1D,IAAI,SAAS,GAAQ,IAAI,CAAC;QAC1B,IAAI,EAAE,GAAQ,GAAG,CAAC;QAClB,IAAI,QAAQ,GAAG,EAAE,CAAC,UAAU,CAAC;QAC7B,IAAI,QAAQ,EAAE,CAAC;YACb,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;gBACpC,OAAO,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,CAAC,SAAS,CAAC;YACrB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,MAAM,GAAG,EAAE,CAAC,eAAe,IAAI,EAAE,CAAC,eAAe,EAAE,CAAC;YACxD,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAC9C,CAAC;iBAAM,CAAC;gBACN,sCAAsC;gBACtC,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC,CAAC;;AAKJ,0CAA0C;AACzC,IAAY,CAAC,KAAK,GAAG,WAAW,CAAC","sourcesContent":["import { core } from './core.js';\r\nimport { assertParam, paramError } from './assert-param.js';\r\n\r\nfunction publishCore<T>(that: BreezeEvent<T>, data: T, errorCallback?: (e: Error) => any) {\r\n  let subscribers = that._subscribers;\r\n  if (!subscribers) return true;\r\n  // subscribers from outer scope.\r\n  subscribers.forEach(function (s) {\r\n    try {\r\n      s.callback(data);\r\n    } catch (e) {\r\n      e.context = \"unable to publish on topic: \" + that.name;\r\n      if (errorCallback) {\r\n        errorCallback(e);\r\n      } else if (that._defaultErrorCallback) {\r\n        that._defaultErrorCallback(e);\r\n      } else {\r\n        fallbackErrorHandler(e);\r\n      }\r\n    }\r\n  });\r\n}\r\n\r\n/**\r\n * Where a subscriber's exception goes when neither the `publish` call nor the event itself\r\n * supplies an error callback.\r\n *\r\n * It used to go nowhere at all. That is the worst thing it could do: a bug in a handler leaves no\r\n * trace, and the symptom is an event that looks as though it was never published. Reporting it\r\n * costs nothing on the path that matters, because it only runs when a subscriber has thrown.\r\n *\r\n * It is still not rethrown. Subscribers are independent, and one that fails must not stop the\r\n * others from being notified.\r\n */\r\nfunction fallbackErrorHandler(e: Error) {\r\n  const handler = BreezeEvent.unhandledErrorCallback;\r\n  if (handler) handler(e);\r\n}\r\n\r\n\r\n/** @hidden @internal */\r\nexport interface Subscription {\r\n  unsubKey: number;\r\n  callback: (data: any) => any;\r\n}\r\n\r\n/**\r\nClass to support basic event publication and subscription semantics.\r\n*/\r\nexport class BreezeEvent<T> {\r\n  /**\r\n   * Names of every event constructed so far. A Set: it is membership, not mapping.\r\n   * @hidden @internal\r\n   */\r\n  static __eventNameMap = new Set<string>();\r\n  /** @hidden @internal */\r\n  static __nextUnsubKey = 1;\r\n\r\n  /**\r\n   * Called with any exception a subscriber throws that nothing else has handled - that is, when\r\n   * neither `publish` nor the event was given an error callback.\r\n   *\r\n   * It logs to `console.error` by default. Set your own to route it into a logger, or `null` to\r\n   * go back to discarding these silently (which is what Breeze did before 3.0, and why handler\r\n   * bugs were so hard to find).\r\n   *\r\n   * ```ts\r\n   * BreezeEvent.unhandledErrorCallback = e => myLogger.error(e);\r\n   * BreezeEvent.unhandledErrorCallback = null;   // say nothing\r\n   * ```\r\n   */\r\n  static unhandledErrorCallback: ((e: Error) => void) | null = (e: Error) => {\r\n    // `context` is set by publishCore and names the event.\r\n    const where = (e as any).context || 'an event subscriber';\r\n    console.error(`breeze: ${where} threw and nothing handled it.`, e);\r\n  };\r\n  /** The name of this Event */\r\n  name: string;\r\n  /** The object doing the publication. i.e. the object to which this event is attached. */\r\n  publisher: Object;\r\n\r\n  // `declare`, so that neither becomes an own property set to undefined on every instance. An\r\n  // event is constructed twice for every entity in the cache and most are never subscribed to,\r\n  // so the slots would be pure weight. Both are read defensively below.\r\n  /** @hidden @internal */\r\n  declare _subscribers: Subscription[];\r\n  /** @hidden @internal */\r\n  declare _defaultErrorCallback: (e: Error) => any;\r\n\r\n  /**\r\n   * Whether anything is listening. Lets a caller skip building event arguments it would only\r\n   * throw away - `publish` on an unsubscribed event still walks the `_getEventParent` chain via\r\n   * `_isEnabled` before discovering there is nobody to tell.\r\n   * @hidden @internal\r\n   */\r\n  get hasSubscribers(): boolean {\r\n    const subs = this._subscribers;\r\n    return subs != null && subs.length > 0;\r\n  }\r\n\r\n\r\n  /**\r\n  Constructor for an Event\r\n  ```ts\r\n  salaryEvent = new BreezeEvent(\"salaryEvent\", person);\r\n  ```\r\n  @param name - The name of the event.\r\n  @param publisher - The object that will be doing the publication. i.e. the object to which this event is attached.\r\n  @param defaultErrorCallback - Function to call when an error occurs during subscription execution. \r\n  If omitted then subscriber notification failures will be ignored.\r\n  */\r\n  constructor(name: string, publisher: Object, defaultErrorCallback?: (e: Error) => any) {\r\n    // Checked inline rather than with assertParam: every entity constructs two of these,\r\n    // and the chain allocates several objects to answer what is one typeof. Same wording.\r\n    if (typeof name !== 'string' || name.length === 0) {\r\n      throw paramError('eventName', \"must be a nonEmpty string\");\r\n    }\r\n    if (publisher == null || typeof publisher !== 'object') {\r\n      throw paramError('publisher', \"must be a 'object'\");\r\n    }\r\n\r\n    this.name = name;\r\n    // register the name\r\n    BreezeEvent.__eventNameMap.add(name);\r\n    this.publisher = publisher;\r\n    if (defaultErrorCallback) {\r\n      this._defaultErrorCallback = defaultErrorCallback;\r\n    }\r\n  }\r\n\r\n  /**\r\n  Publish data for this event.\r\n  ```ts\r\n  // Assume 'salaryEvent' is previously constructed Event\r\n  salaryEvent.publish( { eventType: \"payRaise\", amount: 100 });\r\n  ```\r\n\r\n  This event can also be published asychronously\r\n  ```ts\r\n  salaryEvent.publish( { eventType: \"payRaise\", amount: 100 }, true);\r\n  ```\r\n\r\n  And we can add a handler in case the subscriber 'mishandles' the event.\r\n  ```ts\r\n  salaryEvent.publish( { eventType: \"payRaise\", amount: 100 }, true, function(error) {\r\n      // do something with the 'error' object\r\n  });\r\n  ```\r\n  @param data - Data to publish\r\n  @param publishAsync - (default=false) Whether to publish asynchonously or not.\r\n  @param errorCallback - Function to be called for any errors that occur during publication. If omitted,\r\n  errors will be eaten.\r\n  @returns false if event is disabled; true otherwise.\r\n  */\r\n  publish(data: T, publishAsync: boolean = false, errorCallback?: (e: Error) => any) {\r\n\r\n    if (!BreezeEvent._isEnabled(this.name, this.publisher)) return false;\r\n\r\n    if (publishAsync === true) {\r\n      setTimeout(publishCore, 0, this, data, errorCallback);\r\n    } else {\r\n      publishCore(this, data, errorCallback);\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /**\r\n  Publish data for this event asynchronously.\r\n  ```ts\r\n  // Assume 'salaryEvent' is previously constructed Event\r\n  salaryEvent.publishAsync( { eventType: \"payRaise\", amount: 100 });\r\n  ```\r\n\r\n  And we can add a handler in case the subscriber 'mishandles' the event.\r\n  ```ts\r\n  salaryEvent.publishAsync( { eventType: \"payRaise\", amount: 100 }, function(error) {\r\n      // do something with the 'error' object\r\n  });\r\n  ```\r\n  @param data - Data to publish\r\n  @param errorCallback - Function to be called for any errors that occur during publication. If omitted,\r\n  errors will be eaten.\r\n  */\r\n  publishAsync(data: T, errorCallback: (e: Error) => any) {\r\n    this.publish(data, true, errorCallback);\r\n  }\r\n\r\n  /**\r\n  Subscribe to this event.\r\n  ```ts\r\n  // Assume 'salaryEvent' is previously constructed Event\r\n  salaryEvent.subscribe(function (eventArgs) {\r\n      if (eventArgs.eventType === \"payRaise\") {\r\n          // do something\r\n      }\r\n  });\r\n  ```\r\n\r\n  There are several built in Breeze events, such as {@link EntityAspect.propertyChanged}, {@link EntityAspect.validationErrorsChanged} as well.\r\n  ```ts\r\n  // Assume order is a preexisting 'order' entity\r\n  order.entityAspect.propertyChanged.subscribe(function (pcEvent) {\r\n      if ( pcEvent.propertyName === \"OrderDate\") {\r\n          // do something\r\n      }\r\n  });\r\n  ```\r\n  @param callback - Called whenever data is published for this event, with that data as its argument. What is published is documented on each specific event.\r\n  @returns This is a key for 'unsubscription'.  It can be passed to the 'unsubscribe' method.\r\n  */\r\n  subscribe(callback: (data: T) => any) {\r\n    if (!this._subscribers) {\r\n      this._subscribers = [];\r\n    }\r\n\r\n    let unsubKey = BreezeEvent.__nextUnsubKey;\r\n    this._subscribers.push({ unsubKey: unsubKey, callback: callback });\r\n    ++BreezeEvent.__nextUnsubKey;\r\n    return unsubKey;\r\n  }\r\n\r\n  /**\r\n  Unsubscribe from this event.\r\n  ```ts\r\n  // Assume order is a preexisting 'order' entity\r\n  let token = order.entityAspect.propertyChanged.subscribe(function (pcEvent) {\r\n          // do something\r\n  });\r\n  // sometime later\r\n  order.entityAspect.propertyChanged.unsubscribe(token);\r\n  ```\r\n  @param unsubKey - The value returned from the 'subscribe' method may be used to unsubscribe here.\r\n  @returns Whether unsubscription occured. This will return false if already unsubscribed or if the key simply\r\n  cannot be found.\r\n  */\r\n  // A method, not a field holding a function: written as a field, every event carried its own\r\n  // copy of it rather than sharing one on the prototype.\r\n  unsubscribe(unsubKey: number) {\r\n    if (!this._subscribers) return false;\r\n    let subs = this._subscribers;\r\n    let ix = core.arrayIndexOf(subs, function (s) {\r\n      return s.unsubKey === unsubKey;\r\n    });\r\n    if (ix !== -1) {\r\n      subs.splice(ix, 1);\r\n      if (subs.length === 0) {\r\n        this._subscribers = <any>null;\r\n      }\r\n      return true;\r\n    } else {\r\n      return false;\r\n    }\r\n  }\r\n\r\n  /** remove all subscribers */\r\n  clear() {\r\n    this._subscribers = <any>null;\r\n  }\r\n\r\n  /** event bubbling - document later. */\r\n\r\n  // null or undefined 'getParentFn' means Event does not need to bubble i.e. that it is always enabled - .\r\n  static bubbleEvent(target: any, getParentFn?: (() => any)) {\r\n    target._getEventParent = getParentFn || null;\r\n  }\r\n\r\n  /**\r\n  Enables or disables the named event for an object and all of its children.\r\n  ```ts\r\n  BreezeEvent.enable(“propertyChanged”, myEntityManager, false)\r\n  ```\r\n\r\n  will disable all EntityAspect.propertyChanged events within a EntityManager.\r\n  ```ts\r\n  BreezeEvent.enable(“propertyChanged”, myEntityManager, true)\r\n  ```\r\n\r\n  will enable all EntityAspect.propertyChanged events within a EntityManager.\r\n  ```ts\r\n  BreezeEvent.enable(“propertyChanged”, myEntity.entityAspect, false)\r\n  ```\r\n\r\n  will disable EntityAspect.propertyChanged events for a specific entity.\r\n  ```ts\r\n  BreezeEvent.enable(“propertyChanged”, myEntity.entityAspect, null)\r\n  ```\r\n\r\n  will removes any enabling / disabling at the entity aspect level so now any 'Event.enable' calls at the EntityManager level,\r\n  made either previously or in the future, will control notification.\r\n  ```ts\r\n  BreezeEvent.enable(“validationErrorsChanged”, myEntityManager, function(em) {\r\n      return em.customTag === “blue”;\r\n  })\r\n  ```\r\n\r\n\r\n  will either enable or disable myEntityManager based on the current value of a ‘customTag’ property on myEntityManager.\r\n  Note that this is dynamic, changing the customTag value will cause events to be enabled or disabled immediately.\r\n  @param eventName - The name of the event.\r\n  @param obj - The object at which enabling or disabling will occur.  All event notifications that occur to this object or\r\n  children of this object will be enabled or disabled.\r\n  @param isEnabled - A boolean, a null or a function that returns either a boolean or a null.\r\n  */\r\n static enable(eventName: string, obj: Object, isEnabled: boolean | ((x: any) => boolean)) {\r\n    assertParam(eventName, \"eventName\").isNonEmptyString().check();\r\n    assertParam(obj, \"obj\").isObject().check();\r\n    assertParam(isEnabled, \"isEnabled\").isBoolean().isOptional().or().isFunction().check();\r\n    let ob = <any>obj;\r\n    if (!ob._$eventMap) {\r\n      ob._$eventMap = {};\r\n    }\r\n    ob._$eventMap[eventName] = isEnabled;\r\n  }\r\n\r\n  /**\r\n  Returns whether for a specific event and a specific object and its children, notification is enabled or disabled or not set.\r\n  ```ts\r\n  BreezeEvent.isEnabled(“propertyChanged”, myEntityManager)\r\n\r\n  ```\r\n  @param eventName - The name of the event.\r\n  @param obj - The object for which we want to know if notifications are enabled.\r\n  @returns Whether notifications are enabled. If nothing is set on the object, the answer comes from its parent chain, and defaults to true.\r\n  */\r\n  static isEnabled(eventName: string, obj: Object) {\r\n    assertParam(eventName, \"eventName\").isNonEmptyString().check();\r\n    assertParam(obj, \"obj\").isObject().check();\r\n    // null is ok - it just means that the object is at the top level.\r\n    if ((<any>obj)._getEventParent === undefined) {\r\n      throw new Error(\"This object does not support event enabling/disabling\");\r\n    }\r\n    return BreezeEvent._isEnabled(eventName, obj);\r\n  }\r\n\r\n  /** @hidden @internal */\r\n  static _isEnabled = function (eventName: string, obj: Object) {\r\n    let isEnabled: any = null;\r\n    let ob = <any>obj;\r\n    let eventMap = ob._$eventMap;\r\n    if (eventMap) {\r\n      isEnabled = eventMap[eventName];\r\n    }\r\n    if (isEnabled != null) {\r\n      if (typeof isEnabled === 'function') {\r\n        return !!isEnabled(obj);\r\n      } else {\r\n        return !!isEnabled;\r\n      }\r\n    } else {\r\n      let parent = ob._getEventParent && ob._getEventParent();\r\n      if (parent) {\r\n        return !!this._isEnabled(eventName, parent);\r\n      } else {\r\n        // default if not explicitly disabled.\r\n        return true;\r\n      }\r\n    }\r\n  };\r\n\r\n\r\n}\r\n\r\n// legacy support - deliberately not typed\r\n(core as any).Event = BreezeEvent;"]}

package/entity/array.d.ts

@@ -0,0 +1,3 @@
+export { makeRelationArray } from './relation-array.js';
+export { makeComplexArray } from './complex-array.js';
+export { makePrimitiveArray } from './primitive-array.js';

package/entity/array.js

@@ -0,0 +1,4 @@
+export { makeRelationArray } from './relation-array.js';
+export { makeComplexArray } from './complex-array.js';
+export { makePrimitiveArray } from './primitive-array.js';
+//# sourceMappingURL=array.js.map

package/entity/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../../src/entity/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC","sourcesContent":["export { makeRelationArray } from './relation-array.js';\r\nexport { makeComplexArray } from './complex-array.js';\r\nexport { makePrimitiveArray } from './primitive-array.js';\r\n"]}

package/entity/complex-array.d.ts

@@ -0,0 +1,17 @@
+import { ObservableArray } from './observable-array.js';
+import type { ComplexObject, StructuralObject } from './entity-aspect.js';
+import type { DataProperty } from '../metadata/entity-metadata.js';
+/** The value of a complex property that holds an array of complex objects. It is a real array:
+adding or removing an element marks the owning entity Modified, can be undone by `rejectChanges`,
+and raises the array's `arrayChanged` event with an {@link ArrayChangedArgs}. */
+export interface ComplexArray<T extends ComplexObject = ComplexObject> extends ObservableArray<T> {
+    /** The entity or complex object that owns this array. */
+    parent?: StructuralObject;
+    /** The complex {@link DataProperty} of `parent` that holds this array. */
+    parentProperty?: DataProperty;
+}
+/** For use by breeze plugin authors only. The class is for use in building a {@link ModelLibraryAdapter} implementation.
+@adapter (see {@link ModelLibraryAdapter})
+@hidden
+*/
+export declare function makeComplexArray(arr: any[], parent: StructuralObject, parentProperty: DataProperty): ComplexArray;

package/entity/complex-array.js

@@ -0,0 +1,104 @@
+import { BreezeEvent } from '../core/event.js';
+import { observableArray } from './observable-array.js';
+/*
+ Complex arrays are not a class: they are real arrays whose mutating methods are replaced, so that
+ changing one updates the entity that owns it. A complex array is a collection of complexTypes
+ associated with a data property on a single entity or other complex object, i.e. customer.orders
+ or order.orderDetails.
+ @class {complexArray}
+ */
+/*
+An {@link BreezeEvent} that fires whenever the contents of this array changed.  This event
+is fired any time a new entity is attached or added to the EntityManager and happens to belong to this collection.
+Adds that occur as a result of query or import operations are batched so that all of the adds or removes to any individual
+collections are collected into a single notification event for each relation array.
+@example
+    // assume order is an order entity attached to an EntityManager.
+    orders.arrayChanged.subscribe(
+    function (arrayChangedArgs) {
+        var addedEntities = arrayChangedArgs.added;
+        var removedEntities = arrayChanged.removed;
+    });
+@event arrayChanged
+@param added {Array of Entity} An array of all of the entities added to this collection.
+@param removed {Array of Entity} An array of all of the removed from this collection.
+@readOnly
+*/
+const complexArrayOps = {
+    // skip any that are already attached to this same parent
+    getGoodAdds: function (arr, adds) {
+        return adds.filter(function (a) {
+            return a.complexAspect == null || a.complexAspect.parent !== arr.parent;
+        });
+    },
+    beforeChange: function (arr) {
+        observableArray.updateEntityState(arr);
+    },
+    processAdds: function (arr, adds) {
+        adds.forEach(function (a) {
+            if (a.complexAspect && a.complexAspect.parent != null) {
+                throw new Error("The complexObject is already attached. Either clone it or remove it from its current owner");
+            }
+            setAspect(a, arr);
+        });
+    },
+    processRemoves: function (arr, removes) {
+        removes.forEach(function (a) {
+            clearAspect(a, arr);
+        });
+    },
+    getEventParent: function (arr) {
+        return observableArray.getEntityAspect(arr);
+    },
+    getPendingPubs: function (arr) {
+        const em = observableArray.getEntityAspect(arr).entityManager;
+        return em && em._pendingPubs;
+    },
+    rejectChanges: function (arr) {
+        const origValues = arr._obs.origValues;
+        if (!origValues)
+            return;
+        arr.forEach(function (co) {
+            clearAspect(co, arr);
+        });
+        arr.length = 0;
+        origValues.forEach(function (co) {
+            arr.push(co);
+        });
+    },
+    acceptChanges: function (arr) {
+        arr._obs.origValues = null;
+    }
+};
+// local functions
+function clearAspect(co, arr) {
+    let coAspect = co.complexAspect;
+    // if not already attached - exit
+    if (coAspect.parent !== arr.parent)
+        return null;
+    coAspect.parent = undefined;
+    coAspect.parentProperty = undefined;
+    return coAspect;
+}
+function setAspect(co, arr) {
+    let coAspect = co.complexAspect;
+    // if already attached - exit
+    if (coAspect.parent === arr.parent)
+        return null;
+    coAspect.parent = arr.parent;
+    coAspect.parentProperty = arr.parentProperty;
+    return coAspect;
+}
+/** For use by breeze plugin authors only. The class is for use in building a {@link ModelLibraryAdapter} implementation.
+@adapter (see {@link ModelLibraryAdapter})
+@hidden
+*/
+export function makeComplexArray(arr, parent, parentProperty) {
+    const arrX = arr;
+    arrX.parent = parent;
+    arrX.parentProperty = parentProperty;
+    arrX.arrayChanged = new BreezeEvent("arrayChanged", arrX);
+    observableArray.initialize(arrX, complexArrayOps);
+    return arrX;
+}
+//# sourceMappingURL=complex-array.js.map

package/entity/complex-array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"complex-array.js","sourceRoot":"","sources":["../../src/entity/complex-array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAuC,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAc7F;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;EAgBE;AAEF,MAAM,eAAe,GAAuB;IAE1C,yDAAyD;IACzD,WAAW,EAAE,UAAU,GAAiB,EAAE,IAAqB;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;YAC5B,OAAO,CAAC,CAAC,aAAa,IAAI,IAAI,IAAI,CAAC,CAAC,aAAa,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC;QAC1E,CAAC,CAAC,CAAC;IACL,CAAC;IAED,YAAY,EAAE,UAAU,GAAiB;QACvC,eAAe,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,WAAW,EAAE,UAAU,GAAiB,EAAE,IAAqB;QAC7D,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;YACtB,IAAI,CAAC,CAAC,aAAa,IAAI,CAAC,CAAC,aAAa,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;gBACtD,MAAM,IAAI,KAAK,CAAC,4FAA4F,CAAC,CAAC;YAChH,CAAC;YACD,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,cAAc,EAAE,UAAU,GAAiB,EAAE,OAAwB;QACnE,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;YACzB,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,cAAc,EAAE,UAAU,GAAiB;QACzC,OAAO,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,cAAc,EAAE,UAAU,GAAiB;QACzC,MAAM,EAAE,GAAG,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC;QAC9D,OAAO,EAAE,IAAK,EAAU,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,aAAa,EAAE,UAAU,GAAiB;QACxC,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,UAAU;YAAE,OAAO;QACxB,GAAG,CAAC,OAAO,CAAC,UAAU,EAAiB;YACrC,WAAW,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;QACf,UAAU,CAAC,OAAO,CAAC,UAAU,EAAiB;YAC5C,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,EAAE,UAAU,GAAiB;QACxC,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IAC7B,CAAC;CACF,CAAC;AAEF,kBAAkB;AAElB,SAAS,WAAW,CAAC,EAAiB,EAAE,GAAiB;IACvD,IAAI,QAAQ,GAAG,EAAE,CAAC,aAAa,CAAC;IAChC,iCAAiC;IACjC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAEhD,QAAQ,CAAC,MAAM,GAAG,SAAS,CAAC;IAC5B,QAAQ,CAAC,cAAc,GAAG,SAAS,CAAC;IACpC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,SAAS,CAAC,EAAiB,EAAE,GAAiB;IACrD,IAAI,QAAQ,GAAG,EAAE,CAAC,aAAa,CAAC;IAChC,6BAA6B;IAC7B,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAChD,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAC7B,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;IAE7C,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;EAGE;AACF,MAAM,UAAU,gBAAgB,CAAC,GAAU,EAAE,MAAwB,EAAE,cAA4B;IACjG,MAAM,IAAI,GAAG,GAAU,CAAC;IACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACrB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACrC,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAC1D,eAAe,CAAC,UAAU,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAClD,OAAO,IAAoB,CAAC;AAC9B,CAAC","sourcesContent":["import { BreezeEvent } from '../core/event.js';\r\nimport { ObservableArray, ObservableArrayOps, observableArray } from './observable-array.js';\r\nimport type { ComplexObject, StructuralObject } from './entity-aspect.js';\r\nimport type { DataProperty } from '../metadata/entity-metadata.js';\r\n\r\n/** The value of a complex property that holds an array of complex objects. It is a real array:\r\nadding or removing an element marks the owning entity Modified, can be undone by `rejectChanges`,\r\nand raises the array's `arrayChanged` event with an {@link ArrayChangedArgs}. */\r\nexport interface ComplexArray<T extends ComplexObject = ComplexObject> extends ObservableArray<T> {\r\n  /** The entity or complex object that owns this array. */\r\n  parent?: StructuralObject;\r\n  /** The complex {@link DataProperty} of `parent` that holds this array. */\r\n  parentProperty?: DataProperty;\r\n}\r\n\r\n/*\r\n Complex arrays are not a class: they are real arrays whose mutating methods are replaced, so that\r\n changing one updates the entity that owns it. A complex array is a collection of complexTypes\r\n associated with a data property on a single entity or other complex object, i.e. customer.orders\r\n or order.orderDetails.\r\n @class {complexArray}\r\n */\r\n\r\n/*\r\nAn {@link BreezeEvent} that fires whenever the contents of this array changed.  This event\r\nis fired any time a new entity is attached or added to the EntityManager and happens to belong to this collection.\r\nAdds that occur as a result of query or import operations are batched so that all of the adds or removes to any individual\r\ncollections are collected into a single notification event for each relation array.\r\n@example\r\n    // assume order is an order entity attached to an EntityManager.\r\n    orders.arrayChanged.subscribe(\r\n    function (arrayChangedArgs) {\r\n        var addedEntities = arrayChangedArgs.added;\r\n        var removedEntities = arrayChanged.removed;\r\n    });\r\n@event arrayChanged\r\n@param added {Array of Entity} An array of all of the entities added to this collection.\r\n@param removed {Array of Entity} An array of all of the removed from this collection.\r\n@readOnly\r\n*/\r\n\r\nconst complexArrayOps: ObservableArrayOps = {\r\n\r\n  // skip any that are already attached to this same parent\r\n  getGoodAdds: function (arr: ComplexArray, adds: ComplexObject[]) {\r\n    return adds.filter(function (a) {\r\n      return a.complexAspect == null || a.complexAspect.parent !== arr.parent;\r\n    });\r\n  },\r\n\r\n  beforeChange: function (arr: ComplexArray) {\r\n    observableArray.updateEntityState(arr);\r\n  },\r\n\r\n  processAdds: function (arr: ComplexArray, adds: ComplexObject[]) {\r\n    adds.forEach(function (a) {\r\n      if (a.complexAspect && a.complexAspect.parent != null) {\r\n        throw new Error(\"The complexObject is already attached. Either clone it or remove it from its current owner\");\r\n      }\r\n      setAspect(a, arr);\r\n    });\r\n  },\r\n\r\n  processRemoves: function (arr: ComplexArray, removes: ComplexObject[]) {\r\n    removes.forEach(function (a) {\r\n      clearAspect(a, arr);\r\n    });\r\n  },\r\n\r\n  getEventParent: function (arr: ComplexArray) {\r\n    return observableArray.getEntityAspect(arr);\r\n  },\r\n\r\n  getPendingPubs: function (arr: ComplexArray) {\r\n    const em = observableArray.getEntityAspect(arr).entityManager;\r\n    return em && (em as any)._pendingPubs;\r\n  },\r\n\r\n  rejectChanges: function (arr: ComplexArray) {\r\n    const origValues = arr._obs.origValues;\r\n    if (!origValues) return;\r\n    arr.forEach(function (co: ComplexObject) {\r\n      clearAspect(co, arr);\r\n    });\r\n    arr.length = 0;\r\n    origValues.forEach(function (co: ComplexObject) {\r\n      arr.push(co);\r\n    });\r\n  },\r\n\r\n  acceptChanges: function (arr: ComplexArray) {\r\n    arr._obs.origValues = null;\r\n  }\r\n};\r\n\r\n// local functions\r\n\r\nfunction clearAspect(co: ComplexObject, arr: ComplexArray) {\r\n  let coAspect = co.complexAspect;\r\n  // if not already attached - exit\r\n  if (coAspect.parent !== arr.parent) return null;\r\n\r\n  coAspect.parent = undefined;\r\n  coAspect.parentProperty = undefined;\r\n  return coAspect;\r\n}\r\n\r\nfunction setAspect(co: ComplexObject, arr: ComplexArray) {\r\n  let coAspect = co.complexAspect;\r\n  // if already attached - exit\r\n  if (coAspect.parent === arr.parent) return null;\r\n  coAspect.parent = arr.parent;\r\n  coAspect.parentProperty = arr.parentProperty;\r\n\r\n  return coAspect;\r\n}\r\n\r\n/** For use by breeze plugin authors only. The class is for use in building a {@link ModelLibraryAdapter} implementation.\r\n@adapter (see {@link ModelLibraryAdapter})\r\n@hidden\r\n*/\r\nexport function makeComplexArray(arr: any[], parent: StructuralObject, parentProperty: DataProperty): ComplexArray {\r\n  const arrX = arr as any;\r\n  arrX.parent = parent;\r\n  arrX.parentProperty = parentProperty;\r\n  arrX.arrayChanged = new BreezeEvent(\"arrayChanged\", arrX);\r\n  observableArray.initialize(arrX, complexArrayOps);\r\n  return arrX as ComplexArray;\r\n}\r\n"]}

package/entity/default-property-interceptor.d.ts

@@ -0,0 +1 @@
+export {};