@itwin/editor-common 4.1.0-dev.6 → 4.1.0-dev.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/cjs/EditorIpc.d.ts
CHANGED
package/lib/cjs/EditorIpc.js
CHANGED
|
@@ -10,7 +10,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
10
10
|
exports.editorIpcStrings = void 0;
|
|
11
11
|
/** @internal */
|
|
12
12
|
exports.editorIpcStrings = {
|
|
13
|
-
channel: "editor",
|
|
13
|
+
channel: "itwinjs-core/editor",
|
|
14
14
|
commandBusy: "EditCommandBusy",
|
|
15
15
|
};
|
|
16
16
|
//# sourceMappingURL=EditorIpc.js.map
|
package/lib/cjs/EditorIpc.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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,
|
|
1
|
+
{"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,qBAAqB;IAC9B,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: \"itwinjs-core/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
CHANGED
package/lib/esm/EditorIpc.js
CHANGED
package/lib/esm/EditorIpc.js.map
CHANGED
|
@@ -1 +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,gBAAgB,GAAG;IAC9B,OAAO,EAAE,
|
|
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,gBAAgB,GAAG;IAC9B,OAAO,EAAE,qBAAqB;IAC9B,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: \"itwinjs-core/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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itwin/editor-common",
|
|
3
|
-
"version": "4.1.0-dev.
|
|
3
|
+
"version": "4.1.0-dev.8",
|
|
4
4
|
"description": "iTwin.js editing properties common to frontend and backend",
|
|
5
5
|
"main": "lib/cjs/editor-common.js",
|
|
6
6
|
"module": "lib/esm/editor-common.js",
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
"url": "http://www.bentley.com"
|
|
24
24
|
},
|
|
25
25
|
"peerDependencies": {
|
|
26
|
-
"@itwin/core-bentley": "^4.1.0-dev.
|
|
27
|
-
"@itwin/core-geometry": "^4.1.0-dev.
|
|
28
|
-
"@itwin/core-common": "^4.1.0-dev.
|
|
26
|
+
"@itwin/core-bentley": "^4.1.0-dev.8",
|
|
27
|
+
"@itwin/core-geometry": "^4.1.0-dev.8",
|
|
28
|
+
"@itwin/core-common": "^4.1.0-dev.8"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
31
|
"@itwin/eslint-plugin": "^4.0.0-dev.33",
|
|
@@ -37,10 +37,10 @@
|
|
|
37
37
|
"mocha": "^10.0.0",
|
|
38
38
|
"rimraf": "^3.0.2",
|
|
39
39
|
"typescript": "~5.0.2",
|
|
40
|
-
"@itwin/core-bentley": "4.1.0-dev.
|
|
41
|
-
"@itwin/build-tools": "4.1.0-dev.
|
|
42
|
-
"@itwin/core-geometry": "4.1.0-dev.
|
|
43
|
-
"@itwin/core-common": "4.1.0-dev.
|
|
40
|
+
"@itwin/core-bentley": "4.1.0-dev.8",
|
|
41
|
+
"@itwin/build-tools": "4.1.0-dev.8",
|
|
42
|
+
"@itwin/core-geometry": "4.1.0-dev.8",
|
|
43
|
+
"@itwin/core-common": "4.1.0-dev.8"
|
|
44
44
|
},
|
|
45
45
|
"eslintConfig": {
|
|
46
46
|
"plugins": [
|