@itwin/reports-config-widget-react 0.0.1

package/CHANGELOG.json

@@ -0,0 +1,17 @@
+{
+  "name": "@itwin/reports-config-widget-react",
+  "entries": [
+    {
+      "version": "0.0.1",
+      "tag": "@itwin/reports-config-widget-react_v0.0.1",
+      "date": "Tue, 14 Jun 2022 16:01:06 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Initial release of the reports config widget for Reporting Platform"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log - @itwin/reports-config-widget-react
+
+This log was last generated on Tue, 14 Jun 2022 16:01:06 GMT and should not be manually modified.
+
+## 0.0.1
+Tue, 14 Jun 2022 16:01:06 GMT
+
+### Patches
+
+- Initial release of the reports config widget for Reporting Platform
+

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,38 @@
+# @itwin/reports-config-widget-react
+
+Copyright © Bentley Systems, Incorporated. All rights reserved.
+The Reports Config 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 reports-config-widget package provides a UiProvider class - `ReportsConfigProvider` - 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 must have these additional scopes:
+
+- `insights:read`
+- `insights:modify`
+- `projects:read`
+
+In addition, 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. Further 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
+
+### Call ReportsConfigWidget.initialize() **_before_** making use of the provider
+
+```ts
+import { ReportsConfigWidget } from '@itwin/reports-config-widget-react'
+
+...
+
+await ReportsConfigWidget.initialize(IModelApp.localization);
+
+<Viewer
+  ...
+  uiProviders={[new ReportsConfigProvider()]}
+/>
+```

package/__mocks__/fileMock.js

@@ -0,0 +1,5 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+module.exports = {};