breeze-client 2.2.1 → 3.0.0

package/entity/entity-key.d.ts

@@ -0,0 +1,95 @@
+import { EntityType, MetadataStore } from '../metadata/entity-metadata.js';
+import type { Entity } from './entity-aspect.js';
+/**
+An EntityKey is an object that represents the unique identity of an entity.  EntityKey's are immutable.
+
+
+*/
+export declare class EntityKey {
+    /**  The 'EntityType' that this is a key for. __Read Only__ */
+    entityType: EntityType;
+    /**  An array of the values for this key. This will usually only have a single element,
+    unless the entity type has a multipart key. __Read Only__ */
+    values: any[];
+    /**
+    Constructs a new EntityKey.  Each entity within an EntityManager will have a unique EntityKey.
+    ```ts
+    // assume Employee is registered with the MetadataStore
+    const entityKey = new EntityKey(Employee, 1);
+    ```
+  
+    EntityKey's may also be found by calling EntityAspect.getKey()
+    ```ts
+    // assume employee1 is an existing Employee entity
+    const empKey = employee1.entityAspect.getKey();
+    ```
+  
+    A key of more than one property is clearest given by name, in any order:
+    ```ts
+    const detailKey = new EntityKey(OrderDetail, { orderID: 10248, productID: 11 });
+    ```
+  
+    or as an array, in the order of the type's {@link EntityType.keyProperties}: the order of the
+    key's definition on the server - `HasKey(od => new { od.OrderID, od.ProductID })` - which a
+    generated entity class states in its doc comment, as `Key: orderID, productID`.
+    ```ts
+    const sameKey = new EntityKey(OrderDetail, [10248, 11]);
+    ```
+    A wrong order is not an error - it is a valid key for another row - which is why the named form
+    is better for these.
+    @param entityType - The {@link EntityType} of the entity, or a class registered for it with
+    {@link MetadataStore.registerEntityTypeCtor}.
+    @param keyValues - The key's value; for a key of more than one property, an object of values by
+    property name, or an array in key order. A named value that is not part of the key, or a key
+    property with no value, throws.
+    */
+    constructor(entityType: EntityType | (new () => Entity), keyValues: any);
+    /** Returns the plain form of this key - `{ entityType, values }`, with the entity type's qualified
+    name - which `JSON.stringify` uses and {@link EntityKey.fromJSON} turns back into a key. Breeze
+    uses it to record temporary keys in an {@link EntityManager.exportEntities} bundle. */
+    toJSON(): {
+        /** The qualified name of the key's entity type, such as `"Customer:#Northwind.Models"`. */
+        entityType: string;
+        /** The key's values, one per key property. */
+        values: any[];
+    };
+    /** Recreates a key from the output of {@link EntityKey.toJSON}, looking its entity type up in
+    `metadataStore`. Throws if the type is not there. Used by {@link EntityManager.importEntities}. */
+    static fromJSON(json: any, metadataStore: MetadataStore): EntityKey;
+    /**
+    Used to compare EntityKeys are determine if they refer to the same Entity.
+    There is also an static version of 'equals' with the same functionality.
+  
+    ```ts
+    // assume Employee is registered with the MetadataStore
+    const empKey1 = new EntityKey(Employee, 1);
+    // assume employee1 is an existing Employee entity
+    const empKey2 = employee1.entityAspect.getKey();
+    if (empKey1.equals(empKey2)) {
+        // do something  ...
+    }
+    ```
+    */
+    equals(entityKey: EntityKey): boolean;
+    /** Returns this key as a string: the entity type's qualified name, a hyphen, and the key values
+    joined by `:::` - such as `"Order:#Northwind.Models-10248"`. Given `altEntityType`, that type's
+    name is used instead. Breeze uses this form in error messages and as the property names of an
+    {@link ITempKeyMap}. */
+    toString(altEntityType?: EntityType): string;
+    /**
+    Used to compare EntityKeys are determine if they refer to the same Entity.
+    There is also an instance version of 'equals' with the same functionality.
+    ```ts
+    // assume Employee is registered with the MetadataStore
+    const empKey1 = new EntityKey(Employee, 1);
+    // assume employee1 is an existing Employee entity
+    const empKey2 = employee1.entityAspect.getKey();
+    if (EntityKey.equals(empKey1, empKey2)) {
+        // do something  ...
+    }
+    ```
+    */
+    static equals(k1: EntityKey, k2: EntityKey): boolean;
+    /** hidden */
+    static createKeyString(keyValues: any[]): string;
+}

package/entity/entity-key.js

@@ -0,0 +1,189 @@
+import { core } from '../core/core.js';
+import { paramError } from '../core/assert-param.js';
+import { EntityType, entityTypeForCtor } from '../metadata/entity-metadata.js';
+import { DataType } from '../metadata/data-type.js';
+/**
+An EntityKey is an object that represents the unique identity of an entity.  EntityKey's are immutable.
+
+
+*/
+export class EntityKey {
+    /** @hidden @internal */
+    static ENTITY_KEY_DELIMITER = ":::";
+    /**  The 'EntityType' that this is a key for. __Read Only__ */
+    entityType;
+    /**  An array of the values for this key. This will usually only have a single element,
+    unless the entity type has a multipart key. __Read Only__ */
+    values;
+    /** @hidden @internal */
+    _keyInGroup;
+    /** @hidden @internal */
+    _subtypes;
+    /**
+    Constructs a new EntityKey.  Each entity within an EntityManager will have a unique EntityKey.
+    ```ts
+    // assume Employee is registered with the MetadataStore
+    const entityKey = new EntityKey(Employee, 1);
+    ```
+  
+    EntityKey's may also be found by calling EntityAspect.getKey()
+    ```ts
+    // assume employee1 is an existing Employee entity
+    const empKey = employee1.entityAspect.getKey();
+    ```
+  
+    A key of more than one property is clearest given by name, in any order:
+    ```ts
+    const detailKey = new EntityKey(OrderDetail, { orderID: 10248, productID: 11 });
+    ```
+  
+    or as an array, in the order of the type's {@link EntityType.keyProperties}: the order of the
+    key's definition on the server - `HasKey(od => new { od.OrderID, od.ProductID })` - which a
+    generated entity class states in its doc comment, as `Key: orderID, productID`.
+    ```ts
+    const sameKey = new EntityKey(OrderDetail, [10248, 11]);
+    ```
+    A wrong order is not an error - it is a valid key for another row - which is why the named form
+    is better for these.
+    @param entityType - The {@link EntityType} of the entity, or a class registered for it with
+    {@link MetadataStore.registerEntityTypeCtor}.
+    @param keyValues - The key's value; for a key of more than one property, an object of values by
+    property name, or an array in key order. A named value that is not part of the key, or a key
+    property with no value, throws.
+    */
+    constructor(entityType, keyValues) {
+        // A class stands for its registered type. Checked by typeof first, so the EntityType that
+        // Breeze itself always passes costs one comparison.
+        if (typeof entityType === "function")
+            entityType = entityTypeForCtor(entityType);
+        // Inline, not assertParam: an EntityKey is built for every entity and again for every
+        // foreign key the relationship fixup resolves. Same wording.
+        if (!(entityType instanceof EntityType)) {
+            throw paramError('entityType', "must be an instance of 'EntityType'");
+        }
+        // Only types that take part in an inheritance hierarchy need this, and getSelfAndSubtypes
+        // allocates an array and walks the hierarchy to find that out. Guarding on `subtypes` keeps
+        // the common case - a type with no subtypes, where the walk can only return [this] -
+        // allocation-free. `subtypes` is filled while metadata is built and not touched after.
+        if (entityType.subtypes.length > 0) {
+            let subtypes = entityType.getSelfAndSubtypes();
+            if (subtypes.length > 1) {
+                this._subtypes = subtypes.filter(function (st) {
+                    return st.isAbstract === false;
+                });
+            }
+        }
+        if (!Array.isArray(keyValues)) {
+            keyValues = isPlainObject(keyValues) ? keyValuesByName(entityType, keyValues) : [keyValues];
+        }
+        this.entityType = entityType;
+        entityType.keyProperties.forEach(function (kp, i) {
+            // insure that guid keys are comparable.
+            if (kp.dataType === DataType.Guid) {
+                keyValues[i] = keyValues[i] && keyValues[i].toLowerCase ? keyValues[i].toLowerCase() : keyValues[i];
+            }
+        });
+        this.values = keyValues;
+        this._keyInGroup = EntityKey.createKeyString(keyValues);
+    }
+    /** Returns the plain form of this key - `{ entityType, values }`, with the entity type's qualified
+    name - which `JSON.stringify` uses and {@link EntityKey.fromJSON} turns back into a key. Breeze
+    uses it to record temporary keys in an {@link EntityManager.exportEntities} bundle. */
+    toJSON() {
+        return {
+            /** The qualified name of the key's entity type, such as `"Customer:#Northwind.Models"`. */
+            entityType: this.entityType.name,
+            /** The key's values, one per key property. */
+            values: this.values
+        };
+    }
+    /** Recreates a key from the output of {@link EntityKey.toJSON}, looking its entity type up in
+    `metadataStore`. Throws if the type is not there. Used by {@link EntityManager.importEntities}. */
+    static fromJSON(json, metadataStore) {
+        let et = metadataStore._getStructuralType(json.entityType, true);
+        return new EntityKey(et, json.values);
+    }
+    /**
+    Used to compare EntityKeys are determine if they refer to the same Entity.
+    There is also an static version of 'equals' with the same functionality.
+  
+    ```ts
+    // assume Employee is registered with the MetadataStore
+    const empKey1 = new EntityKey(Employee, 1);
+    // assume employee1 is an existing Employee entity
+    const empKey2 = employee1.entityAspect.getKey();
+    if (empKey1.equals(empKey2)) {
+        // do something  ...
+    }
+    ```
+    */
+    equals(entityKey) {
+        if (!(entityKey instanceof EntityKey))
+            return false;
+        return (this.entityType === entityKey.entityType) &&
+            core.arrayEquals(this.values, entityKey.values);
+    }
+    /** Returns this key as a string: the entity type's qualified name, a hyphen, and the key values
+    joined by `:::` - such as `"Order:#Northwind.Models-10248"`. Given `altEntityType`, that type's
+    name is used instead. Breeze uses this form in error messages and as the property names of an
+    {@link ITempKeyMap}. */
+    /*
+    Returns a human readable representation of this EntityKey.
+    */
+    toString(altEntityType) {
+        return (altEntityType || this.entityType).name + '-' + this._keyInGroup;
+    }
+    /**
+    Used to compare EntityKeys are determine if they refer to the same Entity.
+    There is also an instance version of 'equals' with the same functionality.
+    ```ts
+    // assume Employee is registered with the MetadataStore
+    const empKey1 = new EntityKey(Employee, 1);
+    // assume employee1 is an existing Employee entity
+    const empKey2 = employee1.entityAspect.getKey();
+    if (EntityKey.equals(empKey1, empKey2)) {
+        // do something  ...
+    }
+    ```
+    */
+    static equals(k1, k2) {
+        if (!(k1 instanceof EntityKey))
+            return false;
+        return k1.equals(k2);
+    }
+    /** @hidden @internal */
+    // TODO: we may want to compare to default values later.
+    _isEmpty() {
+        return this.values.join("").length === 0;
+    }
+    /** hidden */
+    // TODO: think about giving _ prefix or documenting.
+    static createKeyString(keyValues) {
+        return keyValues.join(EntityKey.ENTITY_KEY_DELIMITER);
+    }
+}
+EntityKey.prototype._$typeName = "EntityKey";
+/** An object literal - not an array, a Date, or any other object a single key value could be. */
+function isPlainObject(value) {
+    if (value === null || typeof value !== 'object')
+        return false;
+    const proto = Object.getPrototypeOf(value);
+    return proto === Object.prototype || proto === null;
+}
+/** The key values given by name, put in the order of the type's key properties. */
+function keyValuesByName(entityType, values) {
+    const keyProps = entityType.keyProperties;
+    const names = keyProps.map(kp => kp.name);
+    for (const name of Object.keys(values)) {
+        if (!names.includes(name)) {
+            throw new Error(`'${name}' is not part of the key of ${entityType.name}, which is ${names.join(', ')}.`);
+        }
+    }
+    return keyProps.map(kp => {
+        if (!(kp.name in values)) {
+            throw new Error(`The key of ${entityType.name} is ${names.join(', ')}; no value was given for '${kp.name}'.`);
+        }
+        return values[kp.name];
+    });
+}
+//# sourceMappingURL=entity-key.js.map

package/entity/entity-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-key.js","sourceRoot":"","sources":["../../src/entity/entity-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAiB,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAE9F,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD;;;;EAIE;AACF,MAAM,OAAO,SAAS;IAGpB,wBAAwB;IACxB,MAAM,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACpC,8DAA8D;IAC9D,UAAU,CAAa;IACvB;gEAC4D;IAC5D,MAAM,CAAQ;IACd,wBAAwB;IACxB,WAAW,CAAS;IACpB,wBAAwB;IACxB,SAAS,CAAe;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA+BE;IACF,YAAY,UAA2C,EAAE,SAAc;QACrE,0FAA0F;QAC1F,oDAAoD;QACpD,IAAI,OAAO,UAAU,KAAK,UAAU;YAAE,UAAU,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACjF,sFAAsF;QACtF,6DAA6D;QAC7D,IAAI,CAAC,CAAC,UAAU,YAAY,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,UAAU,CAAC,YAAY,EAAE,qCAAqC,CAAC,CAAC;QACxE,CAAC;QACD,0FAA0F;QAC1F,4FAA4F;QAC5F,qFAAqF;QACrF,uFAAuF;QACvF,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,IAAI,QAAQ,GAAG,UAAU,CAAC,kBAAkB,EAAE,CAAC;YAC/C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE;oBAC3C,OAAO,EAAE,CAAC,UAAU,KAAK,KAAK,CAAC;gBACjC,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;YAC9C,wCAAwC;YACxC,IAAI,EAAE,CAAC,QAAQ,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAClC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACtG,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IAE1D,CAAC;IAGD;;0FAEsF;IACtF,MAAM;QACJ,OAAO;YACL,2FAA2F;YAC3F,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;YAChC,8CAA8C;YAC9C,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;IACJ,CAAC;IAED;sGACkG;IAClG,MAAM,CAAC,QAAQ,CAAC,IAAS,EAAE,aAA4B;QACrD,IAAI,EAAE,GAAG,aAAa,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAe,CAAC;QAC/E,OAAO,IAAI,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;MAaE;IACF,MAAM,CAAC,SAAoB;QACzB,IAAI,CAAC,CAAC,SAAS,YAAY,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,UAAU,CAAC;YAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;2BAGuB;IACvB;;MAEE;IACF,QAAQ,CAAC,aAA0B;QACjC,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;MAYE;IACF,MAAM,CAAC,MAAM,CAAC,EAAa,EAAE,EAAa;QACxC,IAAI,CAAC,CAAC,EAAE,YAAY,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QAC7C,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,CAAC;IAED,wBAAwB;IACxB,wDAAwD;IACxD,QAAQ;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,aAAa;IACb,oDAAoD;IACpD,MAAM,CAAC,eAAe,CAAC,SAAgB;QACrC,OAAO,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IACxD,CAAC;;AAGH,SAAS,CAAC,SAAS,CAAC,UAAU,GAAG,WAAW,CAAC;AAE7C,iGAAiG;AACjG,SAAS,aAAa,CAAC,KAAU;IAC/B,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3C,OAAO,KAAK,KAAK,MAAM,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACtD,CAAC;AAED,mFAAmF;AACnF,SAAS,eAAe,CAAC,UAAsB,EAAE,MAA2B;IAC1E,MAAM,QAAQ,GAAG,UAAU,CAAC,aAAa,CAAC;IAC1C,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,IAAI,IAAI,+BAA+B,UAAU,CAAC,IAAI,cAAc,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QACvB,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,cAAc,UAAU,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC;QAChH,CAAC;QACD,OAAO,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { core } from '../core/core.js';\nimport { paramError } from '../core/assert-param.js';\nimport { EntityType, MetadataStore, entityTypeForCtor } from '../metadata/entity-metadata.js';\nimport type { Entity } from './entity-aspect.js';\nimport { DataType } from '../metadata/data-type.js';\n\n/**\nAn EntityKey is an object that represents the unique identity of an entity.  EntityKey's are immutable.\n\n\n*/\nexport class EntityKey {\n  /** @hidden @internal */\n  declare _$typeName: string; // actually placed on prototype\n  /** @hidden @internal */\n  static ENTITY_KEY_DELIMITER = \":::\";\n  /**  The 'EntityType' that this is a key for. __Read Only__ */\n  entityType: EntityType;\n  /**  An array of the values for this key. This will usually only have a single element, \n  unless the entity type has a multipart key. __Read Only__ */\n  values: any[];\n  /** @hidden @internal */\n  _keyInGroup: string;\n  /** @hidden @internal */\n  _subtypes: EntityType[];\n\n  /**\n  Constructs a new EntityKey.  Each entity within an EntityManager will have a unique EntityKey.\n  ```ts\n  // assume Employee is registered with the MetadataStore\n  const entityKey = new EntityKey(Employee, 1);\n  ```\n\n  EntityKey's may also be found by calling EntityAspect.getKey()\n  ```ts\n  // assume employee1 is an existing Employee entity\n  const empKey = employee1.entityAspect.getKey();\n  ```\n\n  A key of more than one property is clearest given by name, in any order:\n  ```ts\n  const detailKey = new EntityKey(OrderDetail, { orderID: 10248, productID: 11 });\n  ```\n\n  or as an array, in the order of the type's {@link EntityType.keyProperties}: the order of the\n  key's definition on the server - `HasKey(od => new { od.OrderID, od.ProductID })` - which a\n  generated entity class states in its doc comment, as `Key: orderID, productID`.\n  ```ts\n  const sameKey = new EntityKey(OrderDetail, [10248, 11]);\n  ```\n  A wrong order is not an error - it is a valid key for another row - which is why the named form\n  is better for these.\n  @param entityType - The {@link EntityType} of the entity, or a class registered for it with\n  {@link MetadataStore.registerEntityTypeCtor}.\n  @param keyValues - The key's value; for a key of more than one property, an object of values by\n  property name, or an array in key order. A named value that is not part of the key, or a key\n  property with no value, throws.\n  */\n  constructor(entityType: EntityType | (new () => Entity), keyValues: any) {\n    // A class stands for its registered type. Checked by typeof first, so the EntityType that\n    // Breeze itself always passes costs one comparison.\n    if (typeof entityType === \"function\") entityType = entityTypeForCtor(entityType);\n    // Inline, not assertParam: an EntityKey is built for every entity and again for every\n    // foreign key the relationship fixup resolves. Same wording.\n    if (!(entityType instanceof EntityType)) {\n      throw paramError('entityType', \"must be an instance of 'EntityType'\");\n    }\n    // Only types that take part in an inheritance hierarchy need this, and getSelfAndSubtypes\n    // allocates an array and walks the hierarchy to find that out. Guarding on `subtypes` keeps\n    // the common case - a type with no subtypes, where the walk can only return [this] -\n    // allocation-free. `subtypes` is filled while metadata is built and not touched after.\n    if (entityType.subtypes.length > 0) {\n      let subtypes = entityType.getSelfAndSubtypes();\n      if (subtypes.length > 1) {\n        this._subtypes = subtypes.filter(function (st) {\n          return st.isAbstract === false;\n        });\n      }\n    }\n\n    if (!Array.isArray(keyValues)) {\n      keyValues = isPlainObject(keyValues) ? keyValuesByName(entityType, keyValues) : [keyValues];\n    }\n\n    this.entityType = entityType;\n    entityType.keyProperties.forEach(function (kp, i) {\n      // insure that guid keys are comparable.\n      if (kp.dataType === DataType.Guid) {\n        keyValues[i] = keyValues[i] && keyValues[i].toLowerCase ? keyValues[i].toLowerCase() : keyValues[i];\n      }\n    });\n\n    this.values = keyValues;\n    this._keyInGroup = EntityKey.createKeyString(keyValues);\n\n  }\n\n\n  /** Returns the plain form of this key - `{ entityType, values }`, with the entity type's qualified\n  name - which `JSON.stringify` uses and {@link EntityKey.fromJSON} turns back into a key. Breeze\n  uses it to record temporary keys in an {@link EntityManager.exportEntities} bundle. */\n  toJSON() {\n    return {\n      /** The qualified name of the key's entity type, such as `\"Customer:#Northwind.Models\"`. */\n      entityType: this.entityType.name,\n      /** The key's values, one per key property. */\n      values: this.values\n    };\n  }\n\n  /** Recreates a key from the output of {@link EntityKey.toJSON}, looking its entity type up in\n  `metadataStore`. Throws if the type is not there. Used by {@link EntityManager.importEntities}. */\n  static fromJSON(json: any, metadataStore: MetadataStore) {\n    let et = metadataStore._getStructuralType(json.entityType, true) as EntityType;\n    return new EntityKey(et, json.values);\n  }\n\n  /**\n  Used to compare EntityKeys are determine if they refer to the same Entity.\n  There is also an static version of 'equals' with the same functionality.\n\n  ```ts\n  // assume Employee is registered with the MetadataStore\n  const empKey1 = new EntityKey(Employee, 1);\n  // assume employee1 is an existing Employee entity\n  const empKey2 = employee1.entityAspect.getKey();\n  if (empKey1.equals(empKey2)) {\n      // do something  ...\n  }\n  ```\n  */\n  equals(entityKey: EntityKey): boolean {\n    if (!(entityKey instanceof EntityKey)) return false;\n    return (this.entityType === entityKey.entityType) &&\n      core.arrayEquals(this.values, entityKey.values);\n  }\n\n  /** Returns this key as a string: the entity type's qualified name, a hyphen, and the key values\n  joined by `:::` - such as `\"Order:#Northwind.Models-10248\"`. Given `altEntityType`, that type's\n  name is used instead. Breeze uses this form in error messages and as the property names of an\n  {@link ITempKeyMap}. */\n  /*\n  Returns a human readable representation of this EntityKey.\n  */\n  toString(altEntityType?: EntityType) {\n    return (altEntityType || this.entityType).name + '-' + this._keyInGroup;\n  }\n\n  /**\n  Used to compare EntityKeys are determine if they refer to the same Entity.\n  There is also an instance version of 'equals' with the same functionality.\n  ```ts\n  // assume Employee is registered with the MetadataStore\n  const empKey1 = new EntityKey(Employee, 1);\n  // assume employee1 is an existing Employee entity\n  const empKey2 = employee1.entityAspect.getKey();\n  if (EntityKey.equals(empKey1, empKey2)) {\n      // do something  ...\n  }\n  ```\n  */\n  static equals(k1: EntityKey, k2: EntityKey) {\n    if (!(k1 instanceof EntityKey)) return false;\n    return k1.equals(k2);\n  }\n\n  /** @hidden @internal */\n  // TODO: we may want to compare to default values later.\n  _isEmpty() {\n    return this.values.join(\"\").length === 0;\n  }\n\n  /** hidden */\n  // TODO: think about giving _ prefix or documenting.\n  static createKeyString(keyValues: any[]) {\n    return keyValues.join(EntityKey.ENTITY_KEY_DELIMITER);\n  }\n\n}\nEntityKey.prototype._$typeName = \"EntityKey\";\n\n/** An object literal - not an array, a Date, or any other object a single key value could be. */\nfunction isPlainObject(value: any): value is Record<string, any> {\n  if (value === null || typeof value !== 'object') return false;\n  const proto = Object.getPrototypeOf(value);\n  return proto === Object.prototype || proto === null;\n}\n\n/** The key values given by name, put in the order of the type's key properties. */\nfunction keyValuesByName(entityType: EntityType, values: Record<string, any>) {\n  const keyProps = entityType.keyProperties;\n  const names = keyProps.map(kp => kp.name);\n  for (const name of Object.keys(values)) {\n    if (!names.includes(name)) {\n      throw new Error(`'${name}' is not part of the key of ${entityType.name}, which is ${names.join(', ')}.`);\n    }\n  }\n  return keyProps.map(kp => {\n    if (!(kp.name in values)) {\n      throw new Error(`The key of ${entityType.name} is ${names.join(', ')}; no value was given for '${kp.name}'.`);\n    }\n    return values[kp.name];\n  });\n}\n\n\n"]}

package/{src → entity}/entity-state.d.ts

@@ -1,84 +1,112 @@
-import { BreezeEnum } from './enum';
-/**
-EntityState is an 'Enum' containing all of the valid states for an 'Entity'.
-**/
-export declare class EntityState extends BreezeEnum {
-    /** The 'Unchanged' state. **/
-    static Unchanged: EntityState;
-    /**  The 'Added' state.  **/
-    static Added: EntityState;
-    /**  The 'Modified' state.   **/
-    static Modified: EntityState;
-    /**  The 'Deleted' state.  **/
-    static Deleted: EntityState;
-    /**  The 'Detached' state.  **/
-    static Detached: EntityState;
-    /**
-    Returns whether an entityState instance is EntityState.Unchanged.
-    >     var es = anEntity.entityAspect.entityState;
-    >     return es.isUnchanged();
-  
-    is the same as
-    >     return es === EntityState.Unchanged;
-    **/
-    isUnchanged(): boolean;
-    /**
-    Return whether an entityState instance is EntityState.Added.
-    
-    >     var es = anEntity.entityAspect.entityState;
-    >     return es.isAdded();
-  
-    is the same as
-    >     return es === EntityState.Added;
-    **/
-    isAdded(): boolean;
-    /**
-    Returns whether an entityState instance is EntityState.Modified.
-    >     var es = anEntity.entityAspect.entityState;
-    >     return es.isModified();
-  
-    is the same as
-    >     return es === EntityState.Modified;
-    **/
-    isModified(): boolean;
-    /**
-    Returns whether an entityState instance is EntityState.Deleted.
-    >     var es = anEntity.entityAspect.entityState;
-    >     return es.isDeleted();
-  
-    is the same as
-    
-    >     return es === EntityState.Deleted;
-    **/
-    isDeleted(): boolean;
-    /**
-    Returns whether an entityState instance is EntityState.Detached.
-    >     var es = anEntity.entityAspect.entityState;
-    >     return es.isDetached();
-  
-    is the same as
-    >     return es === EntityState.Detached;
-    **/
-    isDetached(): boolean;
-    /** Return true if EntityState is Deleted or Detached */
-    isDeletedOrDetached(): boolean;
-    /**
-    Returns whether an entityState instance is EntityState.Unchanged or EntityState.Modified.
-    >     var es = anEntity.entityAspect.entityState;
-    >     return es.isUnchangedOrModified();
-  
-    is the same as
-    >     return es === EntityState.Unchanged || es === EntityState.Modified
-    **/
-    isUnchangedOrModified(): boolean;
-    /** Return true if EntityStatis is Added or Modified */
-    isAddedOrModified(): boolean;
-    /** Returns whether an entityState instance is EntityState.Added or EntityState.Modified or EntityState.Deleted.
-    >     var es = anEntity.entityAspect.entityState;
-    >     return es.isAddedModifiedOrDeleted();
-  
-    is the same as
-    >     return es === EntityState.Added || es === EntityState.Modified || es === EntityState.Deleted
-    **/
-    isAddedModifiedOrDeleted(): boolean;
-}
+import { BreezeEnum } from '../core/enum.js';
+/**
+EntityState is an 'Enum' containing all of the valid states for an 'Entity'.
+*/
+export declare class EntityState extends BreezeEnum {
+    /** The 'Unchanged' state. */
+    static Unchanged: EntityState;
+    /**  The 'Added' state.  */
+    static Added: EntityState;
+    /**  The 'Modified' state.   */
+    static Modified: EntityState;
+    /**  The 'Deleted' state.  */
+    static Deleted: EntityState;
+    /**  The 'Detached' state.  */
+    static Detached: EntityState;
+    /**
+    Returns whether an entityState instance is EntityState.Unchanged.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isUnchanged();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Unchanged;
+    ```
+    */
+    isUnchanged(): boolean;
+    /**
+    Return whether an entityState instance is EntityState.Added.
+    
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isAdded();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Added;
+    ```
+    */
+    isAdded(): boolean;
+    /**
+    Returns whether an entityState instance is EntityState.Modified.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isModified();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Modified;
+    ```
+    */
+    isModified(): boolean;
+    /**
+    Returns whether an entityState instance is EntityState.Deleted.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isDeleted();
+    ```
+  
+    is the same as
+    
+    ```ts
+    return es === EntityState.Deleted;
+    ```
+    */
+    isDeleted(): boolean;
+    /**
+    Returns whether an entityState instance is EntityState.Detached.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isDetached();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Detached;
+    ```
+    */
+    isDetached(): boolean;
+    /** Return true if EntityState is Deleted or Detached */
+    isDeletedOrDetached(): boolean;
+    /**
+    Returns whether an entityState instance is EntityState.Unchanged or EntityState.Modified.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isUnchangedOrModified();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Unchanged || es === EntityState.Modified
+    ```
+    */
+    isUnchangedOrModified(): boolean;
+    /** Return true if EntityStatis is Added or Modified */
+    isAddedOrModified(): boolean;
+    /** Returns whether an entityState instance is EntityState.Added or EntityState.Modified or EntityState.Deleted.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isAddedModifiedOrDeleted();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Added || es === EntityState.Modified || es === EntityState.Deleted
+    ```
+    */
+    isAddedModifiedOrDeleted(): boolean;
+}

package/entity/entity-state.js

@@ -0,0 +1,135 @@
+import { BreezeEnum } from '../core/enum.js';
+/**
+EntityState is an 'Enum' containing all of the valid states for an 'Entity'.
+*/
+export class EntityState extends BreezeEnum {
+    /** The 'Unchanged' state. */
+    static Unchanged = new EntityState();
+    /**  The 'Added' state.  */
+    static Added = new EntityState();
+    /**  The 'Modified' state.   */
+    static Modified = new EntityState();
+    /**  The 'Deleted' state.  */
+    static Deleted = new EntityState();
+    /**  The 'Detached' state.  */
+    static Detached = new EntityState();
+    /**
+    Returns whether an entityState instance is EntityState.Unchanged.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isUnchanged();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Unchanged;
+    ```
+    */
+    isUnchanged() {
+        return this === EntityState.Unchanged;
+    }
+    /**
+    Return whether an entityState instance is EntityState.Added.
+    
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isAdded();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Added;
+    ```
+    */
+    isAdded() {
+        return this === EntityState.Added;
+    }
+    /**
+    Returns whether an entityState instance is EntityState.Modified.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isModified();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Modified;
+    ```
+    */
+    isModified() {
+        return this === EntityState.Modified;
+    }
+    /**
+    Returns whether an entityState instance is EntityState.Deleted.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isDeleted();
+    ```
+  
+    is the same as
+    
+    ```ts
+    return es === EntityState.Deleted;
+    ```
+    */
+    isDeleted() {
+        return this === EntityState.Deleted;
+    }
+    /**
+    Returns whether an entityState instance is EntityState.Detached.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isDetached();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Detached;
+    ```
+    */
+    isDetached() {
+        return this === EntityState.Detached;
+    }
+    /** Return true if EntityState is Deleted or Detached */
+    isDeletedOrDetached() {
+        return this === EntityState.Deleted || this === EntityState.Detached;
+    }
+    /**
+    Returns whether an entityState instance is EntityState.Unchanged or EntityState.Modified.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isUnchangedOrModified();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Unchanged || es === EntityState.Modified
+    ```
+    */
+    isUnchangedOrModified() {
+        return this === EntityState.Unchanged || this === EntityState.Modified;
+    }
+    /** Return true if EntityStatis is Added or Modified */
+    isAddedOrModified() {
+        return this === EntityState.Added || this === EntityState.Modified;
+    }
+    /** Returns whether an entityState instance is EntityState.Added or EntityState.Modified or EntityState.Deleted.
+    ```ts
+    var es = anEntity.entityAspect.entityState;
+    return es.isAddedModifiedOrDeleted();
+    ```
+  
+    is the same as
+    ```ts
+    return es === EntityState.Added || es === EntityState.Modified || es === EntityState.Deleted
+    ```
+    */
+    isAddedModifiedOrDeleted() {
+        return this === EntityState.Added ||
+            this === EntityState.Modified ||
+            this === EntityState.Deleted;
+    }
+}
+EntityState.prototype._$typeName = "EntityState";
+EntityState.resolveSymbols();
+//# sourceMappingURL=entity-state.js.map

package/entity/entity-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-state.js","sourceRoot":"","sources":["../../src/entity/entity-state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C;;EAEE;AACF,MAAM,OAAO,WAAY,SAAQ,UAAU;IAEzC,6BAA6B;IAC7B,MAAM,CAAC,SAAS,GAAG,IAAI,WAAW,EAAE,CAAC;IACrC,2BAA2B;IAC3B,MAAM,CAAC,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC;IACjC,+BAA+B;IAC/B,MAAM,CAAC,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;IACpC,6BAA6B;IAC7B,MAAM,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IACnC,8BAA8B;IAC9B,MAAM,CAAC,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;IAEpC;;;;;;;;;;;MAWE;IACF,WAAW;QACT,OAAO,IAAI,KAAK,WAAW,CAAC,SAAS,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;MAYE;IACF,OAAO;QACL,OAAO,IAAI,KAAK,WAAW,CAAC,KAAK,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;MAWE;IACF,UAAU;QACR,OAAO,IAAI,KAAK,WAAW,CAAC,QAAQ,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;MAYE;IACF,SAAS;QACP,OAAO,IAAI,KAAK,WAAW,CAAC,OAAO,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;MAWE;IACF,UAAU;QACR,OAAO,IAAI,KAAK,WAAW,CAAC,QAAQ,CAAC;IACvC,CAAC;IAED,wDAAwD;IACxD,mBAAmB;QACjB,OAAO,IAAI,KAAK,WAAW,CAAC,OAAO,IAAI,IAAI,KAAK,WAAW,CAAC,QAAQ,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;MAWE;IACF,qBAAqB;QACnB,OAAO,IAAI,KAAK,WAAW,CAAC,SAAS,IAAI,IAAI,KAAK,WAAW,CAAC,QAAQ,CAAC;IACzE,CAAC;IAED,uDAAuD;IACvD,iBAAiB;QACf,OAAO,IAAI,KAAK,WAAW,CAAC,KAAK,IAAI,IAAI,KAAK,WAAW,CAAC,QAAQ,CAAC;IACrE,CAAC;IAED;;;;;;;;;;MAUE;IACF,wBAAwB;QACtB,OAAO,IAAI,KAAK,WAAW,CAAC,KAAK;YAC/B,IAAI,KAAK,WAAW,CAAC,QAAQ;YAC7B,IAAI,KAAK,WAAW,CAAC,OAAO,CAAC;IACjC,CAAC;;AAGH,WAAW,CAAC,SAAS,CAAC,UAAU,GAAG,aAAa,CAAC;AACjD,WAAW,CAAC,cAAc,EAAE,CAAC","sourcesContent":["import { BreezeEnum } from '../core/enum.js';\r\n\r\n/**\r\nEntityState is an 'Enum' containing all of the valid states for an 'Entity'.\r\n*/\r\nexport class EntityState extends BreezeEnum {\r\n\r\n  /** The 'Unchanged' state. */\r\n  static Unchanged = new EntityState();\r\n  /**  The 'Added' state.  */\r\n  static Added = new EntityState();\r\n  /**  The 'Modified' state.   */\r\n  static Modified = new EntityState();\r\n  /**  The 'Deleted' state.  */\r\n  static Deleted = new EntityState();\r\n  /**  The 'Detached' state.  */\r\n  static Detached = new EntityState();\r\n\r\n  /**\r\n  Returns whether an entityState instance is EntityState.Unchanged.\r\n  ```ts\r\n  var es = anEntity.entityAspect.entityState;\r\n  return es.isUnchanged();\r\n  ```\r\n\r\n  is the same as\r\n  ```ts\r\n  return es === EntityState.Unchanged;\r\n  ```\r\n  */\r\n  isUnchanged() {\r\n    return this === EntityState.Unchanged;\r\n  }\r\n\r\n  /**\r\n  Return whether an entityState instance is EntityState.Added.\r\n  \r\n  ```ts\r\n  var es = anEntity.entityAspect.entityState;\r\n  return es.isAdded();\r\n  ```\r\n\r\n  is the same as\r\n  ```ts\r\n  return es === EntityState.Added;\r\n  ```\r\n  */\r\n  isAdded() {\r\n    return this === EntityState.Added;\r\n  }\r\n\r\n  /**\r\n  Returns whether an entityState instance is EntityState.Modified.\r\n  ```ts\r\n  var es = anEntity.entityAspect.entityState;\r\n  return es.isModified();\r\n  ```\r\n\r\n  is the same as\r\n  ```ts\r\n  return es === EntityState.Modified;\r\n  ```\r\n  */\r\n  isModified() {\r\n    return this === EntityState.Modified;\r\n  }\r\n\r\n  /**\r\n  Returns whether an entityState instance is EntityState.Deleted.\r\n  ```ts\r\n  var es = anEntity.entityAspect.entityState;\r\n  return es.isDeleted();\r\n  ```\r\n\r\n  is the same as\r\n  \r\n  ```ts\r\n  return es === EntityState.Deleted;\r\n  ```\r\n  */\r\n  isDeleted() {\r\n    return this === EntityState.Deleted;\r\n  }\r\n\r\n  /**\r\n  Returns whether an entityState instance is EntityState.Detached.\r\n  ```ts\r\n  var es = anEntity.entityAspect.entityState;\r\n  return es.isDetached();\r\n  ```\r\n\r\n  is the same as\r\n  ```ts\r\n  return es === EntityState.Detached;\r\n  ```\r\n  */\r\n  isDetached() {\r\n    return this === EntityState.Detached;\r\n  }\r\n\r\n  /** Return true if EntityState is Deleted or Detached */\r\n  isDeletedOrDetached() {\r\n    return this === EntityState.Deleted || this === EntityState.Detached;\r\n  }\r\n\r\n  /**\r\n  Returns whether an entityState instance is EntityState.Unchanged or EntityState.Modified.\r\n  ```ts\r\n  var es = anEntity.entityAspect.entityState;\r\n  return es.isUnchangedOrModified();\r\n  ```\r\n\r\n  is the same as\r\n  ```ts\r\n  return es === EntityState.Unchanged || es === EntityState.Modified\r\n  ```\r\n  */\r\n  isUnchangedOrModified() {\r\n    return this === EntityState.Unchanged || this === EntityState.Modified;\r\n  }\r\n\r\n  /** Return true if EntityStatis is Added or Modified */\r\n  isAddedOrModified() {\r\n    return this === EntityState.Added || this === EntityState.Modified;\r\n  }\r\n\r\n  /** Returns whether an entityState instance is EntityState.Added or EntityState.Modified or EntityState.Deleted.\r\n  ```ts\r\n  var es = anEntity.entityAspect.entityState;\r\n  return es.isAddedModifiedOrDeleted();\r\n  ```\r\n\r\n  is the same as\r\n  ```ts\r\n  return es === EntityState.Added || es === EntityState.Modified || es === EntityState.Deleted\r\n  ```\r\n  */\r\n  isAddedModifiedOrDeleted() {\r\n    return this === EntityState.Added ||\r\n      this === EntityState.Modified ||\r\n      this === EntityState.Deleted;\r\n  }\r\n\r\n}\r\nEntityState.prototype._$typeName = \"EntityState\";\r\nEntityState.resolveSymbols();\r\n"]}