@itwin/reports-config-widget-react 0.0.1 → 0.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/reports-config-widget-react",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "An iTwin.js 3D Viewer Widget that interfaces with the iTwin Reporting Platform.",
   "keywords": [
     "Bentley",
@@ -12,7 +12,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/imodeljs/viewer-components-react/tree/master/packages/itwin/reports-config-widget-react"
+    "url": "https://github.com/imodeljs/viewer-components-react/tree/master/packages/itwin/reports-config-widget"
   },
   "license": "MIT",
   "author": {
@@ -120,5 +120,5 @@
     "test": "jest",
     "test:watch": "jest --watch "
   },
-  "readme": "# @itwin/reports-config-widget-react\r\n\r\nCopyright © Bentley Systems, Incorporated. All rights reserved.\r\nThe 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/).\r\nThe reports-config-widget package provides a UiProvider class - `ReportsConfigProvider` - which can be passed into the `uiProviders` prop of the iTwin Viewer's `<Viewer />` component.\r\n\r\n## Getting Started\r\n\r\nThis is not a standalone UI and requires a parent iTwin Viewer application to work as intended.\r\nA guide on how to create a basic iTwin Viewer application can be found here: <https://www.itwinjs.org/learning/tutorials/develop-web-viewer/>.\r\nThis 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>.\r\n\r\n## Permissions and Scopes\r\n\r\nThe SPA client used by your iTwin viewer must have these additional scopes:\r\n\r\n- `insights:read`\r\n- `insights:modify`\r\n- `projects:read`\r\n\r\nIn 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/).\r\n\r\n## Sample usage\r\n\r\n### Call ReportsConfigWidget.initialize() **_before_** making use of the provider\r\n\r\n```ts\r\nimport { ReportsConfigWidget } from '@itwin/reports-config-widget-react'\r\n\r\n...\r\n\r\nawait ReportsConfigWidget.initialize(IModelApp.localization);\r\n\r\n<Viewer\r\n  ...\r\n  uiProviders={[new ReportsConfigProvider()]}\r\n/>\r\n```\r\n"
+  "readme": "# @itwin/reports-config-widget-react\r\n\r\nCopyright © Bentley Systems, Incorporated. All rights reserved.\r\nThe 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/). This widget is one piece of the Reporting story that focuses on the configuration of Reports and the extraction thereof. It complements the [Grouping & Mapping Widget](https://www.npmjs.com/package/@itwin/grouping-mapping-widget).\r\nThe reports-config-widget-react package provides a UiProvider class - `ReportsConfigProvider` - which can be passed into the `uiProviders` prop of the iTwin Viewer's `<Viewer />` component.\r\n\r\n## Getting Started\r\n\r\nThis is not a standalone UI and requires a parent iTwin Viewer application to work as intended.\r\nA guide on how to create a basic iTwin Viewer application can be found here: <https://www.itwinjs.org/learning/tutorials/develop-web-viewer/>.\r\nThis 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>.\r\n\r\n## Permissions and Scopes\r\n\r\nThe SPA client used by your iTwin viewer must have these additional scopes:\r\n\r\n- `insights:read`\r\n- `insights:modify`\r\n- `projects:read`\r\n\r\nIn 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/).\r\n\r\n## Sample usage\r\n\r\n### Call ReportsConfigWidget.initialize() **_before_** making use of the provider\r\n\r\n```ts\r\nimport { ReportsConfigProvider, ReportsConfigWidget } from '@itwin/reports-config-widget-react'\r\n\r\n...\r\n\r\nawait ReportsConfigWidget.initialize(IModelApp.localization);\r\n\r\n<Viewer\r\n  ...\r\n  uiProviders={[new ReportsConfigProvider()]}\r\n/>\r\n```\r\n"
 }

package/reports-config-widget-react.build.error.log

@@ -1,10 +1,10 @@
-PASS src/test/ReportMappings.test.tsx (35.105 s)
-PASS src/test/Reports.test.tsx (8.612 s)
-PASS src/test/ReportAction.test.tsx (5.139 s)
+PASS src/test/ReportMappings.test.tsx (33.661 s)
+PASS src/test/Reports.test.tsx (7.992 s)
+PASS src/test/ReportAction.test.tsx
 PASS src/test/WidgetHeader.test.tsx
 
 Test Suites: 4 passed, 4 total
 Tests:       22 passed, 22 total
 Snapshots:   0 total
-Time:        52.605 s
+Time:        49.631 s
 Ran all test suites.

package/reports-config-widget-react.build.log

@@ -1,12 +1,12 @@
 Invoking: npm test -- --coverage 
 
 
-> @itwin/reports-config-widget-react@0.0.0 test /home/vsts/work/1/s/packages/itwin/reports-config-widget
+> @itwin/reports-config-widget-react@0.0.1 test /home/vsts/work/1/s/packages/itwin/reports-config-widget
 > jest "--coverage"
 
-PASS src/test/ReportMappings.test.tsx (35.105 s)
-PASS src/test/Reports.test.tsx (8.612 s)
-PASS src/test/ReportAction.test.tsx (5.139 s)
+PASS src/test/ReportMappings.test.tsx (33.661 s)
+PASS src/test/Reports.test.tsx (7.992 s)
+PASS src/test/ReportAction.test.tsx
 PASS src/test/WidgetHeader.test.tsx
 ------------------------------|---------|----------|---------|---------|-------------------------------
 File                          | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s             
@@ -41,5 +41,5 @@ All files                     |   87.72 |     70.3 |   86.32 |   87.64 |
 Test Suites: 4 passed, 4 total
 Tests:       22 passed, 22 total
 Snapshots:   0 total
-Time:        52.605 s
+Time:        49.631 s
 Ran all test suites.

package/src/test/ReportAction.test.tsx

@@ -113,7 +113,7 @@ describe("Reports Action", () => {
   it("should be able to add report", async () => {
     const mockReport: Report = {
       id: faker.datatype.uuid(),
-      displayName: faker.random.word(),
+      displayName: "mOcKRePoRt1",
       description: "",
       deleted: false,
       _links: {
@@ -150,8 +150,8 @@ describe("Reports Action", () => {
       name: /description/i,
     });
 
-    await userEvent.type(nameInput, faker.random.word());
-    await userEvent.type(descriptionInput, faker.random.words());
+    await userEvent.type(nameInput, "mOcKTeXt");
+    await userEvent.type(descriptionInput, "moCk DeScRiPtIoN");
     expect(cancelButton).toBeEnabled();
     expect(addButton).toBeEnabled();
 

package/src/test/ReportMappings.test.tsx

@@ -60,9 +60,9 @@ const mockIModelsResponse = [
   {
     iModel: {
       id: mockIModelId1,
-      displayName: faker.random.alpha(10),
-      name: faker.random.alpha(10),
-      description: faker.random.words(10),
+      displayName: "rAnDoMdIsPlAynAmE1",
+      name: "rAnDomName1",
+      description: "rAnDoMDeScRiPtIoN1",
       createdDateTime: "2021-10-04T22:13:50.397Z",
       state: IModelState.Initialized,
       projectId: mockITwinId,
@@ -83,9 +83,9 @@ const mockIModelsResponse = [
   {
     iModel: {
       id: mockIModelId2,
-      displayName: faker.random.alpha(10),
-      name: faker.random.alpha(10),
-      description: faker.random.words(10),
+      displayName: "rAnDoMdIsPlAynAmE2",
+      name: "rAnDomName2",
+      description: "rAnDoMDeScRiPtIoN2",
       createdDateTime: "2021-10-04T22:13:50.397Z",
       state: IModelState.Initialized,
       projectId: mockITwinId,
@@ -121,8 +121,8 @@ const mockProjectIModels = {
 
 const mockReport: Report = {
   id: mockReportId,
-  displayName: faker.random.alpha(10),
-  description: faker.random.words(10),
+  displayName: "mOcKRePoRt1",
+  description: "mOcKRePoRtDeScRiPtIoN1",
   deleted: false,
   _links: {
     project: {
@@ -180,11 +180,11 @@ const mockMappingsFactory = (
   mockReportMappings: ReportMappingCollection
 ): [MappingSingle[], RequestHandler[]] => {
   const mockMappings: MappingSingle[] = mockReportMappings.mappings!.map(
-    (mapping) => ({
+    (mapping, index) => ({
       mapping: {
         id: mapping.mappingId,
-        mappingName: faker.random.alpha(10),
-        description: faker.random.words(10),
+        mappingName: `mOcKMaPpIngNaMe${index}`,
+        description: `mOcKmApPInGDeScRiPtIoN${index}`,
         extractionEnabled: false,
         createdOn: "",
         createdBy: "",
@@ -509,13 +509,14 @@ describe("Report Mappings View", () => {
 
     // Adding an extra unmapped mapping.
     const extraMappingId = faker.datatype.uuid();
-    const extraMappingName = faker.random.alpha(10);
+    const extraMappingName = "mOcKNaMeExTrA";
+    const extraMappingDescription = "mOcKDeScRiPtIoNeXtRa";
 
     mockMappings.push({
       mapping: {
         id: extraMappingId,
         mappingName: extraMappingName,
-        description: faker.random.words(10),
+        description: extraMappingDescription,
         extractionEnabled: false,
         createdOn: "",
         createdBy: "",

package/src/test/Reports.test.tsx

@@ -42,10 +42,10 @@ const mockIModelId = faker.datatype.uuid();
 const reportsFactory = (): ReportCollection => ({
   reports: Array.from(
     { length: faker.datatype.number({ min: 3, max: 5 }) },
-    () => ({
+    (_, index) => ({
       id: `${faker.datatype.uuid()}`,
-      displayName: faker.random.alpha(10),
-      description: faker.random.words(10),
+      displayName: `mOcKRePoRT${index}`,
+      description: `mOcKRePoRTDeScRiPtIoN${index}`,
     })
   ),
   _links: {