@itwin/ecschema-rpcinterface-tests 5.1.0-dev.64 → 5.1.0-dev.65

package/lib/dist/bundled-tests.js

@@ -27432,6 +27432,8 @@ __webpack_require__.r(__webpack_exports__);
  */
 var CommonLoggerCategory;
 (function (CommonLoggerCategory) {
+    /** The logger category used by common APIs relating to text annotations. */
+    CommonLoggerCategory["Annotations"] = "core-common.Annotations";
     /** The logger category used by common classes relating to ElementProps. */
     CommonLoggerCategory["ElementProps"] = "core-common.ElementProps";
     /** The logger category used by common classes relating to Geometry. */
@@ -43383,6 +43385,7 @@ class TextAnnotation {
 "use strict";
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   FieldRun: () => (/* binding */ FieldRun),
 /* harmony export */   FractionRun: () => (/* binding */ FractionRun),
 /* harmony export */   LineBreakRun: () => (/* binding */ LineBreakRun),
 /* harmony export */   Paragraph: () => (/* binding */ Paragraph),
@@ -43475,6 +43478,7 @@ var Run;
             case "fraction": return FractionRun.create(props);
             case "tab": return TabRun.create(props);
             case "linebreak": return LineBreakRun.create(props);
+            case "field": return FieldRun.create(props);
         }
     }
     Run.fromJSON = fromJSON;
@@ -43618,6 +43622,113 @@ class TabRun extends TextBlockComponent {
         return other instanceof TabRun && super.equals(other);
     }
 }
+/** A [[Run]] that displays the formatted value of a property of some [Element]($backend).
+ * When a [[TextBlock]] containing a [[FieldRun]] is written into the iModel as an [ITextAnnotation]($backend) element,
+ * a dependency is established between the two elements via the [ElementDrivesTextAnnotation]($backend) relationship such that
+ * whenever the source element specified by [[propertyHost]] is modified, the field(s) in the `ITextAnnotation` element are automatically
+ * recalculated, causing their [[cachedContent]] to update. If the field's display string cannot be evaluated (for example, because the specified element or
+ * property does not exist), then its cached content is set to [[FieldRun.invalidContentIndicator]].
+ * A [[FieldRun]] displays its [[cachedContent]] in the same way that [[TextRun]]s display their `content`, including word wrapping where appropriate.
+ * @beta
+ */
+class FieldRun extends TextBlockComponent {
+    /** Display string used to signal an error in computing the field's value. */
+    static invalidContentIndicator = "####";
+    /** Discriminator field for the [[Run]] union. */
+    type = "field";
+    /** The element and BIS class containing the property described by [[propertyPath]]. */
+    propertyHost;
+    /** Describes how to obtain the property value from [[propertyHost]]. */
+    propertyPath;
+    /** Specifies how to format the property value obtained from [[propertyPath]] into a string to be stored in [[cachedContent]]. */
+    formatter;
+    _cachedContent;
+    /** The field's most recently evaluated display string. */
+    get cachedContent() {
+        return this._cachedContent;
+    }
+    /** @internal Used by core-backend when re-evaluating field content. */
+    setCachedContent(content) {
+        this._cachedContent = content ?? FieldRun.invalidContentIndicator;
+    }
+    constructor(props) {
+        super(props);
+        this._cachedContent = props.cachedContent ?? FieldRun.invalidContentIndicator;
+        this.propertyHost = props.propertyHost;
+        this.propertyPath = props.propertyPath;
+        this.formatter = props.formatter;
+    }
+    /** Create a FieldRun from its JSON representation. */
+    static create(props) {
+        return new FieldRun({
+            ...props,
+            propertyHost: { ...props.propertyHost },
+            propertyPath: structuredClone(props.propertyPath),
+            formatter: structuredClone(props.formatter),
+        });
+    }
+    /** Convert the FieldRun to its JSON representation. */
+    toJSON() {
+        const json = {
+            ...super.toJSON(),
+            type: "field",
+            propertyHost: { ...this.propertyHost },
+            propertyPath: structuredClone(this.propertyPath),
+        };
+        if (this.cachedContent !== FieldRun.invalidContentIndicator) {
+            json.cachedContent = this.cachedContent;
+        }
+        if (this.formatter) {
+            json.formatter = structuredClone(this.formatter);
+        }
+        return json;
+    }
+    /** Create a deep copy of this FieldRun. */
+    clone() {
+        return new FieldRun(this.toJSON());
+    }
+    /** Convert this FieldRun to a simple string representation. */
+    stringify() {
+        return this.cachedContent;
+    }
+    /** Returns true if `this` is equivalent to `other`. */
+    equals(other) {
+        if (!(other instanceof FieldRun) || !super.equals(other)) {
+            return false;
+        }
+        if (this.propertyHost.elementId !== other.propertyHost.elementId ||
+            this.propertyHost.className !== other.propertyHost.className ||
+            this.propertyHost.schemaName !== other.propertyHost.schemaName) {
+            return false;
+        }
+        if (this.propertyPath.propertyName !== other.propertyPath.propertyName) {
+            return false;
+        }
+        const thisAccessors = this.propertyPath.accessors ?? [];
+        const otherAccessors = other.propertyPath.accessors ?? [];
+        const thisJsonAccessors = this.propertyPath.jsonAccessors ?? [];
+        const otherJsonAccessors = other.propertyPath.jsonAccessors ?? [];
+        if (thisAccessors.length !== otherAccessors.length || thisJsonAccessors.length !== otherJsonAccessors.length) {
+            return false;
+        }
+        if (!thisAccessors.every((value, index) => value === otherAccessors[index])) {
+            return false;
+        }
+        if (!thisJsonAccessors.every((value, index) => value === otherJsonAccessors[index])) {
+            return false;
+        }
+        if (this.formatter && other.formatter) {
+            // ###TODO better comparison of formatter objects.
+            if (JSON.stringify(this.formatter) !== JSON.stringify(other.formatter)) {
+                return false;
+            }
+        }
+        else if (this.formatter || other.formatter) {
+            return false;
+        }
+        return true;
+    }
+}
 /** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.
  * @beta
  */
@@ -44183,6 +44294,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   FeatureOverrides: () => (/* reexport safe */ _FeatureSymbology__WEBPACK_IMPORTED_MODULE_36__.FeatureOverrides),
 /* harmony export */   FeatureTable: () => (/* reexport safe */ _FeatureTable__WEBPACK_IMPORTED_MODULE_37__.FeatureTable),
 /* harmony export */   FeatureTableHeader: () => (/* reexport safe */ _tile_IModelTileIO__WEBPACK_IMPORTED_MODULE_154__.FeatureTableHeader),
+/* harmony export */   FieldRun: () => (/* reexport safe */ _annotation_TextBlock__WEBPACK_IMPORTED_MODULE_3__.FieldRun),
 /* harmony export */   FillDisplay: () => (/* reexport safe */ _GeometryParams__WEBPACK_IMPORTED_MODULE_58__.FillDisplay),
 /* harmony export */   FillFlags: () => (/* reexport safe */ _GraphicParams__WEBPACK_IMPORTED_MODULE_61__.FillFlags),
 /* harmony export */   FontMap: () => (/* reexport safe */ _Fonts__WEBPACK_IMPORTED_MODULE_38__.FontMap),
@@ -67834,14 +67946,21 @@ class ECClass extends _SchemaItem__WEBPACK_IMPORTED_MODULE_9__.SchemaItem {
             return this.traverseBaseClasses((thisSchemaItem, thatSchemaItemOrKey) => _SchemaItem__WEBPACK_IMPORTED_MODULE_9__.SchemaItem.equalByKey(thisSchemaItem, thatSchemaItemOrKey), targetClass);
         }
     }
-    /**
-     * A synchronous version of the [[ECClass.is]], indicating if the targetClass is of this type.
-     * @param targetClass The class to check.
-     */
-    isSync(targetClass) {
-        if (_SchemaItem__WEBPACK_IMPORTED_MODULE_9__.SchemaItem.equalByKey(this, targetClass))
-            return true;
-        return this.traverseBaseClassesSync((thisSchemaItem, thatSchemaItemOrKey) => _SchemaItem__WEBPACK_IMPORTED_MODULE_9__.SchemaItem.equalByKey(thisSchemaItem, thatSchemaItemOrKey), targetClass);
+    /** @internal */
+    isSync(targetClass, schemaName) {
+        if (schemaName !== undefined) {
+            (0,_itwin_core_bentley__WEBPACK_IMPORTED_MODULE_0__.assert)(typeof (targetClass) === "string", "Expected targetClass of type string because schemaName was specified");
+            const key = new _SchemaKey__WEBPACK_IMPORTED_MODULE_5__.SchemaItemKey(targetClass, new _SchemaKey__WEBPACK_IMPORTED_MODULE_5__.SchemaKey(schemaName));
+            if (_SchemaItem__WEBPACK_IMPORTED_MODULE_9__.SchemaItem.equalByKey(this, key))
+                return true;
+            return this.traverseBaseClassesSync((thisSchemaItem, thatSchemaItemOrKey) => _SchemaItem__WEBPACK_IMPORTED_MODULE_9__.SchemaItem.equalByKey(thisSchemaItem, thatSchemaItemOrKey), key);
+        }
+        else {
+            (0,_itwin_core_bentley__WEBPACK_IMPORTED_MODULE_0__.assert)(ECClass.isECClass(targetClass), "Expected targetClass to be of type ECClass");
+            if (_SchemaItem__WEBPACK_IMPORTED_MODULE_9__.SchemaItem.equalByKey(this, targetClass))
+                return true;
+            return this.traverseBaseClassesSync((thisSchemaItem, thatSchemaItemOrKey) => _SchemaItem__WEBPACK_IMPORTED_MODULE_9__.SchemaItem.equalByKey(thisSchemaItem, thatSchemaItemOrKey), targetClass);
+        }
     }
     /**
      * @internal
@@ -318001,7 +318120,7 @@ var loadLanguages = instance.loadLanguages;
 /***/ ((module) => {
 
 "use strict";
-module.exports = /*#__PURE__*/JSON.parse('{"name":"@itwin/core-frontend","version":"5.1.0-dev.64","description":"iTwin.js frontend components","main":"lib/cjs/core-frontend.js","module":"lib/esm/core-frontend.js","typings":"lib/cjs/core-frontend","license":"MIT","scripts":{"build":"npm run -s copy:public && npm run -s build:cjs && npm run -s build:esm && npm run -s webpackWorkers && npm run -s copy:workers","build:cjs":"npm run -s copy:js:cjs && tsc 1>&2 --outDir lib/cjs","build:esm":"npm run -s copy:js:esm && tsc 1>&2 --module ES2022 --outDir lib/esm","clean":"rimraf -g lib .rush/temp/package-deps*.json","copy:public":"cpx \\"./src/public/**/*\\" ./lib/public","copy:js:cjs":"cpx \\"./src/**/*.js\\" ./lib/cjs","copy:js:esm":"cpx \\"./src/**/*.js\\" ./lib/esm","copy:workers":"cpx \\"./lib/workers/webpack/parse-imdl-worker.js\\" ./lib/public/scripts","docs":"betools docs --json=../../generated-docs/core/core-frontend/file.json --tsIndexFile=./core-frontend.ts --onlyJson --excludes=webgl/**/*,**/map/*.d.ts,**/tile/*.d.ts,**/*-css.ts","extract-api":"betools extract-api --entry=core-frontend && npm run extract-extension-api","extract-extension-api":"eslint --no-inline-config -c extraction.eslint.config.js  \\"./src/**/*.ts\\" 1>&2","lint":"eslint \\"./src/**/*.ts\\" 1>&2","lint-fix":"eslint --fix -f visualstudio \\"./src/**/*.ts\\" 1>&2","lint-deprecation":"eslint --fix -f visualstudio --no-inline-config -c ../../common/config/eslint/eslint.config.deprecation-policy.js \\"./src/**/*.ts\\"","pseudolocalize":"betools pseudolocalize --englishDir ./src/public/locales/en --out ./public/locales/en-PSEUDO","test":"npm run webpackTestWorker && vitest --run","cover":"npm run webpackTestWorker && vitest --run","webpackTests":"webpack --config ./src/test/utils/webpack.config.js 1>&2 && npm run -s webpackTestWorker","webpackTestWorker":"webpack --config ./src/test/worker/webpack.config.js 1>&2 && cpx \\"./lib/test/test-worker.js\\" ./lib/test","webpackWorkers":"webpack --config ./src/workers/ImdlParser/webpack.config.js 1>&2"},"repository":{"type":"git","url":"https://github.com/iTwin/itwinjs-core.git","directory":"core/frontend"},"keywords":["Bentley","BIM","iModel","digital-twin","iTwin"],"author":{"name":"Bentley Systems, Inc.","url":"http://www.bentley.com"},"peerDependencies":{"@itwin/appui-abstract":"workspace:*","@itwin/core-bentley":"workspace:*","@itwin/core-common":"workspace:*","@itwin/core-geometry":"workspace:*","@itwin/core-orbitgt":"workspace:*","@itwin/core-quantity":"workspace:*","@itwin/ecschema-metadata":"workspace:*","@itwin/ecschema-rpcinterface-common":"workspace:*"},"//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/appui-abstract":"workspace:*","@itwin/build-tools":"workspace:*","@itwin/core-bentley":"workspace:*","@itwin/core-common":"workspace:*","@itwin/core-geometry":"workspace:*","@itwin/core-orbitgt":"workspace:*","@itwin/core-quantity":"workspace:*","@itwin/ecschema-metadata":"workspace:*","@itwin/ecschema-rpcinterface-common":"workspace:*","@itwin/eslint-plugin":"5.2.2-dev.2","@types/chai-as-promised":"^7","@types/sinon":"^17.0.2","@vitest/browser":"^3.0.6","@vitest/coverage-v8":"^3.0.6","cpx2":"^8.0.0","eslint":"^9.31.0","glob":"^10.3.12","playwright":"~1.47.1","rimraf":"^6.0.1","sinon":"^17.0.2","source-map-loader":"^5.0.0","typescript":"~5.6.2","typemoq":"^2.1.0","vitest":"^3.0.6","vite-multiple-assets":"^1.3.1","vite-plugin-static-copy":"2.2.0","webpack":"^5.97.1"},"//dependencies":["NOTE: these dependencies should be only for things that DO NOT APPEAR IN THE API","NOTE: core-frontend should remain UI technology agnostic, so no react/angular dependencies are allowed"],"dependencies":{"@itwin/cloud-agnostic-core":"^2.2.4","@itwin/object-storage-core":"^2.3.0","@itwin/core-i18n":"workspace:*","@itwin/webgl-compatibility":"workspace:*","@loaders.gl/core":"^3.1.6","@loaders.gl/draco":"^3.1.6","fuse.js":"^3.3.0","wms-capabilities":"0.4.0"}}');
+module.exports = /*#__PURE__*/JSON.parse('{"name":"@itwin/core-frontend","version":"5.1.0-dev.65","description":"iTwin.js frontend components","main":"lib/cjs/core-frontend.js","module":"lib/esm/core-frontend.js","typings":"lib/cjs/core-frontend","license":"MIT","scripts":{"build":"npm run -s copy:public && npm run -s build:cjs && npm run -s build:esm && npm run -s webpackWorkers && npm run -s copy:workers","build:cjs":"npm run -s copy:js:cjs && tsc 1>&2 --outDir lib/cjs","build:esm":"npm run -s copy:js:esm && tsc 1>&2 --module ES2022 --outDir lib/esm","clean":"rimraf -g lib .rush/temp/package-deps*.json","copy:public":"cpx \\"./src/public/**/*\\" ./lib/public","copy:js:cjs":"cpx \\"./src/**/*.js\\" ./lib/cjs","copy:js:esm":"cpx \\"./src/**/*.js\\" ./lib/esm","copy:workers":"cpx \\"./lib/workers/webpack/parse-imdl-worker.js\\" ./lib/public/scripts","docs":"betools docs --json=../../generated-docs/core/core-frontend/file.json --tsIndexFile=./core-frontend.ts --onlyJson --excludes=webgl/**/*,**/map/*.d.ts,**/tile/*.d.ts,**/*-css.ts","extract-api":"betools extract-api --entry=core-frontend && npm run extract-extension-api","extract-extension-api":"eslint --no-inline-config -c extraction.eslint.config.js  \\"./src/**/*.ts\\" 1>&2","lint":"eslint \\"./src/**/*.ts\\" 1>&2","lint-fix":"eslint --fix -f visualstudio \\"./src/**/*.ts\\" 1>&2","lint-deprecation":"eslint --fix -f visualstudio --no-inline-config -c ../../common/config/eslint/eslint.config.deprecation-policy.js \\"./src/**/*.ts\\"","pseudolocalize":"betools pseudolocalize --englishDir ./src/public/locales/en --out ./public/locales/en-PSEUDO","test":"npm run webpackTestWorker && vitest --run","cover":"npm run webpackTestWorker && vitest --run","webpackTests":"webpack --config ./src/test/utils/webpack.config.js 1>&2 && npm run -s webpackTestWorker","webpackTestWorker":"webpack --config ./src/test/worker/webpack.config.js 1>&2 && cpx \\"./lib/test/test-worker.js\\" ./lib/test","webpackWorkers":"webpack --config ./src/workers/ImdlParser/webpack.config.js 1>&2"},"repository":{"type":"git","url":"https://github.com/iTwin/itwinjs-core.git","directory":"core/frontend"},"keywords":["Bentley","BIM","iModel","digital-twin","iTwin"],"author":{"name":"Bentley Systems, Inc.","url":"http://www.bentley.com"},"peerDependencies":{"@itwin/appui-abstract":"workspace:*","@itwin/core-bentley":"workspace:*","@itwin/core-common":"workspace:*","@itwin/core-geometry":"workspace:*","@itwin/core-orbitgt":"workspace:*","@itwin/core-quantity":"workspace:*","@itwin/ecschema-metadata":"workspace:*","@itwin/ecschema-rpcinterface-common":"workspace:*"},"//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/appui-abstract":"workspace:*","@itwin/build-tools":"workspace:*","@itwin/core-bentley":"workspace:*","@itwin/core-common":"workspace:*","@itwin/core-geometry":"workspace:*","@itwin/core-orbitgt":"workspace:*","@itwin/core-quantity":"workspace:*","@itwin/ecschema-metadata":"workspace:*","@itwin/ecschema-rpcinterface-common":"workspace:*","@itwin/eslint-plugin":"5.2.2-dev.2","@types/chai-as-promised":"^7","@types/sinon":"^17.0.2","@vitest/browser":"^3.0.6","@vitest/coverage-v8":"^3.0.6","cpx2":"^8.0.0","eslint":"^9.31.0","glob":"^10.3.12","playwright":"~1.47.1","rimraf":"^6.0.1","sinon":"^17.0.2","source-map-loader":"^5.0.0","typescript":"~5.6.2","typemoq":"^2.1.0","vitest":"^3.0.6","vite-multiple-assets":"^1.3.1","vite-plugin-static-copy":"2.2.0","webpack":"^5.97.1"},"//dependencies":["NOTE: these dependencies should be only for things that DO NOT APPEAR IN THE API","NOTE: core-frontend should remain UI technology agnostic, so no react/angular dependencies are allowed"],"dependencies":{"@itwin/cloud-agnostic-core":"^2.2.4","@itwin/object-storage-core":"^2.3.0","@itwin/core-i18n":"workspace:*","@itwin/webgl-compatibility":"workspace:*","@loaders.gl/core":"^3.1.6","@loaders.gl/draco":"^3.1.6","fuse.js":"^3.3.0","wms-capabilities":"0.4.0"}}');
 
 /***/ })