@itwin/unified-selection 0.1.0 → 0.3.0

package/lib/esm/unified-selection/types/IModel.js

@@ -0,0 +1,21 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * Identifies the type of changes made to the `CoreIModelSelectionSet` to produce a `CoreSelectionSetEvent`.
+ * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/
+ * @internal
+ */
+export var CoreSelectionSetEventType;
+(function (CoreSelectionSetEventType) {
+    /** Elements have been added to the set. */
+    CoreSelectionSetEventType[CoreSelectionSetEventType["Add"] = 0] = "Add";
+    /** Elements have been removed from the set. */
+    CoreSelectionSetEventType[CoreSelectionSetEventType["Remove"] = 1] = "Remove";
+    /** Some elements have been added to the set and others have been removed. */
+    CoreSelectionSetEventType[CoreSelectionSetEventType["Replace"] = 2] = "Replace";
+    /** All elements are about to be removed from the set. */
+    CoreSelectionSetEventType[CoreSelectionSetEventType["Clear"] = 3] = "Clear";
+})(CoreSelectionSetEventType || (CoreSelectionSetEventType = {}));
+//# sourceMappingURL=IModel.js.map

package/lib/esm/unified-selection/types/IModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModel.js","sourceRoot":"","sources":["../../../../src/unified-selection/types/IModel.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAKhG;;;;GAIG;AACH,MAAM,CAAN,IAAY,yBASX;AATD,WAAY,yBAAyB;IACnC,2CAA2C;IAC3C,uEAAG,CAAA;IACH,+CAA+C;IAC/C,6EAAM,CAAA;IACN,6EAA6E;IAC7E,+EAAO,CAAA;IACP,yDAAyD;IACzD,2EAAK,CAAA;AACP,CAAC,EATW,yBAAyB,KAAzB,yBAAyB,QASpC","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\nimport { Id64Arg } from \"@itwin/core-bentley\";\nimport { Event } from \"@itwin/presentation-shared\";\n\n/**\n * Identifies the type of changes made to the `CoreIModelSelectionSet` to produce a `CoreSelectionSetEvent`.\n * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/\n * @internal\n */\nexport enum CoreSelectionSetEventType {\n  /** Elements have been added to the set. */\n  Add,\n  /** Elements have been removed from the set. */\n  Remove,\n  /** Some elements have been added to the set and others have been removed. */\n  Replace,\n  /** All elements are about to be removed from the set. */\n  Clear,\n}\n\n/**\n * Payload sent to `CoreIModelSelectionSet.onChanged` event listeners to describe how the contents of the set have changed.\n * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionsetevent/\n * @internal\n */\nexport interface CoreSelectionSetEventUnsafe {\n  /**\n   * The type of operation that produced this event.\n   *\n   * Actually, this should be `CoreSelectionSetEventType`, however we can't use it here because in TS two identical enums with\n   * different names aren't equal, so [`SelectionSetEventType `](https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/)\n   * doesn't map to `CoreSelectionSetEventType` as far as TS is concerned. Due to this reason, this interface is marked as `unsafe`.\n   */\n  type: number;\n  /** The element Ids added to the set. */\n  added?: Id64Arg;\n  /** The element Ids removed from the set. */\n  removed?: Id64Arg;\n  /** The affected `CoreIModelSelectionSet`. */\n  set: CoreIModelSelectionSet;\n}\n\n/**\n * A set of *currently selected* elements in an iModel.\n * @see https://www.itwinjs.org/reference/core-frontend/selectionset/\n * @internal\n */\nexport interface CoreIModelSelectionSet {\n  /** Event called whenever elements are added or removed from this SelectionSet. */\n  onChanged: Event<(ev: CoreSelectionSetEventUnsafe) => void>;\n  /** The IDs of the selected elements. */\n  readonly elements: Set<string>;\n  /** Clear current selection set. */\n  emptyAll(): void;\n  /** Add one or more Ids to the current selection set. */\n  add(elem: Id64Arg): boolean;\n  /** Remove one or more Ids from the current selection set. */\n  remove(elem: Id64Arg): boolean;\n}\n\n/**\n * A set if ID's optimized for performance-critical code which represents large sets of ID's as pairs of 32-bit integers.\n * @see https://www.itwinjs.org/reference/core-bentley/ids/id64/id64.uint32set/\n */\ninterface Uint32Set {\n  /** Add any number of Ids to the set. */\n  addIds(ids: Id64Arg): void;\n  /** Remove any number of Ids from the set. */\n  deleteIds(ids: Id64Arg): void;\n}\n\n/**\n * A set of *hilited* elements in an iModel, by element id.\n * @see https://www.itwinjs.org/reference/core-frontend/selectionset/hiliteset/\n * @internal\n */\nexport interface CoreIModelHiliteSet {\n  /** Control whether the hilited elements should be synchronized with the contents of `CoreIModelSelectionSet`.*/\n  wantSyncWithSelectionSet: boolean;\n  /** The set of hilited elements. */\n  readonly elements: Uint32Set;\n  /** The set of hilited subcategories. */\n  readonly subcategories: Uint32Set;\n  /** The set of hilited models. */\n  readonly models: Uint32Set;\n  /** Remove all elements from the hilited set. */\n  clear(): void;\n}\n"]}

package/lib/esm/unified-selection.d.ts

@@ -1,10 +1,8 @@
-/**
- * @module UnifiedSelection
- *
- * @docs-group-description UnifiedSelection
- * API for working with unified selection.
- */
 export * from "./unified-selection/Selectable";
-export * from "./unified-selection/SelectionStorage";
+export { SelectionStorage, createStorage } from "./unified-selection/SelectionStorage";
+export { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from "./unified-selection/HiliteSetProvider";
+export { createCachingHiliteSetProvider, CachingHiliteSetProvider } from "./unified-selection/CachingHiliteSetProvider";
+export { computeSelection } from "./unified-selection/SelectionScope";
+export { enableUnifiedSelectionSyncWithIModel } from "./unified-selection/EnableUnifiedSelectionSyncWithIModel";
 export { StorageSelectionChangeType, StorageSelectionChangeEventArgs, StorageSelectionChangesListener, SelectionChangeEvent, } from "./unified-selection/SelectionChangeEvent";
 //# sourceMappingURL=unified-selection.d.ts.map

package/lib/esm/unified-selection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unified-selection.d.ts","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,+BAA+B,EAC/B,oBAAoB,GACrB,MAAM,0CAA0C,CAAC"}
+{"version":3,"file":"unified-selection.d.ts","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAKA,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,oCAAoC,EAAE,MAAM,0DAA0D,CAAC;AAChH,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,+BAA+B,EAC/B,oBAAoB,GACrB,MAAM,0CAA0C,CAAC"}

package/lib/esm/unified-selection.js

@@ -2,12 +2,10 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-/**
- * @module UnifiedSelection
- *
- * @docs-group-description UnifiedSelection
- * API for working with unified selection.
- */
 export * from "./unified-selection/Selectable";
-export * from "./unified-selection/SelectionStorage";
+export { createStorage } from "./unified-selection/SelectionStorage";
+export { createHiliteSetProvider } from "./unified-selection/HiliteSetProvider";
+export { createCachingHiliteSetProvider } from "./unified-selection/CachingHiliteSetProvider";
+export { computeSelection } from "./unified-selection/SelectionScope";
+export { enableUnifiedSelectionSyncWithIModel } from "./unified-selection/EnableUnifiedSelectionSyncWithIModel";
 //# sourceMappingURL=unified-selection.js.map

package/lib/esm/unified-selection.js.map

@@ -1 +1 @@
-{"version":3,"file":"unified-selection.js","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;;;;GAKG;AACH,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,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\n/**\n * @module UnifiedSelection\n *\n * @docs-group-description UnifiedSelection\n * API for working with unified selection.\n */\nexport * from \"./unified-selection/Selectable\";\nexport * from \"./unified-selection/SelectionStorage\";\nexport {\n  StorageSelectionChangeType,\n  StorageSelectionChangeEventArgs,\n  StorageSelectionChangesListener,\n  SelectionChangeEvent,\n} from \"./unified-selection/SelectionChangeEvent\";\n"]}
+{"version":3,"file":"unified-selection.js","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAoB,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAgC,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EAAE,8BAA8B,EAA4B,MAAM,8CAA8C,CAAC;AACxH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,oCAAoC,EAAE,MAAM,0DAA0D,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\nexport * from \"./unified-selection/Selectable\";\nexport { SelectionStorage, createStorage } from \"./unified-selection/SelectionStorage\";\nexport { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from \"./unified-selection/HiliteSetProvider\";\nexport { createCachingHiliteSetProvider, CachingHiliteSetProvider } from \"./unified-selection/CachingHiliteSetProvider\";\nexport { computeSelection } from \"./unified-selection/SelectionScope\";\nexport { enableUnifiedSelectionSyncWithIModel } from \"./unified-selection/EnableUnifiedSelectionSyncWithIModel\";\nexport {\n  StorageSelectionChangeType,\n  StorageSelectionChangeEventArgs,\n  StorageSelectionChangesListener,\n  SelectionChangeEvent,\n} from \"./unified-selection/SelectionChangeEvent\";\n"]}

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@itwin/unified-selection",
-  "version": "0.1.0",
-  "description": "Package for managing unified selection",
+  "version": "0.3.0",
+  "description": "Package for managing unified selection in iTwin.js applications.",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/iTwin/presentation.git",
@@ -9,9 +10,15 @@
   },
   "keywords": [
     "Bentley",
-    "EC",
-    "Unified selection",
-    "iTwin.js"
+    "Highlight",
+    "Hilite",
+    "iTwin.js",
+    "Presentation",
+    "Selection",
+    "Selection level",
+    "Selection scope",
+    "Selection storage",
+    "Unified selection"
   ],
   "author": {
     "name": "Bentley Systems, Inc.",
@@ -20,26 +27,32 @@
   "main": "lib/cjs/unified-selection.js",
   "module": "lib/esm/unified-selection.js",
   "types": "lib/cjs/unified-selection.d.ts",
-  "dependencies": {},
+  "dependencies": {
+    "@itwin/core-bentley": "^4.5.2",
+    "rxjs": "^7.8.1",
+    "rxjs-for-await": "^1.0.0",
+    "@itwin/presentation-shared": "^0.1.0"
+  },
   "devDependencies": {
-    "@itwin/build-tools": "^4.4.0",
-    "@itwin/eslint-plugin": "4.0.0-dev.48",
-    "@types/chai": "^4.3.11",
+    "@itwin/build-tools": "^4.5.2",
+    "@itwin/eslint-plugin": "^4.0.0",
+    "@types/chai": "^4.3.14",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^18.17.7",
+    "@types/node": "^18.19.31",
     "@types/sinon": "^17.0.3",
     "@types/sinon-chai": "^3.2.12",
     "chai": "^4.4.1",
     "chai-as-promised": "^7.1.1",
     "cpx2": "^7.0.1",
-    "eslint": "^8.56.0",
-    "mocha": "^10.3.0",
+    "eslint": "^8.57.0",
+    "mocha": "^10.4.0",
     "nyc": "^15.1.0",
+    "rimraf": "^5.0.5",
     "sinon": "^17.0.1",
     "sinon-chai": "^3.7.0",
-    "source-map-support": "^0.5.21",
-    "typescript": "~5.0.4"
+    "typescript": "~5.4.5",
+    "presentation-test-utilities": "^0.0.0"
   },
   "scripts": {
     "build": "npm run -s build:cjs && npm run -s build:esm",
@@ -49,7 +62,7 @@
     "clean": "rimraf lib build",
     "cover": "nyc npm -s test",
     "lint": "eslint ./src/**/*.ts",
-    "test": "mocha --config ./.mocharc.json \"./lib/cjs/test/**/*.test.js\"",
+    "test": "mocha --enable-source-maps --config ./.mocharc.json \"./lib/cjs/test/**/*.test.js\"",
     "test:watch": "npm -s test -- --reporter min --watch-extensions ts --watch",
     "extract-api": "betools extract-api --entry=unified-selection --apiReportFolder=./api --apiReportTempFolder=./api/temp --apiSummaryFolder=./api",
     "check-internal": "node ../../scripts/checkInternal.js --apiSummary ./api/unified-selection.api.md"