breeze-client 2.2.1 → 3.0.0

package/entity/relation-array.d.ts

@@ -0,0 +1,24 @@
+import { ObservableArray } from './observable-array.js';
+import type { Entity, QueriedAs } from './entity-aspect.js';
+import type { QueryErrorCallback, QueryResult, QuerySuccessCallback } from '../manager/entity-manager.js';
+import type { DataProperty, NavigationProperty } from '../metadata/entity-metadata.js';
+/** The value of a collection navigation property, such as `customer.orders`. It is a real array:
+adding an entity sets the entity's inverse navigation property (or foreign key) to point at the
+parent, attaching it to the parent's manager if it is detached, and removing one sets its inverse
+navigation property to null. Changes raise the array's `arrayChanged` event with an {@link ArrayChangedArgs}. */
+export interface RelationArray<T extends Entity = Entity> extends ObservableArray<T> {
+    /** The entity whose navigation property holds this array. */
+    parentEntity: Entity;
+    /** Not set on a relation array: always undefined. Use `navigationProperty`. */
+    parentProperty?: DataProperty;
+    /** The {@link NavigationProperty} of `parentEntity` that holds this array. */
+    navigationProperty: NavigationProperty;
+    load(): Promise<QueryResult<QueriedAs<T>>>;
+    /** @deprecated Await the returned promise instead of passing callbacks. */
+    load(querySuccessCallback?: QuerySuccessCallback, queryErrorCallback?: QueryErrorCallback): Promise<QueryResult<QueriedAs<T>>>;
+}
+/** 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 makeRelationArray(arr: any[], parentEntity: Entity, navigationProperty: NavigationProperty): RelationArray;

package/entity/relation-array.js

@@ -0,0 +1,176 @@
+import { BreezeEvent } from '../core/event.js';
+import { observableArray } from './observable-array.js';
+import { EntityState } from './entity-state.js';
+import { EntityQuery } from '../query/entity-query.js';
+/*
+ Relation arrays are not a class: they are real arrays whose mutating methods are replaced, so that
+ changing one updates both ends of the relationship. A relation array is a collection of entities
+ associated with a navigation property on a single entity, i.e. customer.orders or
+ order.orderDetails.
+ @class {relationArray}
+ */
+/*
+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) {
+        let addedEntities = arrayChangedArgs.added;
+        let 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
+*/
+/**
+Performs an asynchronous load of all other the entities associated with this relationArray.
+@example
+    // assume orders is an empty, as yet unpopulated, relation array of orders
+    // associated with a specific customer.
+    orders.load().then(...)
+The callback arguments are deprecated. They still work, but the promise is the supported
+form and they will be removed in a future major version.
+@param [callback] {Function} Deprecated.
+@param [errorCallback] {Function} Deprecated.
+@returns {Promise}
+*/
+function load(callback, errorCallback) {
+    const parent = this.parentEntity;
+    const query = EntityQuery.fromEntityNavigation(this.parentEntity, this.navigationProperty);
+    const em = parent.entityAspect.entityManager;
+    return em.executeQuery(query, callback, errorCallback);
+}
+const relationArrayOps = {
+    getGoodAdds: function (arr, adds) {
+        return getGoodAdds(arr, adds);
+    },
+    beforeChange: function (arr) {
+        // a relation array does not change the state of the entity that owns it
+    },
+    processAdds: function (arr, adds) {
+        processAdds(arr, adds);
+    },
+    processRemoves: function (arr, removes) {
+        processRemoves(arr, removes);
+    },
+    getEventParent: function (arr) {
+        return arr.parentEntity.entityAspect;
+    },
+    getPendingPubs: function (arr) {
+        const em = arr.parentEntity.entityAspect.entityManager;
+        return em && em._pendingPubs;
+    }
+};
+function getGoodAdds(relationArray, adds) {
+    let goodAdds = checkForDups(relationArray, adds);
+    if (!goodAdds.length) {
+        return goodAdds;
+    }
+    let parentEntity = relationArray.parentEntity;
+    let entityManager = parentEntity.entityAspect.entityManager;
+    // we do not want to attach an entity during loading
+    // because these will all be 'attached' at a later step.
+    if (entityManager && !entityManager.isLoading) {
+        goodAdds.forEach(function (add) {
+            if (add.entityAspect.entityState.isDetached()) {
+                relationArray._obs.inProgress = true;
+                try {
+                    entityManager.attachEntity(add, EntityState.Added);
+                }
+                finally {
+                    relationArray._obs.inProgress = false;
+                }
+            }
+        });
+    }
+    return goodAdds;
+}
+function processAdds(relationArray, adds) {
+    let parentEntity = relationArray.parentEntity;
+    let np = relationArray.navigationProperty;
+    let addsInProcess = relationArray._obs.addsInProcess;
+    let invNp = np.inverse;
+    let startIx = addsInProcess.length;
+    try {
+        adds.forEach(function (childEntity) {
+            addsInProcess.push(childEntity);
+            if (invNp) {
+                childEntity.setProperty(invNp.name, parentEntity);
+            }
+            else {
+                // This occurs with a unidirectional 1-n navigation - in this case
+                // we need to update the fks instead of the navProp
+                let pks = parentEntity.entityType.keyProperties;
+                np.invForeignKeyNames.forEach(function (fk, i) {
+                    childEntity.setProperty(fk, parentEntity.getProperty(pks[i].name));
+                });
+            }
+        });
+    }
+    finally {
+        addsInProcess.splice(startIx, adds.length);
+    }
+}
+function processRemoves(relationArray, removes) {
+    let inp = relationArray.navigationProperty.inverse;
+    if (inp) {
+        removes.forEach(function (childEntity) {
+            childEntity.setProperty(inp.name, null);
+        });
+    }
+}
+function checkForDups(relationArray, adds) {
+    // don't allow dups in this array. - also prevents recursion
+    let parentEntity = relationArray.parentEntity;
+    let navProp = relationArray.navigationProperty;
+    let inverseProp = navProp.inverse;
+    let addsInProcess = relationArray._obs.addsInProcess;
+    let goodAdds;
+    if (inverseProp) {
+        goodAdds = adds.filter(function (a) {
+            if (addsInProcess.indexOf(a) >= 0) {
+                return false;
+            }
+            let inverseValue = a.getProperty(inverseProp.name);
+            return inverseValue !== parentEntity;
+        });
+    }
+    else {
+        // This occurs with a unidirectional 1->N relation ( where there is no n -> 1)
+        // in this case we compare fks.
+        let fkPropNames = navProp.invForeignKeyNames;
+        let keyProps = parentEntity.entityType.keyProperties;
+        goodAdds = adds.filter(function (a) {
+            if (addsInProcess.indexOf(a) >= 0) {
+                return false;
+            }
+            return fkPropNames.some(function (fk, i) {
+                let keyProp = keyProps[i].name;
+                let keyVal = parentEntity.getProperty(keyProp);
+                let fkVal = a.getProperty(fk);
+                return keyVal !== fkVal;
+            });
+        });
+    }
+    return goodAdds;
+}
+/** 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 makeRelationArray(arr, parentEntity, navigationProperty) {
+    const arrX = arr;
+    arrX.parentEntity = parentEntity;
+    arrX.navigationProperty = navigationProperty;
+    arrX.arrayChanged = new BreezeEvent("arrayChanged", arrX);
+    arrX.load = load;
+    // addsInProcess: the pushes currently being processed on this array, which is what stops the
+    // relationship fixup from recursing back into it.
+    observableArray.initialize(arrX, relationArrayOps, { addsInProcess: [] });
+    return arrX;
+}
+//# sourceMappingURL=relation-array.js.map

package/entity/relation-array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation-array.js","sourceRoot":"","sources":["../../src/entity/relation-array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAuC,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7F,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAqBvD;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;EAgBE;AAEF;;;;;;;;;;;EAWE;AACF,SAAS,IAAI,CAAsB,QAA+B,EAAE,aAAkC;IACpG,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;IACjC,MAAM,KAAK,GAAG,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3F,MAAM,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,aAAc,CAAC;IAC9C,OAAO,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;AACzD,CAAC;AAED,MAAM,gBAAgB,GAAuB;IAE3C,WAAW,EAAE,UAAU,GAAkB,EAAE,IAAc;QACvD,OAAO,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,YAAY,EAAE,UAAU,GAAkB;QACxC,wEAAwE;IAC1E,CAAC;IAED,WAAW,EAAE,UAAU,GAAkB,EAAE,IAAc;QACvD,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,cAAc,EAAE,UAAU,GAAkB,EAAE,OAAiB;QAC7D,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,cAAc,EAAE,UAAU,GAAkB;QAC1C,OAAO,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC;IACvC,CAAC;IAED,cAAc,EAAE,UAAU,GAAkB;QAC1C,MAAM,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,aAAa,CAAC;QACvD,OAAO,EAAE,IAAK,EAAU,CAAC,YAAY,CAAC;IACxC,CAAC;CACF,CAAC;AAEF,SAAS,WAAW,CAAC,aAA4B,EAAE,IAAc;IAC/D,IAAI,QAAQ,GAAG,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACjD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;IAC9C,IAAI,aAAa,GAAG,YAAY,CAAC,YAAY,CAAC,aAAa,CAAC;IAC5D,oDAAoD;IACpD,wDAAwD;IACxD,IAAI,aAAa,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;QAC9C,QAAQ,CAAC,OAAO,CAAC,UAAU,GAAG;YAC5B,IAAI,GAAG,CAAC,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;gBAC9C,aAAa,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACrC,IAAI,CAAC;oBACH,aAAc,CAAC,YAAY,CAAC,GAAG,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;gBACtD,CAAC;wBAAS,CAAC;oBACT,aAAa,CAAC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;gBACxC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,WAAW,CAAC,aAA4B,EAAE,IAAc;IAC/D,IAAI,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;IAC9C,IAAI,EAAE,GAAG,aAAa,CAAC,kBAAkB,CAAC;IAC1C,IAAI,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,aAAc,CAAC;IAEtD,IAAI,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC;IACvB,IAAI,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC;IACnC,IAAI,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,UAAU,WAAW;YAChC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAChC,IAAI,KAAK,EAAE,CAAC;gBACV,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,kEAAkE;gBAClE,mDAAmD;gBACnD,IAAI,GAAG,GAAG,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC;gBAChD,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;oBAC3C,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBACrE,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;AAEH,CAAC;AAED,SAAS,cAAc,CAAC,aAA4B,EAAE,OAAiB;IACrE,IAAI,GAAG,GAAG,aAAa,CAAC,kBAAkB,CAAC,OAAO,CAAC;IACnD,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,CAAC,OAAO,CAAC,UAAU,WAAW;YACnC,WAAW,CAAC,WAAW,CAAC,GAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,aAA4B,EAAE,IAAc;IAChE,4DAA4D;IAC5D,IAAI,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;IAC9C,IAAI,OAAO,GAAG,aAAa,CAAC,kBAAkB,CAAC;IAC/C,IAAI,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAClC,IAAI,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,aAAc,CAAC;IACtD,IAAI,QAAkB,CAAC;IACvB,IAAI,WAAW,EAAE,CAAC;QAChB,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;YAChC,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,WAAY,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,YAAY,KAAK,YAAY,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,8EAA8E;QAC9E,+BAA+B;QAC/B,IAAI,WAAW,GAAG,OAAO,CAAC,kBAAkB,CAAC;QAC7C,IAAI,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC;QACrD,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;YAChC,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;gBACrC,IAAI,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC/B,IAAI,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAC/C,IAAI,KAAK,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;gBAC9B,OAAO,MAAM,KAAK,KAAK,CAAC;YAC1B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;EAGE;AACF,MAAM,UAAU,iBAAiB,CAAC,GAAU,EAAE,YAAoB,EAAE,kBAAsC;IACxG,MAAM,IAAI,GAAG,GAAU,CAAC;IACxB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACjC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAC7C,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAC1D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACjB,6FAA6F;IAC7F,kDAAkD;IAClD,eAAe,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1E,OAAO,IAAqB,CAAC;AAC/B,CAAC","sourcesContent":["import { BreezeEvent } from '../core/event.js';\r\nimport { ObservableArray, ObservableArrayOps, observableArray } from './observable-array.js';\r\nimport { EntityState } from './entity-state.js';\r\nimport { EntityQuery } from '../query/entity-query.js';\r\nimport type { Entity, QueriedAs } from './entity-aspect.js';\r\nimport type { QueryErrorCallback, QueryResult, QuerySuccessCallback } from '../manager/entity-manager.js';\r\nimport type { DataProperty, NavigationProperty } from '../metadata/entity-metadata.js';\r\n\r\n/** The value of a collection navigation property, such as `customer.orders`. It is a real array:\r\nadding an entity sets the entity's inverse navigation property (or foreign key) to point at the\r\nparent, attaching it to the parent's manager if it is detached, and removing one sets its inverse\r\nnavigation property to null. Changes raise the array's `arrayChanged` event with an {@link ArrayChangedArgs}. */\r\nexport interface RelationArray<T extends Entity = Entity> extends ObservableArray<T> {\r\n  /** The entity whose navigation property holds this array. */\r\n  parentEntity: Entity;\r\n  /** Not set on a relation array: always undefined. Use `navigationProperty`. */\r\n  parentProperty?: DataProperty;\r\n  /** The {@link NavigationProperty} of `parentEntity` that holds this array. */\r\n  navigationProperty: NavigationProperty;\r\n  load(): Promise<QueryResult<QueriedAs<T>>>;\r\n  /** @deprecated Await the returned promise instead of passing callbacks. */\r\n  load(querySuccessCallback?: QuerySuccessCallback, queryErrorCallback?: QueryErrorCallback): Promise<QueryResult<QueriedAs<T>>>;\r\n}\r\n\r\n/*\r\n Relation arrays are not a class: they are real arrays whose mutating methods are replaced, so that\r\n changing one updates both ends of the relationship. A relation array is a collection of entities\r\n associated with a navigation property on a single entity, i.e. customer.orders or\r\n order.orderDetails.\r\n @class {relationArray}\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        let addedEntities = arrayChangedArgs.added;\r\n        let 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\n/**\r\nPerforms an asynchronous load of all other the entities associated with this relationArray.\r\n@example\r\n    // assume orders is an empty, as yet unpopulated, relation array of orders\r\n    // associated with a specific customer.\r\n    orders.load().then(...)\r\nThe callback arguments are deprecated. They still work, but the promise is the supported\r\nform and they will be removed in a future major version.\r\n@param [callback] {Function} Deprecated.\r\n@param [errorCallback] {Function} Deprecated.\r\n@returns {Promise}\r\n*/\r\nfunction load(this: RelationArray, callback?: QuerySuccessCallback, errorCallback?: QueryErrorCallback): Promise<QueryResult> {\r\n  const parent = this.parentEntity;\r\n  const query = EntityQuery.fromEntityNavigation(this.parentEntity, this.navigationProperty);\r\n  const em = parent.entityAspect.entityManager!;\r\n  return em.executeQuery(query, callback, errorCallback);\r\n}\r\n\r\nconst relationArrayOps: ObservableArrayOps = {\r\n\r\n  getGoodAdds: function (arr: RelationArray, adds: Entity[]) {\r\n    return getGoodAdds(arr, adds);\r\n  },\r\n\r\n  beforeChange: function (arr: RelationArray) {\r\n    // a relation array does not change the state of the entity that owns it\r\n  },\r\n\r\n  processAdds: function (arr: RelationArray, adds: Entity[]) {\r\n    processAdds(arr, adds);\r\n  },\r\n\r\n  processRemoves: function (arr: RelationArray, removes: Entity[]) {\r\n    processRemoves(arr, removes);\r\n  },\r\n\r\n  getEventParent: function (arr: RelationArray) {\r\n    return arr.parentEntity.entityAspect;\r\n  },\r\n\r\n  getPendingPubs: function (arr: RelationArray) {\r\n    const em = arr.parentEntity.entityAspect.entityManager;\r\n    return em && (em as any)._pendingPubs;\r\n  }\r\n};\r\n\r\nfunction getGoodAdds(relationArray: RelationArray, adds: Entity[]) {\r\n  let goodAdds = checkForDups(relationArray, adds);\r\n  if (!goodAdds.length) {\r\n    return goodAdds;\r\n  }\r\n  let parentEntity = relationArray.parentEntity;\r\n  let entityManager = parentEntity.entityAspect.entityManager;\r\n  // we do not want to attach an entity during loading\r\n  // because these will all be 'attached' at a later step.\r\n  if (entityManager && !entityManager.isLoading) {\r\n    goodAdds.forEach(function (add) {\r\n      if (add.entityAspect.entityState.isDetached()) {\r\n        relationArray._obs.inProgress = true;\r\n        try {\r\n          entityManager!.attachEntity(add, EntityState.Added);\r\n        } finally {\r\n          relationArray._obs.inProgress = false;\r\n        }\r\n      }\r\n    });\r\n  }\r\n  return goodAdds;\r\n}\r\n\r\nfunction processAdds(relationArray: RelationArray, adds: Entity[]) {\r\n  let parentEntity = relationArray.parentEntity;\r\n  let np = relationArray.navigationProperty;\r\n  let addsInProcess = relationArray._obs.addsInProcess!;\r\n\r\n  let invNp = np.inverse;\r\n  let startIx = addsInProcess.length;\r\n  try {\r\n    adds.forEach(function (childEntity) {\r\n      addsInProcess.push(childEntity);\r\n      if (invNp) {\r\n        childEntity.setProperty(invNp.name, parentEntity);\r\n      } else {\r\n        // This occurs with a unidirectional 1-n navigation - in this case\r\n        // we need to update the fks instead of the navProp\r\n        let pks = parentEntity.entityType.keyProperties;\r\n        np.invForeignKeyNames.forEach(function (fk, i) {\r\n          childEntity.setProperty(fk, parentEntity.getProperty(pks[i].name));\r\n        });\r\n      }\r\n    });\r\n  } finally {\r\n    addsInProcess.splice(startIx, adds.length);\r\n  }\r\n\r\n}\r\n\r\nfunction processRemoves(relationArray: RelationArray, removes: Entity[]) {\r\n  let inp = relationArray.navigationProperty.inverse;\r\n  if (inp) {\r\n    removes.forEach(function (childEntity) {\r\n      childEntity.setProperty(inp!.name, null);\r\n    });\r\n  }\r\n}\r\n\r\nfunction checkForDups(relationArray: RelationArray, adds: Entity[]) {\r\n  // don't allow dups in this array. - also prevents recursion\r\n  let parentEntity = relationArray.parentEntity;\r\n  let navProp = relationArray.navigationProperty;\r\n  let inverseProp = navProp.inverse;\r\n  let addsInProcess = relationArray._obs.addsInProcess!;\r\n  let goodAdds: Entity[];\r\n  if (inverseProp) {\r\n    goodAdds = adds.filter(function (a) {\r\n      if (addsInProcess.indexOf(a) >= 0) {\r\n        return false;\r\n      }\r\n      let inverseValue = a.getProperty(inverseProp!.name);\r\n      return inverseValue !== parentEntity;\r\n    });\r\n  } else {\r\n    // This occurs with a unidirectional 1->N relation ( where there is no n -> 1)\r\n    // in this case we compare fks.\r\n    let fkPropNames = navProp.invForeignKeyNames;\r\n    let keyProps = parentEntity.entityType.keyProperties;\r\n    goodAdds = adds.filter(function (a) {\r\n      if (addsInProcess.indexOf(a) >= 0) {\r\n        return false;\r\n      }\r\n      return fkPropNames.some(function (fk, i) {\r\n        let keyProp = keyProps[i].name;\r\n        let keyVal = parentEntity.getProperty(keyProp);\r\n        let fkVal = a.getProperty(fk);\r\n        return keyVal !== fkVal;\r\n      });\r\n    });\r\n  }\r\n  return goodAdds;\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 makeRelationArray(arr: any[], parentEntity: Entity, navigationProperty: NavigationProperty): RelationArray {\r\n  const arrX = arr as any;\r\n  arrX.parentEntity = parentEntity;\r\n  arrX.navigationProperty = navigationProperty;\r\n  arrX.arrayChanged = new BreezeEvent(\"arrayChanged\", arrX);\r\n  arrX.load = load;\r\n  // addsInProcess: the pushes currently being processed on this array, which is what stops the\r\n  // relationship fixup from recursing back into it.\r\n  observableArray.initialize(arrX, relationArrayOps, { addsInProcess: [] });\r\n  return arrX as RelationArray;\r\n}\r\n"]}

package/entity/unattached-children-map.d.ts

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

package/entity/unattached-children-map.js

@@ -0,0 +1,105 @@
+import { core } from '../core/core.js';
+/** @hidden @internal */
+// Represents entities not yet attached to navigationProperties. 
+export class UnattachedChildrenMap {
+    // key is EntityKey.toString(), value is array of { navigationProperty, children }
+    map = new Map();
+    // Which keys each child is parked under, so that detaching it is a lookup rather than a scan
+    // of the whole map. A WeakMap because it is only ever read for a child we are already holding,
+    // and an entry that outlives its entity would be the leak this exists to close.
+    childKeys = new WeakMap();
+    addChild(parentEntityKey, navigationProperty, child) {
+        let tuple = this.getTuple(parentEntityKey, navigationProperty);
+        if (!tuple) {
+            tuple = { navigationProperty: navigationProperty, children: [] };
+            core.getMapArray(this.map, parentEntityKey.toString()).push(tuple);
+        }
+        tuple.children.push(child);
+        // getTuple looks up the hierarchy, so the tuple just pushed into may be stored under a base
+        // type's key. Record every key it could be under; removeChild ignores the ones it is not in.
+        let keys = this.childKeys.get(child);
+        if (!keys) {
+            keys = new Set();
+            this.childKeys.set(child, keys);
+        }
+        keys.add(parentEntityKey.toString());
+        let entityType = parentEntityKey.entityType;
+        while (entityType.baseEntityType) {
+            entityType = entityType.baseEntityType;
+            keys.add(parentEntityKey.toString(entityType));
+        }
+    }
+    /**
+     * Takes a child out of every entry it is parked under, and drops an entry that is left empty.
+     *
+     * Called when an entity is detached. Without it a child whose parent never arrived is held for
+     * the life of the manager: `clear()` replaces the whole map, but `detachEntity` is how an
+     * application drops one row. See the retention tier.
+     */
+    removeChild(child) {
+        const keys = this.childKeys.get(child);
+        if (!keys)
+            return;
+        for (const keyString of keys) {
+            const tuples = this.map.get(keyString);
+            if (!tuples)
+                continue;
+            for (let i = tuples.length - 1; i >= 0; i--) {
+                const children = tuples[i].children;
+                const ix = children.indexOf(child);
+                if (ix >= 0)
+                    children.splice(ix, 1);
+                if (children.length === 0)
+                    tuples.splice(i, 1);
+            }
+            if (tuples.length === 0)
+                this.map.delete(keyString);
+        }
+        this.childKeys.delete(child);
+    }
+    removeChildren(parentEntityKeyString, navigationProperty) {
+        let tuples = this.map.get(parentEntityKeyString);
+        if (!tuples)
+            return;
+        core.arrayRemoveItem(tuples, (t) => {
+            return t.navigationProperty === navigationProperty;
+        });
+        if (!tuples.length) {
+            this.map.delete(parentEntityKeyString);
+        }
+    }
+    getTuple(parentEntityKey, navigationProperty) {
+        let tuples = this.getTuples(parentEntityKey);
+        if (!tuples)
+            return null;
+        let tuple = core.arrayFirst(tuples, function (t) {
+            return t.navigationProperty === navigationProperty;
+        });
+        return tuple;
+    }
+    getTuples(parentEntityKey) {
+        let tuples = this.map.get(parentEntityKey.toString());
+        let entityType = parentEntityKey.entityType;
+        // Nothing above it in the hierarchy, which is the usual case: there is only one entry to
+        // find, so hand back the stored array rather than copying it into a new one. addChild goes
+        // through here for every child it registers.
+        if (!entityType.baseEntityType)
+            return tuples && tuples.length ? tuples : undefined;
+        let allTuples;
+        while (entityType.baseEntityType) {
+            entityType = entityType.baseEntityType;
+            let baseTuples = this.map.get(parentEntityKey.toString(entityType));
+            if (baseTuples) {
+                // only now is a combined array needed
+                allTuples = allTuples || (tuples ? tuples.slice() : []);
+                allTuples.push(...baseTuples);
+            }
+        }
+        allTuples = allTuples || tuples;
+        return allTuples && allTuples.length ? allTuples : undefined;
+    }
+    getTuplesByString(parentEntityKeyString) {
+        return this.map.get(parentEntityKeyString);
+    }
+}
+//# sourceMappingURL=unattached-children-map.js.map

package/entity/unattached-children-map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unattached-children-map.js","sourceRoot":"","sources":["../../src/entity/unattached-children-map.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAWvC,wBAAwB;AACxB,iEAAiE;AACjE,MAAM,OAAO,qBAAqB;IAChC,kFAAkF;IAClF,GAAG,GAAG,IAAI,GAAG,EAAuB,CAAC;IAErC,6FAA6F;IAC7F,+FAA+F;IAC/F,gFAAgF;IACxE,SAAS,GAAG,IAAI,OAAO,EAAuB,CAAC;IAEvD,QAAQ,CAAC,eAA0B,EAAE,kBAAsC,EAAE,KAAa;QACxF,IAAI,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;YACjE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrE,CAAC;QACD,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE3B,4FAA4F;QAC5F,6FAA6F;QAC7F,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,EAAE,CAAC;YAAC,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;YAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAAC,CAAC;QACzE,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrC,IAAI,UAAU,GAAG,eAAe,CAAC,UAAU,CAAC;QAC5C,OAAO,UAAU,CAAC,cAAc,EAAE,CAAC;YACjC,UAAU,GAAG,UAAU,CAAC,cAAc,CAAC;YACvC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,KAAa;QACvB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI;YAAE,OAAO;QAClB,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACvC,IAAI,CAAC,MAAM;gBAAE,SAAS;YACtB,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5C,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBACpC,MAAM,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACnC,IAAI,EAAE,IAAI,CAAC;oBAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;gBACpC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;oBAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACjD,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;gBAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,cAAc,CAAC,qBAA6B,EAAE,kBAAsC;QAClF,IAAI,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM;YAAE,OAAO;QACpB,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAM,EAAE,EAAE;YACtC,OAAO,CAAC,CAAC,kBAAkB,KAAK,kBAAkB,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,eAA0B,EAAE,kBAAsC;QACzE,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QACzB,IAAI,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;YAC7C,OAAO,CAAC,CAAC,kBAAkB,KAAK,kBAAkB,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAED,SAAS,CAAC,eAA0B;QAClC,IAAI,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtD,IAAI,UAAU,GAAG,eAAe,CAAC,UAAU,CAAC;QAC5C,yFAAyF;QACzF,2FAA2F;QAC3F,6CAA6C;QAC7C,IAAI,CAAC,UAAU,CAAC,cAAc;YAAE,OAAO,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpF,IAAI,SAAkC,CAAC;QACvC,OAAO,UAAU,CAAC,cAAc,EAAE,CAAC;YACjC,UAAU,GAAG,UAAU,CAAC,cAAc,CAAC;YACvC,IAAI,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YACpE,IAAI,UAAU,EAAE,CAAC;gBACf,sCAAsC;gBACtC,SAAS,GAAG,SAAS,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACxD,SAAS,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QACD,SAAS,GAAG,SAAS,IAAI,MAAM,CAAC;QAChC,OAAO,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED,iBAAiB,CAAC,qBAA6B;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IAC7C,CAAC;CAEF","sourcesContent":["import { core } from '../core/core.js';\r\nimport { Entity } from './entity-aspect.js';\r\nimport { NavigationProperty } from '../metadata/entity-metadata.js';\r\nimport { EntityKey } from './entity-key.js';\r\n\r\n/** @hidden @internal */\r\nexport interface INavTuple {\r\n  navigationProperty: NavigationProperty;\r\n  children: Entity[];\r\n}\r\n\r\n/** @hidden @internal */\r\n// Represents entities not yet attached to navigationProperties. \r\nexport class UnattachedChildrenMap {\r\n  // key is EntityKey.toString(), value is array of { navigationProperty, children }\r\n  map = new Map<string, INavTuple[]>();\r\n\r\n  // Which keys each child is parked under, so that detaching it is a lookup rather than a scan\r\n  // of the whole map. A WeakMap because it is only ever read for a child we are already holding,\r\n  // and an entry that outlives its entity would be the leak this exists to close.\r\n  private childKeys = new WeakMap<Entity, Set<string>>();\r\n\r\n  addChild(parentEntityKey: EntityKey, navigationProperty: NavigationProperty, child: Entity) {\r\n    let tuple = this.getTuple(parentEntityKey, navigationProperty);\r\n    if (!tuple) {\r\n      tuple = { navigationProperty: navigationProperty, children: [] };\r\n      core.getMapArray(this.map, parentEntityKey.toString()).push(tuple);\r\n    }\r\n    tuple.children.push(child);\r\n\r\n    // getTuple looks up the hierarchy, so the tuple just pushed into may be stored under a base\r\n    // type's key. Record every key it could be under; removeChild ignores the ones it is not in.\r\n    let keys = this.childKeys.get(child);\r\n    if (!keys) { keys = new Set<string>(); this.childKeys.set(child, keys); }\r\n    keys.add(parentEntityKey.toString());\r\n    let entityType = parentEntityKey.entityType;\r\n    while (entityType.baseEntityType) {\r\n      entityType = entityType.baseEntityType;\r\n      keys.add(parentEntityKey.toString(entityType));\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Takes a child out of every entry it is parked under, and drops an entry that is left empty.\r\n   *\r\n   * Called when an entity is detached. Without it a child whose parent never arrived is held for\r\n   * the life of the manager: `clear()` replaces the whole map, but `detachEntity` is how an\r\n   * application drops one row. See the retention tier.\r\n   */\r\n  removeChild(child: Entity) {\r\n    const keys = this.childKeys.get(child);\r\n    if (!keys) return;\r\n    for (const keyString of keys) {\r\n      const tuples = this.map.get(keyString);\r\n      if (!tuples) continue;\r\n      for (let i = tuples.length - 1; i >= 0; i--) {\r\n        const children = tuples[i].children;\r\n        const ix = children.indexOf(child);\r\n        if (ix >= 0) children.splice(ix, 1);\r\n        if (children.length === 0) tuples.splice(i, 1);\r\n      }\r\n      if (tuples.length === 0) this.map.delete(keyString);\r\n    }\r\n    this.childKeys.delete(child);\r\n  }\r\n\r\n  removeChildren(parentEntityKeyString: string, navigationProperty: NavigationProperty) {\r\n    let tuples = this.map.get(parentEntityKeyString);\r\n    if (!tuples) return;\r\n    core.arrayRemoveItem(tuples, (t: any) => {\r\n      return t.navigationProperty === navigationProperty;\r\n    });\r\n    if (!tuples.length) {\r\n      this.map.delete(parentEntityKeyString);\r\n    }\r\n  }\r\n\r\n  getTuple(parentEntityKey: EntityKey, navigationProperty: NavigationProperty) {\r\n    let tuples = this.getTuples(parentEntityKey);\r\n    if (!tuples) return null;\r\n    let tuple = core.arrayFirst(tuples, function (t) {\r\n      return t.navigationProperty === navigationProperty;\r\n    });\r\n    return tuple;\r\n  }\r\n\r\n  getTuples(parentEntityKey: EntityKey) {\r\n    let tuples = this.map.get(parentEntityKey.toString());\r\n    let entityType = parentEntityKey.entityType;\r\n    // Nothing above it in the hierarchy, which is the usual case: there is only one entry to\r\n    // find, so hand back the stored array rather than copying it into a new one. addChild goes\r\n    // through here for every child it registers.\r\n    if (!entityType.baseEntityType) return tuples && tuples.length ? tuples : undefined;\r\n\r\n    let allTuples: INavTuple[] | undefined;\r\n    while (entityType.baseEntityType) {\r\n      entityType = entityType.baseEntityType;\r\n      let baseTuples = this.map.get(parentEntityKey.toString(entityType));\r\n      if (baseTuples) {\r\n        // only now is a combined array needed\r\n        allTuples = allTuples || (tuples ? tuples.slice() : []);\r\n        allTuples.push(...baseTuples);\r\n      }\r\n    }\r\n    allTuples = allTuples || tuples;\r\n    return allTuples && allTuples.length ? allTuples : undefined;\r\n  }\r\n\r\n  getTuplesByString(parentEntityKeyString: string) {\r\n    return this.map.get(parentEntityKeyString);\r\n  }\r\n\r\n}\r\n"]}