@itwin/ecschema-editing 4.10.0-dev.0 → 4.10.0-dev.2

package/lib/cjs/Merging/SchemaItemMerger.js

@@ -1,121 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateSchemaItemKey = exports.updateSchemaItemFullName = exports.mergeSchemaItems = exports.locateSchemaItem = void 0;
-const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
-const EnumerationMerger_1 = require("./EnumerationMerger");
-const PhenomenonMerger_1 = require("./PhenomenonMerger");
-const PropertyCategoryMerger_1 = require("./PropertyCategoryMerger");
-const UnitSystemMerger_1 = require("./UnitSystemMerger");
-const KindOfQuantityMerger_1 = require("./KindOfQuantityMerger");
-const ConstantMerger_1 = require("./ConstantMerger");
-const ClassMerger_1 = require("./ClassMerger");
-const Utils = require("../Differencing/Utils");
-/**
- * Handles the merging logic for everything that is same for all schema items such as labels or descriptions
- * @internal
- */
-async function mergeSchemaItem(context, difference, merger) {
-    if (difference.changeType === "add") {
-        await merger.add(context, difference);
-        return;
-    }
-    if (difference.changeType === "modify") {
-        const schemaItem = await locateSchemaItem(context, difference.itemName, difference.schemaType);
-        return merger.modify(context, difference, schemaItem.key, schemaItem);
-    }
-    throw new Error(`The merger does not support ${difference.changeType} of ${difference.schemaType}.`);
-}
-/**
- * @internal
- */
-async function locateSchemaItem(context, itemName, schemaType) {
-    const schemaItemKey = new ecschema_metadata_1.SchemaItemKey(itemName, context.targetSchemaKey);
-    const schemaItem = await context.editor.schemaContext.getSchemaItem(schemaItemKey);
-    if (schemaItem === undefined) {
-        throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.ClassNotFound, `${schemaType} ${schemaItemKey.fullName} not found in schema context.`);
-    }
-    return schemaItem;
-}
-exports.locateSchemaItem = locateSchemaItem;
-/**
- * Merges the given set of schema items. As schema items may depend or relate with other
- * schema items, the list gets filtered to ensure the items get merged in a certain order.
- * @param context       The current merging context.
- * @param differences   Set of schema item that differed.
- * @returns             An async iterable with the merge result for each schema item.
- * @internal
- */
-async function* mergeSchemaItems(context, differences) {
-    for (const difference of differences.filter(Utils.isUnitSystemDifference)) {
-        yield await mergeSchemaItem(context, difference, UnitSystemMerger_1.unitSystemMerger);
-    }
-    for (const difference of differences.filter(Utils.isPropertyCategoryDifference)) {
-        yield await mergeSchemaItem(context, difference, PropertyCategoryMerger_1.propertyCategoryMerger);
-    }
-    for (const difference of differences.filter(Utils.isEnumerationDifference)) {
-        yield await mergeSchemaItem(context, difference, EnumerationMerger_1.enumerationMerger);
-    }
-    for (const difference of differences.filter(Utils.isEnumeratorDifference)) {
-        yield await mergeSchemaItem(context, difference, EnumerationMerger_1.enumeratorMerger);
-    }
-    for (const difference of differences.filter(Utils.isPhenomenonDifference)) {
-        yield await mergeSchemaItem(context, difference, PhenomenonMerger_1.phenomenonMerger);
-    }
-    // TODO:
-    // The following schema items are not supported yet. Mentioned in the processing order:
-    // - Unit
-    // - Inverted Unit
-    // - Format
-    for (const difference of differences.filter(Utils.isKindOfQuantityDifference)) {
-        yield await mergeSchemaItem(context, difference, KindOfQuantityMerger_1.kindOfQuantityMerger);
-    }
-    for (const difference of differences.filter(Utils.isConstantDifference)) {
-        yield await mergeSchemaItem(context, difference, ConstantMerger_1.constantMerger);
-    }
-    // Classes are slightly differently merged, since they can refer each other the process
-    // uses several stages to merge.
-    for await (const classMergeResult of (0, ClassMerger_1.mergeClassItems)(context, differences)) {
-        yield classMergeResult;
-    }
-}
-exports.mergeSchemaItems = mergeSchemaItems;
-/**
- * Convenience-method around updateSchemaItemKey that returns the full name instead of a SchemaItemKey.
- * @internal
- */
-async function updateSchemaItemFullName(context, reference) {
-    const schemaItemKey = await updateSchemaItemKey(context, reference);
-    return schemaItemKey.fullName;
-}
-exports.updateSchemaItemFullName = updateSchemaItemFullName;
-/**
- * Updates the given reference if it refers to a SchemaItem in the source Schema and
- * returns a SchemaItemKey. If any other schema is referred the reference is not change.
- * @internal
- */
-async function updateSchemaItemKey(context, reference) {
-    const [schemaName, itemName] = ecschema_metadata_1.SchemaItem.parseFullName(reference);
-    if (context.sourceSchemaKey.compareByName(schemaName)) {
-        return resolveSchemaItemKey(context.editor.schemaContext, new ecschema_metadata_1.SchemaItemKey(itemName, context.targetSchemaKey));
-    }
-    const referencedSchema = await context.targetSchema.getReference(schemaName);
-    if (referencedSchema !== undefined) {
-        return resolveSchemaItemKey(context.editor.schemaContext, new ecschema_metadata_1.SchemaItemKey(itemName, referencedSchema.schemaKey));
-    }
-    throw new Error(`Cannot locate referenced schema item ${reference}`);
-}
-exports.updateSchemaItemKey = updateSchemaItemKey;
-/**
- * To support case insensitivity for schema items, the given key is checked if there
- * exists an item for it.
- * @internal
- */
-async function resolveSchemaItemKey(schemaContext, itemKey) {
-    const item = await schemaContext.getSchemaItem(itemKey);
-    if (item === undefined) {
-        // If the schema item hasn't been created yet, we have to trust the given key is correctly spelled.
-        return itemKey;
-    }
-    return item.key;
-}
-//# sourceMappingURL=SchemaItemMerger.js.map

package/lib/cjs/Merging/SchemaItemMerger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SchemaItemMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaItemMerger.ts"],"names":[],"mappings":";;;AAMA,gEAAqH;AACrH,2DAA0E;AAC1E,yDAAsD;AACtD,qEAAkE;AAClE,yDAAsD;AACtD,iEAA8D;AAC9D,qDAAkD;AAClD,+CAAgD;AAChD,+CAA+C;AAU/C;;;GAGG;AACH,KAAK,UAAU,eAAe,CAAkE,OAA2B,EAAE,UAAa,EAAE,MAAkC;IAC5K,IAAI,UAAU,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QACpC,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACtC,OAAO;IACT,CAAC;IAED,IAAI,UAAU,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/F,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,+BAA+B,UAAU,CAAC,UAAU,OAAO,UAAU,CAAC,UAAU,GAAG,CAAC,CAAC;AACvG,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB,CAAC,OAA2B,EAAE,QAAgB,EAAE,UAAkB;IACtG,MAAM,aAAa,GAAG,IAAI,iCAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACnF,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,GAAG,UAAU,IAAI,aAAa,CAAC,QAAQ,+BAA+B,CAAC,CAAC;IAClI,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AARD,4CAQC;AAED;;;;;;;GAOG;AACI,KAAK,SAAS,CAAC,CAAC,gBAAgB,CAAC,OAA2B,EAAE,WAAkC;IACrG,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC1E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,mCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,EAAE,CAAC;QAChF,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,+CAAsB,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE,CAAC;QAC3E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,qCAAiB,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC1E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,oCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC1E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,mCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,QAAQ;IACR,uFAAuF;IACvF,SAAS;IACT,kBAAkB;IAClB,WAAW;IAEX,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAC9E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,2CAAoB,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACxE,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,+BAAc,CAAC,CAAC;IACnE,CAAC;IAED,uFAAuF;IACvF,gCAAgC;IAChC,IAAI,KAAK,EAAE,MAAM,gBAAgB,IAAI,IAAA,6BAAe,EAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;QAC3E,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,4CAwCC;AAED;;;GAGG;AACI,KAAK,UAAU,wBAAwB,CAAC,OAA2B,EAAE,SAAiB;IAC3F,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACpE,OAAO,aAAa,CAAC,QAAQ,CAAC;AAChC,CAAC;AAHD,4DAGC;AAED;;;;GAIG;AACI,KAAK,UAAU,mBAAmB,CAAC,OAA2B,EAAE,SAAiB;IACtF,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,8BAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACnE,IAAI,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QACtD,OAAO,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,iCAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;IAClH,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAC7E,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,iCAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;IACrH,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC;AACvE,CAAC;AAZD,kDAYC;AAED;;;;GAIG;AACH,KAAK,UAAU,oBAAoB,CAAC,aAA4B,EAAE,OAAsB;IACtF,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACxD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,mGAAmG;QACnG,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC;AAClB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport type { SchemaMergeContext } from \"./SchemaMerger\";\r\nimport { AnySchemaDifference, AnySchemaItemDifference, AnySchemaItemPathDifference } from \"../Differencing/SchemaDifference\";\r\nimport { ECObjectsError, ECObjectsStatus, SchemaContext, SchemaItem, SchemaItemKey } from \"@itwin/ecschema-metadata\";\r\nimport { enumerationMerger, enumeratorMerger } from \"./EnumerationMerger\";\r\nimport { phenomenonMerger } from \"./PhenomenonMerger\";\r\nimport { propertyCategoryMerger } from \"./PropertyCategoryMerger\";\r\nimport { unitSystemMerger } from \"./UnitSystemMerger\";\r\nimport { kindOfQuantityMerger } from \"./KindOfQuantityMerger\";\r\nimport { constantMerger } from \"./ConstantMerger\";\r\nimport { mergeClassItems } from \"./ClassMerger\";\r\nimport * as Utils from \"../Differencing/Utils\";\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaItemMergerHandler<T extends AnySchemaItemDifference | AnySchemaItemPathDifference> {\r\n  add: (context: SchemaMergeContext, difference: T) => Promise<SchemaItemKey>;\r\n  modify: (context: SchemaMergeContext, difference: T, itemKey: SchemaItemKey, item: any) => Promise<void>;\r\n}\r\n\r\n/**\r\n * Handles the merging logic for everything that is same for all schema items such as labels or descriptions\r\n * @internal\r\n */\r\nasync function mergeSchemaItem<T extends AnySchemaItemDifference | AnySchemaItemPathDifference>(context: SchemaMergeContext, difference: T, merger: SchemaItemMergerHandler<T>): Promise<void> {\r\n  if (difference.changeType === \"add\") {\r\n    await merger.add(context, difference);\r\n    return;\r\n  }\r\n\r\n  if (difference.changeType === \"modify\") {\r\n    const schemaItem = await locateSchemaItem(context, difference.itemName, difference.schemaType);\r\n    return merger.modify(context, difference, schemaItem.key, schemaItem);\r\n  }\r\n\r\n  throw new Error(`The merger does not support ${difference.changeType} of ${difference.schemaType}.`);\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport async function locateSchemaItem(context: SchemaMergeContext, itemName: string, schemaType: string) {\r\n  const schemaItemKey = new SchemaItemKey(itemName, context.targetSchemaKey);\r\n  const schemaItem = await context.editor.schemaContext.getSchemaItem(schemaItemKey);\r\n  if (schemaItem === undefined) {\r\n    throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `${schemaType} ${schemaItemKey.fullName} not found in schema context.`);\r\n  }\r\n\r\n  return schemaItem;\r\n}\r\n\r\n/**\r\n * Merges the given set of schema items. As schema items may depend or relate with other\r\n * schema items, the list gets filtered to ensure the items get merged in a certain order.\r\n * @param context       The current merging context.\r\n * @param differences   Set of schema item that differed.\r\n * @returns             An async iterable with the merge result for each schema item.\r\n * @internal\r\n */\r\nexport async function* mergeSchemaItems(context: SchemaMergeContext, differences: AnySchemaDifference[]) {\r\n  for (const difference of differences.filter(Utils.isUnitSystemDifference)) {\r\n    yield await mergeSchemaItem(context, difference, unitSystemMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isPropertyCategoryDifference)) {\r\n    yield await mergeSchemaItem(context, difference, propertyCategoryMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isEnumerationDifference)) {\r\n    yield await mergeSchemaItem(context, difference, enumerationMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isEnumeratorDifference)) {\r\n    yield await mergeSchemaItem(context, difference, enumeratorMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isPhenomenonDifference)) {\r\n    yield await mergeSchemaItem(context, difference, phenomenonMerger);\r\n  }\r\n\r\n  // TODO:\r\n  // The following schema items are not supported yet. Mentioned in the processing order:\r\n  // - Unit\r\n  // - Inverted Unit\r\n  // - Format\r\n\r\n  for (const difference of differences.filter(Utils.isKindOfQuantityDifference)) {\r\n    yield await mergeSchemaItem(context, difference, kindOfQuantityMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isConstantDifference)) {\r\n    yield await mergeSchemaItem(context, difference, constantMerger);\r\n  }\r\n\r\n  // Classes are slightly differently merged, since they can refer each other the process\r\n  // uses several stages to merge.\r\n  for await (const classMergeResult of mergeClassItems(context, differences)) {\r\n    yield classMergeResult;\r\n  }\r\n}\r\n\r\n/**\r\n * Convenience-method around updateSchemaItemKey that returns the full name instead of a SchemaItemKey.\r\n * @internal\r\n */\r\nexport async function updateSchemaItemFullName(context: SchemaMergeContext, reference: string) {\r\n  const schemaItemKey = await updateSchemaItemKey(context, reference);\r\n  return schemaItemKey.fullName;\r\n}\r\n\r\n/**\r\n * Updates the given reference if it refers to a SchemaItem in the source Schema and\r\n * returns a SchemaItemKey. If any other schema is referred the reference is not change.\r\n * @internal\r\n */\r\nexport async function updateSchemaItemKey(context: SchemaMergeContext, reference: string) {\r\n  const [schemaName, itemName] = SchemaItem.parseFullName(reference);\r\n  if (context.sourceSchemaKey.compareByName(schemaName)) {\r\n    return resolveSchemaItemKey(context.editor.schemaContext, new SchemaItemKey(itemName, context.targetSchemaKey));\r\n  }\r\n\r\n  const referencedSchema = await context.targetSchema.getReference(schemaName);\r\n  if (referencedSchema !== undefined) {\r\n    return resolveSchemaItemKey(context.editor.schemaContext, new SchemaItemKey(itemName, referencedSchema.schemaKey));\r\n  }\r\n\r\n  throw new Error(`Cannot locate referenced schema item ${reference}`);\r\n}\r\n\r\n/**\r\n * To support case insensitivity for schema items, the given key is checked if there\r\n * exists an item for it.\r\n * @internal\r\n */\r\nasync function resolveSchemaItemKey(schemaContext: SchemaContext, itemKey: SchemaItemKey): Promise<SchemaItemKey> {\r\n  const item = await schemaContext.getSchemaItem(itemKey);\r\n  if (item === undefined) {\r\n    // If the schema item hasn't been created yet, we have to trust the given key is correctly spelled.\r\n    return itemKey;\r\n  }\r\n  return item.key;\r\n}\r\n"]}