@itwin/imodel-transformer 2.0.0-dev.7 → 2.0.0-dev.71

package/lib/cjs/imodel-transformer.js

@@ -10,9 +10,31 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 /*---------------------------------------------------------------------------------------------
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
@@ -22,16 +44,18 @@ __exportStar(require("./TransformerLoggerCategory"), exports);
 __exportStar(require("./IModelExporter"), exports);
 __exportStar(require("./IModelImporter"), exports);
 __exportStar(require("./IModelTransformer"), exports);
+__exportStar(require("./IModelTransformContext"), exports);
+__exportStar(require("./schema-processing/SchemaProcessingStrategy"), exports);
+__exportStar(require("./IModelTransformerError"), exports);
 __exportStar(require("./BranchProvenanceInitializer"), exports);
-const semver = require("semver");
+const semver = __importStar(require("semver"));
+const core_bentley_1 = require("@itwin/core-bentley");
 const package_json_1 = require("@itwin/core-backend/package.json");
-// must use an untyped require to not hoist src into lib/cjs, also the compiled output will be in 'lib/cjs', not 'src' so use `../..` to reach package.json
-const { version: ourVersion, name: ourName, peerDependencies,
-// eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
- } = require("../../package.json");
+const IModelTransformerError_1 = require("./IModelTransformerError");
+const TransformerPackageMetadata_1 = require("./TransformerPackageMetadata");
+const { version: ourVersion, name: ourName, peerDependencies, } = TransformerPackageMetadata_1.transformerPackageMetadata;
 const ourITwinCoreBackendDepRange = peerDependencies["@itwin/core-backend"];
 const noStrictDepCheckEnvVar = "TRANSFORMER_NO_STRICT_DEP_CHECK";
-const suggestEnvVarName = "SUGGEST_TRANSFORMER_VERSIONS";
 // warn if using a prerelease or dev version
 if (semver.prerelease(package_json_1.version)) {
     // eslint-disable-next-line no-console
@@ -46,34 +70,13 @@ if (process.env[noStrictDepCheckEnvVar] !== "1" &&
     const errHeader = `${ourName}@${ourVersion} only supports @itwin/core-backend@${ourITwinCoreBackendDepRange}, ` +
         `but @itwin/core-backend${package_json_1.version} was resolved when looking for the peer dependency.\n` +
         `If you know exactly what you are doing, you can disable this check by setting ${noStrictDepCheckEnvVar}=1 in the environment\n`;
-    if (process.env[suggestEnvVarName]) {
-        // let's not import https except in this case
-        // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
-        const https = require("https");
-        https.get(`https://registry.npmjs.org/${ourName}`, async (resp) => {
-            const chunks = [];
-            const packumentSrc = await new Promise((r) => resp
-                .setEncoding("utf8")
-                .on("data", (d) => chunks.push(d))
-                .on("end", () => r(chunks.join(""))));
-            const packumentJson = JSON.parse(packumentSrc);
-            const isTaglessVersion = (version) => version.includes("-");
-            const latestFirstApplicableVersions = Object.entries(packumentJson.versions)
-                .filter(([, v]) => semver.satisfies(package_json_1.version, v.peerDependencies?.["@itwin/core-backend"] ?? ""))
-                .map(([k]) => k)
-                .filter(isTaglessVersion)
-                .reverse();
-            throw Error([
-                errHeader,
-                `You have ${suggestEnvVarName}=1 set in the environment, so we suggest one of the following versions.`,
-                "Be aware that older versions may be missing bug fixes.",
-                ...latestFirstApplicableVersions,
-            ].join("\n"));
-        });
-    }
-    else {
-        throw Error(`${errHeader}You can rerun with the environment variable ${suggestEnvVarName}=1 to have this error suggest a version`);
-    }
+    core_bentley_1.ITwinError.throwError({
+        iTwinErrorId: {
+            scope: IModelTransformerError_1.IModelTransformerErrorScope,
+            key: IModelTransformerError_1.IModelTransformerError.DependencyVersionMismatch,
+        },
+        message: errHeader,
+    });
 }
 /** @docs-package-description
  * The @itwin/imodel-transformer package contains classes that [backend code]($docs/learning/backend/index.md) can use to
@@ -95,4 +98,28 @@ if (process.env[noStrictDepCheckEnvVar] !== "1" &&
  * @docs-group-description Logging
  * Logger categories used by this package.
  */
+/**
+ * @docs-group-description ChangedElementForest
+ * Internal indexing of changed elements and their ancestors for incremental export traversal.
+ */
+/**
+ * @docs-group-description ElementAspectExportCoordinator
+ * Internal coordination for scoped, owner-batched ElementAspect export.
+ */
+/**
+ * @docs-group-description ElementAspectExportProcessor
+ * Internal source queries, filtering, and export callbacks for ElementAspects owned by accepted elements.
+ */
+/**
+ * @docs-group-description ChangedElementForest
+ * Internal index of changed elements and their ancestors for incremental traversal.
+ */
+/**
+ * @docs-group-description IModelTransformerError
+ * Stable identifiers for errors originating from this package.
+ */
+/**
+ * @docs-group-description TransformerPackageMetadata
+ * Internal metadata describing this package and its peer dependencies.
+ */
 //# sourceMappingURL=imodel-transformer.js.map

package/lib/cjs/imodel-transformer.js.map

@@ -1 +1 @@
-{"version":3,"file":"imodel-transformer.js","sourceRoot":"","sources":["../../src/imodel-transformer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;gGAGgG;AAChG,8DAA4C;AAC5C,mDAAiC;AACjC,mDAAiC;AACjC,sDAAoC;AACpC,gEAA8C;AAE9C,iCAAiC;AACjC,mEAAsF;AAEtF,2JAA2J;AAC3J,MAAM,EACJ,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,OAAO,EACb,gBAAgB;AAChB,qGAAqG;EACtG,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAElC,MAAM,2BAA2B,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;AAE5E,MAAM,sBAAsB,GAAG,iCAAiC,CAAC;AACjE,MAAM,iBAAiB,GAAG,8BAA8B,CAAC;AAEzD,4CAA4C;AAC5C,IAAI,MAAM,CAAC,UAAU,CAAC,sBAAuB,CAAC,EAAE,CAAC;IAC/C,sCAAsC;IACtC,OAAO,CAAC,IAAI,CACV,kCAAkC,sBAAuB,KAAK;QAC5D,uFAAuF;QACvF,+FAA+F,CAClG,CAAC;AACJ,CAAC;AAED,IACE,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,KAAK,GAAG;IAC3C,CAAC,MAAM,CAAC,SAAS,CAAC,sBAAuB,EAAE,2BAA2B,EAAE;QACtE,iBAAiB,EAAE,IAAI;KACxB,CAAC,EACF,CAAC;IACD,MAAM,SAAS,GACb,GAAG,OAAO,IAAI,UAAU,sCAAsC,2BAA2B,IAAI;QAC7F,0BAA0B,sBAAuB,uDAAuD;QACxG,iFAAiF,sBAAsB,yBAAyB,CAAC;IAEnI,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACnC,6CAA6C;QAC7C,qGAAqG;QACrG,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAA2B,CAAC;QACzD,KAAK,CAAC,GAAG,CAAC,8BAA8B,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAChE,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,MAAM,YAAY,GAAG,MAAM,IAAI,OAAO,CAAS,CAAC,CAAC,EAAE,EAAE,CACnD,IAAI;iBACD,WAAW,CAAC,MAAM,CAAC;iBACnB,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;iBACjC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CACvC,CAAC;YAYF,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAoB,CAAC;YAClE,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpE,MAAM,6BAA6B,GAAG,MAAM,CAAC,OAAO,CAClD,aAAa,CAAC,QAAQ,CACvB;iBACE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAChB,MAAM,CAAC,SAAS,CACd,sBAAuB,EACvB,CAAC,CAAC,gBAAgB,EAAE,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAClD,CACF;iBACA,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;iBACf,MAAM,CAAC,gBAAgB,CAAC;iBACxB,OAAO,EAAE,CAAC;YAEb,MAAM,KAAK,CACT;gBACE,SAAS;gBACT,YAAY,iBAAiB,yEAAyE;gBACtG,wDAAwD;gBACxD,GAAG,6BAA6B;aACjC,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,MAAM,KAAK,CACT,GAAG,SAAS,+CAA+C,iBAAiB,yCAAyC,CACtH,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\nexport * from \"./TransformerLoggerCategory\";\nexport * from \"./IModelExporter\";\nexport * from \"./IModelImporter\";\nexport * from \"./IModelTransformer\";\nexport * from \"./BranchProvenanceInitializer\";\n\nimport * as semver from \"semver\";\nimport { version as iTwinCoreBackendVersion } from \"@itwin/core-backend/package.json\";\n\n// must use an untyped require to not hoist src into lib/cjs, also the compiled output will be in 'lib/cjs', not 'src' so use `../..` to reach package.json\nconst {\n  version: ourVersion,\n  name: ourName,\n  peerDependencies,\n  // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports\n} = require(\"../../package.json\");\n\nconst ourITwinCoreBackendDepRange = peerDependencies[\"@itwin/core-backend\"];\n\nconst noStrictDepCheckEnvVar = \"TRANSFORMER_NO_STRICT_DEP_CHECK\";\nconst suggestEnvVarName = \"SUGGEST_TRANSFORMER_VERSIONS\";\n\n// warn if using a prerelease or dev version\nif (semver.prerelease(iTwinCoreBackendVersion)) {\n  // eslint-disable-next-line no-console\n  console.warn(\n    `Warning: dev version detected (${iTwinCoreBackendVersion}). ` +\n      \"This version is most likely fine, but it may introduce new behavior that could cause \" +\n      \"unexpected issues or changes in the transformer's functionality. Please proceed with caution.\"\n  );\n}\n\nif (\n  process.env[noStrictDepCheckEnvVar] !== \"1\" &&\n  !semver.satisfies(iTwinCoreBackendVersion, ourITwinCoreBackendDepRange, {\n    includePrerelease: true,\n  })\n) {\n  const errHeader =\n    `${ourName}@${ourVersion} only supports @itwin/core-backend@${ourITwinCoreBackendDepRange}, ` +\n    `but @itwin/core-backend${iTwinCoreBackendVersion} was resolved when looking for the peer dependency.\\n` +\n    `If you know exactly what you are doing, you can disable this check by setting ${noStrictDepCheckEnvVar}=1 in the environment\\n`;\n\n  if (process.env[suggestEnvVarName]) {\n    // let's not import https except in this case\n    // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports\n    const https = require(\"https\") as typeof import(\"https\");\n    https.get(`https://registry.npmjs.org/${ourName}`, async (resp) => {\n      const chunks: string[] = [];\n      const packumentSrc = await new Promise<string>((r) =>\n        resp\n          .setEncoding(\"utf8\")\n          .on(\"data\", (d) => chunks.push(d))\n          .on(\"end\", () => r(chunks.join(\"\")))\n      );\n      interface PackumentSubset {\n        versions: Record<\n          string,\n          {\n            peerDependencies?: {\n              \"@itwin/core-backend\": string; // eslint-disable-line @typescript-eslint/naming-convention\n            };\n          }\n        >;\n      }\n\n      const packumentJson = JSON.parse(packumentSrc) as PackumentSubset;\n      const isTaglessVersion = (version: string) => version.includes(\"-\");\n      const latestFirstApplicableVersions = Object.entries(\n        packumentJson.versions\n      )\n        .filter(([, v]) =>\n          semver.satisfies(\n            iTwinCoreBackendVersion,\n            v.peerDependencies?.[\"@itwin/core-backend\"] ?? \"\"\n          )\n        )\n        .map(([k]) => k)\n        .filter(isTaglessVersion)\n        .reverse();\n\n      throw Error(\n        [\n          errHeader,\n          `You have ${suggestEnvVarName}=1 set in the environment, so we suggest one of the following versions.`,\n          \"Be aware that older versions may be missing bug fixes.\",\n          ...latestFirstApplicableVersions,\n        ].join(\"\\n\")\n      );\n    });\n  } else {\n    throw Error(\n      `${errHeader}You can rerun with the environment variable ${suggestEnvVarName}=1 to have this error suggest a version`\n    );\n  }\n}\n\n/** @docs-package-description\n * The @itwin/imodel-transformer package contains classes that [backend code]($docs/learning/backend/index.md) can use to\n * traverse iModels, as well as *transform* an iModel into another existing or empty one, by exporting elements from one during\n * traversal and importing them into another.\n *\n * You can read further in [iModelTransformation and Data Exchange]($docs/learning/transformer/index.md) here.\n */\n/**\n * @docs-group-description iModels\n * Classes for working with [iModels]($docs/learning/iModels.md).\n * See [the learning article]($docs/learning/backend/index.md).\n */\n/**\n * @docs-group-description Utils\n * Miscellaneous utility classes.\n */\n/**\n * @docs-group-description Logging\n * Logger categories used by this package.\n */\n"]}
+{"version":3,"file":"imodel-transformer.js","sourceRoot":"","sources":["../../src/imodel-transformer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;gGAGgG;AAChG,8DAA4C;AAC5C,mDAAiC;AACjC,mDAAiC;AACjC,sDAAoC;AACpC,2DAAyC;AACzC,+EAA6D;AAC7D,2DAAyC;AACzC,gEAA8C;AAW9C,MAAY,MAAM,mCAAe;AACjC,sDAAiD;AACjD,mEAAsF;AACtF,qEAGkC;AAClC,6EAA0E;AAE1E,MAAM,EACJ,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,OAAO,EACb,gBAAgB,GACjB,GAAG,uDAA0B,CAAC;AAE/B,MAAM,2BAA2B,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;AAE5E,MAAM,sBAAsB,GAAG,iCAAiC,CAAC;AAEjE,4CAA4C;AAC5C,IAAI,MAAM,CAAC,UAAU,CAAC,sBAAuB,CAAC,EAAE,CAAC;IAC/C,sCAAsC;IACtC,OAAO,CAAC,IAAI,CACV,kCAAkC,sBAAuB,KAAK;QAC5D,uFAAuF;QACvF,+FAA+F,CAClG,CAAC;AACJ,CAAC;AAED,IACE,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,KAAK,GAAG;IAC3C,CAAC,MAAM,CAAC,SAAS,CAAC,sBAAuB,EAAE,2BAA2B,EAAE;QACtE,iBAAiB,EAAE,IAAI;KACxB,CAAC,EACF,CAAC;IACD,MAAM,SAAS,GACb,GAAG,OAAO,IAAI,UAAU,sCAAsC,2BAA2B,IAAI;QAC7F,0BAA0B,sBAAuB,uDAAuD;QACxG,iFAAiF,sBAAsB,yBAAyB,CAAC;IAEnI,yBAAU,CAAC,UAAU,CAAC;QACpB,YAAY,EAAE;YACZ,KAAK,EAAE,oDAA2B;YAClC,GAAG,EAAE,+CAAsB,CAAC,yBAAyB;SACtD;QACD,OAAO,EAAE,SAAS;KACnB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\nexport * from \"./TransformerLoggerCategory\";\nexport * from \"./IModelExporter\";\nexport * from \"./IModelImporter\";\nexport * from \"./IModelTransformer\";\nexport * from \"./IModelTransformContext\";\nexport * from \"./schema-processing/SchemaProcessingStrategy\";\nexport * from \"./IModelTransformerError\";\nexport * from \"./BranchProvenanceInitializer\";\nexport type {\n  CollectedChanges,\n  DeletionBatch,\n  DeletionRecordBase,\n  ElementDeletionRecord,\n  ExternalSourceAspectDeletionRecord,\n  ModelDeletionRecord,\n  RelationshipDeletionRecord,\n} from \"./ChangesetScanner\";\n\nimport * as semver from \"semver\";\nimport { ITwinError } from \"@itwin/core-bentley\";\nimport { version as iTwinCoreBackendVersion } from \"@itwin/core-backend/package.json\";\nimport {\n  IModelTransformerError,\n  IModelTransformerErrorScope,\n} from \"./IModelTransformerError\";\nimport { transformerPackageMetadata } from \"./TransformerPackageMetadata\";\n\nconst {\n  version: ourVersion,\n  name: ourName,\n  peerDependencies,\n} = transformerPackageMetadata;\n\nconst ourITwinCoreBackendDepRange = peerDependencies[\"@itwin/core-backend\"];\n\nconst noStrictDepCheckEnvVar = \"TRANSFORMER_NO_STRICT_DEP_CHECK\";\n\n// warn if using a prerelease or dev version\nif (semver.prerelease(iTwinCoreBackendVersion)) {\n  // eslint-disable-next-line no-console\n  console.warn(\n    `Warning: dev version detected (${iTwinCoreBackendVersion}). ` +\n      \"This version is most likely fine, but it may introduce new behavior that could cause \" +\n      \"unexpected issues or changes in the transformer's functionality. Please proceed with caution.\"\n  );\n}\n\nif (\n  process.env[noStrictDepCheckEnvVar] !== \"1\" &&\n  !semver.satisfies(iTwinCoreBackendVersion, ourITwinCoreBackendDepRange, {\n    includePrerelease: true,\n  })\n) {\n  const errHeader =\n    `${ourName}@${ourVersion} only supports @itwin/core-backend@${ourITwinCoreBackendDepRange}, ` +\n    `but @itwin/core-backend${iTwinCoreBackendVersion} was resolved when looking for the peer dependency.\\n` +\n    `If you know exactly what you are doing, you can disable this check by setting ${noStrictDepCheckEnvVar}=1 in the environment\\n`;\n\n  ITwinError.throwError({\n    iTwinErrorId: {\n      scope: IModelTransformerErrorScope,\n      key: IModelTransformerError.DependencyVersionMismatch,\n    },\n    message: errHeader,\n  });\n}\n\n/** @docs-package-description\n * The @itwin/imodel-transformer package contains classes that [backend code]($docs/learning/backend/index.md) can use to\n * traverse iModels, as well as *transform* an iModel into another existing or empty one, by exporting elements from one during\n * traversal and importing them into another.\n *\n * You can read further in [iModelTransformation and Data Exchange]($docs/learning/transformer/index.md) here.\n */\n/**\n * @docs-group-description iModels\n * Classes for working with [iModels]($docs/learning/iModels.md).\n * See [the learning article]($docs/learning/backend/index.md).\n */\n/**\n * @docs-group-description Utils\n * Miscellaneous utility classes.\n */\n/**\n * @docs-group-description Logging\n * Logger categories used by this package.\n */\n/**\n * @docs-group-description ChangedElementForest\n * Internal indexing of changed elements and their ancestors for incremental export traversal.\n */\n/**\n * @docs-group-description ElementAspectExportCoordinator\n * Internal coordination for scoped, owner-batched ElementAspect export.\n */\n/**\n * @docs-group-description ElementAspectExportProcessor\n * Internal source queries, filtering, and export callbacks for ElementAspects owned by accepted elements.\n */\n/**\n * @docs-group-description ChangedElementForest\n * Internal index of changed elements and their ancestors for incremental traversal.\n */\n/**\n * @docs-group-description IModelTransformerError\n * Stable identifiers for errors originating from this package.\n */\n/**\n * @docs-group-description TransformerPackageMetadata\n * Internal metadata describing this package and its peer dependencies.\n */\n"]}

package/lib/cjs/schema-processing/DynamicSchemaUnionStrategy.d.ts

@@ -0,0 +1,29 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { SchemaDifferenceResult } from "@itwin/ecschema-editing";
+import { Schema } from "@itwin/ecschema-metadata";
+import { SchemaProcessingContext, SchemaProcessingResult, SchemaProcessingStrategy } from "./SchemaProcessingStrategy";
+/**
+ * Processes ordinary schemas with newer-version selection and unions compatible
+ * differences for existing dynamic schemas. Dynamic schema root read and write
+ * versions must match; only the minor version may differ.
+ * @beta
+ */
+export declare class DynamicSchemaUnionStrategy implements SchemaProcessingStrategy {
+    /**
+     * Transform schema differences before conflict validation and merging.
+     * A subclass that changes the differencing result is responsible for ensuring
+     * that its changes are safe for the source and target schemas.
+     * @param sourceSchema The source schema being processed.
+     * @param targetSchema The existing target schema.
+     * @param differences The complete result from [[getSchemaDifferences]].
+     * @returns The differencing result to validate and merge.
+     * @beta
+     */
+    protected onSchemaDifferences(_sourceSchema: Schema, _targetSchema: Schema, differences: SchemaDifferenceResult): Promise<SchemaDifferenceResult>;
+    /** Select ordinary schemas and union compatible dynamic schema differences. */
+    processSchemas(context: SchemaProcessingContext): Promise<SchemaProcessingResult[]>;
+    private createPlan;
+}
+//# sourceMappingURL=DynamicSchemaUnionStrategy.d.ts.map

package/lib/cjs/schema-processing/DynamicSchemaUnionStrategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicSchemaUnionStrategy.d.ts","sourceRoot":"","sources":["../../../src/schema-processing/DynamicSchemaUnionStrategy.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAKL,sBAAsB,EAEvB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAEL,MAAM,EAGP,MAAM,0BAA0B,CAAC;AAKlC,OAAO,EAEL,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AAsBpC;;;;;GAKG;AACH,qBAAa,0BAA2B,YAAW,wBAAwB;IACzE;;;;;;;;;OASG;IACH,UAAgB,mBAAmB,CACjC,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,sBAAsB,GAClC,OAAO,CAAC,sBAAsB,CAAC,CAEjC;IAED,+EAA+E;IAClE,cAAc,CACzB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,sBAAsB,EAAE,CAAC,CA2EnC;YAEa,UAAU;CAwDzB"}

package/lib/cjs/schema-processing/DynamicSchemaUnionStrategy.js

@@ -0,0 +1,212 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicSchemaUnionStrategy = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const ecschema_editing_1 = require("@itwin/ecschema-editing");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const IModelTransformerError_1 = require("../IModelTransformerError");
+/**
+ * Processes ordinary schemas with newer-version selection and unions compatible
+ * differences for existing dynamic schemas. Dynamic schema root read and write
+ * versions must match; only the minor version may differ.
+ * @beta
+ */
+class DynamicSchemaUnionStrategy {
+    /**
+     * Transform schema differences before conflict validation and merging.
+     * A subclass that changes the differencing result is responsible for ensuring
+     * that its changes are safe for the source and target schemas.
+     * @param sourceSchema The source schema being processed.
+     * @param targetSchema The existing target schema.
+     * @param differences The complete result from [[getSchemaDifferences]].
+     * @returns The differencing result to validate and merge.
+     * @beta
+     */
+    async onSchemaDifferences(_sourceSchema, _targetSchema, differences) {
+        return differences;
+    }
+    /** Select ordinary schemas and union compatible dynamic schema differences. */
+    async processSchemas(context) {
+        const plans = [];
+        const conflicts = [];
+        for (const sourceSchema of context.sourceSchemas) {
+            try {
+                plans.push(await this.createPlan(sourceSchema, context.targetSchemas));
+            }
+            catch (error) {
+                if (core_bentley_1.ITwinError.isError(error, IModelTransformerError_1.IModelTransformerErrorScope, IModelTransformerError_1.IModelTransformerError.SchemaConflict)) {
+                    conflicts.push(error);
+                    continue;
+                }
+                throw error;
+            }
+        }
+        throwSchemaConflicts(conflicts);
+        const schemaEditingContext = new ecschema_metadata_1.SchemaContext();
+        const schemaCandidates = new Map();
+        for (const plan of plans) {
+            if (plan.kind === "dynamic-merge") {
+                collectSchemaCandidates(plan.target, schemaCandidates, true);
+                collectSchemaReferences(plan.source, schemaCandidates);
+            }
+            else if (plan.kind === "dynamic-noop") {
+                collectSchemaCandidates(plan.source, schemaCandidates, false);
+                collectSchemaReferences(plan.source, schemaCandidates);
+            }
+        }
+        for (const { schema } of schemaCandidates.values()) {
+            await schemaEditingContext.addSchema(schema);
+        }
+        const schemaMerger = new ecschema_editing_1.SchemaMerger(schemaEditingContext);
+        const results = [];
+        for (const plan of plans) {
+            switch (plan.kind) {
+                case "new":
+                    if (plan.source.isDynamic ||
+                        (await context.shouldExportSchema(plan.source.schemaKey))) {
+                        results.push({ kind: "source", schema: plan.source });
+                    }
+                    break;
+                case "ordinary":
+                    if (await context.shouldExportSchema(plan.source.schemaKey)) {
+                        results.push({ kind: "source", schema: plan.source });
+                    }
+                    break;
+                case "dynamic-noop":
+                    break;
+                case "dynamic-merge": {
+                    const mergedSchema = await schemaMerger.merge({
+                        ...plan.differences,
+                        conflicts: undefined,
+                    });
+                    const sourceVersion = plan.source.schemaKey.version;
+                    mergedSchema.setVersion(sourceVersion.read, sourceVersion.write, incrementMinorVersion(sourceVersion, plan.target.schemaKey.version));
+                    results.push({ kind: "generated", schema: mergedSchema });
+                    break;
+                }
+            }
+        }
+        appendRequiredNoOpSchemas(results, plans);
+        return results;
+    }
+    async createPlan(source, targetSchemas) {
+        const target = await targetSchemas.getSchema(source.name);
+        if (target === undefined)
+            return { kind: "new", source };
+        if (source.isDynamic !== target.isDynamic) {
+            throw createSchemaConflictError(source, "Schema DynamicSchema marker changed", new Error("The source and target DynamicSchema markers differ."));
+        }
+        if (!source.isDynamic)
+            return { kind: "ordinary", source, target };
+        const sourceVersion = source.schemaKey.version;
+        const targetVersion = target.schemaKey.version;
+        if (sourceVersion.read !== targetVersion.read ||
+            sourceVersion.write !== targetVersion.write) {
+            throw createSchemaConflictError(source, "Dynamic schema has incompatible root versions", new Error(`source ${sourceVersion.toString(false)}, target ${targetVersion.toString(false)}`));
+        }
+        const differences = await this.onSchemaDifferences(source, target, await (0, ecschema_editing_1.getSchemaDifferences)(target, source));
+        const unresolvedConflicts = (differences.conflicts ?? []).filter((conflict) => !isCompatibleReferenceVersionConflict(conflict));
+        if (unresolvedConflicts.length > 0) {
+            throw createSchemaConflictError(source, "Schema conflict", new ecschema_editing_1.SchemaConflictsError(`Schema '${source.name}' has unresolved conflicts`, unresolvedConflicts, source.schemaKey, target.schemaKey));
+        }
+        return differences.differences.length === 0
+            ? { kind: "dynamic-noop", source, target }
+            : { kind: "dynamic-merge", source, target, differences };
+    }
+}
+exports.DynamicSchemaUnionStrategy = DynamicSchemaUnionStrategy;
+function createSchemaConflictError(schema, operation, cause) {
+    return core_bentley_1.ITwinError.create({
+        message: `${operation} for '${schema.schemaKey.toString(false)}': ${cause.message}`,
+        iTwinErrorId: {
+            scope: IModelTransformerError_1.IModelTransformerErrorScope,
+            key: IModelTransformerError_1.IModelTransformerError.SchemaConflict,
+        },
+        cause,
+        schemaKey: schema.schemaKey.toString(false),
+    });
+}
+function throwSchemaConflicts(conflicts) {
+    if (conflicts.length === 1)
+        throw conflicts[0];
+    if (conflicts.length > 1)
+        throw new AggregateError(conflicts, "Schema processing failed");
+}
+function appendRequiredNoOpSchemas(results, plans) {
+    const noOpSchemas = new Map(plans
+        .filter((plan) => plan.kind === "dynamic-noop")
+        .map((plan) => [plan.source.name.toLowerCase(), plan.source]));
+    const requiredNoOpSchemas = new Set();
+    const schemasToVisit = results.map((result) => result.schema);
+    for (const schema of schemasToVisit) {
+        for (const reference of schema.references) {
+            const schemaName = reference.name.toLowerCase();
+            const noOpSchema = noOpSchemas.get(schemaName);
+            if (noOpSchema === undefined || requiredNoOpSchemas.has(schemaName))
+                continue;
+            requiredNoOpSchemas.add(schemaName);
+            schemasToVisit.push(noOpSchema);
+        }
+    }
+    for (const schemaName of requiredNoOpSchemas) {
+        const schema = noOpSchemas.get(schemaName);
+        if (schema !== undefined)
+            results.push({ kind: "source", schema });
+    }
+}
+function incrementMinorVersion(sourceVersion, targetVersion) {
+    const maximumVersion = sourceVersion.compare(targetVersion) >= 0 ? sourceVersion : targetVersion;
+    if (maximumVersion.minor >= 9_999_999) {
+        throw new Error(`Cannot increment schema version ${maximumVersion.toString(false)}`);
+    }
+    return maximumVersion.minor + 1;
+}
+function isCompatibleReferenceVersionConflict(conflict) {
+    if (conflict.code !== ecschema_editing_1.ConflictCode.ConflictingReferenceVersion)
+        return false;
+    if (typeof conflict.source !== "string" ||
+        typeof conflict.target !== "string")
+        return false;
+    const sourceVersion = ecschema_metadata_1.SchemaKey.parseString(conflict.source).version;
+    const targetVersion = ecschema_metadata_1.SchemaKey.parseString(conflict.target).version;
+    return (sourceVersion.read === targetVersion.read &&
+        sourceVersion.write === targetVersion.write);
+}
+function collectSchemaCandidates(schema, candidates, isTargetRoot, visited = new Set()) {
+    const traversalKey = schema.schemaKey.toString();
+    if (visited.has(traversalKey))
+        return;
+    visited.add(traversalKey);
+    const schemaName = schema.name.toLowerCase();
+    const existing = candidates.get(schemaName);
+    if (existing === undefined) {
+        candidates.set(schemaName, { schema, isTargetRoot });
+    }
+    else if (existing.schema.schemaKey.version.read !== schema.schemaKey.version.read ||
+        existing.schema.schemaKey.version.write !== schema.schemaKey.version.write) {
+        throw createSchemaConflictError(schema, "Schema reference has incompatible read/write versions", new Error(`${existing.schema.schemaKey.version.read}.${existing.schema.schemaKey.version.write} ` +
+            `and ${schema.schemaKey.version.read}.${schema.schemaKey.version.write} differ. ` +
+            "Only minor-version reference differences are supported."));
+    }
+    else if (isTargetRoot ||
+        (!existing.isTargetRoot &&
+            schema.schemaKey.version.compare(existing.schema.schemaKey.version) > 0)) {
+        candidates.set(schemaName, { schema, isTargetRoot });
+    }
+    for (const reference of schema.references) {
+        collectSchemaCandidates(reference, candidates, false, visited);
+    }
+}
+function collectSchemaReferences(schema, candidates) {
+    for (const reference of schema.references) {
+        collectSchemaCandidates(reference, candidates, false);
+    }
+}
+//# sourceMappingURL=DynamicSchemaUnionStrategy.js.map

package/lib/cjs/schema-processing/DynamicSchemaUnionStrategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicSchemaUnionStrategy.js","sourceRoot":"","sources":["../../../src/schema-processing/DynamicSchemaUnionStrategy.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,sDAAiD;AACjD,8DAOiC;AACjC,gEAKkC;AAClC,sEAGmC;AA4BnC;;;;;GAKG;AACH;IACE;;;;;;;;;OASG;IACO,KAAK,CAAC,mBAAmB,CACjC,aAAqB,EACrB,aAAqB,EACrB,WAAmC;QAEnC,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,+EAA+E;IACxE,KAAK,CAAC,cAAc,CACzB,OAAgC;QAEhC,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,MAAM,SAAS,GAAY,EAAE,CAAC;QAC9B,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YACjD,IAAI,CAAC;gBACH,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;YACzE,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACxB,IACE,yBAAU,CAAC,OAAO,CAChB,KAAK,EACL,oDAA2B,EAC3B,+CAAsB,CAAC,cAAc,CACtC,EACD,CAAC;oBACD,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACtB,SAAS;gBACX,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QACD,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAEhC,MAAM,oBAAoB,GAAG,IAAI,iCAAa,EAAE,CAAC;QACjD,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA2B,CAAC;QAC5D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;gBAClC,uBAAuB,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;gBAC7D,uBAAuB,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YACzD,CAAC;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;gBACxC,uBAAuB,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC;gBAC9D,uBAAuB,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QACD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC;YACnD,MAAM,oBAAoB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,+BAAY,CAAC,oBAAoB,CAAC,CAAC;QAC5D,MAAM,OAAO,GAA6B,EAAE,CAAC;QAC7C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,KAAK;oBACR,IACE,IAAI,CAAC,MAAM,CAAC,SAAS;wBACrB,CAAC,MAAM,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EACzD,CAAC;wBACD,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;oBACxD,CAAC;oBACD,MAAM;gBACR,KAAK,UAAU;oBACb,IAAI,MAAM,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC5D,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;oBACxD,CAAC;oBACD,MAAM;gBACR,KAAK,cAAc;oBACjB,MAAM;gBACR,KAAK,eAAe,EAAE,CAAC;oBACrB,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC;wBAC5C,GAAG,IAAI,CAAC,WAAW;wBACnB,SAAS,EAAE,SAAS;qBACrB,CAAC,CAAC;oBACH,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;oBACpD,YAAY,CAAC,UAAU,CACrB,aAAa,CAAC,IAAI,EAClB,aAAa,CAAC,KAAK,EACnB,qBAAqB,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CACpE,CAAC;oBACF,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;oBAC1D,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,yBAAyB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,MAAc,EACd,aAAqC;QAErC,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAEzD,IAAI,MAAM,CAAC,SAAS,KAAK,MAAM,CAAC,SAAS,EAAE,CAAC;YAC1C,MAAM,yBAAyB,CAC7B,MAAM,EACN,qCAAqC,EACrC,IAAI,KAAK,CAAC,qDAAqD,CAAC,CACjE,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,SAAS;YAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAEnE,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;QAC/C,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;QAC/C,IACE,aAAa,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI;YACzC,aAAa,CAAC,KAAK,KAAK,aAAa,CAAC,KAAK,EAC3C,CAAC;YACD,MAAM,yBAAyB,CAC7B,MAAM,EACN,+CAA+C,EAC/C,IAAI,KAAK,CACP,UAAU,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CACnF,CACF,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAChD,MAAM,EACN,MAAM,EACN,MAAM,IAAA,uCAAoB,EAAC,MAAM,EAAE,MAAM,CAAC,CAC3C,CAAC;QACF,MAAM,mBAAmB,GAAG,CAAC,WAAW,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAC9D,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,oCAAoC,CAAC,QAAQ,CAAC,CAC9D,CAAC;QACF,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,yBAAyB,CAC7B,MAAM,EACN,iBAAiB,EACjB,IAAI,uCAAoB,CACtB,WAAW,MAAM,CAAC,IAAI,4BAA4B,EAClD,mBAAmB,EACnB,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC;YACzC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE;YAC1C,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;IAC7D,CAAC;CACF;;AAED,SAAS,yBAAyB,CAChC,MAAc,EACd,SAAiB,EACjB,KAAY;IAEZ,OAAO,yBAAU,CAAC,MAAM,CAAsB;QAC5C,OAAO,EAAE,GAAG,SAAS,SAAS,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE;QACnF,YAAY,EAAE;YACZ,KAAK,EAAE,oDAA2B;YAClC,GAAG,EAAE,+CAAsB,CAAC,cAAc;SAC3C;QACD,KAAK;QACL,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;KAC5C,CAAC,CAAC;AACL,CAAC;AAED,SAAS,oBAAoB,CAAC,SAAkB;IAC9C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;IAC/C,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;QACtB,MAAM,IAAI,cAAc,CAAC,SAAS,EAAE,0BAA0B,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,yBAAyB,CAChC,OAAiC,EACjC,KAAmB;IAEnB,MAAM,WAAW,GAAG,IAAI,GAAG,CACzB,KAAK;SACF,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC;SAC9C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAChE,CAAC;IACF,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9C,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9D,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE,CAAC;QACpC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAChD,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC/C,IAAI,UAAU,KAAK,SAAS,IAAI,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC;gBACjE,SAAS;YAEX,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACpC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAC5B,aAAwB,EACxB,aAAwB;IAExB,MAAM,cAAc,GAClB,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC;IAC5E,IAAI,cAAc,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,mCAAmC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CACpE,CAAC;IACJ,CAAC;IACD,OAAO,cAAc,CAAC,KAAK,GAAG,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,oCAAoC,CAC3C,QAAqC;IAErC,IAAI,QAAQ,CAAC,IAAI,KAAK,+BAAY,CAAC,2BAA2B;QAAE,OAAO,KAAK,CAAC;IAC7E,IACE,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ;QACnC,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ;QAEnC,OAAO,KAAK,CAAC;IAEf,MAAM,aAAa,GAAG,6BAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;IACrE,MAAM,aAAa,GAAG,6BAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;IACrE,OAAO,CACL,aAAa,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI;QACzC,aAAa,CAAC,KAAK,KAAK,aAAa,CAAC,KAAK,CAC5C,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAC9B,MAAc,EACd,UAAwC,EACxC,YAAqB,EACrB,OAAO,GAAgB,IAAI,GAAG,EAAU;IAExC,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;IACjD,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;QAAE,OAAO;IACtC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAE1B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAC7C,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC5C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IACvD,CAAC;SAAM,IACL,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI;QACxE,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,KAAK,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAC1E,CAAC;QACD,MAAM,yBAAyB,CAC7B,MAAM,EACN,uDAAuD,EACvD,IAAI,KAAK,CACP,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,GAAG;YACrF,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,WAAW;YACjF,yDAAyD,CAC5D,CACF,CAAC;IACJ,CAAC;SAAM,IACL,YAAY;QACZ,CAAC,CAAC,QAAQ,CAAC,YAAY;YACrB,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAC1E,CAAC;QACD,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QAC1C,uBAAuB,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAC9B,MAAc,EACd,UAAwC;IAExC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QAC1C,uBAAuB,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;AACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { ITwinError } from \"@itwin/core-bentley\";\nimport {\n  AnySchemaDifferenceConflict,\n  ConflictCode,\n  getSchemaDifferences,\n  SchemaConflictsError,\n  SchemaDifferenceResult,\n  SchemaMerger,\n} from \"@itwin/ecschema-editing\";\nimport {\n  ECVersion,\n  Schema,\n  SchemaContext,\n  SchemaKey,\n} from \"@itwin/ecschema-metadata\";\nimport {\n  IModelTransformerError,\n  IModelTransformerErrorScope,\n} from \"../IModelTransformerError\";\nimport {\n  ReadonlySchemaAccessor,\n  SchemaProcessingContext,\n  SchemaProcessingResult,\n  SchemaProcessingStrategy,\n} from \"./SchemaProcessingStrategy\";\n\ntype SchemaPlan =\n  | { kind: \"new\"; source: Schema }\n  | { kind: \"ordinary\"; source: Schema; target: Schema }\n  | { kind: \"dynamic-noop\"; source: Schema; target: Schema }\n  | {\n      kind: \"dynamic-merge\";\n      source: Schema;\n      target: Schema;\n      differences: SchemaDifferenceResult;\n    };\n\ninterface SchemaCandidate {\n  schema: Schema;\n  isTargetRoot: boolean;\n}\n\ninterface SchemaConflictError extends ITwinError {\n  schemaKey: string;\n}\n\n/**\n * Processes ordinary schemas with newer-version selection and unions compatible\n * differences for existing dynamic schemas. Dynamic schema root read and write\n * versions must match; only the minor version may differ.\n * @beta\n */\nexport class DynamicSchemaUnionStrategy implements SchemaProcessingStrategy {\n  /**\n   * Transform schema differences before conflict validation and merging.\n   * A subclass that changes the differencing result is responsible for ensuring\n   * that its changes are safe for the source and target schemas.\n   * @param sourceSchema The source schema being processed.\n   * @param targetSchema The existing target schema.\n   * @param differences The complete result from [[getSchemaDifferences]].\n   * @returns The differencing result to validate and merge.\n   * @beta\n   */\n  protected async onSchemaDifferences(\n    _sourceSchema: Schema,\n    _targetSchema: Schema,\n    differences: SchemaDifferenceResult\n  ): Promise<SchemaDifferenceResult> {\n    return differences;\n  }\n\n  /** Select ordinary schemas and union compatible dynamic schema differences. */\n  public async processSchemas(\n    context: SchemaProcessingContext\n  ): Promise<SchemaProcessingResult[]> {\n    const plans: SchemaPlan[] = [];\n    const conflicts: Error[] = [];\n    for (const sourceSchema of context.sourceSchemas) {\n      try {\n        plans.push(await this.createPlan(sourceSchema, context.targetSchemas));\n      } catch (error: unknown) {\n        if (\n          ITwinError.isError(\n            error,\n            IModelTransformerErrorScope,\n            IModelTransformerError.SchemaConflict\n          )\n        ) {\n          conflicts.push(error);\n          continue;\n        }\n        throw error;\n      }\n    }\n    throwSchemaConflicts(conflicts);\n\n    const schemaEditingContext = new SchemaContext();\n    const schemaCandidates = new Map<string, SchemaCandidate>();\n    for (const plan of plans) {\n      if (plan.kind === \"dynamic-merge\") {\n        collectSchemaCandidates(plan.target, schemaCandidates, true);\n        collectSchemaReferences(plan.source, schemaCandidates);\n      } else if (plan.kind === \"dynamic-noop\") {\n        collectSchemaCandidates(plan.source, schemaCandidates, false);\n        collectSchemaReferences(plan.source, schemaCandidates);\n      }\n    }\n    for (const { schema } of schemaCandidates.values()) {\n      await schemaEditingContext.addSchema(schema);\n    }\n\n    const schemaMerger = new SchemaMerger(schemaEditingContext);\n    const results: SchemaProcessingResult[] = [];\n    for (const plan of plans) {\n      switch (plan.kind) {\n        case \"new\":\n          if (\n            plan.source.isDynamic ||\n            (await context.shouldExportSchema(plan.source.schemaKey))\n          ) {\n            results.push({ kind: \"source\", schema: plan.source });\n          }\n          break;\n        case \"ordinary\":\n          if (await context.shouldExportSchema(plan.source.schemaKey)) {\n            results.push({ kind: \"source\", schema: plan.source });\n          }\n          break;\n        case \"dynamic-noop\":\n          break;\n        case \"dynamic-merge\": {\n          const mergedSchema = await schemaMerger.merge({\n            ...plan.differences,\n            conflicts: undefined,\n          });\n          const sourceVersion = plan.source.schemaKey.version;\n          mergedSchema.setVersion(\n            sourceVersion.read,\n            sourceVersion.write,\n            incrementMinorVersion(sourceVersion, plan.target.schemaKey.version)\n          );\n          results.push({ kind: \"generated\", schema: mergedSchema });\n          break;\n        }\n      }\n    }\n\n    appendRequiredNoOpSchemas(results, plans);\n    return results;\n  }\n\n  private async createPlan(\n    source: Schema,\n    targetSchemas: ReadonlySchemaAccessor\n  ): Promise<SchemaPlan> {\n    const target = await targetSchemas.getSchema(source.name);\n    if (target === undefined) return { kind: \"new\", source };\n\n    if (source.isDynamic !== target.isDynamic) {\n      throw createSchemaConflictError(\n        source,\n        \"Schema DynamicSchema marker changed\",\n        new Error(\"The source and target DynamicSchema markers differ.\")\n      );\n    }\n    if (!source.isDynamic) return { kind: \"ordinary\", source, target };\n\n    const sourceVersion = source.schemaKey.version;\n    const targetVersion = target.schemaKey.version;\n    if (\n      sourceVersion.read !== targetVersion.read ||\n      sourceVersion.write !== targetVersion.write\n    ) {\n      throw createSchemaConflictError(\n        source,\n        \"Dynamic schema has incompatible root versions\",\n        new Error(\n          `source ${sourceVersion.toString(false)}, target ${targetVersion.toString(false)}`\n        )\n      );\n    }\n\n    const differences = await this.onSchemaDifferences(\n      source,\n      target,\n      await getSchemaDifferences(target, source)\n    );\n    const unresolvedConflicts = (differences.conflicts ?? []).filter(\n      (conflict) => !isCompatibleReferenceVersionConflict(conflict)\n    );\n    if (unresolvedConflicts.length > 0) {\n      throw createSchemaConflictError(\n        source,\n        \"Schema conflict\",\n        new SchemaConflictsError(\n          `Schema '${source.name}' has unresolved conflicts`,\n          unresolvedConflicts,\n          source.schemaKey,\n          target.schemaKey\n        )\n      );\n    }\n\n    return differences.differences.length === 0\n      ? { kind: \"dynamic-noop\", source, target }\n      : { kind: \"dynamic-merge\", source, target, differences };\n  }\n}\n\nfunction createSchemaConflictError(\n  schema: Schema,\n  operation: string,\n  cause: Error\n): Error {\n  return ITwinError.create<SchemaConflictError>({\n    message: `${operation} for '${schema.schemaKey.toString(false)}': ${cause.message}`,\n    iTwinErrorId: {\n      scope: IModelTransformerErrorScope,\n      key: IModelTransformerError.SchemaConflict,\n    },\n    cause,\n    schemaKey: schema.schemaKey.toString(false),\n  });\n}\n\nfunction throwSchemaConflicts(conflicts: Error[]): void {\n  if (conflicts.length === 1) throw conflicts[0];\n  if (conflicts.length > 1)\n    throw new AggregateError(conflicts, \"Schema processing failed\");\n}\n\nfunction appendRequiredNoOpSchemas(\n  results: SchemaProcessingResult[],\n  plans: SchemaPlan[]\n): void {\n  const noOpSchemas = new Map(\n    plans\n      .filter((plan) => plan.kind === \"dynamic-noop\")\n      .map((plan) => [plan.source.name.toLowerCase(), plan.source])\n  );\n  const requiredNoOpSchemas = new Set<string>();\n  const schemasToVisit = results.map((result) => result.schema);\n  for (const schema of schemasToVisit) {\n    for (const reference of schema.references) {\n      const schemaName = reference.name.toLowerCase();\n      const noOpSchema = noOpSchemas.get(schemaName);\n      if (noOpSchema === undefined || requiredNoOpSchemas.has(schemaName))\n        continue;\n\n      requiredNoOpSchemas.add(schemaName);\n      schemasToVisit.push(noOpSchema);\n    }\n  }\n  for (const schemaName of requiredNoOpSchemas) {\n    const schema = noOpSchemas.get(schemaName);\n    if (schema !== undefined) results.push({ kind: \"source\", schema });\n  }\n}\n\nfunction incrementMinorVersion(\n  sourceVersion: ECVersion,\n  targetVersion: ECVersion\n): number {\n  const maximumVersion =\n    sourceVersion.compare(targetVersion) >= 0 ? sourceVersion : targetVersion;\n  if (maximumVersion.minor >= 9_999_999) {\n    throw new Error(\n      `Cannot increment schema version ${maximumVersion.toString(false)}`\n    );\n  }\n  return maximumVersion.minor + 1;\n}\n\nfunction isCompatibleReferenceVersionConflict(\n  conflict: AnySchemaDifferenceConflict\n): boolean {\n  if (conflict.code !== ConflictCode.ConflictingReferenceVersion) return false;\n  if (\n    typeof conflict.source !== \"string\" ||\n    typeof conflict.target !== \"string\"\n  )\n    return false;\n\n  const sourceVersion = SchemaKey.parseString(conflict.source).version;\n  const targetVersion = SchemaKey.parseString(conflict.target).version;\n  return (\n    sourceVersion.read === targetVersion.read &&\n    sourceVersion.write === targetVersion.write\n  );\n}\n\nfunction collectSchemaCandidates(\n  schema: Schema,\n  candidates: Map<string, SchemaCandidate>,\n  isTargetRoot: boolean,\n  visited: Set<string> = new Set<string>()\n): void {\n  const traversalKey = schema.schemaKey.toString();\n  if (visited.has(traversalKey)) return;\n  visited.add(traversalKey);\n\n  const schemaName = schema.name.toLowerCase();\n  const existing = candidates.get(schemaName);\n  if (existing === undefined) {\n    candidates.set(schemaName, { schema, isTargetRoot });\n  } else if (\n    existing.schema.schemaKey.version.read !== schema.schemaKey.version.read ||\n    existing.schema.schemaKey.version.write !== schema.schemaKey.version.write\n  ) {\n    throw createSchemaConflictError(\n      schema,\n      \"Schema reference has incompatible read/write versions\",\n      new Error(\n        `${existing.schema.schemaKey.version.read}.${existing.schema.schemaKey.version.write} ` +\n          `and ${schema.schemaKey.version.read}.${schema.schemaKey.version.write} differ. ` +\n          \"Only minor-version reference differences are supported.\"\n      )\n    );\n  } else if (\n    isTargetRoot ||\n    (!existing.isTargetRoot &&\n      schema.schemaKey.version.compare(existing.schema.schemaKey.version) > 0)\n  ) {\n    candidates.set(schemaName, { schema, isTargetRoot });\n  }\n\n  for (const reference of schema.references) {\n    collectSchemaCandidates(reference, candidates, false, visited);\n  }\n}\n\nfunction collectSchemaReferences(\n  schema: Schema,\n  candidates: Map<string, SchemaCandidate>\n): void {\n  for (const reference of schema.references) {\n    collectSchemaCandidates(reference, candidates, false);\n  }\n}\n"]}

package/lib/cjs/schema-processing/SchemaProcessingCoordinator.d.ts

@@ -0,0 +1,25 @@
+import { IModelDb } from "@itwin/core-backend";
+import { Schema, SchemaKey } from "@itwin/ecschema-metadata";
+import { ExportSchemaResult, IModelExporter } from "../IModelExporter";
+import { SchemaProcessingStrategy } from "./SchemaProcessingStrategy";
+interface SchemaProcessingCoordinatorArgs {
+    exporter: IModelExporter;
+    targetDb: IModelDb;
+    getSchemaExportDirectory: () => string;
+    shouldExportSchema: (schemaKey: SchemaKey) => Promise<boolean>;
+    serializeSourceSchema: (schema: Schema) => Promise<void | ExportSchemaResult>;
+}
+/** @internal */
+export declare class SchemaProcessingCoordinator {
+    private readonly _args;
+    private readonly _longNamedSchemas;
+    constructor(_args: SchemaProcessingCoordinatorArgs);
+    process(strategy: SchemaProcessingStrategy): Promise<void>;
+    serializeSourceSchema(schema: Schema): Promise<ExportSchemaResult>;
+    private get _schemaExportDirectory();
+    private serializeSchema;
+    private getSchemaExportFileName;
+    private createLongNameResolvingSchemaContext;
+}
+export {};
+//# sourceMappingURL=SchemaProcessingCoordinator.d.ts.map

package/lib/cjs/schema-processing/SchemaProcessingCoordinator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaProcessingCoordinator.d.ts","sourceRoot":"","sources":["../../../src/schema-processing/SchemaProcessingCoordinator.ts"],"names":[],"mappings":"AAOA,OAAO,EAAsB,QAAQ,EAAc,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,MAAM,EAAE,SAAS,EAAgB,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAKvE,OAAO,EAGL,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AAEpC,UAAU,+BAA+B;IACvC,QAAQ,EAAE,cAAc,CAAC;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,wBAAwB,EAAE,MAAM,MAAM,CAAC;IACvC,kBAAkB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/D,qBAAqB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,GAAG,kBAAkB,CAAC,CAAC;CAC/E;AAED,gBAAgB;AAChB,qBAAa,2BAA2B;IAGnB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAFzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6B;IAE/D,YAAoC,KAAK,EAAE,+BAA+B,EAAI;IAEjE,OAAO,CAAC,QAAQ,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmEtE;IAEY,qBAAqB,CAChC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,kBAAkB,CAAC,CAU7B;IAED,OAAO,KAAK,sBAAsB,GAEjC;YAEa,eAAe;IAe7B,OAAO,CAAC,uBAAuB;IAkB/B,OAAO,CAAC,oCAAoC;CAU7C"}