@itwin/imodel-transformer 0.0.1-dev.0

package/lib/cjs/transformer.js

@@ -0,0 +1,77 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+__exportStar(require("./TransformerLoggerCategory"), exports);
+__exportStar(require("./IModelExporter"), exports);
+__exportStar(require("./IModelImporter"), exports);
+__exportStar(require("./IModelTransformer"), exports);
+const semver = require("semver");
+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
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { version: ourVersion, name: ourName, peerDependencies } = require("../../package.json");
+const ourITwinCoreBackendDepRange = peerDependencies["@itwin/core-backend"];
+if (!semver.satisfies(package_json_1.version, ourITwinCoreBackendDepRange)) {
+    const suggestEnvVarName = "SUGGEST_TRANSFORMER_VERSIONS";
+    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 (process.env[suggestEnvVarName]) {
+        // let's not import https except in this case
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        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]) => { var _a, _b; return semver.satisfies(package_json_1.version, (_b = (_a = v.peerDependencies) === null || _a === void 0 ? void 0 : _a["@itwin/core-backend"]) !== null && _b !== void 0 ? _b : ""); })
+                .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.\n`,
+                `Be aware that older versions may be missing bug fixes.\n`,
+                latestFirstApplicableVersions.join("\n"),
+            ].join(""));
+        });
+    }
+    else {
+        throw Error(`${errHeader} You can rerun with the environment variable ${suggestEnvVarName}=1 to have this error suggest a version`);
+    }
+}
+/** @docs-package-description
+ * The @itwin/imodel-transformer package contains classes that [backend code]($docs/learning/backend/index.md) can use to
+ * traverse iModels, as well as *transform* an iModel into another existing or empty one, by exporting elements from one during
+ * traversal and importing them into another.
+ *
+ * You can read further in [iModelTransformation and Data Exchange]($docs/learning/transformer/index.md) here.
+ */
+/**
+ * @docs-group-description iModels
+ * Classes for working with [iModels]($docs/learning/iModels.md).
+ * See [the learning article]($docs/learning/backend/index.md).
+ */
+/**
+ * @docs-group-description Utils
+ * Miscellaneous utility classes.
+ */
+/**
+ * @docs-group-description Logging
+ * Logger categories used by this package.
+ */
+//# sourceMappingURL=transformer.js.map

package/lib/cjs/transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformer.js","sourceRoot":"","sources":["../../src/transformer.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F,8DAA4C;AAC5C,mDAAiC;AACjC,mDAAiC;AACjC,sDAAoC;AAEpC,iCAAiC;AACjC,mEAAsF;AAEtF,2JAA2J;AAC3J,8DAA8D;AAC9D,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAE/F,MAAM,2BAA2B,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;AAE5E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,sBAAuB,EAAE,2BAA2B,CAAC,EAAE;IAC3E,MAAM,iBAAiB,GAAG,8BAA8B,CAAC;IAEzD,MAAM,SAAS,GACb,GAAG,OAAO,IAAI,UAAU,sCAAsC,2BAA2B,IAAI;UAC3F,0BAA0B,sBAAuB,uDAAuD,CAAC;IAE7G,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;QAClC,6CAA6C;QAC7C,8DAA8D;QAC9D,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,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAItJ,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,GAC/B,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC;iBACrC,MAAM,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,EAAE,EAAE,eAAC,OAAA,MAAM,CAAC,SAAS,CAAC,sBAAuB,EAAE,MAAA,MAAA,CAAC,CAAC,gBAAgB,0CAAG,qBAAqB,CAAC,mCAAI,EAAE,CAAC,CAAA,EAAA,CAAC;iBAC9G,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;iBACf,MAAM,CAAC,gBAAgB,CAAC;iBACxB,OAAO,EAAE,CAAC;YAEf,MAAM,KAAK,CAAC;gBACV,SAAS;gBACT,YAAY,iBAAiB,2EAA2E;gBACxG,0DAA0D;gBAC1D,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC;aACzC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;KACJ;SAAM;QACL,MAAM,KAAK,CACT,GAAG,SAAS,gDAAgD,iBAAiB,yCAAyC,CACvH,CAAC;KACH;CACF;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\";\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\n// eslint-disable-next-line @typescript-eslint/no-var-requires\nconst { version: ourVersion, name: ourName, peerDependencies } = require(\"../../package.json\");\n\nconst ourITwinCoreBackendDepRange = peerDependencies[\"@itwin/core-backend\"];\n\nif (!semver.satisfies(iTwinCoreBackendVersion, ourITwinCoreBackendDepRange)) {\n  const suggestEnvVarName = \"SUGGEST_TRANSFORMER_VERSIONS\";\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\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\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) => resp.setEncoding(\"utf8\").on(\"data\", (d) => chunks.push(d)).on(\"end\", () => r(chunks.join(\"\"))));\n      interface PackumentSubset {\n        versions: Record<string, { peerDependencies?: { \"@itwin/core-backend\": string } }>;\n      }\n      const packumentJson = JSON.parse(packumentSrc) as PackumentSubset;\n      const isTaglessVersion = (version: string) => version.includes(\"-\");\n      const latestFirstApplicableVersions\n        = Object.entries(packumentJson.versions)\n          .filter(([,v]) => semver.satisfies(iTwinCoreBackendVersion, v.peerDependencies?.[\"@itwin/core-backend\"] ?? \"\"))\n          .map(([k]) => k)\n          .filter(isTaglessVersion)\n          .reverse();\n\n      throw Error([\n        errHeader,\n        `You have ${suggestEnvVarName}=1 set in the environment, so we suggest one of the following versions.\\n`,\n        `Be aware that older versions may be missing bug fixes.\\n`,\n        latestFirstApplicableVersions.join(\"\\n\"),\n      ].join(\"\"));\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"]}

package/package.json

@@ -0,0 +1,120 @@
+{
+  "name": "@itwin/imodel-transformer",
+  "version": "0.0.1-dev.0",
+  "description": "API for exporting an iModel's parts and also importing them into another iModel",
+  "main": "lib/cjs/transformer.js",
+  "typings": "lib/cjs/transformer",
+  "license": "MIT",
+  "engines": {
+    "node": "^18.0.0"
+  },
+  "scripts": {
+    "build": "npm run -s build:cjs && npm run -s copy:test-assets",
+    "build:ci": "npm run -s build",
+    "build:cjs": "tsc 1>&2 --outDir lib/cjs",
+    "clean": "rimraf lib",
+    "docs": "npm run -s docs:extract && npm run -s docs:reference && npm run -s docs:changelog",
+    "docs:changelog": "cpx ./CHANGELOG.md ../../build/docs/reference/transformer",
+    "# env var is workaround, need to contribute a better rush-less root-package.json detector to betools": "",
+    "docs:reference": "cross-env RUSHSTACK_FILE_ERROR_BASE_FOLDER='../..' betools docs --includes=../../build/docs/extract --json=../../build/docs/reference/transformer/file.json --tsIndexFile=transformer.ts --onlyJson",
+    "docs:extract": "betools extract --fileExt=ts --extractFrom=./src/test --recursive --out=../../build/docs/extract",
+    "copy:test-assets": "cpx \"./src/test/assets/**/*\" ./lib/cjs/test/assets",
+    "cover": "nyc npm -s test",
+    "extract-api": "betools extract-api --entry=transformer",
+    "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
+    "lint:no-tests": "eslint -f visualstudio \"./src/*.ts\" 1>&2",
+    "lint:fix": "eslint --fix -f visualstudio \"./src/**/*.ts\" 1>&2",
+    "test": "mocha \"lib/cjs/test/**/*.test.js\" --timeout 8000 --require source-map-support/register",
+    "no-internal-report": "no-internal-report src/**/*.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iTwin/transformer.git",
+    "directory": "packages/transformer"
+  },
+  "keywords": [
+    "Bentley",
+    "BIM",
+    "iModel",
+    "digital-twin",
+    "iTwin"
+  ],
+  "author": {
+    "name": "Bentley Systems, Inc.",
+    "url": "http://www.bentley.com"
+  },
+  "//deps": [
+    "SEE file://./README.md#versioning",
+    "This package relies on @internal APIs in iTwin.js, and therefore has very strict peerDep versions",
+    "We perform a version check at runtime to ensure this.",
+    "Every new iTwin.js version must be validated, and fixes are rarely ported to old versions.",
+    "Removing Dependencies on internal APIs is ongoing.",
+    "You can find a script to see the latest @itwin/imodel-transformer version for your iTwin.js version in the README"
+  ],
+  "peerDependencies": {
+    "@itwin/core-backend": "3.6.0 - 3.6.1",
+    "@itwin/core-bentley": "3.6.0 - 3.6.1",
+    "@itwin/core-common": "3.6.0 - 3.6.1",
+    "@itwin/core-geometry": "3.6.0 - 3.6.1",
+    "@itwin/core-quantity": "3.6.0 - 3.6.1",
+    "@itwin/ecschema-metadata": "3.6.0 - 3.6.1"
+  },
+  "//devDependencies": [
+    "NOTE: All peerDependencies should also be listed as devDependencies since peerDependencies are not considered by npm install",
+    "NOTE: All tools used by scripts in this package must be listed as devDependencies"
+  ],
+  "devDependencies": {
+    "@itwin/build-tools": "3.6.0 - 3.6.1",
+    "@itwin/core-backend": "3.6.0 - 3.6.1",
+    "@itwin/core-bentley": "3.6.0 - 3.6.1",
+    "@itwin/core-common": "3.6.0 - 3.6.1",
+    "@itwin/core-geometry": "3.6.0 - 3.6.1",
+    "@itwin/core-quantity": "3.6.0 - 3.6.1",
+    "@itwin/ecschema-metadata": "3.6.0 - 3.6.1",
+    "@itwin/eslint-plugin": "3.6.0 - 3.6.1",
+    "@types/chai": "4.3.1",
+    "@types/chai-as-promised": "^7",
+    "@types/mocha": "^8.2.2",
+    "@types/node": "^18.11.5",
+    "@types/semver": "7.3.10",
+    "@types/sinon": "^9.0.0",
+    "chai": "^4.1.2",
+    "chai-as-promised": "^7",
+    "cpx2": "^3.0.0",
+    "cross-env": "^5.1.4",
+    "eslint": "^7.11.0",
+    "js-base64": "^3.7.5",
+    "mocha": "^10.0.0",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^15.1.0",
+    "rimraf": "^3.0.2",
+    "sinon": "^9.0.2",
+    "source-map-support": "^0.5.21",
+    "typescript": "~4.4.0"
+  },
+  "dependencies": {
+    "semver": "^7.3.5"
+  },
+  "nyc": {
+    "extends": "./node_modules/@itwin/build-tools/.nycrc"
+  },
+  "eslintConfig": {
+    "plugins": [
+      "@itwin"
+    ],
+    "extends": "plugin:@itwin/itwinjs-recommended",
+    "rules": {
+      "@itwin/no-internal": [
+        "warn",
+        {
+          "tag": [
+            "internal"
+          ]
+        }
+      ]
+    },
+    "parserOptions": {
+      "project": "./tsconfig.json"
+    }
+  }
+}