@itwin/grouping-mapping-widget 0.2.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2022 Bentley Systems, Inc. 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,26 @@
+# @itwin/grouping-mapping-widget
+
+Copyright © Bentley Systems, Incorporated. All rights reserved.
+The Grouping Mapping widget is a UI component for iTwin Viewer applications that simplifies how users (and developers) interface with the [Reporting Platform APIs](https://developer.bentley.com/apis/insights/overview/).
+The grouping-mapping-widget package provides a UiProvider class - `GroupingMappingProvider` - which can be passed into the `uiProviders` prop of the iTwin Viewer's `<Viewer />` component.
+
+## Getting Started
+
+This is not a standalone UI and requires a parent iTwin Viewer application to work as intended.
+A guide on how to create a basic iTwin Viewer application can be found here: <https://www.itwinjs.org/learning/tutorials/develop-web-viewer/>.
+This package provides a viewer 'widget'. Documentation on how to add a widget to your application can be found here: <https://developer.bentley.com/tutorials/itwin-viewer-hello-world/#2-your-first-ui-widget>.
+
+## Permissions and Scopes
+
+The SPA client used by your iTwin viewer application must have allowed scopes `insights:read` and `insights:write`, found under the Reporting & Insights category.
+Users must have the `imodels_read` and `imodels_write` [permissions](https://developer.bentley.com/apis/insights/operations/create-mapping/#authorization) assigned at either the Project or iModel level. Additional instruction on how to create roles and assign permissions can be found in the [iTwin Platform Projects API documentation](https://developer.bentley.com/apis/projects/tutorials/).
+
+## Sample usage
+
+```tsx
+import { GroupingMappingProvider } from "@itwin/grouping-mapping-widget";
+<Viewer
+  ...
+  uiProviders={[new GroupingMappingProvider()]}
+/>
+```

package/lib/cjs/api/GroupQueryBuilderApi.d.ts

@@ -0,0 +1,15 @@
+import type { KeySet } from "@itwin/presentation-common";
+import type { SelectionChangesListener } from "@itwin/presentation-frontend";
+import { PresentationPropertyDataProvider } from "@itwin/presentation-components";
+import type { IModelConnection } from "@itwin/core-frontend";
+export interface PropertyProps {
+    keys: KeySet;
+    imodel?: IModelConnection;
+}
+export declare class GroupQueryBuilderApi {
+    private static selectionListener;
+    static addSelectionListener(listener: SelectionChangesListener): void;
+    static removeSelectionListener(): void;
+    static createPropertyDataProvider(keys: KeySet, imodel: IModelConnection): PresentationPropertyDataProvider;
+}
+//# sourceMappingURL=GroupQueryBuilderApi.d.ts.map

package/lib/cjs/api/GroupQueryBuilderApi.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupQueryBuilderApi = void 0;
+const presentation_frontend_1 = require("@itwin/presentation-frontend");
+const presentation_components_1 = require("@itwin/presentation-components");
+/* This class demonstrates the key APIs needed to access formatted property information
+   suitable to present to end users. */
+class GroupQueryBuilderApi {
+    static addSelectionListener(listener) {
+        this.selectionListener = listener;
+        presentation_frontend_1.Presentation.selection.selectionChange.addListener(this.selectionListener);
+    }
+    static removeSelectionListener() {
+        presentation_frontend_1.Presentation.selection.selectionChange.removeListener(this.selectionListener);
+    }
+    static createPropertyDataProvider(keys, imodel) {
+        const dataProvider = new presentation_components_1.PresentationPropertyDataProvider({
+            imodel,
+            ruleset: presentation_components_1.DEFAULT_PROPERTY_GRID_RULESET,
+        });
+        dataProvider.keys = keys;
+        dataProvider.isNestedPropertyCategoryGroupingEnabled = true;
+        return dataProvider;
+    }
+}
+exports.GroupQueryBuilderApi = GroupQueryBuilderApi;
+//# sourceMappingURL=GroupQueryBuilderApi.js.map

package/lib/cjs/api/GroupQueryBuilderApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupQueryBuilderApi.js","sourceRoot":"","sources":["../../../src/api/GroupQueryBuilderApi.ts"],"names":[],"mappings":";;;AAOA,wEAEsC;AACtC,4EAGwC;AAQxC;uCACuC;AACvC,MAAa,oBAAoB;IAGxB,MAAM,CAAC,oBAAoB,CAAC,QAAkC;QACnE,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QAClC,oCAAY,CAAC,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,uBAAuB;QACnC,oCAAY,CAAC,SAAS,CAAC,eAAe,CAAC,cAAc,CACnD,IAAI,CAAC,iBAAiB,CACvB,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,0BAA0B,CACtC,IAAY,EACZ,MAAwB;QAExB,MAAM,YAAY,GAAG,IAAI,0DAAgC,CAAC;YACxD,MAAM;YACN,OAAO,EAAE,uDAA6B;SACvC,CAAC,CAAC;QACH,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;QACzB,YAAY,CAAC,uCAAuC,GAAG,IAAI,CAAC;QAC5D,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AA1BD,oDA0BC","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*--------------------------------------------------------------------------------------------*/\nimport type { KeySet } from \"@itwin/presentation-common\";\nimport type {\n  SelectionChangesListener} from \"@itwin/presentation-frontend\";\nimport {\n  Presentation,\n} from \"@itwin/presentation-frontend\";\nimport {\n  DEFAULT_PROPERTY_GRID_RULESET,\n  PresentationPropertyDataProvider,\n} from \"@itwin/presentation-components\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\n\nexport interface PropertyProps {\n  keys: KeySet;\n  imodel?: IModelConnection;\n}\n\n/* This class demonstrates the key APIs needed to access formatted property information\n   suitable to present to end users. */\nexport class GroupQueryBuilderApi {\n  private static selectionListener: SelectionChangesListener;\n\n  public static addSelectionListener(listener: SelectionChangesListener) {\n    this.selectionListener = listener;\n    Presentation.selection.selectionChange.addListener(this.selectionListener);\n  }\n\n  public static removeSelectionListener() {\n    Presentation.selection.selectionChange.removeListener(\n      this.selectionListener,\n    );\n  }\n\n  public static createPropertyDataProvider(\n    keys: KeySet,\n    imodel: IModelConnection,\n  ) {\n    const dataProvider = new PresentationPropertyDataProvider({\n      imodel,\n      ruleset: DEFAULT_PROPERTY_GRID_RULESET,\n    });\n    dataProvider.keys = keys;\n    dataProvider.isNestedPropertyCategoryGroupingEnabled = true;\n    return dataProvider;\n  }\n}\n"]}