Change Log - ecschema-metadata

4.10.2

Thu Nov 21 2024

Version update only

4.10.1

Thu Nov 14 2024

Version update only

4.10.0

Wed Nov 13 2024

Updates

• Deprecate SchemaMatchType.Identical and switch to Exact as default
• Support inverted units through SchemaUnitsConverter
• Updated deserialization/serialization logic to handle newer schemas containing unknowns.

4.9.7

Wed Nov 06 2024

Version update only

4.9.6

Tue Nov 05 2024

Version update only

4.9.5

Tue Oct 22 2024

Version update only

4.9.4

Wed Oct 09 2024

Version update only

4.9.3

Thu Oct 03 2024

Version update only

4.9.2

Wed Oct 02 2024

Version update only

4.9.1

Wed Sep 25 2024

Version update only

4.9.0

Mon Sep 23 2024

Updates

• remove almost-equal dependency
• formatting tests

4.8.7

Fri Sep 13 2024

Version update only

4.8.6

Fri Sep 06 2024

Version update only

4.8.5

Wed Aug 28 2024

Version update only

4.8.4

Thu Aug 22 2024

Version update only

4.8.3

Fri Aug 16 2024

Version update only

4.8.2

Thu Aug 15 2024

Version update only

4.8.1

Mon Aug 12 2024

Version update only

4.8.0

Thu Aug 08 2024

Updates

• Restore clean script
• Deprecate CustomAttributeClass.containerType and add CustomAttributeClass.appliesTo as it's replacement
• SchemaUnitProvider now has the beta tag.
• Added SchemaItem name editing support.
• added esm build

4.7.8

Wed Jul 31 2024

Version update only

4.7.7

Fri Jul 19 2024

Version update only

4.7.6

Fri Jul 12 2024

Version update only

4.7.5

Thu Jul 11 2024

Version update only

4.7.4

Mon Jul 01 2024

Version update only

4.7.3

Thu Jun 27 2024

Version update only

4.7.2

Fri Jun 21 2024

Version update only

4.7.1

Thu Jun 13 2024

Version update only

4.7.0

Wed Jun 12 2024

Version update only

4.6.2

Fri Jun 07 2024

Version update only

4.6.1

Wed May 29 2024

Version update only

4.6.0

Mon May 13 2024

Updates

• Added setter methods for editing/merging workflows

4.5.2

Tue Apr 16 2024

Version update only

4.5.1

Wed Apr 03 2024

Version update only

4.5.0

Tue Apr 02 2024

Updates

• Units v1.0.8 schema is released which introduces a new unit - Decanewton (daN)
• Added error handle when trying to create a schema fromJson that has referenced custom attributes and no references defined in the schema.

4.4.9

Mon Apr 15 2024

Version update only

4.4.8

Mon Mar 25 2024

Version update only

4.4.7

Fri Mar 15 2024

Version update only

4.4.6

Fri Mar 08 2024

Version update only

4.4.5

Tue Mar 05 2024

Version update only

4.4.4

Fri Mar 01 2024

Version update only

4.4.3

Fri Feb 23 2024

Version update only

4.4.2

Fri Feb 16 2024

Version update only

4.4.1

Fri Feb 16 2024

Version update only

4.4.0

Mon Feb 12 2024

Updates

• Added setters for property attribute values used in schema merging
• Added setters for relationship or relationshipconstraint properties
• Added setter for koq persistenceUnit used in schema merging

4.3.5

Mon Mar 25 2024

Version update only

4.3.4

Fri Mar 22 2024

Version update only

4.3.3

Wed Jan 03 2024

Version update only

4.3.2

Thu Dec 14 2023

Version update only

4.3.1

Wed Dec 13 2023

Version update only

4.3.0

Thu Dec 07 2023

Version update only

4.2.4

Mon Nov 20 2023

Version update only

4.2.3

Mon Nov 06 2023

Version update only

4.2.2

Thu Nov 02 2023

Version update only

4.2.1

Tue Oct 24 2023

Version update only

4.2.0

Tue Oct 17 2023

Updates

• Make SchemaLoader, SchemaJsonLocater and SchemaPropsGetter beta
• Added the ability to rename an ECProperty via the setName method.

4.1.9

Tue Oct 10 2023

Version update only

4.1.8

Fri Oct 06 2023

Version update only

4.1.7

Thu Sep 28 2023

Version update only

4.1.6

Tue Sep 12 2023

Version update only

4.1.5

Fri Sep 08 2023

Version update only

4.1.4

Thu Sep 07 2023

Version update only

4.1.3

Wed Aug 30 2023

Version update only

4.1.2

Wed Aug 23 2023

Version update only

4.1.1

Fri Aug 18 2023

Version update only

4.1.0

Mon Aug 14 2023

Updates

• Added the ability to update the name of an EC Class via the ecschema-editing API.
• Upgrade sinon to 15.0.4
• Switch to ESLint new flat config system

4.0.7

Thu Aug 10 2023

Version update only

4.0.6

Mon Jul 24 2023

Version update only

4.0.5

Tue Jul 18 2023

Version update only

4.0.4

Wed Jul 12 2023

Version update only

4.0.3

Mon Jul 03 2023

Version update only

4.0.2

Wed Jun 21 2023

Version update only

4.0.1

Wed Jun 21 2023

Version update only

4.0.0

Mon May 22 2023

Updates

• Added support for async schema location
• Update to eslint@8
• Replaced UnitProps interface with SchemaItemUnitProps type.

3.8.0

Fri Dec 08 2023

Version update only

3.7.17

Mon Nov 20 2023

Version update only

3.7.16

Mon Oct 16 2023

Version update only

3.7.15

Tue Oct 10 2023

Version update only

3.7.14

Fri Sep 29 2023

Version update only

3.7.13

Tue Aug 08 2023

Version update only

3.7.12

Thu Jul 27 2023

Version update only

3.7.11

Tue Jul 11 2023

Version update only

3.7.10

Wed Jul 05 2023

Version update only

3.7.9

Tue Jun 20 2023

Version update only

3.7.8

Thu Jun 01 2023

Version update only

3.7.7

Wed May 24 2023

Version update only

3.7.6

Mon May 15 2023

Version update only

3.7.5

Thu May 04 2023

Version update only

3.7.4

Tue Apr 25 2023

Version update only

3.7.3

Thu Apr 20 2023

Version update only

3.7.2

Wed Apr 12 2023

Version update only

3.7.1

Mon Apr 03 2023

Version update only

3.7.0

Wed Mar 29 2023

Version update only

3.6.3

Mon Mar 27 2023

Version update only

3.6.2

Fri Mar 17 2023

Version update only

3.6.1

Fri Feb 24 2023

Version update only

3.6.0

Wed Feb 08 2023

Version update only

3.5.6

Fri Feb 24 2023

Version update only

3.5.5

Thu Jan 26 2023

Version update only

3.5.4

Wed Jan 18 2023

Version update only

3.5.3

Fri Jan 13 2023

Version update only

3.5.2

Wed Jan 11 2023

Version update only

3.5.1

Thu Dec 15 2022

Version update only

3.5.0

Wed Dec 07 2022

Updates

• bump up xmldom/xmldom version to avoid prototype pollution

3.4.7

Wed Nov 30 2022

Version update only

3.4.6

Tue Nov 22 2022

Version update only

3.4.5

Thu Nov 17 2022

Version update only

3.4.4

Thu Nov 10 2022

Updates

• bump xmldom to resolve GHSA-crh6-fp67-6883

3.4.3

Fri Oct 28 2022

Version update only

3.4.2

Mon Oct 24 2022

Version update only

3.4.1

Mon Oct 17 2022

Version update only

3.4.0

Thu Oct 13 2022

Updates

• Added SchemaLoader
• Updated Node types declaration to support latest v16

3.3.5

Tue Sep 27 2022

Version update only

3.3.4

Thu Sep 08 2022

Version update only

3.3.3

Tue Sep 06 2022

Version update only

3.3.2

Thu Sep 01 2022

Version update only

3.3.1

Fri Aug 26 2022

Version update only

3.3.0

Thu Aug 18 2022

Updates

• upgrade mocha to version 10.0.0
• Added the ability to retrieve all known schema from a schema context.
• default values of properties numerator, denominator and offset must not be serialized

3.2.9

Fri Aug 26 2022

Version update only

3.2.8

Tue Aug 09 2022

Version update only

3.2.7

Mon Aug 01 2022

Version update only

3.2.6

Fri Jul 15 2022

Version update only

3.2.5

Wed Jul 13 2022

Version update only

3.2.4

Tue Jun 21 2022

Version update only

3.2.3

Fri Jun 17 2022

Version update only

3.2.2

Fri Jun 10 2022

Version update only

3.2.1

Tue Jun 07 2022

Version update only

3.2.0

Fri May 20 2022

Version update only

3.1.3

Fri Apr 15 2022

Version update only

3.1.2

Wed Apr 06 2022

Version update only

3.1.1

Thu Mar 31 2022

Version update only

3.1.0

Tue Mar 29 2022

Updates

• Now consuming format type definitions from @itwin/core-quantity. Implementation of the SchemaUnitProvider class to retrieve Units from EC schemas.
• Simplifying the initialization of the SchemaUnitProvider by allowing a ISchemaLocater to be passed in during construction.

3.0.3

Fri Mar 25 2022

Version update only

3.0.2

Thu Mar 10 2022

Version update only

3.0.1

Thu Feb 24 2022

Version update only

3.0.0

Mon Jan 24 2022

Updates

• Added delete class from schema and delete property from class as well as corresponding tests
• Upgrade target to ES2019
• rename to @itwin/ecschema-metadata
• remove ClientRequestContext and its subclasses
• Removing deprecated editing and validation types from ecschema-metadata.
• remove alpha toXmlString method and its implicit xmldom dependency

2.19.28

Wed Jan 12 2022

Version update only

2.19.27

Wed Jan 05 2022

Version update only

2.19.26

Wed Dec 08 2021

Version update only

2.19.25

Fri Dec 03 2021

Version update only

2.19.24

Mon Nov 29 2021

Version update only

2.19.23

Mon Nov 22 2021

Version update only

2.19.22

Tue Nov 16 2021

Version update only

2.19.21

Wed Nov 10 2021

Version update only

2.19.20

Fri Oct 29 2021

Version update only

2.19.19

Mon Oct 25 2021

Version update only

2.19.18

Thu Oct 21 2021

Version update only

2.19.17

Thu Oct 14 2021

Version update only

2.19.16

Mon Oct 11 2021

Version update only

2.19.15

Fri Oct 08 2021

Version update only

2.19.14

Fri Oct 01 2021

Version update only

2.19.13

Tue Sep 21 2021

Version update only

2.19.12

Wed Sep 15 2021

Updates

• Bump xmldom@^0.6.0 -> @xmldom/xmldom@^0.7.0, and remove @types/xmldom, as typedefs are now delivered with their core pkg. This should resolve cve-2021-32796

2.19.11

Thu Sep 09 2021

Version update only

2.19.10

Wed Sep 08 2021

Version update only

2.19.9

Wed Aug 25 2021

Version update only

2.19.8

Mon Aug 23 2021

Version update only

2.19.7

Fri Aug 20 2021

Updates

• remove alpha toXmlString method and its implicit xmldom dependency

2.19.6

Tue Aug 17 2021

Version update only

2.19.5

Fri Aug 13 2021

Version update only

2.19.4

Thu Aug 12 2021

Version update only

2.19.3

Wed Aug 04 2021

Updates

• switch to xmldom@0.6.0 which correctly escapes entities in attributes when serializing

2.19.2

Tue Aug 03 2021

Version update only

2.19.1

Thu Jul 29 2021

Version update only

2.19.0

Mon Jul 26 2021

Updates

• remove internal barrel-import usage

2.18.4

Tue Aug 10 2021

Version update only

2.18.3

Wed Jul 28 2021

Version update only

2.18.2

Mon Jul 26 2021

Version update only

2.18.1

Fri Jul 16 2021

Version update only

2.18.0

Fri Jul 09 2021

Updates

• ECSchema validation and editing APIs moved from the ecschema-metadata package to the ecschema-editing package.
• Addet setVersion method to the Schema class.

2.17.3

Mon Jul 26 2021

Version update only

2.17.2

Thu Jul 08 2021

Version update only

2.17.1

Fri Jul 02 2021

Version update only

2.17.0

Mon Jun 28 2021

Updates

• Add functions to encode and decode ECNames.
• Added tests for validating custom attribute namespace and schema version
• Added get fullName tests for each schema item type if they didn't exist before

2.16.10

Thu Jul 22 2021

Version update only

2.16.9

Tue Jul 06 2021

Version update only

2.16.8

Fri Jul 02 2021

Version update only

2.16.7

Mon Jun 28 2021

Version update only

2.16.6

Mon Jun 28 2021

Version update only

2.16.5

Fri Jun 25 2021

Version update only

2.16.4

Wed Jun 23 2021

Version update only

2.16.3

Wed Jun 16 2021

Version update only

2.16.2

Thu Jun 03 2021

Version update only

2.16.1

Thu May 27 2021

Version update only

2.16.0

Mon May 24 2021

Updates

• ECSchema Rpc Interface changes
• Changed class properties to use map and added corresponding performance tests
• Added additional testing for checking cyclic schema reference during deserialization

2.15.6

Wed May 26 2021

Version update only

2.15.5

Thu May 20 2021

Version update only

2.15.4

Tue May 18 2021

Version update only

2.15.3

Mon May 17 2021

Version update only

2.15.2

Wed May 12 2021

Version update only

2.15.1

Wed May 05 2021

Version update only

2.15.0

Fri Apr 30 2021

Updates

• Adding Units Package to core
• Fix unit conversion tests and add checking if base units matches for conversions
• Replace instanceOf with custom type guards
• Replace instanceOf with custom type guards
• update xmldom to 0.5.0

2.14.4

Thu Apr 22 2021

Version update only

2.14.3

Thu Apr 15 2021

Version update only

2.14.2

Thu Apr 08 2021

Version update only

2.14.1

Mon Apr 05 2021

Version update only

2.14.0

Fri Apr 02 2021

Version update only

2.13.0

Tue Mar 09 2021

Updates

• Updated to use TypeScript 4.1
• begin rename project from iModel.js to iTwin.js

2.12.3

Mon Mar 08 2021

Version update only

2.12.2

Wed Mar 03 2021

Version update only

2.12.1

Tue Feb 23 2021

Version update only

2.12.0

Thu Feb 18 2021

Updates

• EC Validation Rule 102 added regarding abstract base class restrictions

2.11.2

Wed Feb 17 2021

Version update only

2.11.1

Thu Feb 04 2021

Version update only

2.11.0

Thu Jan 28 2021

Version update only

2.10.3

Fri Jan 08 2021

Version update only

2.10.2

Fri Jan 08 2021

Version update only

2.10.1

Mon Dec 21 2020

Version update only

2.10.0

Fri Dec 18 2020

Updates

• Modifier attribute from Mixins won't be removed.

2.9.9

Sun Dec 13 2020

Version update only

2.9.8

Thu Dec 10 2020

Version update only

2.9.7

Wed Dec 09 2020

Version update only

2.9.6

Mon Dec 07 2020

Version update only

2.9.5

Fri Dec 04 2020

Version update only

2.9.4

Wed Dec 02 2020

Version update only

2.9.3

Mon Nov 23 2020

Version update only

2.9.2

Mon Nov 23 2020

Version update only

2.9.1

Thu Nov 19 2020

Version update only

2.9.0

Wed Nov 18 2020

Updates

• ECRules applied upon reference addition
• Fixed how schema dependency graph is build

2.8.1

Mon Nov 02 2020

Version update only

2.8.0

Fri Oct 23 2020

Version update only

2.7.6

Wed Nov 11 2020

Version update only

2.7.5

Fri Oct 23 2020

Version update only

2.7.4

Mon Oct 19 2020

Version update only

2.7.3

Wed Oct 14 2020

Version update only

2.7.2

Tue Oct 13 2020

Version update only

2.7.1

Thu Oct 08 2020

Version update only

2.7.0

Fri Oct 02 2020

Updates

• Fixed lint warnings.

2.6.5

Sat Sep 26 2020

Version update only

2.6.4

Tue Sep 22 2020

Version update only

2.6.3

Mon Sep 21 2020

Version update only

2.6.2

Mon Sep 21 2020

Version update only

2.6.1

Fri Sep 18 2020

Version update only

2.6.0

Thu Sep 17 2020

Updates

• Moved ESLint configuration to a plugin

2.5.5

Wed Sep 02 2020

Version update only

2.5.4

Fri Aug 28 2020

Version update only

2.5.3

Wed Aug 26 2020

Version update only

2.5.2

Tue Aug 25 2020

Updates

• extend ECVersion read and write ver to 3 digits

2.5.1

Mon Aug 24 2020

Version update only

2.5.0

Thu Aug 20 2020

Updates

• Added new EC Rules for NavigationProperty validation.
• Added support for adding schema references via the Editor class.
• Switch to ESLint

2.4.2

Fri Aug 14 2020

Version update only

2.4.1

Fri Aug 07 2020

Version update only

2.4.0

Tue Jul 28 2020

Version update only

2.3.3

Thu Jul 23 2020

Version update only

2.3.2

Tue Jul 14 2020

Version update only

2.3.1

Mon Jul 13 2020

Version update only

2.3.0

Fri Jul 10 2020

Updates

• Added editors for KoQ, Unit, Phenomenon, UnitSystem and tests for all of them.
• Added editors for all remaining SchemaItems.

2.2.1

Tue Jul 07 2020

Version update only

2.2.0

Fri Jun 19 2020

Updates

• SchemaKey names are compared case-insensitive.
• Added Editor classes to enable in-memory schema edits.

2.1.0

Thu May 28 2020

Updates

• Extend ECVersion valid numbers
• InvertedUnits.toJSON serialized the names of unitsystem and invertedUnit with their name instead of fullName.
• SchemaValidater implementation for applying EC rules to in memory EC Schemas.
• changed enum property toXml() to use name and not fullName.

2.0.0

Wed May 06 2020

Updates

• new EC Rule 501 - CustomAttribute schemas must be referenced by the container's schema.
• Removing deprecated API. Please see NextVersion.md under the heading 'ecschema-metadata Package' for details.
• Deprecating schema classes' method 'toJson' and replacing it with the JSON.stringify supported method 'toJSON'. Also deprecating the 'deserialize' method and replacing it with 'fromJSON' for naming consistency.
• Undefined display labels should equal empty display labels during schema comparison.
• order imports.
• Removed unused package dependencies
• Upgrade to Rush 5.23.2
• Added SchemaContext.getCachedSchema to retrieve a previously load Schema by SchemaKey

1.14.1

Wed Apr 22 2020

Version update only

1.14.0

Tue Mar 31 2020

Version update only

1.13.0

Wed Mar 04 2020

Version update only

1.12.0

Wed Feb 12 2020

Version update only

1.11.0

Wed Jan 22 2020

Updates

• Setting ECEnumeration property 'isStrict' to true if not present when parsing schema XML.
• Upgrade to TypeScript 3.7.2.

1.10.0

Tue Jan 07 2020

Updates

• Diagnostic is now a parameter in rule suppression functions
• deprecating EC schema file locater classes (moved to ecschema-locaters package)
• Adding SchemaReferenceDelta to allow reporting of schema reference version differences during schema comparison.

1.9.0

Tue Dec 10 2019

Updates

• Resolving an error in schema validation in ecschema-metadata

1.8.0

Fri Nov 22 2019

Updates

• Edited Schema.ts and all related .test.ts files to require a schema alias.
• Bis-Rule Suppression Implementation

1.7.0

Fri Nov 01 2019

Updates

• Fix in Schema XML serialization to ensure type references include Schema alias, not Schema name.

1.6.0

Wed Oct 09 2019

Updates

• Updating ECSchema-Metadata docs to clarify that FormatOverrides return a fully qualified name for both name and fullname. Update tests to make it clear as well
• Add ability to get inherited custom attributes from base properties

1.5.0

Mon Sep 30 2019

Updates

• Fixing bug where format overrides which specified a unit but no label set the label to 'undefined' #177676
• Upgrade to TypeScript 3.6.2

1.4.0

Tue Sep 10 2019

Updates

• Add public method getCustomAttributes() and getCustomAttributesSync() to ECClass to recursively retrieve all custom attributes in the current class and its bases

1.3.0

Tue Aug 13 2019

Updates

• Fix bug with OverrideFormat names. Remove the setter from KindOfQuantity for persistence format as that shouldn't be set by the public API.
• Fix issues with KindOfQuantity serialization and deserialization to ECXml

1.2.0

Wed Jul 24 2019

Updates

• Add Xml serialization methods for Schema, SchemaItem and Property
• Fixing XmlParser.getQualifiedTypeName() to be able to parse alias:ItemName correctly

1.1.0

Mon Jul 01 2019

Updates

• Update to TypeScript 3.5

1.0.0

Mon Jun 03 2019

Version update only

0.191.0

Mon May 13 2019

Updates

• Add XmlParser for direct consumption of Xml Schemas
• Adds parameter for api-extractor to validate missing release tags
• Adds ignoreMissingTags flag
• Fix broken links
• Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization.
• Added ability to suppress rule violations from being reported during schema validation.
• Upgrade TypeDoc dependency to 0.14.2
• Updated BIS and EC schema validation documentation and adjusted diagnostic codes to match documentation.

0.190.0

Thu Mar 14 2019

Version update only

0.189.0

Wed Mar 06 2019

Updates

• Changes package.json to include api-extractor and adds api-extractor.json
• Implemented BIS rules for schema validation.
• Use new buildIModelJsBuild script
• Change the default version pattern to be padded with zeroes to match 'RR.ww.mm'.
• Convert Schema._items from Array to Map and return IterableIterator instead of Array in Schema.getItems/getClasses
• Removing BIS Rules from ecschema-metadata
• SchemaContext is now required when constructing a Schema instance.
• Added schema validation support via the configuration of rule sets that can be applied during schema traversal
• Upgrade to TypeScript 3.2.2

0.188.0

Wed Jan 16 2019

Version update only

0.187.0

Tue Jan 15 2019

Version update only

0.186.0

Mon Jan 14 2019

Version update only

0.185.0

Fri Jan 11 2019

Version update only

0.184.0

Thu Jan 10 2019

Version update only

0.183.0

Mon Jan 07 2019

Version update only

0.182.0

Mon Jan 07 2019

Version update only

0.181.0

Fri Jan 04 2019

Version update only

0.180.0

Wed Jan 02 2019

Version update only

0.179.0

Wed Dec 19 2018

Version update only

0.178.0

Thu Dec 13 2018

Version update only

0.177.0

Wed Dec 12 2018

Version update only

0.176.0

Mon Dec 10 2018

Version update only

0.175.0

Mon Dec 10 2018

Version update only

0.174.0

Mon Dec 10 2018

Version update only

0.173.0

Thu Dec 06 2018

Version update only

0.172.0

Tue Dec 04 2018

Version update only

0.171.0

Mon Dec 03 2018

Version update only

0.170.0

Mon Nov 26 2018

Version update only

0.169.0

Tue Nov 20 2018

Version update only

0.168.0

Sat Nov 17 2018

Version update only

0.167.0

Fri Nov 16 2018

Version update only

0.166.0

Mon Nov 12 2018

Version update only

0.165.0

Mon Nov 12 2018

Version update only

0.164.0

Thu Nov 08 2018

Updates

• Updated to TypeScript 3.1

0.163.0

Wed Oct 31 2018

Updates

• Rename CustomAttributeInstance to CustomAttribute
• Refactored parsing of JSON data to happen in a new dedicated class JsonParser instead of fromJson methods. The fromJson methods have been replaced with deserialize methods which work in conjunction with JsonParser to ensure type safety and objects are created with required properties.
• Update barrel module to include missing types.

0.162.0

Wed Oct 24 2018

Updates

• Exports are imported from Index and tested against explicitly imported modules to ensure equality.
• Updated how default values are set. They are now all set within the constructor.

0.161.0

Fri Oct 19 2018

Version update only

0.160.0

Wed Oct 17 2018

Version update only

0.159.0

Tue Oct 16 2018

Version update only

0.158.0

Mon Oct 15 2018

Version update only

0.157.0

Sun Oct 14 2018

Version update only

0.156.0

Fri Oct 12 2018

Updates

• Initial release