@itwin/editor-common 3.6.0-dev.8 → 4.0.0-dev.2

package/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Change Log - @itwin/editor-common
 
-This log was last generated on Wed, 07 Dec 2022 19:12:37 GMT and should not be manually modified.
+This log was last generated on Thu, 26 Jan 2023 22:53:27 GMT and should not be manually modified.
+
+## 3.5.5
+Thu, 26 Jan 2023 22:53:27 GMT
+
+_Version update only_
+
+## 3.5.4
+Wed, 18 Jan 2023 15:27:15 GMT
+
+_Version update only_
+
+## 3.5.3
+Fri, 13 Jan 2023 17:23:07 GMT
+
+_Version update only_
+
+## 3.5.2
+Wed, 11 Jan 2023 16:46:30 GMT
+
+_Version update only_
+
+## 3.5.1
+Thu, 15 Dec 2022 16:38:29 GMT
+
+_Version update only_
 
 ## 3.5.0
 Wed, 07 Dec 2022 19:12:37 GMT

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2023 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/lib/cjs/EditorIpc.d.ts

@@ -2,14 +2,38 @@
  * @module Editing
  */
 /** @internal */
-export declare const editorChannel = "editor";
-/** @alpha */
+export declare const editorIpcStrings: {
+    readonly channel: "editor";
+    readonly commandBusy: "EditCommandBusy";
+};
+/**
+ * Interface called from frontend `EditTool`s to start and drive the active `EditCommand` on the backend.
+ * @beta
+ */
 export interface EditorIpc {
+    /** Start a new instance of an `EditCommand` on the backend, and then call its `onStart` method.
+     * @param commandId the Id of a registered `EditCommand` on the backend. If commandId === "", the current command is
+     * requested to finish but no new EditCommand is started.
+     * @param iModelKey the key that identifies the iModel that the EditCommand modifies.
+     * @param args arguments passed to the constructor of the new `EditCommand`
+     * @return the value returned by the new `EditCommand`'s `onStart` method.
+     * @note The current `EditCommand` (if one is active) is asked to  finish and clean up its operation via `EditCommand.requestFinish`
+     * before the new `EditCommand` is constructed. If it cannot finish immediately, it may return a string that identifies
+     * the work it is performing for `EditTools.busyHandler` to retry and/or display.
+     */
     startCommand: (commandId: string, iModelKey: string, ...args: any[]) => Promise<any>;
+    /** Call a method on the currently active `EditCommand` and return its value.
+     * @param name the name of the method to invoke.
+     * @param args arguments passed to the method.
+     * @note throws an exception if there is no active `EditCommand`, or if the active EditCommand does not implement the supplied method. */
     callMethod: (name: string, ...args: any[]) => Promise<any>;
 }
-/** @alpha */
+/**
+ * Interface implemented by all backend `EditCommands`.
+ * @beta
+ */
 export interface EditCommandIpc {
+    /** Identify the current `EditCommand`'s name and version, optionally returning additional properties that describe its state. */
     ping: () => Promise<{
         commandId: string;
         version: string;

package/lib/cjs/EditorIpc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EditorIpc.d.ts","sourceRoot":"","sources":["../../src/EditorIpc.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,gBAAgB;AAChB,eAAO,MAAM,aAAa,WAAW,CAAC;AAEtC,aAAa;AACb,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACrF,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC5D;AAED,aAAa;AACb,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAAC;CACtF"}
+{"version":3,"file":"EditorIpc.d.ts","sourceRoot":"","sources":["../../src/EditorIpc.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,gBAAgB;AAChB,eAAO,MAAM,gBAAgB;;;CAGnB,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,SAAS;IAExB;;;;;;;;;OASG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAErF;;;6IAGyI;IACzI,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC5D;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,iIAAiI;IACjI,IAAI,EAAE,MAAM,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAAC;CACtF"}

package/lib/cjs/EditorIpc.js

@@ -7,7 +7,10 @@
  * @module Editing
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.editorChannel = void 0;
+exports.editorIpcStrings = void 0;
 /** @internal */
-exports.editorChannel = "editor";
+exports.editorIpcStrings = {
+    channel: "editor",
+    commandBusy: "EditCommandBusy",
+};
 //# sourceMappingURL=EditorIpc.js.map

package/lib/cjs/EditorIpc.js.map

@@ -1 +1 @@
-{"version":3,"file":"EditorIpc.js","sourceRoot":"","sources":["../../src/EditorIpc.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gBAAgB;AACH,QAAA,aAAa,GAAG,QAAQ,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 Editing\r\n */\r\n\r\n/** @internal */\r\nexport const editorChannel = \"editor\";\r\n\r\n/** @alpha */\r\nexport interface EditorIpc {\r\n  startCommand: (commandId: string, iModelKey: string, ...args: any[]) => Promise<any>;\r\n  callMethod: (name: string, ...args: any[]) => Promise<any>;\r\n}\r\n\r\n/** @alpha */\r\nexport interface EditCommandIpc {\r\n  ping: () => Promise<{ commandId: string, version: string, [propName: string]: any }>;\r\n}\r\n"]}
+{"version":3,"file":"EditorIpc.js","sourceRoot":"","sources":["../../src/EditorIpc.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gBAAgB;AACH,QAAA,gBAAgB,GAAG;IAC9B,OAAO,EAAE,QAAQ;IACjB,WAAW,EAAE,iBAAiB;CACtB,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 Editing\r\n */\r\n\r\n/** @internal */\r\nexport const editorIpcStrings = {\r\n  channel: \"editor\",\r\n  commandBusy: \"EditCommandBusy\",\r\n} as const;\r\n\r\n/**\r\n * Interface called from frontend `EditTool`s to start and drive the active `EditCommand` on the backend.\r\n * @beta\r\n */\r\nexport interface EditorIpc {\r\n\r\n  /** Start a new instance of an `EditCommand` on the backend, and then call its `onStart` method.\r\n   * @param commandId the Id of a registered `EditCommand` on the backend. If commandId === \"\", the current command is\r\n   * requested to finish but no new EditCommand is started.\r\n   * @param iModelKey the key that identifies the iModel that the EditCommand modifies.\r\n   * @param args arguments passed to the constructor of the new `EditCommand`\r\n   * @return the value returned by the new `EditCommand`'s `onStart` method.\r\n   * @note The current `EditCommand` (if one is active) is asked to  finish and clean up its operation via `EditCommand.requestFinish`\r\n   * before the new `EditCommand` is constructed. If it cannot finish immediately, it may return a string that identifies\r\n   * the work it is performing for `EditTools.busyHandler` to retry and/or display.\r\n   */\r\n  startCommand: (commandId: string, iModelKey: string, ...args: any[]) => Promise<any>;\r\n\r\n  /** Call a method on the currently active `EditCommand` and return its value.\r\n   * @param name the name of the method to invoke.\r\n   * @param args arguments passed to the method.\r\n   * @note throws an exception if there is no active `EditCommand`, or if the active EditCommand does not implement the supplied method. */\r\n  callMethod: (name: string, ...args: any[]) => Promise<any>;\r\n}\r\n\r\n/**\r\n * Interface implemented by all backend `EditCommands`.\r\n * @beta\r\n */\r\nexport interface EditCommandIpc {\r\n  /** Identify the current `EditCommand`'s name and version, optionally returning additional properties that describe its state. */\r\n  ping: () => Promise<{ commandId: string, version: string, [propName: string]: any }>;\r\n}\r\n"]}

package/lib/esm/EditorIpc.d.ts

@@ -2,14 +2,38 @@
  * @module Editing
  */
 /** @internal */
-export declare const editorChannel = "editor";
-/** @alpha */
+export declare const editorIpcStrings: {
+    readonly channel: "editor";
+    readonly commandBusy: "EditCommandBusy";
+};
+/**
+ * Interface called from frontend `EditTool`s to start and drive the active `EditCommand` on the backend.
+ * @beta
+ */
 export interface EditorIpc {
+    /** Start a new instance of an `EditCommand` on the backend, and then call its `onStart` method.
+     * @param commandId the Id of a registered `EditCommand` on the backend. If commandId === "", the current command is
+     * requested to finish but no new EditCommand is started.
+     * @param iModelKey the key that identifies the iModel that the EditCommand modifies.
+     * @param args arguments passed to the constructor of the new `EditCommand`
+     * @return the value returned by the new `EditCommand`'s `onStart` method.
+     * @note The current `EditCommand` (if one is active) is asked to  finish and clean up its operation via `EditCommand.requestFinish`
+     * before the new `EditCommand` is constructed. If it cannot finish immediately, it may return a string that identifies
+     * the work it is performing for `EditTools.busyHandler` to retry and/or display.
+     */
     startCommand: (commandId: string, iModelKey: string, ...args: any[]) => Promise<any>;
+    /** Call a method on the currently active `EditCommand` and return its value.
+     * @param name the name of the method to invoke.
+     * @param args arguments passed to the method.
+     * @note throws an exception if there is no active `EditCommand`, or if the active EditCommand does not implement the supplied method. */
     callMethod: (name: string, ...args: any[]) => Promise<any>;
 }
-/** @alpha */
+/**
+ * Interface implemented by all backend `EditCommands`.
+ * @beta
+ */
 export interface EditCommandIpc {
+    /** Identify the current `EditCommand`'s name and version, optionally returning additional properties that describe its state. */
     ping: () => Promise<{
         commandId: string;
         version: string;

package/lib/esm/EditorIpc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EditorIpc.d.ts","sourceRoot":"","sources":["../../src/EditorIpc.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,gBAAgB;AAChB,eAAO,MAAM,aAAa,WAAW,CAAC;AAEtC,aAAa;AACb,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACrF,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC5D;AAED,aAAa;AACb,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAAC;CACtF"}
+{"version":3,"file":"EditorIpc.d.ts","sourceRoot":"","sources":["../../src/EditorIpc.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,gBAAgB;AAChB,eAAO,MAAM,gBAAgB;;;CAGnB,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,SAAS;IAExB;;;;;;;;;OASG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAErF;;;6IAGyI;IACzI,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC5D;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,iIAAiI;IACjI,IAAI,EAAE,MAAM,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAAC;CACtF"}

package/lib/esm/EditorIpc.js

@@ -6,5 +6,8 @@
  * @module Editing
  */
 /** @internal */
-export const editorChannel = "editor";
+export const editorIpcStrings = {
+    channel: "editor",
+    commandBusy: "EditCommandBusy",
+};
 //# sourceMappingURL=EditorIpc.js.map

package/lib/esm/EditorIpc.js.map

@@ -1 +1 @@
-{"version":3,"file":"EditorIpc.js","sourceRoot":"","sources":["../../src/EditorIpc.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,gBAAgB;AAChB,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,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 Editing\r\n */\r\n\r\n/** @internal */\r\nexport const editorChannel = \"editor\";\r\n\r\n/** @alpha */\r\nexport interface EditorIpc {\r\n  startCommand: (commandId: string, iModelKey: string, ...args: any[]) => Promise<any>;\r\n  callMethod: (name: string, ...args: any[]) => Promise<any>;\r\n}\r\n\r\n/** @alpha */\r\nexport interface EditCommandIpc {\r\n  ping: () => Promise<{ commandId: string, version: string, [propName: string]: any }>;\r\n}\r\n"]}
+{"version":3,"file":"EditorIpc.js","sourceRoot":"","sources":["../../src/EditorIpc.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,gBAAgB;AAChB,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,OAAO,EAAE,QAAQ;IACjB,WAAW,EAAE,iBAAiB;CACtB,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 Editing\r\n */\r\n\r\n/** @internal */\r\nexport const editorIpcStrings = {\r\n  channel: \"editor\",\r\n  commandBusy: \"EditCommandBusy\",\r\n} as const;\r\n\r\n/**\r\n * Interface called from frontend `EditTool`s to start and drive the active `EditCommand` on the backend.\r\n * @beta\r\n */\r\nexport interface EditorIpc {\r\n\r\n  /** Start a new instance of an `EditCommand` on the backend, and then call its `onStart` method.\r\n   * @param commandId the Id of a registered `EditCommand` on the backend. If commandId === \"\", the current command is\r\n   * requested to finish but no new EditCommand is started.\r\n   * @param iModelKey the key that identifies the iModel that the EditCommand modifies.\r\n   * @param args arguments passed to the constructor of the new `EditCommand`\r\n   * @return the value returned by the new `EditCommand`'s `onStart` method.\r\n   * @note The current `EditCommand` (if one is active) is asked to  finish and clean up its operation via `EditCommand.requestFinish`\r\n   * before the new `EditCommand` is constructed. If it cannot finish immediately, it may return a string that identifies\r\n   * the work it is performing for `EditTools.busyHandler` to retry and/or display.\r\n   */\r\n  startCommand: (commandId: string, iModelKey: string, ...args: any[]) => Promise<any>;\r\n\r\n  /** Call a method on the currently active `EditCommand` and return its value.\r\n   * @param name the name of the method to invoke.\r\n   * @param args arguments passed to the method.\r\n   * @note throws an exception if there is no active `EditCommand`, or if the active EditCommand does not implement the supplied method. */\r\n  callMethod: (name: string, ...args: any[]) => Promise<any>;\r\n}\r\n\r\n/**\r\n * Interface implemented by all backend `EditCommands`.\r\n * @beta\r\n */\r\nexport interface EditCommandIpc {\r\n  /** Identify the current `EditCommand`'s name and version, optionally returning additional properties that describe its state. */\r\n  ping: () => Promise<{ commandId: string, version: string, [propName: string]: any }>;\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/editor-common",
-  "version": "3.6.0-dev.8",
+  "version": "4.0.0-dev.2",
   "description": "iTwin.js editing properties common to frontend and backend",
   "main": "lib/cjs/editor-common.js",
   "module": "lib/esm/editor-common.js",
@@ -22,16 +22,16 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^3.6.0-dev.8",
-    "@itwin/core-geometry": "^3.6.0-dev.8",
-    "@itwin/core-common": "^3.6.0-dev.8"
+    "@itwin/core-bentley": "^4.0.0-dev.2",
+    "@itwin/core-geometry": "^4.0.0-dev.2",
+    "@itwin/core-common": "^4.0.0-dev.2"
   },
   "devDependencies": {
-    "@itwin/core-bentley": "3.6.0-dev.8",
-    "@itwin/build-tools": "3.6.0-dev.8",
-    "@itwin/eslint-plugin": "3.6.0-dev.8",
-    "@itwin/core-geometry": "3.6.0-dev.8",
-    "@itwin/core-common": "3.6.0-dev.8",
+    "@itwin/core-bentley": "4.0.0-dev.2",
+    "@itwin/build-tools": "4.0.0-dev.2",
+    "@itwin/eslint-plugin": "4.0.0-dev.2",
+    "@itwin/core-geometry": "4.0.0-dev.2",
+    "@itwin/core-common": "4.0.0-dev.2",
     "@types/chai": "4.3.1",
     "@types/mocha": "^8.2.2",
     "@types/node": "18.11.5",