@itwin/core-common 3.6.0-dev.21 → 3.6.0-dev.22

package/lib/esm/geometry/TextString.d.ts

@@ -1,56 +1,56 @@
-/** @packageDocumentation
- * @module Geometry
- */
-import { Point3d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from "@itwin/core-geometry";
-import { FontId } from "../Fonts";
-/** Properties for a TextString class.
- * @see [[GeometryStreamEntryProps]]
- * @public
- * @extensions
- */
-export interface TextStringProps {
-    /** text string */
-    text: string;
-    /** FontId for the TextString. FontIds are mapped to font names and types via the FontMap */
-    font: FontId;
-    height: number;
-    widthFactor?: number;
-    /** bold text. Default is false */
-    bold?: boolean;
-    /** italic text. Default is false */
-    italic?: boolean;
-    /** underline text. Default is false */
-    underline?: boolean;
-    /** Optional position relative to element's placement. Default is 0,0,0 */
-    origin?: XYZProps;
-    /** Optional rotation relative to element's placement. Default is identity matrix */
-    rotation?: YawPitchRollProps;
-}
-/** A single line of text, all with the same font, styles (underline, bold, italic), and size.
- * This class also holds the origin and direction for the text.
- * A paragraph is composed of one or more instances of TextStrings.
- * @public
- */
-export declare class TextString {
-    /** Text string */
-    text: string;
-    /** FontId for this TextString. FontIds are mapped to font names and types via the FontMap */
-    font: FontId;
-    height: number;
-    widthFactor?: number;
-    /** bold text. Default is false */
-    bold?: boolean;
-    /** italic text. Default is false */
-    italic?: boolean;
-    /** underline text. Default is false */
-    underline?: boolean;
-    /** position relative to element's placement */
-    readonly origin: Point3d;
-    /** Rotation relative to element's placement */
-    readonly rotation: YawPitchRollAngles;
-    get width(): number;
-    constructor(props: TextStringProps);
-    toJSON(): TextStringProps;
-    transformInPlace(transform: Transform): boolean;
-}
+/** @packageDocumentation
+ * @module Geometry
+ */
+import { Point3d, Transform, XYZProps, YawPitchRollAngles, YawPitchRollProps } from "@itwin/core-geometry";
+import { FontId } from "../Fonts";
+/** Properties for a TextString class.
+ * @see [[GeometryStreamEntryProps]]
+ * @public
+ * @extensions
+ */
+export interface TextStringProps {
+    /** text string */
+    text: string;
+    /** FontId for the TextString. FontIds are mapped to font names and types via the FontMap */
+    font: FontId;
+    height: number;
+    widthFactor?: number;
+    /** bold text. Default is false */
+    bold?: boolean;
+    /** italic text. Default is false */
+    italic?: boolean;
+    /** underline text. Default is false */
+    underline?: boolean;
+    /** Optional position relative to element's placement. Default is 0,0,0 */
+    origin?: XYZProps;
+    /** Optional rotation relative to element's placement. Default is identity matrix */
+    rotation?: YawPitchRollProps;
+}
+/** A single line of text, all with the same font, styles (underline, bold, italic), and size.
+ * This class also holds the origin and direction for the text.
+ * A paragraph is composed of one or more instances of TextStrings.
+ * @public
+ */
+export declare class TextString {
+    /** Text string */
+    text: string;
+    /** FontId for this TextString. FontIds are mapped to font names and types via the FontMap */
+    font: FontId;
+    height: number;
+    widthFactor?: number;
+    /** bold text. Default is false */
+    bold?: boolean;
+    /** italic text. Default is false */
+    italic?: boolean;
+    /** underline text. Default is false */
+    underline?: boolean;
+    /** position relative to element's placement */
+    readonly origin: Point3d;
+    /** Rotation relative to element's placement */
+    readonly rotation: YawPitchRollAngles;
+    get width(): number;
+    constructor(props: TextStringProps);
+    toJSON(): TextStringProps;
+    transformInPlace(transform: Transform): boolean;
+}
 //# sourceMappingURL=TextString.d.ts.map

package/lib/esm/geometry/TextString.js

@@ -1,62 +1,62 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Geometry
- */
-import { Point3d, Vector3d, YawPitchRollAngles } from "@itwin/core-geometry";
-/** A single line of text, all with the same font, styles (underline, bold, italic), and size.
- * This class also holds the origin and direction for the text.
- * A paragraph is composed of one or more instances of TextStrings.
- * @public
- */
-export class TextString {
-    constructor(props) {
-        this.text = props.text;
-        this.font = props.font;
-        this.height = props.height;
-        this.widthFactor = props.widthFactor;
-        this.bold = props.bold;
-        this.italic = props.italic;
-        this.underline = props.underline;
-        this.origin = Point3d.fromJSON(props.origin);
-        this.rotation = YawPitchRollAngles.fromJSON(props.rotation);
-    }
-    get width() { return this.height * (this.widthFactor ? this.widthFactor : 1.0); }
-    toJSON() {
-        const val = {};
-        val.text = this.text;
-        val.font = this.font;
-        val.height = this.height;
-        val.widthFactor = this.widthFactor;
-        val.bold = this.bold;
-        val.italic = this.italic;
-        val.underline = this.underline;
-        if (!this.origin.isAlmostZero)
-            val.origin = this.origin;
-        if (!this.rotation.isIdentity())
-            val.rotation = this.rotation;
-        return val;
-    }
-    transformInPlace(transform) {
-        const newOrigin = transform.multiplyPoint3d(this.origin, this.origin);
-        const newTransform = this.rotation.toMatrix3d().multiplyMatrixTransform(transform);
-        const scales = new Vector3d();
-        if (!newTransform.matrix.normalizeColumnsInPlace(scales))
-            return false;
-        const newRotation = YawPitchRollAngles.createFromMatrix3d(newTransform.matrix);
-        if (undefined === newRotation)
-            return false;
-        const newHeight = this.height * scales.y;
-        const newWidth = this.width * scales.x;
-        if (newHeight < 1.0e-10 || newWidth < 1.0e-10)
-            return false;
-        this.origin.setFrom(newOrigin);
-        this.rotation.setFrom(newRotation);
-        this.height = newHeight;
-        this.widthFactor = (newHeight === newWidth ? undefined : (newWidth / newHeight));
-        return true;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Geometry
+ */
+import { Point3d, Vector3d, YawPitchRollAngles } from "@itwin/core-geometry";
+/** A single line of text, all with the same font, styles (underline, bold, italic), and size.
+ * This class also holds the origin and direction for the text.
+ * A paragraph is composed of one or more instances of TextStrings.
+ * @public
+ */
+export class TextString {
+    constructor(props) {
+        this.text = props.text;
+        this.font = props.font;
+        this.height = props.height;
+        this.widthFactor = props.widthFactor;
+        this.bold = props.bold;
+        this.italic = props.italic;
+        this.underline = props.underline;
+        this.origin = Point3d.fromJSON(props.origin);
+        this.rotation = YawPitchRollAngles.fromJSON(props.rotation);
+    }
+    get width() { return this.height * (this.widthFactor ? this.widthFactor : 1.0); }
+    toJSON() {
+        const val = {};
+        val.text = this.text;
+        val.font = this.font;
+        val.height = this.height;
+        val.widthFactor = this.widthFactor;
+        val.bold = this.bold;
+        val.italic = this.italic;
+        val.underline = this.underline;
+        if (!this.origin.isAlmostZero)
+            val.origin = this.origin;
+        if (!this.rotation.isIdentity())
+            val.rotation = this.rotation;
+        return val;
+    }
+    transformInPlace(transform) {
+        const newOrigin = transform.multiplyPoint3d(this.origin, this.origin);
+        const newTransform = this.rotation.toMatrix3d().multiplyMatrixTransform(transform);
+        const scales = new Vector3d();
+        if (!newTransform.matrix.normalizeColumnsInPlace(scales))
+            return false;
+        const newRotation = YawPitchRollAngles.createFromMatrix3d(newTransform.matrix);
+        if (undefined === newRotation)
+            return false;
+        const newHeight = this.height * scales.y;
+        const newWidth = this.width * scales.x;
+        if (newHeight < 1.0e-10 || newWidth < 1.0e-10)
+            return false;
+        this.origin.setFrom(newOrigin);
+        this.rotation.setFrom(newRotation);
+        this.height = newHeight;
+        this.widthFactor = (newHeight === newWidth ? undefined : (newWidth / newHeight));
+        return true;
+    }
+}
 //# sourceMappingURL=TextString.js.map

package/lib/esm/geometry/TextString.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextString.js","sourceRoot":"","sources":["../../../src/geometry/TextString.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAa,QAAQ,EAAY,kBAAkB,EAAqB,MAAM,sBAAsB,CAAC;AA6BrH;;;;GAIG;AACH,MAAM,OAAO,UAAU;IAqBrB,YAAmB,KAAsB;QACvC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAZD,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAcjF,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY;YAC3B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE;YAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,gBAAgB,CAAC,SAAoB;QAC1C,MAAM,SAAS,GAAG,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACtE,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;QACnF,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,CAAC;YACtD,OAAO,KAAK,CAAC;QACf,MAAM,WAAW,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC/E,IAAI,SAAS,KAAK,WAAW;YAC3B,OAAO,KAAK,CAAC;QACf,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC;QACvC,IAAI,SAAS,GAAG,OAAO,IAAI,QAAQ,GAAG,OAAO;YAC3C,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC;IACd,CAAC;CACF","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 Geometry\n */\n\nimport { Point3d, Transform, Vector3d, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\nimport { FontId } from \"../Fonts\";\n\n/** Properties for a TextString class.\n * @see [[GeometryStreamEntryProps]]\n * @public\n * @extensions\n */\nexport interface TextStringProps {\n  /** text string */\n  text: string;\n  /** FontId for the TextString. FontIds are mapped to font names and types via the FontMap */\n  font: FontId;\n  /* text height */\n  height: number;\n  /*  width / height ratio. Default is 1.0 */\n  widthFactor?: number;\n  /** bold text. Default is false */\n  bold?: boolean;\n  /** italic text. Default is false */\n  italic?: boolean;\n  /** underline text. Default is false */\n  underline?: boolean;\n  /** Optional position relative to element's placement. Default is 0,0,0 */\n  origin?: XYZProps;\n  /** Optional rotation relative to element's placement. Default is identity matrix */\n  rotation?: YawPitchRollProps;\n}\n\n/** A single line of text, all with the same font, styles (underline, bold, italic), and size.\n * This class also holds the origin and direction for the text.\n * A paragraph is composed of one or more instances of TextStrings.\n * @public\n */\nexport class TextString {\n  /** Text string */\n  public text: string;\n  /** FontId for this TextString. FontIds are mapped to font names and types via the FontMap */\n  public font: FontId;\n  /* text height, in meters */\n  public height: number;\n  /*  width / height ratio. Default is 1.0 */\n  public widthFactor?: number;\n  /** bold text. Default is false */\n  public bold?: boolean;\n  /** italic text. Default is false */\n  public italic?: boolean;\n  /** underline text. Default is false */\n  public underline?: boolean;\n  /** position relative to element's placement */\n  public readonly origin: Point3d;\n  /** Rotation relative to element's placement */\n  public readonly rotation: YawPitchRollAngles;\n  public get width() { return this.height * (this.widthFactor ? this.widthFactor : 1.0); }\n\n  public constructor(props: TextStringProps) {\n    this.text = props.text;\n    this.font = props.font;\n    this.height = props.height;\n    this.widthFactor = props.widthFactor;\n    this.bold = props.bold;\n    this.italic = props.italic;\n    this.underline = props.underline;\n    this.origin = Point3d.fromJSON(props.origin);\n    this.rotation = YawPitchRollAngles.fromJSON(props.rotation);\n  }\n\n  public toJSON(): TextStringProps {\n    const val: any = {};\n    val.text = this.text;\n    val.font = this.font;\n    val.height = this.height;\n    val.widthFactor = this.widthFactor;\n    val.bold = this.bold;\n    val.italic = this.italic;\n    val.underline = this.underline;\n    if (!this.origin.isAlmostZero)\n      val.origin = this.origin;\n\n    if (!this.rotation.isIdentity())\n      val.rotation = this.rotation;\n\n    return val;\n  }\n\n  public transformInPlace(transform: Transform): boolean {\n    const newOrigin = transform.multiplyPoint3d(this.origin, this.origin);\n    const newTransform = this.rotation.toMatrix3d().multiplyMatrixTransform(transform);\n    const scales = new Vector3d();\n    if (!newTransform.matrix.normalizeColumnsInPlace(scales))\n      return false;\n    const newRotation = YawPitchRollAngles.createFromMatrix3d(newTransform.matrix);\n    if (undefined === newRotation)\n      return false;\n    const newHeight = this.height * scales.y;\n    const newWidth = this.width * scales.x;\n    if (newHeight < 1.0e-10 || newWidth < 1.0e-10)\n      return false;\n    this.origin.setFrom(newOrigin);\n    this.rotation.setFrom(newRotation);\n    this.height = newHeight;\n    this.widthFactor = (newHeight === newWidth ? undefined : (newWidth / newHeight));\n    return true;\n  }\n}\n"]}
+{"version":3,"file":"TextString.js","sourceRoot":"","sources":["../../../src/geometry/TextString.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAa,QAAQ,EAAY,kBAAkB,EAAqB,MAAM,sBAAsB,CAAC;AA6BrH;;;;GAIG;AACH,MAAM,OAAO,UAAU;IAqBrB,YAAmB,KAAsB;QACvC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAZD,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAcjF,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY;YAC3B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE;YAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,gBAAgB,CAAC,SAAoB;QAC1C,MAAM,SAAS,GAAG,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACtE,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;QACnF,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,CAAC;YACtD,OAAO,KAAK,CAAC;QACf,MAAM,WAAW,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC/E,IAAI,SAAS,KAAK,WAAW;YAC3B,OAAO,KAAK,CAAC;QACf,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC;QACvC,IAAI,SAAS,GAAG,OAAO,IAAI,QAAQ,GAAG,OAAO;YAC3C,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC;IACd,CAAC;CACF","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\n/** @packageDocumentation\r\n * @module Geometry\r\n */\r\n\r\nimport { Point3d, Transform, Vector3d, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\r\nimport { FontId } from \"../Fonts\";\r\n\r\n/** Properties for a TextString class.\r\n * @see [[GeometryStreamEntryProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport interface TextStringProps {\r\n  /** text string */\r\n  text: string;\r\n  /** FontId for the TextString. FontIds are mapped to font names and types via the FontMap */\r\n  font: FontId;\r\n  /* text height */\r\n  height: number;\r\n  /*  width / height ratio. Default is 1.0 */\r\n  widthFactor?: number;\r\n  /** bold text. Default is false */\r\n  bold?: boolean;\r\n  /** italic text. Default is false */\r\n  italic?: boolean;\r\n  /** underline text. Default is false */\r\n  underline?: boolean;\r\n  /** Optional position relative to element's placement. Default is 0,0,0 */\r\n  origin?: XYZProps;\r\n  /** Optional rotation relative to element's placement. Default is identity matrix */\r\n  rotation?: YawPitchRollProps;\r\n}\r\n\r\n/** A single line of text, all with the same font, styles (underline, bold, italic), and size.\r\n * This class also holds the origin and direction for the text.\r\n * A paragraph is composed of one or more instances of TextStrings.\r\n * @public\r\n */\r\nexport class TextString {\r\n  /** Text string */\r\n  public text: string;\r\n  /** FontId for this TextString. FontIds are mapped to font names and types via the FontMap */\r\n  public font: FontId;\r\n  /* text height, in meters */\r\n  public height: number;\r\n  /*  width / height ratio. Default is 1.0 */\r\n  public widthFactor?: number;\r\n  /** bold text. Default is false */\r\n  public bold?: boolean;\r\n  /** italic text. Default is false */\r\n  public italic?: boolean;\r\n  /** underline text. Default is false */\r\n  public underline?: boolean;\r\n  /** position relative to element's placement */\r\n  public readonly origin: Point3d;\r\n  /** Rotation relative to element's placement */\r\n  public readonly rotation: YawPitchRollAngles;\r\n  public get width() { return this.height * (this.widthFactor ? this.widthFactor : 1.0); }\r\n\r\n  public constructor(props: TextStringProps) {\r\n    this.text = props.text;\r\n    this.font = props.font;\r\n    this.height = props.height;\r\n    this.widthFactor = props.widthFactor;\r\n    this.bold = props.bold;\r\n    this.italic = props.italic;\r\n    this.underline = props.underline;\r\n    this.origin = Point3d.fromJSON(props.origin);\r\n    this.rotation = YawPitchRollAngles.fromJSON(props.rotation);\r\n  }\r\n\r\n  public toJSON(): TextStringProps {\r\n    const val: any = {};\r\n    val.text = this.text;\r\n    val.font = this.font;\r\n    val.height = this.height;\r\n    val.widthFactor = this.widthFactor;\r\n    val.bold = this.bold;\r\n    val.italic = this.italic;\r\n    val.underline = this.underline;\r\n    if (!this.origin.isAlmostZero)\r\n      val.origin = this.origin;\r\n\r\n    if (!this.rotation.isIdentity())\r\n      val.rotation = this.rotation;\r\n\r\n    return val;\r\n  }\r\n\r\n  public transformInPlace(transform: Transform): boolean {\r\n    const newOrigin = transform.multiplyPoint3d(this.origin, this.origin);\r\n    const newTransform = this.rotation.toMatrix3d().multiplyMatrixTransform(transform);\r\n    const scales = new Vector3d();\r\n    if (!newTransform.matrix.normalizeColumnsInPlace(scales))\r\n      return false;\r\n    const newRotation = YawPitchRollAngles.createFromMatrix3d(newTransform.matrix);\r\n    if (undefined === newRotation)\r\n      return false;\r\n    const newHeight = this.height * scales.y;\r\n    const newWidth = this.width * scales.x;\r\n    if (newHeight < 1.0e-10 || newWidth < 1.0e-10)\r\n      return false;\r\n    this.origin.setFrom(newOrigin);\r\n    this.rotation.setFrom(newRotation);\r\n    this.height = newHeight;\r\n    this.widthFactor = (newHeight === newWidth ? undefined : (newWidth / newHeight));\r\n    return true;\r\n  }\r\n}\r\n"]}

package/lib/esm/ipc/IpcSession.d.ts

@@ -1,24 +1,24 @@
-/** @packageDocumentation
- * @module IpcSocket
- */
-/** @internal */
-export interface InterceptedRpcRequest {
-    definition: {
-        interfaceName: string;
-        interfaceVersion: string;
-    };
-    operation: string;
-    parameters: any[];
-    context: {
-        [index: string]: string;
-    };
-}
-/** @internal */
-export declare abstract class IpcSession {
-    private static _active?;
-    static get active(): IpcSession | undefined;
-    static start(session: IpcSession): void;
-    static stop(): void;
-    abstract handleRpc(info: InterceptedRpcRequest): Promise<any>;
-}
+/** @packageDocumentation
+ * @module IpcSocket
+ */
+/** @internal */
+export interface InterceptedRpcRequest {
+    definition: {
+        interfaceName: string;
+        interfaceVersion: string;
+    };
+    operation: string;
+    parameters: any[];
+    context: {
+        [index: string]: string;
+    };
+}
+/** @internal */
+export declare abstract class IpcSession {
+    private static _active?;
+    static get active(): IpcSession | undefined;
+    static start(session: IpcSession): void;
+    static stop(): void;
+    abstract handleRpc(info: InterceptedRpcRequest): Promise<any>;
+}
 //# sourceMappingURL=IpcSession.d.ts.map

package/lib/esm/ipc/IpcSession.js

@@ -1,24 +1,24 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module IpcSocket
- */
-/** @internal */
-export class IpcSession {
-    static get active() { return this._active; }
-    static start(session) {
-        if (this._active) {
-            return;
-        }
-        this._active = session;
-    }
-    static stop() {
-        if (!this._active) {
-            return;
-        }
-        this._active = undefined;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IpcSocket
+ */
+/** @internal */
+export class IpcSession {
+    static get active() { return this._active; }
+    static start(session) {
+        if (this._active) {
+            return;
+        }
+        this._active = session;
+    }
+    static stop() {
+        if (!this._active) {
+            return;
+        }
+        this._active = undefined;
+    }
+}
 //# sourceMappingURL=IpcSession.js.map

package/lib/esm/ipc/IpcSession.js.map

@@ -1 +1 @@
-{"version":3,"file":"IpcSession.js","sourceRoot":"","sources":["../../../src/ipc/IpcSession.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAUH,gBAAgB;AAChB,MAAM,OAAgB,UAAU;IAEvB,MAAM,KAAK,MAAM,KAA6B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEpE,MAAM,CAAC,KAAK,CAAC,OAAmB;QACrC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO;SACR;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,IAAI;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO;SACR;QAED,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3B,CAAC;CAGF","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 IpcSocket\n */\n\n/** @internal */\nexport interface InterceptedRpcRequest {\n  definition: { interfaceName: string, interfaceVersion: string };\n  operation: string;\n  parameters: any[];\n  context: { [index: string]: string };\n}\n\n/** @internal */\nexport abstract class IpcSession {\n  private static _active?: IpcSession;\n  public static get active(): IpcSession | undefined { return this._active; }\n\n  public static start(session: IpcSession) {\n    if (this._active) {\n      return;\n    }\n\n    this._active = session;\n  }\n\n  public static stop() {\n    if (!this._active) {\n      return;\n    }\n\n    this._active = undefined;\n  }\n\n  public abstract handleRpc(info: InterceptedRpcRequest): Promise<any>;\n}\n"]}
+{"version":3,"file":"IpcSession.js","sourceRoot":"","sources":["../../../src/ipc/IpcSession.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAUH,gBAAgB;AAChB,MAAM,OAAgB,UAAU;IAEvB,MAAM,KAAK,MAAM,KAA6B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEpE,MAAM,CAAC,KAAK,CAAC,OAAmB;QACrC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO;SACR;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,IAAI;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO;SACR;QAED,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3B,CAAC;CAGF","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\n/** @packageDocumentation\r\n * @module IpcSocket\r\n */\r\n\r\n/** @internal */\r\nexport interface InterceptedRpcRequest {\r\n  definition: { interfaceName: string, interfaceVersion: string };\r\n  operation: string;\r\n  parameters: any[];\r\n  context: { [index: string]: string };\r\n}\r\n\r\n/** @internal */\r\nexport abstract class IpcSession {\r\n  private static _active?: IpcSession;\r\n  public static get active(): IpcSession | undefined { return this._active; }\r\n\r\n  public static start(session: IpcSession) {\r\n    if (this._active) {\r\n      return;\r\n    }\r\n\r\n    this._active = session;\r\n  }\r\n\r\n  public static stop() {\r\n    if (!this._active) {\r\n      return;\r\n    }\r\n\r\n    this._active = undefined;\r\n  }\r\n\r\n  public abstract handleRpc(info: InterceptedRpcRequest): Promise<any>;\r\n}\r\n"]}

package/lib/esm/ipc/IpcSocket.d.ts

@@ -1,97 +1,97 @@
-/** @packageDocumentation
- * @module IpcSocket
- */
-/**
- * The prefix for all IpcSocket channels to disambiguate from system channels.
- * @internal
- * */
-export declare const iTwinChannel: (channel: string) => string;
-/**
- * A function to handle an Ipc message.
- * @public
- */
-export declare type IpcListener = (evt: Event, ...args: any[]) => void;
-/**
- * Function returned when establishing an Ipc `receive` listener or `invoke` handler. Call this method to remove the listener/handler.
- * @public
- * @extensions
- */
-export declare type RemoveFunction = () => void;
-/**
- * Payload of an IpcInvoke response. The presence of `error` indicates that the backend threw an exception and the
- * frontend will re-throw a [BackendError]$(frontend) with the `errorNumber` and `message` values. Otherwise the `result`
- * member holds the response.
- * @internal */
-export declare type IpcInvokeReturn = {
-    result: any;
-    error?: never;
-} | {
-    result?: never;
-    error: {
-        name: string;
-        message: string;
-        errorNumber: number;
-        stack?: string;
-    };
-};
-/**
- * An inter-process socket connection between a single [IModelHost]($backend) on the backend (the node process), and an [IModelApp]($frontend) on
- * the frontend (the browser process.) Each side will implement this interface to form a two way connection. The frontend and backend
- * processes connected through an IpcSocket don't necessarily have to be on the same computer, but often are.
- * @public
-*/
-export interface IpcSocket {
-    /**
-     * Send a message over the socket.
-     * @param channel The name of the channel for the message. Must begin with the [[iTwinChannel]] prefix.
-     * @param data The optional data of the message.
-     * @note `data` is serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only
-     * primitive types and `ArrayBuffers` are allowed.
-     */
-    send: (channel: string, ...data: any[]) => void;
-    /**
-     * Establish a handler to receive messages for a channel through a socket.
-     * @param channel The name of the channel for the messages. Must begin with the [[iTwinChannel]] prefix.
-     * @param listener A function called when messages are sent over `channel`
-     * @note returns A function to call to remove the listener.
-     */
-    addListener: (channel: string, listener: IpcListener) => RemoveFunction;
-    /**
-     * Remove a previously registered listener
-     * @param channel The name of the channel for the listener previously registered with [[addListener]]
-     * @param listener The function passed to [[addListener]]
-     */
-    removeListener: (channel: string, listener: IpcListener) => void;
-}
-/**
- * Interface for the frontend (browser) side of a socket connection. Frontends may invoke methods implemented on the backend.
- * @public
- */
-export interface IpcSocketFrontend extends IpcSocket {
-    /**
-     * Send a message to the backend via `channel` and expect a result asynchronously.
-     * @param channel The name of the channel for the method.  Must begin with the [[iTwinChannel]] prefix.
-     * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.
-     * Note that this interface *may* be implemented via Electron for desktop apps, or via
-     * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based
-     * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.
-     * @note `args` are serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only
-     * primitive types and `ArrayBuffers` are allowed.
-     */
-    invoke: (channel: string, ...args: any[]) => Promise<any>;
-}
-/**
- * Interface for the backend (Node.js) side of a socket connection. Backends provide the implementation
- * of methods that are invoked from the frontend.
- * @public
- */
-export interface IpcSocketBackend extends IpcSocket {
-    /**
-     * Establish a backend implementation of an Ipc interface for a channel.
-     * @param channel The name of the channel for this handler. Must begin with the [[iTwinChannel]] prefix.
-     * @param handler A function that supplies the implementation for methods invoked over `channel` via [[IpcSocketFrontend.invoke]]
-     * @note returns A function to call to remove the handler.
-     */
-    handle: (channel: string, handler: (...args: any[]) => Promise<any>) => RemoveFunction;
-}
+/** @packageDocumentation
+ * @module IpcSocket
+ */
+/**
+ * The prefix for all IpcSocket channels to disambiguate from system channels.
+ * @internal
+ * */
+export declare const iTwinChannel: (channel: string) => string;
+/**
+ * A function to handle an Ipc message.
+ * @public
+ */
+export declare type IpcListener = (evt: Event, ...args: any[]) => void;
+/**
+ * Function returned when establishing an Ipc `receive` listener or `invoke` handler. Call this method to remove the listener/handler.
+ * @public
+ * @extensions
+ */
+export declare type RemoveFunction = () => void;
+/**
+ * Payload of an IpcInvoke response. The presence of `error` indicates that the backend threw an exception and the
+ * frontend will re-throw a [BackendError]$(frontend) with the `errorNumber` and `message` values. Otherwise the `result`
+ * member holds the response.
+ * @internal */
+export declare type IpcInvokeReturn = {
+    result: any;
+    error?: never;
+} | {
+    result?: never;
+    error: {
+        name: string;
+        message: string;
+        errorNumber: number;
+        stack?: string;
+    };
+};
+/**
+ * An inter-process socket connection between a single [IModelHost]($backend) on the backend (the node process), and an [IModelApp]($frontend) on
+ * the frontend (the browser process.) Each side will implement this interface to form a two way connection. The frontend and backend
+ * processes connected through an IpcSocket don't necessarily have to be on the same computer, but often are.
+ * @public
+*/
+export interface IpcSocket {
+    /**
+     * Send a message over the socket.
+     * @param channel The name of the channel for the message. Must begin with the [[iTwinChannel]] prefix.
+     * @param data The optional data of the message.
+     * @note `data` is serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only
+     * primitive types and `ArrayBuffers` are allowed.
+     */
+    send: (channel: string, ...data: any[]) => void;
+    /**
+     * Establish a handler to receive messages for a channel through a socket.
+     * @param channel The name of the channel for the messages. Must begin with the [[iTwinChannel]] prefix.
+     * @param listener A function called when messages are sent over `channel`
+     * @note returns A function to call to remove the listener.
+     */
+    addListener: (channel: string, listener: IpcListener) => RemoveFunction;
+    /**
+     * Remove a previously registered listener
+     * @param channel The name of the channel for the listener previously registered with [[addListener]]
+     * @param listener The function passed to [[addListener]]
+     */
+    removeListener: (channel: string, listener: IpcListener) => void;
+}
+/**
+ * Interface for the frontend (browser) side of a socket connection. Frontends may invoke methods implemented on the backend.
+ * @public
+ */
+export interface IpcSocketFrontend extends IpcSocket {
+    /**
+     * Send a message to the backend via `channel` and expect a result asynchronously.
+     * @param channel The name of the channel for the method.  Must begin with the [[iTwinChannel]] prefix.
+     * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.
+     * Note that this interface *may* be implemented via Electron for desktop apps, or via
+     * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based
+     * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.
+     * @note `args` are serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only
+     * primitive types and `ArrayBuffers` are allowed.
+     */
+    invoke: (channel: string, ...args: any[]) => Promise<any>;
+}
+/**
+ * Interface for the backend (Node.js) side of a socket connection. Backends provide the implementation
+ * of methods that are invoked from the frontend.
+ * @public
+ */
+export interface IpcSocketBackend extends IpcSocket {
+    /**
+     * Establish a backend implementation of an Ipc interface for a channel.
+     * @param channel The name of the channel for this handler. Must begin with the [[iTwinChannel]] prefix.
+     * @param handler A function that supplies the implementation for methods invoked over `channel` via [[IpcSocketFrontend.invoke]]
+     * @note returns A function to call to remove the handler.
+     */
+    handle: (channel: string, handler: (...args: any[]) => Promise<any>) => RemoveFunction;
+}
 //# sourceMappingURL=IpcSocket.d.ts.map

package/lib/esm/ipc/IpcSocket.js

@@ -1,13 +1,13 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module IpcSocket
- */
-/**
- * The prefix for all IpcSocket channels to disambiguate from system channels.
- * @internal
- * */
-export const iTwinChannel = (channel) => `itwin.${channel}`;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IpcSocket
+ */
+/**
+ * The prefix for all IpcSocket channels to disambiguate from system channels.
+ * @internal
+ * */
+export const iTwinChannel = (channel) => `itwin.${channel}`;
 //# sourceMappingURL=IpcSocket.js.map

package/lib/esm/ipc/IpcSocket.js.map

@@ -1 +1 @@
-{"version":3,"file":"IpcSocket.js","sourceRoot":"","sources":["../../../src/ipc/IpcSocket.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;KAGK;AACL,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,OAAO,EAAE,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 IpcSocket\n */\n\n/**\n * The prefix for all IpcSocket channels to disambiguate from system channels.\n * @internal\n * */\nexport const iTwinChannel = (channel: string) => `itwin.${channel}`;\n\n/**\n * A function to handle an Ipc message.\n * @public\n */\nexport type IpcListener = (evt: Event, ...args: any[]) => void;\n\n/**\n * Function returned when establishing an Ipc `receive` listener or `invoke` handler. Call this method to remove the listener/handler.\n * @public\n * @extensions\n */\nexport type RemoveFunction = () => void;\n\n/**\n * Payload of an IpcInvoke response. The presence of `error` indicates that the backend threw an exception and the\n * frontend will re-throw a [BackendError]$(frontend) with the `errorNumber` and `message` values. Otherwise the `result`\n * member holds the response.\n * @internal */\nexport type IpcInvokeReturn = { result: any, error?: never } | { result?: never, error: { name: string, message: string, errorNumber: number, stack?: string } };\n\n/**\n * An inter-process socket connection between a single [IModelHost]($backend) on the backend (the node process), and an [IModelApp]($frontend) on\n * the frontend (the browser process.) Each side will implement this interface to form a two way connection. The frontend and backend\n * processes connected through an IpcSocket don't necessarily have to be on the same computer, but often are.\n * @public\n*/\nexport interface IpcSocket {\n  /**\n   * Send a message over the socket.\n   * @param channel The name of the channel for the message. Must begin with the [[iTwinChannel]] prefix.\n   * @param data The optional data of the message.\n   * @note `data` is serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\n   * primitive types and `ArrayBuffers` are allowed.\n   */\n  send: (channel: string, ...data: any[]) => void;\n  /**\n   * Establish a handler to receive messages for a channel through a socket.\n   * @param channel The name of the channel for the messages. Must begin with the [[iTwinChannel]] prefix.\n   * @param listener A function called when messages are sent over `channel`\n   * @note returns A function to call to remove the listener.\n   */\n  addListener: (channel: string, listener: IpcListener) => RemoveFunction;\n  /**\n   * Remove a previously registered listener\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\n   * @param listener The function passed to [[addListener]]\n   */\n  removeListener: (channel: string, listener: IpcListener) => void;\n}\n\n/**\n * Interface for the frontend (browser) side of a socket connection. Frontends may invoke methods implemented on the backend.\n * @public\n */\nexport interface IpcSocketFrontend extends IpcSocket {\n  /**\n   * Send a message to the backend via `channel` and expect a result asynchronously.\n   * @param channel The name of the channel for the method.  Must begin with the [[iTwinChannel]] prefix.\n   * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.\n   * Note that this interface *may* be implemented via Electron for desktop apps, or via\n   * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based\n   * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.\n   * @note `args` are serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\n   * primitive types and `ArrayBuffers` are allowed.\n   */\n  invoke: (channel: string, ...args: any[]) => Promise<any>;\n}\n\n/**\n * Interface for the backend (Node.js) side of a socket connection. Backends provide the implementation\n * of methods that are invoked from the frontend.\n * @public\n */\nexport interface IpcSocketBackend extends IpcSocket {\n  /**\n   * Establish a backend implementation of an Ipc interface for a channel.\n   * @param channel The name of the channel for this handler. Must begin with the [[iTwinChannel]] prefix.\n   * @param handler A function that supplies the implementation for methods invoked over `channel` via [[IpcSocketFrontend.invoke]]\n   * @note returns A function to call to remove the handler.\n   */\n  handle: (channel: string, handler: (...args: any[]) => Promise<any>) => RemoveFunction;\n}\n\n"]}
+{"version":3,"file":"IpcSocket.js","sourceRoot":"","sources":["../../../src/ipc/IpcSocket.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;KAGK;AACL,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,OAAO,EAAE,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\n/** @packageDocumentation\r\n * @module IpcSocket\r\n */\r\n\r\n/**\r\n * The prefix for all IpcSocket channels to disambiguate from system channels.\r\n * @internal\r\n * */\r\nexport const iTwinChannel = (channel: string) => `itwin.${channel}`;\r\n\r\n/**\r\n * A function to handle an Ipc message.\r\n * @public\r\n */\r\nexport type IpcListener = (evt: Event, ...args: any[]) => void;\r\n\r\n/**\r\n * Function returned when establishing an Ipc `receive` listener or `invoke` handler. Call this method to remove the listener/handler.\r\n * @public\r\n * @extensions\r\n */\r\nexport type RemoveFunction = () => void;\r\n\r\n/**\r\n * Payload of an IpcInvoke response. The presence of `error` indicates that the backend threw an exception and the\r\n * frontend will re-throw a [BackendError]$(frontend) with the `errorNumber` and `message` values. Otherwise the `result`\r\n * member holds the response.\r\n * @internal */\r\nexport type IpcInvokeReturn = { result: any, error?: never } | { result?: never, error: { name: string, message: string, errorNumber: number, stack?: string } };\r\n\r\n/**\r\n * An inter-process socket connection between a single [IModelHost]($backend) on the backend (the node process), and an [IModelApp]($frontend) on\r\n * the frontend (the browser process.) Each side will implement this interface to form a two way connection. The frontend and backend\r\n * processes connected through an IpcSocket don't necessarily have to be on the same computer, but often are.\r\n * @public\r\n*/\r\nexport interface IpcSocket {\r\n  /**\r\n   * Send a message over the socket.\r\n   * @param channel The name of the channel for the message. Must begin with the [[iTwinChannel]] prefix.\r\n   * @param data The optional data of the message.\r\n   * @note `data` is serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  send: (channel: string, ...data: any[]) => void;\r\n  /**\r\n   * Establish a handler to receive messages for a channel through a socket.\r\n   * @param channel The name of the channel for the messages. Must begin with the [[iTwinChannel]] prefix.\r\n   * @param listener A function called when messages are sent over `channel`\r\n   * @note returns A function to call to remove the listener.\r\n   */\r\n  addListener: (channel: string, listener: IpcListener) => RemoveFunction;\r\n  /**\r\n   * Remove a previously registered listener\r\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\r\n   * @param listener The function passed to [[addListener]]\r\n   */\r\n  removeListener: (channel: string, listener: IpcListener) => void;\r\n}\r\n\r\n/**\r\n * Interface for the frontend (browser) side of a socket connection. Frontends may invoke methods implemented on the backend.\r\n * @public\r\n */\r\nexport interface IpcSocketFrontend extends IpcSocket {\r\n  /**\r\n   * Send a message to the backend via `channel` and expect a result asynchronously.\r\n   * @param channel The name of the channel for the method.  Must begin with the [[iTwinChannel]] prefix.\r\n   * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.\r\n   * Note that this interface *may* be implemented via Electron for desktop apps, or via\r\n   * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based\r\n   * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.\r\n   * @note `args` are serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  invoke: (channel: string, ...args: any[]) => Promise<any>;\r\n}\r\n\r\n/**\r\n * Interface for the backend (Node.js) side of a socket connection. Backends provide the implementation\r\n * of methods that are invoked from the frontend.\r\n * @public\r\n */\r\nexport interface IpcSocketBackend extends IpcSocket {\r\n  /**\r\n   * Establish a backend implementation of an Ipc interface for a channel.\r\n   * @param channel The name of the channel for this handler. Must begin with the [[iTwinChannel]] prefix.\r\n   * @param handler A function that supplies the implementation for methods invoked over `channel` via [[IpcSocketFrontend.invoke]]\r\n   * @note returns A function to call to remove the handler.\r\n   */\r\n  handle: (channel: string, handler: (...args: any[]) => Promise<any>) => RemoveFunction;\r\n}\r\n\r\n"]}