breeze-client 2.2.1 → 3.0.0

package/entity/key-generator.d.ts

@@ -0,0 +1,57 @@
+import { EntityType } from '../metadata/entity-metadata.js';
+import { EntityKey } from './entity-key.js';
+/** Generates temporary key values for new entities - one added with an unset key when its type's
+`autoGeneratedKeyType` is not `None`, or one passed to {@link EntityManager.generateTempKeyValue} -
+and keeps a record of the temporary values the manager's entities hold, so that an import cannot
+give a second entity one of them. Each {@link EntityManager} has its own, as
+{@link EntityManager.keyGenerator}, and replaces it when cleared. To supply your own, pass a
+subclass's constructor as `keyGeneratorCtor` in the {@link EntityManagerConfig}, and have its
+`generateTempKeyValue` pass the value it makes to `super.generateTempKeyValue` as `valueIfAvail`,
+so that the value is recorded; Breeze calls only {@link KeyGenerator.generateTempKeyValue}. */
+export declare class KeyGenerator {
+    /** Creates a generator that has handed out no values. An {@link EntityManager} creates its own
+    from {@link EntityManagerConfig.keyGeneratorCtor}. */
+    constructor();
+    /**
+    Returns a unique 'temporary' id for the specified {@link EntityType}.
+    Uniqueness is defined for this purpose as being unique within each instance of a KeyGenerator. This is sufficient
+    because each EntityManager will have its own instance of a KeyGenerator and any entities imported into
+    the EntityManager with temporary keys will have them regenerated and remapped on import.
+  
+    The return value of this method must be of the correct type as determined by the keyProperties of the
+    specified EntityType
+    @example
+        // Assume em1 is a preexisting EntityManager, and the server generates Order keys
+        const order1 = em1.createEntity(Order);
+        // next line calls em1.keyGenerator.generateTempKeyValue(order1.entityType),
+        // sets order1's 'orderID' property to the result, and returns it
+        const oid1 = em1.generateTempKeyValue(order1);
+        const saveResult = await em1.saveChanges();
+        const sameOrder1 = saveResult.entities[0];
+        // order1 === sameOrder1;
+        // but order1.orderID != oid1
+        // because the server will have generated a new id
+        // and the client will have been updated with this
+        // new id.
+    @param entityType - The type to generate a key for. Its key must be a single property.
+    @param valueIfAvail - A key value to use if no entity in the manager holds it. When entities with
+    temporary keys are imported, the manager passes each one's key here, so that the key survives the
+    import where it can; a subclass passes the value it made. If the value is taken, or omitted, a new
+    one is generated. Either way, the value returned is recorded as held.
+    @returns The key value, of the key property's data type.
+    */
+    generateTempKeyValue(entityType: EntityType, valueIfAvail?: any): any;
+    /** Returns an {@link EntityKey} for each temporary key value the manager's entities hold: the
+    values this generator handed out or recorded, less those released when an entity was saved and
+    given the server's key, or detached.
+    @deprecated Ask the entities instead:
+    `em.getEntities().filter(e => e.entityAspect.hasTempKey).map(e => e.entityAspect.getKey())`.
+    Breeze does not call it. It still works; it is not scheduled for removal. */
+    getTempKeys(): EntityKey[];
+    /** Whether `entityKey`'s value is a temporary key an entity in the manager holds - one of the
+    values {@link KeyGenerator.getTempKeys} returns. Always false for a multipart key.
+    @deprecated Ask the entity instead: `em.getEntityByKey(key)?.entityAspect.hasTempKey`, or
+    {@link EntityAspect.hasTempKey} when you have the entity. Breeze does not call it. It still
+    works; it is not scheduled for removal. */
+    isTempKey(entityKey: EntityKey): boolean;
+}

package/entity/key-generator.js

@@ -0,0 +1,155 @@
+import { EntityKey } from './entity-key.js';
+import { config } from '../config/config.js';
+/** Generates temporary key values for new entities - one added with an unset key when its type's
+`autoGeneratedKeyType` is not `None`, or one passed to {@link EntityManager.generateTempKeyValue} -
+and keeps a record of the temporary values the manager's entities hold, so that an import cannot
+give a second entity one of them. Each {@link EntityManager} has its own, as
+{@link EntityManager.keyGenerator}, and replaces it when cleared. To supply your own, pass a
+subclass's constructor as `keyGeneratorCtor` in the {@link EntityManagerConfig}, and have its
+`generateTempKeyValue` pass the value it makes to `super.generateTempKeyValue` as `valueIfAvail`,
+so that the value is recorded; Breeze calls only {@link KeyGenerator.generateTempKeyValue}. */
+/*
+  @class KeyGenerator
+  */
+export class KeyGenerator {
+    /** @hidden @internal */
+    _tempIdMap;
+    /** Creates a generator that has handed out no values. An {@link EntityManager} creates its own
+    from {@link EntityManagerConfig.keyGeneratorCtor}. */
+    constructor() {
+        // key is dataProperty.name + || + entityType.name, value is propEntry
+        // propEntry = { entityType, propertyName, keyMap }
+        // keyMap has key of the actual value ( as a string) and a value of null or the real id.
+        this._tempIdMap = new Map();
+    }
+    /**
+    Returns a unique 'temporary' id for the specified {@link EntityType}.
+    Uniqueness is defined for this purpose as being unique within each instance of a KeyGenerator. This is sufficient
+    because each EntityManager will have its own instance of a KeyGenerator and any entities imported into
+    the EntityManager with temporary keys will have them regenerated and remapped on import.
+  
+    The return value of this method must be of the correct type as determined by the keyProperties of the
+    specified EntityType
+    @example
+        // Assume em1 is a preexisting EntityManager, and the server generates Order keys
+        const order1 = em1.createEntity(Order);
+        // next line calls em1.keyGenerator.generateTempKeyValue(order1.entityType),
+        // sets order1's 'orderID' property to the result, and returns it
+        const oid1 = em1.generateTempKeyValue(order1);
+        const saveResult = await em1.saveChanges();
+        const sameOrder1 = saveResult.entities[0];
+        // order1 === sameOrder1;
+        // but order1.orderID != oid1
+        // because the server will have generated a new id
+        // and the client will have been updated with this
+        // new id.
+    @param entityType - The type to generate a key for. Its key must be a single property.
+    @param valueIfAvail - A key value to use if no entity in the manager holds it. When entities with
+    temporary keys are imported, the manager passes each one's key here, so that the key survives the
+    import where it can; a subclass passes the value it made. If the value is taken, or omitted, a new
+    one is generated. Either way, the value returned is recorded as held.
+    @returns The key value, of the key property's data type.
+    */
+    generateTempKeyValue(entityType, valueIfAvail) {
+        let keyProps = entityType.keyProperties;
+        if (keyProps.length > 1) {
+            throw new Error("Ids can not be autogenerated for entities with multipart keys");
+        }
+        let keyProp = keyProps[0];
+        let propEntry = this._getPropEntry(keyProp, true);
+        let nextId;
+        if (valueIfAvail != null) {
+            if (!propEntry.keyMap.has(valueIfAvail.toString())) {
+                nextId = valueIfAvail;
+            }
+        }
+        if (nextId === undefined) {
+            let dataType = keyProp.dataType;
+            let getNextFn = dataType.getNext;
+            if (getNextFn) {
+                nextId = getNextFn(this);
+                // need to watch out for collision with previously imported ids that might also get generated.
+                while (propEntry.keyMap.has(nextId.toString())) {
+                    nextId = getNextFn(this);
+                }
+            }
+            else {
+                throw new Error("Cannot use a property with a dataType of: " + dataType.toString() + " for id generation");
+            }
+        }
+        propEntry.keyMap.add(nextId.toString());
+        return nextId;
+    }
+    /** Returns an {@link EntityKey} for each temporary key value the manager's entities hold: the
+    values this generator handed out or recorded, less those released when an entity was saved and
+    given the server's key, or detached.
+    @deprecated Ask the entities instead:
+    `em.getEntities().filter(e => e.entityAspect.hasTempKey).map(e => e.entityAspect.getKey())`.
+    Breeze does not call it. It still works; it is not scheduled for removal. */
+    getTempKeys() {
+        let results = [];
+        //noinspection JSHint
+        this._tempIdMap.forEach(propEntry => {
+            const entityType = propEntry.entityType;
+            propEntry.keyMap.forEach(keyValue => {
+                results.push(new EntityKey(entityType, [keyValue]));
+            });
+        });
+        return results;
+    }
+    // proto methods below are not part of the KeyGenerator interface.
+    /** Whether `entityKey`'s value is a temporary key an entity in the manager holds - one of the
+    values {@link KeyGenerator.getTempKeys} returns. Always false for a multipart key.
+    @deprecated Ask the entity instead: `em.getEntityByKey(key)?.entityAspect.hasTempKey`, or
+    {@link EntityAspect.hasTempKey} when you have the entity. Breeze does not call it. It still
+    works; it is not scheduled for removal. */
+    isTempKey(entityKey) {
+        let keyProps = entityKey.entityType.keyProperties;
+        if (keyProps.length > 1)
+            return false;
+        let keyProp = keyProps[0];
+        let propEntry = this._getPropEntry(keyProp);
+        if (!propEntry) {
+            return false;
+        }
+        return propEntry.keyMap.has(entityKey.values[0].toString());
+    }
+    /**
+    Forgets a temporary key value that no entity holds any longer: the manager calls it when an
+    entity with a temporary key is saved, and the server's key replaces it, or is detached. The value
+    is then free for an import to keep. Without this the generator remembered every value it had
+    ever handed out, for the life of the manager.
+    @hidden @internal
+    */
+    _releaseTempKeyValue(entityType, value) {
+        const keyProps = entityType.keyProperties;
+        if (keyProps.length !== 1 || value == null)
+            return;
+        this._getPropEntry(keyProps[0])?.keyMap.delete(value.toString());
+    }
+    /**
+    Records a temporary key value this generator did not hand out, or has forgotten: the manager
+    calls it when an entity that already has a temporary key is attached - one detached earlier, or
+    one from another manager - so that an import cannot give a second entity the same key.
+    @hidden @internal
+    */
+    _reserveTempKeyValue(entityType, value) {
+        const keyProps = entityType.keyProperties;
+        if (keyProps.length !== 1 || value == null)
+            return;
+        this._getPropEntry(keyProps[0], true).keyMap.add(value.toString());
+    }
+    _getPropEntry(keyProp, createIfMissing = false) {
+        let key = keyProp.name + ".." + keyProp.parentType.name;
+        let propEntry = this._tempIdMap.get(key);
+        if (!propEntry) {
+            if (createIfMissing) {
+                propEntry = { entityType: keyProp.parentType, propertyName: keyProp.name, keyMap: new Set() };
+                this._tempIdMap.set(key, propEntry);
+            }
+        }
+        return propEntry;
+    }
+}
+config.registerType(KeyGenerator, "KeyGenerator");
+//# sourceMappingURL=key-generator.js.map

package/entity/key-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-generator.js","sourceRoot":"","sources":["../../src/entity/key-generator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAW7C;;;;;;;8FAO8F;AAC9F;;IAEI;AACJ,MAAM,OAAO,YAAY;IACvB,wBAAwB;IAChB,UAAU,CAAa;IAG/B;yDACqD;IACrD;QACE,sEAAsE;QACtE,mDAAmD;QACnD,wFAAwF;QACxF,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;IAC9B,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;;;;;;;;MA2BE;IACF,oBAAoB,CAAC,UAAsB,EAAE,YAAkB;QAC7D,IAAI,QAAQ,GAAG,UAAU,CAAC,aAAa,CAAC;QACxC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACnF,CAAC;QACD,IAAI,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1B,IAAI,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAClD,IAAI,MAAW,CAAC;QAChB,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;gBACnD,MAAM,GAAG,YAAY,CAAC;YACxB,CAAC;QACH,CAAC;QAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAChC,IAAI,SAAS,GAAI,QAAgB,CAAC,OAAO,CAAC;YAC1C,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;gBACzB,8FAA8F;gBAC9F,OAAO,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;oBAC/C,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,4CAA4C,GAAG,QAAQ,CAAC,QAAQ,EAAE,GAAG,oBAAoB,CAAC,CAAC;YAC7G,CAAC;QACH,CAAC;QAED,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;gFAK4E;IAC5E,WAAW;QACT,IAAI,OAAO,GAAgB,EAAE,CAAC;QAC9B,qBAAqB;QACrB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAClC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC;YACxC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAClC,OAAO,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAGD,kEAAkE;IAElE;;;;8CAI0C;IAC1C,SAAS,CAAC,SAAoB;QAC5B,IAAI,QAAQ,GAAG,SAAS,CAAC,UAAU,CAAC,aAAa,CAAC;QAClD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACtC,IAAI,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1B,IAAI,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;MAME;IACF,oBAAoB,CAAC,UAAsB,EAAE,KAAU;QACrD,MAAM,QAAQ,GAAG,UAAU,CAAC,aAAa,CAAC;QAC1C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO;QACnD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;MAKE;IACF,oBAAoB,CAAC,UAAsB,EAAE,KAAU;QACrD,MAAM,QAAQ,GAAG,UAAU,CAAC,aAAa,CAAC;QAC1C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO;QACnD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IAKO,aAAa,CAAC,OAAqB,EAAE,eAAe,GAAG,KAAK;QAClE,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;QACxD,IAAI,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,eAAe,EAAE,CAAC;gBACpB,SAAS,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,UAAwB,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;gBAC5G,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CAEF;AAED,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC","sourcesContent":["import { EntityType, DataProperty } from '../metadata/entity-metadata.js';\r\nimport { EntityKey } from './entity-key.js';\r\nimport { config } from '../config/config.js';\r\n\r\ninterface IPropEntry {\r\n  entityType: EntityType;\r\n  propertyName: string;\r\n  /** Keys are generated id values as strings. A Set: it records which ids are taken. */\r\n  keyMap: Set<string>;\r\n}\r\n\r\ntype ITempIdMap = Map<string, IPropEntry>;\r\n\r\n/** Generates temporary key values for new entities - one added with an unset key when its type's\r\n`autoGeneratedKeyType` is not `None`, or one passed to {@link EntityManager.generateTempKeyValue} -\r\nand keeps a record of the temporary values the manager's entities hold, so that an import cannot\r\ngive a second entity one of them. Each {@link EntityManager} has its own, as\r\n{@link EntityManager.keyGenerator}, and replaces it when cleared. To supply your own, pass a\r\nsubclass's constructor as `keyGeneratorCtor` in the {@link EntityManagerConfig}, and have its\r\n`generateTempKeyValue` pass the value it makes to `super.generateTempKeyValue` as `valueIfAvail`,\r\nso that the value is recorded; Breeze calls only {@link KeyGenerator.generateTempKeyValue}. */\r\n/*\r\n  @class KeyGenerator\r\n  */\r\nexport class KeyGenerator {\r\n  /** @hidden @internal */\r\n  private _tempIdMap: ITempIdMap;\r\n\r\n\r\n  /** Creates a generator that has handed out no values. An {@link EntityManager} creates its own\r\n  from {@link EntityManagerConfig.keyGeneratorCtor}. */\r\n  constructor() {\r\n    // key is dataProperty.name + || + entityType.name, value is propEntry\r\n    // propEntry = { entityType, propertyName, keyMap }\r\n    // keyMap has key of the actual value ( as a string) and a value of null or the real id.\r\n    this._tempIdMap = new Map();\r\n  }\r\n\r\n\r\n  /**\r\n  Returns a unique 'temporary' id for the specified {@link EntityType}.\r\n  Uniqueness is defined for this purpose as being unique within each instance of a KeyGenerator. This is sufficient\r\n  because each EntityManager will have its own instance of a KeyGenerator and any entities imported into\r\n  the EntityManager with temporary keys will have them regenerated and remapped on import.\r\n\r\n  The return value of this method must be of the correct type as determined by the keyProperties of the\r\n  specified EntityType\r\n  @example\r\n      // Assume em1 is a preexisting EntityManager, and the server generates Order keys\r\n      const order1 = em1.createEntity(Order);\r\n      // next line calls em1.keyGenerator.generateTempKeyValue(order1.entityType),\r\n      // sets order1's 'orderID' property to the result, and returns it\r\n      const oid1 = em1.generateTempKeyValue(order1);\r\n      const saveResult = await em1.saveChanges();\r\n      const sameOrder1 = saveResult.entities[0];\r\n      // order1 === sameOrder1;\r\n      // but order1.orderID != oid1\r\n      // because the server will have generated a new id\r\n      // and the client will have been updated with this\r\n      // new id.\r\n  @param entityType - The type to generate a key for. Its key must be a single property.\r\n  @param valueIfAvail - A key value to use if no entity in the manager holds it. When entities with\r\n  temporary keys are imported, the manager passes each one's key here, so that the key survives the\r\n  import where it can; a subclass passes the value it made. If the value is taken, or omitted, a new\r\n  one is generated. Either way, the value returned is recorded as held.\r\n  @returns The key value, of the key property's data type.\r\n  */\r\n  generateTempKeyValue(entityType: EntityType, valueIfAvail?: any): any {\r\n    let keyProps = entityType.keyProperties;\r\n    if (keyProps.length > 1) {\r\n      throw new Error(\"Ids can not be autogenerated for entities with multipart keys\");\r\n    }\r\n    let keyProp = keyProps[0];\r\n    let propEntry = this._getPropEntry(keyProp, true);\r\n    let nextId: any;\r\n    if (valueIfAvail != null) {\r\n      if (!propEntry.keyMap.has(valueIfAvail.toString())) {\r\n        nextId = valueIfAvail;\r\n      }\r\n    }\r\n\r\n    if (nextId === undefined) {\r\n      let dataType = keyProp.dataType;\r\n      let getNextFn = (dataType as any).getNext;\r\n      if (getNextFn) {\r\n        nextId = getNextFn(this);\r\n        // need to watch out for collision with previously imported ids that might also get generated.\r\n        while (propEntry.keyMap.has(nextId.toString())) {\r\n          nextId = getNextFn(this);\r\n        }\r\n      } else {\r\n        throw new Error(\"Cannot use a property with a dataType of: \" + dataType.toString() + \" for id generation\");\r\n      }\r\n    }\r\n\r\n    propEntry.keyMap.add(nextId.toString());\r\n    return nextId;\r\n  }\r\n\r\n  /** Returns an {@link EntityKey} for each temporary key value the manager's entities hold: the\r\n  values this generator handed out or recorded, less those released when an entity was saved and\r\n  given the server's key, or detached.\r\n  @deprecated Ask the entities instead:\r\n  `em.getEntities().filter(e => e.entityAspect.hasTempKey).map(e => e.entityAspect.getKey())`.\r\n  Breeze does not call it. It still works; it is not scheduled for removal. */\r\n  getTempKeys() {\r\n    let results: EntityKey[] = [];\r\n    //noinspection JSHint\r\n    this._tempIdMap.forEach(propEntry => {\r\n      const entityType = propEntry.entityType;\r\n      propEntry.keyMap.forEach(keyValue => {\r\n        results.push(new EntityKey(entityType, [keyValue]));\r\n      });\r\n    });\r\n    return results;\r\n  }\r\n\r\n\r\n  // proto methods below are not part of the KeyGenerator interface.\r\n\r\n  /** Whether `entityKey`'s value is a temporary key an entity in the manager holds - one of the\r\n  values {@link KeyGenerator.getTempKeys} returns. Always false for a multipart key.\r\n  @deprecated Ask the entity instead: `em.getEntityByKey(key)?.entityAspect.hasTempKey`, or\r\n  {@link EntityAspect.hasTempKey} when you have the entity. Breeze does not call it. It still\r\n  works; it is not scheduled for removal. */\r\n  isTempKey(entityKey: EntityKey) {\r\n    let keyProps = entityKey.entityType.keyProperties;\r\n    if (keyProps.length > 1) return false;\r\n    let keyProp = keyProps[0];\r\n    let propEntry = this._getPropEntry(keyProp);\r\n    if (!propEntry) {\r\n      return false;\r\n    }\r\n    return propEntry.keyMap.has(entityKey.values[0].toString());\r\n  }\r\n\r\n  /**\r\n  Forgets a temporary key value that no entity holds any longer: the manager calls it when an\r\n  entity with a temporary key is saved, and the server's key replaces it, or is detached. The value\r\n  is then free for an import to keep. Without this the generator remembered every value it had\r\n  ever handed out, for the life of the manager.\r\n  @hidden @internal\r\n  */\r\n  _releaseTempKeyValue(entityType: EntityType, value: any) {\r\n    const keyProps = entityType.keyProperties;\r\n    if (keyProps.length !== 1 || value == null) return;\r\n    this._getPropEntry(keyProps[0])?.keyMap.delete(value.toString());\r\n  }\r\n\r\n  /**\r\n  Records a temporary key value this generator did not hand out, or has forgotten: the manager\r\n  calls it when an entity that already has a temporary key is attached - one detached earlier, or\r\n  one from another manager - so that an import cannot give a second entity the same key.\r\n  @hidden @internal\r\n  */\r\n  _reserveTempKeyValue(entityType: EntityType, value: any) {\r\n    const keyProps = entityType.keyProperties;\r\n    if (keyProps.length !== 1 || value == null) return;\r\n    this._getPropEntry(keyProps[0], true).keyMap.add(value.toString());\r\n  }\r\n\r\n  /** @hidden @internal */\r\n  private _getPropEntry(keyProp: DataProperty, createIfMissing: true): IPropEntry;\r\n  private _getPropEntry(keyProp: DataProperty, createIfMissing?: boolean): IPropEntry | undefined;\r\n  private _getPropEntry(keyProp: DataProperty, createIfMissing = false) {\r\n    let key = keyProp.name + \"..\" + keyProp.parentType.name;\r\n    let propEntry = this._tempIdMap.get(key);\r\n    if (!propEntry) {\r\n      if (createIfMissing) {\r\n        propEntry = { entityType: keyProp.parentType as EntityType, propertyName: keyProp.name, keyMap: new Set() };\r\n        this._tempIdMap.set(key, propEntry);\r\n      }\r\n    }\r\n    return propEntry;\r\n  }\r\n\r\n}\r\n\r\nconfig.registerType(KeyGenerator, \"KeyGenerator\");\r\n\r\n"]}

package/entity/observable-array.d.ts

@@ -0,0 +1,25 @@
+import { BreezeEvent } from '../core/event.js';
+import type { DataProperty } from '../metadata/entity-metadata.js';
+/** The argument to the `arrayChanged` event of a relation, complex or primitive array. */
+export interface ArrayChangedArgs {
+    /** The array that changed. */
+    array: any[];
+    /** The items added. Undefined when the event reports removals: each change raises its own event,
+    so a `splice` that both removes and adds raises one for the removals, then one for the additions.
+    While a query or import is loading, the changes to an array are collected into a single event
+    that can carry both, as the net change: an item added and removed again during the load is in
+    neither list. */
+    added?: any[];
+    /** The items removed. Undefined when the event reports only additions. */
+    removed?: any[];
+}
+/**
+ * A real array - every Array method is the native one - plus change notification and the links
+ * back to the entity that owns it. Only the five mutators are replaced.
+ * @hidden
+ */
+export interface ObservableArray<T = any> extends Array<T> {
+    arrayChanged: BreezeEvent<ArrayChangedArgs>;
+    parent?: Object;
+    parentProperty?: DataProperty;
+}

package/entity/observable-array.js

@@ -0,0 +1,230 @@
+// --- the five mutators -----------------------------------------------------------------------
+// Shared function objects: every array gets the same five, so the only per-array cost is the
+// property slot. Each one reads its behaviour from `this._obs.ops`.
+function push(...items) {
+    const state = this._obs;
+    if (state.inProgress) {
+        return -1;
+    }
+    const goodAdds = state.ops.getGoodAdds(this, items);
+    if (!goodAdds.length) {
+        return this.length;
+    }
+    state.ops.beforeChange(this);
+    const result = Array.prototype.push.apply(this, goodAdds);
+    processAdds(this, goodAdds);
+    return result;
+}
+function unshift(...items) {
+    const state = this._obs;
+    const goodAdds = state.ops.getGoodAdds(this, items);
+    if (!goodAdds.length) {
+        return this.length;
+    }
+    state.ops.beforeChange(this);
+    const result = Array.prototype.unshift.apply(this, goodAdds);
+    processAdds(this, goodAdds);
+    return result;
+}
+// An empty array removes nothing, so there is nothing to tell the kind about and nothing to
+// publish. Without this the kinds are handed `[undefined]`: a relation array dereferences it and
+// throws, where a plain array would just return undefined.
+function pop() {
+    if (this.length === 0)
+        return undefined;
+    const state = this._obs;
+    state.ops.beforeChange(this);
+    const result = Array.prototype.pop.call(this);
+    processRemoves(this, [result]);
+    return result;
+}
+function shift() {
+    if (this.length === 0)
+        return undefined;
+    const state = this._obs;
+    state.ops.beforeChange(this);
+    const result = Array.prototype.shift.call(this);
+    processRemoves(this, [result]);
+    return result;
+}
+function splice(...args) {
+    const state = this._obs;
+    const goodAdds = state.ops.getGoodAdds(this, args.slice(2));
+    const newArgs = args.slice(0, 2).concat(goodAdds);
+    state.ops.beforeChange(this);
+    const result = Array.prototype.splice.apply(this, newArgs);
+    processRemoves(this, result);
+    if (goodAdds.length) {
+        processAdds(this, goodAdds);
+    }
+    return result;
+}
+function getEventParent() {
+    return this._obs.ops.getEventParent(this);
+}
+// --- shared machinery ------------------------------------------------------------------------
+/**
+ * Adds items without asking the kind whether it wants them. The merge path has already decided,
+ * and re-checking would attach the same entities a second time.
+ */
+function pushUnchecked(arr, ...items) {
+    const state = arr._obs;
+    if (state.inProgress) {
+        return -1;
+    }
+    state.ops.beforeChange(arr);
+    const result = Array.prototype.push.apply(arr, items);
+    processAdds(arr, items);
+    return result;
+}
+function processAdds(arr, adds) {
+    arr._obs.ops.processAdds(arr, adds);
+    publish(arr, "arrayChanged", { array: arr, added: adds });
+}
+function processRemoves(arr, removes) {
+    arr._obs.ops.processRemoves(arr, removes);
+    publish(arr, "arrayChanged", { array: arr, removed: removes });
+}
+/**
+ * Publishes now, or - while an EntityManager is loading - queues one event per array and folds
+ * later changes into it, so that a query produces a single arrayChanged per collection.
+ */
+function publish(publisher, eventName, eventArgs) {
+    const state = publisher._obs;
+    const pendingPubs = state.ops.getPendingPubs(publisher);
+    if (pendingPubs) {
+        if (!state.pendingArgs) {
+            state.pendingArgs = { array: eventArgs.array };
+            combineArgs(state.pendingArgs, eventArgs);
+            pendingPubs.push(function () {
+                const args = state.pendingArgs;
+                state.pendingArgs = null;
+                // Changes that cancelled out leave empty lists, which are left off; none at all, no event.
+                if (!args.added?.length)
+                    delete args.added;
+                if (!args.removed?.length)
+                    delete args.removed;
+                if (args.added || args.removed)
+                    publisher[eventName].publish(args);
+            });
+        }
+        else {
+            combineArgs(state.pendingArgs, eventArgs);
+        }
+    }
+    else {
+        publisher[eventName].publish(eventArgs);
+    }
+}
+/** The aspect of the entity that owns this array, whether directly or through a complex object. */
+function getEntityAspect(arr) {
+    const parent = arr.parent;
+    return parent.entityAspect || parent.complexAspect.getEntityAspect();
+}
+/** Marks the owning entity Modified, and keeps a copy of the contents the first time. */
+function updateEntityState(arr) {
+    const entityAspect = getEntityAspect(arr);
+    if (entityAspect.entityState.isUnchanged()) {
+        entityAspect.setModified();
+    }
+    const state = arr._obs;
+    if (entityAspect.entityState.isModified() && !state.origValues) {
+        state.origValues = arr.slice(0);
+    }
+}
+/**
+ * Empty the array in one go, running `onRemove` for each item first.
+ *
+ * The obvious spelling - let each item take itself out - is quadratic. Nulling a child's
+ * reference to its parent makes the interceptor splice that child out of this very array, and a
+ * splice from the front shifts everything after it, so emptying n children moves n²/2 elements.
+ * Detaching a customer with 16,000 orders spent 239ms doing that, and published 16,000
+ * arrayChanged events for what is one change to the collection.
+ *
+ * So `isClearing` is set while `onRemove` runs. The interceptor sees it and skips its splice -
+ * everything else it does for the child, nulling the navigation property and clearing the
+ * foreign key, still happens. The array is then truncated at once and one event is published
+ * carrying everything that was in it, which is what the batched query and import paths already
+ * do for a collection that changes wholesale.
+ */
+function clearAll(arr, onRemove) {
+    const removed = arr.slice(0);
+    if (!removed.length)
+        return removed;
+    const state = arr._obs;
+    if (onRemove) {
+        state.isClearing = true;
+        try {
+            for (const item of removed)
+                onRemove(item);
+        }
+        finally {
+            state.isClearing = false;
+        }
+    }
+    arr.length = 0;
+    publish(arr, "arrayChanged", { array: arr, removed: removed });
+    return removed;
+}
+/**
+ * True while `clearAll` is emptying this array, meaning it will remove its own contents and
+ * publish for them; anything that would otherwise splice one item out should leave it alone.
+ */
+function isClearing(arr) {
+    return !!(arr && arr._obs && arr._obs.isClearing);
+}
+/**
+ * Folds one change into the batched event, as a net change: an item added and then removed in the
+ * same batch - or removed and then added - drops out of both lists, so applying the event's
+ * removals and additions in either order gives the right result. `target` owns its lists; the
+ * source's are only read.
+ *
+ * It used to copy only keys the target already had, so a batch that started with an addition
+ * lost every later removal, and the reverse.
+ */
+function combineArgs(target, source) {
+    const pairs = [["added", "removed"], ["removed", "added"]];
+    for (const [key, opposite] of pairs) {
+        for (const item of source[key] ?? []) {
+            const undone = target[opposite]?.indexOf(item) ?? -1;
+            if (undone >= 0) {
+                target[opposite].splice(undone, 1);
+            }
+            else {
+                (target[key] ??= []).push(item);
+            }
+        }
+    }
+}
+/**
+ * Turns a plain array into an observable one: the five mutators, the event-parent hook and the
+ * single state property. Anything else a kind needs belongs in its `ops` or in its state.
+ */
+function initialize(arr, ops, state) {
+    arr.push = push;
+    arr.unshift = unshift;
+    arr.pop = pop;
+    arr.shift = shift;
+    arr.splice = splice;
+    arr._getEventParent = getEventParent;
+    arr._obs = Object.assign({ ops: ops }, state);
+}
+/** @hidden @internal */
+export const observableArray = {
+    initialize: initialize,
+    updateEntityState: updateEntityState,
+    publish: publish,
+    getEntityAspect: getEntityAspect,
+    pushUnchecked: pushUnchecked,
+    clearAll: clearAll,
+    isClearing: isClearing,
+    /** Puts back the contents the owning entity had before its changes. */
+    rejectChanges: (arr) => arr._obs.ops.rejectChanges?.(arr),
+    /** Forgets the saved contents: what was changed is now what is stored. */
+    acceptChanges: (arr) => arr._obs.ops.acceptChanges?.(arr),
+    /** True once the array has been changed away from what the server sent. */
+    hasOriginalValues: (arr) => !!arr._obs?.origValues,
+    /** The contents the array had before its entity was changed, or null if it has not been. */
+    originalContents: (arr) => arr?._obs?.origValues ?? null,
+};
+//# sourceMappingURL=observable-array.js.map

package/entity/observable-array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"observable-array.js","sourceRoot":"","sources":["../../src/entity/observable-array.ts"],"names":[],"mappings":"AAwFA,gGAAgG;AAChG,6FAA6F;AAC7F,oEAAoE;AAEpE,SAAS,IAAI,CAAY,GAAG,KAAY;IACtC,MAAM,KAAK,GAAG,IAAI,CAAC,IAA4B,CAAC;IAChD,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1D,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,OAAO,CAAY,GAAG,KAAY;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,IAA4B,CAAC;IAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC7D,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,4FAA4F;AAC5F,iGAAiG;AACjG,2DAA2D;AAE3D,SAAS,GAAG;IACV,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACxC,MAAM,KAAK,GAAG,IAAI,CAAC,IAA4B,CAAC;IAChD,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,cAAc,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,KAAK;IACZ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACxC,MAAM,KAAK,GAAG,IAAI,CAAC,IAA4B,CAAC;IAChD,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChD,cAAc,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,MAAM,CAAY,GAAG,IAAW;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,IAA4B,CAAC;IAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClD,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,OAAqC,CAAC,CAAC;IACzF,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc;IACrB,OAAQ,IAAI,CAAC,IAA6B,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AACtE,CAAC;AAED,gGAAgG;AAEhG;;;GAGG;AACH,SAAS,aAAa,CAAC,GAAQ,EAAE,GAAG,KAAY;IAC9C,MAAM,KAAK,GAAG,GAAG,CAAC,IAA4B,CAAC;IAC/C,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtD,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,WAAW,CAAC,GAAQ,EAAE,IAAW;IACvC,GAAG,CAAC,IAA6B,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC9D,OAAO,CAAC,GAAG,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,cAAc,CAAC,GAAQ,EAAE,OAAc;IAC7C,GAAG,CAAC,IAA6B,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACpE,OAAO,CAAC,GAAG,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;AACjE,CAAC;AAED;;;GAGG;AACH,SAAS,OAAO,CAAC,SAAc,EAAE,SAAiB,EAAE,SAAc;IAChE,MAAM,KAAK,GAAG,SAAS,CAAC,IAA4B,CAAC;IACrD,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACxD,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YACvB,KAAK,CAAC,WAAW,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YAC1C,WAAW,CAAC,IAAI,CAAC;gBACf,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC;gBAC/B,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;gBACzB,2FAA2F;gBAC3F,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM;oBAAE,OAAO,IAAI,CAAC,KAAK,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM;oBAAE,OAAO,IAAI,CAAC,OAAO,CAAC;gBAC/C,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO;oBAAE,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;SAAM,CAAC;QACN,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AAED,mGAAmG;AACnG,SAAS,eAAe,CAAC,GAAQ;IAC/B,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAC1B,OAAO,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,aAAa,CAAC,eAAe,EAAE,CAAC;AACvE,CAAC;AAED,yFAAyF;AACzF,SAAS,iBAAiB,CAAC,GAAQ;IACjC,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,YAAY,CAAC,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC;QAC3C,YAAY,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IACD,MAAM,KAAK,GAAG,GAAG,CAAC,IAA4B,CAAC;IAC/C,IAAI,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;QAC/D,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAS,QAAQ,CAAC,GAAQ,EAAE,QAA8B;IACxD,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7B,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC;IAEpC,MAAM,KAAK,GAAG,GAAG,CAAC,IAA4B,CAAC;IAC/C,IAAI,QAAQ,EAAE,CAAC;QACb,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC;YACH,KAAK,MAAM,IAAI,IAAI,OAAO;gBAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;gBAAS,CAAC;YACT,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;IACf,OAAO,CAAC,GAAG,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/D,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,GAAQ;IAC1B,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,IAAK,GAAG,CAAC,IAA6B,CAAC,UAAU,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,WAAW,CAAC,MAAwB,EAAE,MAAwB;IACrE,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,CAAU,CAAC;IACpE,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC;QACpC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACrD,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;gBAChB,MAAM,CAAC,QAAQ,CAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,GAAQ,EAAE,GAAuB,EAAE,KAAqC;IAC1F,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;IAChB,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;IACtB,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;IACd,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;IAClB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IACpB,GAAG,CAAC,eAAe,GAAG,cAAc,CAAC;IACrC,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,CAAyB,CAAC;AACxE,CAAC;AAED,wBAAwB;AACxB,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,UAAU,EAAE,UAAU;IACtB,iBAAiB,EAAE,iBAAiB;IACpC,OAAO,EAAE,OAAO;IAChB,eAAe,EAAE,eAAe;IAChC,aAAa,EAAE,aAAa;IAC5B,QAAQ,EAAE,QAAQ;IAClB,UAAU,EAAE,UAAU;IACtB,uEAAuE;IACvE,aAAa,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAE,GAAG,CAAC,IAA6B,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC;IACxF,0EAA0E;IAC1E,aAAa,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAE,GAAG,CAAC,IAA6B,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC;IACxF,2EAA2E;IAC3E,iBAAiB,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,CAAE,GAAG,CAAC,IAA6B,EAAE,UAAU;IACjF,4FAA4F;IAC5F,gBAAgB,EAAE,CAAC,GAAQ,EAAgB,EAAE,CAAE,GAAG,EAAE,IAAyC,EAAE,UAAU,IAAI,IAAI;CAClH,CAAC","sourcesContent":["import { BreezeEvent } from '../core/event.js';\r\nimport type { EntityAspect } from './entity-aspect.js';\r\nimport type { DataProperty } from '../metadata/entity-metadata.js';\r\n\r\n/*\r\n * The observable arrays - relation, complex and primitive - are real arrays, and have to be:\r\n * applications index them, iterate them, spread them and `JSON.stringify` them, and every one of\r\n * those is the engine's fast path only while the object stays a plain array with\r\n * `Array.prototype`. That rules out both of the tidier-looking alternatives: a subclass or a\r\n * swapped prototype costs about 20x on `forEach`/`map`/`filter`, and a `Proxy` about 400x on\r\n * reads.\r\n *\r\n * What is *not* free is the number of own properties. Past roughly a dozen, V8 moves the array\r\n * to dictionary properties and indexed reads get about 90x slower. 2.x copied sixteen functions\r\n * onto every array and paid exactly that.\r\n *\r\n * So only the five mutators live on the instance - they have to, to be intercepted - plus\r\n * `_getEventParent`, which BreezeEvent looks for on the publisher itself. Everything else, the\r\n * per-kind behaviour and the bookkeeping, hangs off one `_obs` property.\r\n * `test/unit/observable-array.spec.ts` pins the count so this cannot drift back.\r\n */\r\n\r\n/** The argument to the `arrayChanged` event of a relation, complex or primitive array. */\r\nexport interface ArrayChangedArgs {\r\n  /** The array that changed. */\r\n  array: any[];\r\n  /** The items added. Undefined when the event reports removals: each change raises its own event,\r\n  so a `splice` that both removes and adds raises one for the removals, then one for the additions.\r\n  While a query or import is loading, the changes to an array are collected into a single event\r\n  that can carry both, as the net change: an item added and removed again during the load is in\r\n  neither list. */\r\n  added?: any[];\r\n  /** The items removed. Undefined when the event reports only additions. */\r\n  removed?: any[];\r\n}\r\n\r\n/**\r\n * What differs between a relation, complex and primitive array. One shared instance per kind,\r\n * reached through `arr._obs.ops`, so that none of it sits on the array itself.\r\n * @hidden @internal\r\n */\r\nexport interface ObservableArrayOps {\r\n  /** The subset of `adds` that should actually be added. */\r\n  getGoodAdds(arr: any, adds: any[]): any[];\r\n  processAdds(arr: any, adds: any[]): void;\r\n  processRemoves(arr: any, removes: any[]): void;\r\n  /** Runs before any mutation; where an array marks its owning entity modified. */\r\n  beforeChange(arr: any): void;\r\n  getEventParent(arr: any): Object;\r\n  getPendingPubs(arr: any): any[] | undefined;\r\n  rejectChanges?(arr: any): void;\r\n  acceptChanges?(arr: any): void;\r\n}\r\n\r\n/**\r\n * Per-array bookkeeping: one object, one own property on the array.\r\n * @hidden @internal\r\n */\r\nexport interface ObservableArrayState {\r\n  ops: ObservableArrayOps;\r\n  /** The contents before the first change, once the owning entity is Modified. */\r\n  origValues?: any[] | null;\r\n  /** Set while an arrayChanged event is queued behind an EntityManager's pending publications. */\r\n  pendingArgs?: any;\r\n  /** Relation arrays: the adds being processed, which stops relationship fixup recursing. */\r\n  addsInProcess?: any[];\r\n  /** Relation arrays: set while attaching an entity, so a re-entrant push is ignored. */\r\n  inProgress?: boolean;\r\n  /** Set while `clearAll` is emptying the array; see there. */\r\n  isClearing?: boolean;\r\n}\r\n\r\n/**\r\n * A real array - every Array method is the native one - plus change notification and the links\r\n * back to the entity that owns it. Only the five mutators are replaced.\r\n * @hidden\r\n */\r\nexport interface ObservableArray<T = any> extends Array<T> {\r\n  arrayChanged: BreezeEvent<ArrayChangedArgs>;\r\n  parent?: Object;\r\n  parentProperty?: DataProperty;\r\n\r\n  /** @hidden @internal */\r\n  _obs: ObservableArrayState;\r\n  /** @hidden @internal BreezeEvent reads this off the publisher to walk the enable/disable chain. */\r\n  _getEventParent(): Object;\r\n}\r\n\r\n// --- the five mutators -----------------------------------------------------------------------\r\n// Shared function objects: every array gets the same five, so the only per-array cost is the\r\n// property slot. Each one reads its behaviour from `this._obs.ops`.\r\n\r\nfunction push(this: any, ...items: any[]): number {\r\n  const state = this._obs as ObservableArrayState;\r\n  if (state.inProgress) {\r\n    return -1;\r\n  }\r\n  const goodAdds = state.ops.getGoodAdds(this, items);\r\n  if (!goodAdds.length) {\r\n    return this.length;\r\n  }\r\n  state.ops.beforeChange(this);\r\n  const result = Array.prototype.push.apply(this, goodAdds);\r\n  processAdds(this, goodAdds);\r\n  return result;\r\n}\r\n\r\nfunction unshift(this: any, ...items: any[]): number {\r\n  const state = this._obs as ObservableArrayState;\r\n  const goodAdds = state.ops.getGoodAdds(this, items);\r\n  if (!goodAdds.length) {\r\n    return this.length;\r\n  }\r\n  state.ops.beforeChange(this);\r\n  const result = Array.prototype.unshift.apply(this, goodAdds);\r\n  processAdds(this, goodAdds);\r\n  return result;\r\n}\r\n\r\n// An empty array removes nothing, so there is nothing to tell the kind about and nothing to\r\n// publish. Without this the kinds are handed `[undefined]`: a relation array dereferences it and\r\n// throws, where a plain array would just return undefined.\r\n\r\nfunction pop(this: any): any {\r\n  if (this.length === 0) return undefined;\r\n  const state = this._obs as ObservableArrayState;\r\n  state.ops.beforeChange(this);\r\n  const result = Array.prototype.pop.call(this);\r\n  processRemoves(this, [result]);\r\n  return result;\r\n}\r\n\r\nfunction shift(this: any): any {\r\n  if (this.length === 0) return undefined;\r\n  const state = this._obs as ObservableArrayState;\r\n  state.ops.beforeChange(this);\r\n  const result = Array.prototype.shift.call(this);\r\n  processRemoves(this, [result]);\r\n  return result;\r\n}\r\n\r\nfunction splice(this: any, ...args: any[]): any[] {\r\n  const state = this._obs as ObservableArrayState;\r\n  const goodAdds = state.ops.getGoodAdds(this, args.slice(2));\r\n  const newArgs = args.slice(0, 2).concat(goodAdds);\r\n  state.ops.beforeChange(this);\r\n  const result = Array.prototype.splice.apply(this, newArgs as [number, number, ...any[]]);\r\n  processRemoves(this, result);\r\n  if (goodAdds.length) {\r\n    processAdds(this, goodAdds);\r\n  }\r\n  return result;\r\n}\r\n\r\nfunction getEventParent(this: any): Object {\r\n  return (this._obs as ObservableArrayState).ops.getEventParent(this);\r\n}\r\n\r\n// --- shared machinery ------------------------------------------------------------------------\r\n\r\n/**\r\n * Adds items without asking the kind whether it wants them. The merge path has already decided,\r\n * and re-checking would attach the same entities a second time.\r\n */\r\nfunction pushUnchecked(arr: any, ...items: any[]): number {\r\n  const state = arr._obs as ObservableArrayState;\r\n  if (state.inProgress) {\r\n    return -1;\r\n  }\r\n  state.ops.beforeChange(arr);\r\n  const result = Array.prototype.push.apply(arr, items);\r\n  processAdds(arr, items);\r\n  return result;\r\n}\r\n\r\nfunction processAdds(arr: any, adds: any[]): void {\r\n  (arr._obs as ObservableArrayState).ops.processAdds(arr, adds);\r\n  publish(arr, \"arrayChanged\", { array: arr, added: adds });\r\n}\r\n\r\nfunction processRemoves(arr: any, removes: any[]): void {\r\n  (arr._obs as ObservableArrayState).ops.processRemoves(arr, removes);\r\n  publish(arr, \"arrayChanged\", { array: arr, removed: removes });\r\n}\r\n\r\n/**\r\n * Publishes now, or - while an EntityManager is loading - queues one event per array and folds\r\n * later changes into it, so that a query produces a single arrayChanged per collection.\r\n */\r\nfunction publish(publisher: any, eventName: string, eventArgs: any): void {\r\n  const state = publisher._obs as ObservableArrayState;\r\n  const pendingPubs = state.ops.getPendingPubs(publisher);\r\n  if (pendingPubs) {\r\n    if (!state.pendingArgs) {\r\n      state.pendingArgs = { array: eventArgs.array };\r\n      combineArgs(state.pendingArgs, eventArgs);\r\n      pendingPubs.push(function () {\r\n        const args = state.pendingArgs;\r\n        state.pendingArgs = null;\r\n        // Changes that cancelled out leave empty lists, which are left off; none at all, no event.\r\n        if (!args.added?.length) delete args.added;\r\n        if (!args.removed?.length) delete args.removed;\r\n        if (args.added || args.removed) publisher[eventName].publish(args);\r\n      });\r\n    } else {\r\n      combineArgs(state.pendingArgs, eventArgs);\r\n    }\r\n  } else {\r\n    publisher[eventName].publish(eventArgs);\r\n  }\r\n}\r\n\r\n/** The aspect of the entity that owns this array, whether directly or through a complex object. */\r\nfunction getEntityAspect(arr: any): EntityAspect {\r\n  const parent = arr.parent;\r\n  return parent.entityAspect || parent.complexAspect.getEntityAspect();\r\n}\r\n\r\n/** Marks the owning entity Modified, and keeps a copy of the contents the first time. */\r\nfunction updateEntityState(arr: any): void {\r\n  const entityAspect = getEntityAspect(arr);\r\n  if (entityAspect.entityState.isUnchanged()) {\r\n    entityAspect.setModified();\r\n  }\r\n  const state = arr._obs as ObservableArrayState;\r\n  if (entityAspect.entityState.isModified() && !state.origValues) {\r\n    state.origValues = arr.slice(0);\r\n  }\r\n}\r\n\r\n/**\r\n * Empty the array in one go, running `onRemove` for each item first.\r\n *\r\n * The obvious spelling - let each item take itself out - is quadratic. Nulling a child's\r\n * reference to its parent makes the interceptor splice that child out of this very array, and a\r\n * splice from the front shifts everything after it, so emptying n children moves n²/2 elements.\r\n * Detaching a customer with 16,000 orders spent 239ms doing that, and published 16,000\r\n * arrayChanged events for what is one change to the collection.\r\n *\r\n * So `isClearing` is set while `onRemove` runs. The interceptor sees it and skips its splice -\r\n * everything else it does for the child, nulling the navigation property and clearing the\r\n * foreign key, still happens. The array is then truncated at once and one event is published\r\n * carrying everything that was in it, which is what the batched query and import paths already\r\n * do for a collection that changes wholesale.\r\n */\r\nfunction clearAll(arr: any, onRemove?: (item: any) => void): any[] {\r\n  const removed = arr.slice(0);\r\n  if (!removed.length) return removed;\r\n\r\n  const state = arr._obs as ObservableArrayState;\r\n  if (onRemove) {\r\n    state.isClearing = true;\r\n    try {\r\n      for (const item of removed) onRemove(item);\r\n    } finally {\r\n      state.isClearing = false;\r\n    }\r\n  }\r\n  arr.length = 0;\r\n  publish(arr, \"arrayChanged\", { array: arr, removed: removed });\r\n  return removed;\r\n}\r\n\r\n/**\r\n * True while `clearAll` is emptying this array, meaning it will remove its own contents and\r\n * publish for them; anything that would otherwise splice one item out should leave it alone.\r\n */\r\nfunction isClearing(arr: any): boolean {\r\n  return !!(arr && arr._obs && (arr._obs as ObservableArrayState).isClearing);\r\n}\r\n\r\n/**\r\n * Folds one change into the batched event, as a net change: an item added and then removed in the\r\n * same batch - or removed and then added - drops out of both lists, so applying the event's\r\n * removals and additions in either order gives the right result. `target` owns its lists; the\r\n * source's are only read.\r\n *\r\n * It used to copy only keys the target already had, so a batch that started with an addition\r\n * lost every later removal, and the reverse.\r\n */\r\nfunction combineArgs(target: ArrayChangedArgs, source: ArrayChangedArgs): void {\r\n  const pairs = [[\"added\", \"removed\"], [\"removed\", \"added\"]] as const;\r\n  for (const [key, opposite] of pairs) {\r\n    for (const item of source[key] ?? []) {\r\n      const undone = target[opposite]?.indexOf(item) ?? -1;\r\n      if (undone >= 0) {\r\n        target[opposite]!.splice(undone, 1);\r\n      } else {\r\n        (target[key] ??= []).push(item);\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Turns a plain array into an observable one: the five mutators, the event-parent hook and the\r\n * single state property. Anything else a kind needs belongs in its `ops` or in its state.\r\n */\r\nfunction initialize(arr: any, ops: ObservableArrayOps, state?: Partial<ObservableArrayState>): void {\r\n  arr.push = push;\r\n  arr.unshift = unshift;\r\n  arr.pop = pop;\r\n  arr.shift = shift;\r\n  arr.splice = splice;\r\n  arr._getEventParent = getEventParent;\r\n  arr._obs = Object.assign({ ops: ops }, state) as ObservableArrayState;\r\n}\r\n\r\n/** @hidden @internal */\r\nexport const observableArray = {\r\n  initialize: initialize,\r\n  updateEntityState: updateEntityState,\r\n  publish: publish,\r\n  getEntityAspect: getEntityAspect,\r\n  pushUnchecked: pushUnchecked,\r\n  clearAll: clearAll,\r\n  isClearing: isClearing,\r\n  /** Puts back the contents the owning entity had before its changes. */\r\n  rejectChanges: (arr: any) => (arr._obs as ObservableArrayState).ops.rejectChanges?.(arr),\r\n  /** Forgets the saved contents: what was changed is now what is stored. */\r\n  acceptChanges: (arr: any) => (arr._obs as ObservableArrayState).ops.acceptChanges?.(arr),\r\n  /** True once the array has been changed away from what the server sent. */\r\n  hasOriginalValues: (arr: any) => !!(arr._obs as ObservableArrayState)?.origValues,\r\n  /** The contents the array had before its entity was changed, or null if it has not been. */\r\n  originalContents: (arr: any): any[] | null => (arr?._obs as ObservableArrayState | undefined)?.origValues ?? null,\r\n};\r\n"]}

package/entity/primitive-array.d.ts

@@ -0,0 +1,12 @@
+import { ObservableArray } from './observable-array.js';
+import type { StructuralObject } from './entity-aspect.js';
+import type { DataProperty } from '../metadata/entity-metadata.js';
+export interface PrimitiveArray extends ObservableArray<any> {
+    parent?: StructuralObject;
+    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 makePrimitiveArray(arr: any[], parent: StructuralObject, parentProperty: DataProperty): PrimitiveArray;

package/entity/primitive-array.js

@@ -0,0 +1,71 @@
+import { BreezeEvent } from '../core/event.js';
+import { observableArray } from './observable-array.js';
+/*
+ Primitive 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 primitive array is a collection of primitive
+ values associated with a data property on a single entity or complex object, i.e.
+ customer.invoiceNumbers.
+ @class {primitiveArray}
+ */
+/*
+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 Primitives} An array of all of the items added to this collection.
+@param removed {Array of Primitives} An array of all of the items removed from this collection.
+@readOnly
+*/
+const primitiveArrayOps = {
+    // every value is welcome: there is nothing to attach, and no duplicate to guard against
+    getGoodAdds: function (arr, adds) {
+        return adds;
+    },
+    beforeChange: function (arr) {
+        observableArray.updateEntityState(arr);
+    },
+    processAdds: function (arr, adds) {
+        // nothing needed
+    },
+    processRemoves: function (arr, removes) {
+        // nothing needed
+    },
+    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.length = 0;
+        Array.prototype.push.apply(arr, origValues);
+    },
+    acceptChanges: function (arr) {
+        arr._obs.origValues = null;
+    }
+};
+/** 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 makePrimitiveArray(arr, parent, parentProperty) {
+    const arrX = arr;
+    arrX.parent = parent;
+    arrX.parentProperty = parentProperty;
+    arrX.arrayChanged = new BreezeEvent("arrayChanged", arrX);
+    observableArray.initialize(arrX, primitiveArrayOps);
+    return arrX;
+}
+//# sourceMappingURL=primitive-array.js.map

package/entity/primitive-array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"primitive-array.js","sourceRoot":"","sources":["../../src/entity/primitive-array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAuC,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAS7F;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;EAgBE;AAEF,MAAM,iBAAiB,GAAuB;IAE5C,wFAAwF;IACxF,WAAW,EAAE,UAAU,GAAmB,EAAE,IAAW;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,EAAE,UAAU,GAAmB;QACzC,eAAe,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,WAAW,EAAE,UAAU,GAAmB,EAAE,IAAW;QACrD,iBAAiB;IACnB,CAAC;IAED,cAAc,EAAE,UAAU,GAAmB,EAAE,OAAc;QAC3D,iBAAiB;IACnB,CAAC;IAED,cAAc,EAAE,UAAU,GAAmB;QAC3C,OAAO,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,cAAc,EAAE,UAAU,GAAmB;QAC3C,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,GAAmB;QAC1C,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,UAAU;YAAE,OAAO;QACxB,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED,aAAa,EAAE,UAAU,GAAmB;QAC1C,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IAC7B,CAAC;CACF,CAAC;AAEF;;;EAGE;AACF,MAAM,UAAU,kBAAkB,CAAC,GAAU,EAAE,MAAwB,EAAE,cAA4B;IACnG,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,iBAAiB,CAAC,CAAC;IACpD,OAAO,IAAsB,CAAC;AAChC,CAAC","sourcesContent":["import { BreezeEvent } from '../core/event.js';\nimport { ObservableArray, ObservableArrayOps, observableArray } from './observable-array.js';\nimport type { StructuralObject } from './entity-aspect.js';\nimport type { DataProperty } from '../metadata/entity-metadata.js';\n\nexport interface PrimitiveArray extends ObservableArray<any> {\n  parent?: StructuralObject;\n  parentProperty?: DataProperty;\n}\n\n/*\n Primitive arrays are not a class: they are real arrays whose mutating methods are replaced, so\n that changing one updates the entity that owns it. A primitive array is a collection of primitive\n values associated with a data property on a single entity or complex object, i.e.\n customer.invoiceNumbers.\n @class {primitiveArray}\n */\n\n/*\nAn {@link BreezeEvent} that fires whenever the contents of this array changed.  This event\nis fired any time a new entity is attached or added to the EntityManager and happens to belong to this collection.\nAdds that occur as a result of query or import operations are batched so that all of the adds or removes to any individual\ncollections are collected into a single notification event for each relation array.\n@example\n    // assume order is an order entity attached to an EntityManager.\n    orders.arrayChanged.subscribe(\n    function (arrayChangedArgs) {\n        let addedEntities = arrayChangedArgs.added;\n        let removedEntities = arrayChanged.removed;\n    });\n@event arrayChanged\n@param added {Array of Primitives} An array of all of the items added to this collection.\n@param removed {Array of Primitives} An array of all of the items removed from this collection.\n@readOnly\n*/\n\nconst primitiveArrayOps: ObservableArrayOps = {\n\n  // every value is welcome: there is nothing to attach, and no duplicate to guard against\n  getGoodAdds: function (arr: PrimitiveArray, adds: any[]) {\n    return adds;\n  },\n\n  beforeChange: function (arr: PrimitiveArray) {\n    observableArray.updateEntityState(arr);\n  },\n\n  processAdds: function (arr: PrimitiveArray, adds: any[]) {\n    // nothing needed\n  },\n\n  processRemoves: function (arr: PrimitiveArray, removes: any[]) {\n    // nothing needed\n  },\n\n  getEventParent: function (arr: PrimitiveArray) {\n    return observableArray.getEntityAspect(arr);\n  },\n\n  getPendingPubs: function (arr: PrimitiveArray) {\n    const em = observableArray.getEntityAspect(arr).entityManager;\n    return em && (em as any)._pendingPubs;\n  },\n\n  rejectChanges: function (arr: PrimitiveArray) {\n    const origValues = arr._obs.origValues;\n    if (!origValues) return;\n    arr.length = 0;\n    Array.prototype.push.apply(arr, origValues);\n  },\n\n  acceptChanges: function (arr: PrimitiveArray) {\n    arr._obs.origValues = null;\n  }\n};\n\n/** For use by breeze plugin authors only. The class is for use in building a {@link ModelLibraryAdapter} implementation.\n@adapter (see {@link ModelLibraryAdapter})\n@hidden\n*/\nexport function makePrimitiveArray(arr: any[], parent: StructuralObject, parentProperty: DataProperty): PrimitiveArray {\n  const arrX = arr as any;\n  arrX.parent = parent;\n  arrX.parentProperty = parentProperty;\n  arrX.arrayChanged = new BreezeEvent(\"arrayChanged\", arrX);\n  observableArray.initialize(arrX, primitiveArrayOps);\n  return arrX as PrimitiveArray;\n}\n"]}