@itwin/reports-config-widget-react 0.4.0 → 0.6.0

package/CHANGELOG.json

@@ -1,6 +1,67 @@
 {
   "name": "@itwin/reports-config-widget-react",
   "entries": [
+    {
+      "date": "Mon, 10 Jun 2024 17:40:08 GMT",
+      "version": "0.6.0",
+      "tag": "@itwin/reports-config-widget-react_v0.6.0",
+      "comments": {
+        "patch": [
+          {
+            "author": "Guillar1@users.noreply.github.com",
+            "package": "@itwin/reports-config-widget-react",
+            "commit": "5afd6004849184a8a417df306e956af6d5eca51b",
+            "comment": "Fixed an issue that caused the extraction state for the mappings in the ReportMappings component to keep appearing after every rerender while in a final state."
+          }
+        ],
+        "none": [
+          {
+            "author": "hansraj.koravenciah@bentley.com",
+            "package": "@itwin/reports-config-widget-react",
+            "commit": "36c49a556b4c99a4203d243fcb44581ec80ee9fb",
+            "comment": "Ran prettier on ec3, lca, reportconfig and reportmapping widgets"
+          }
+        ],
+        "minor": [
+          {
+            "author": "hansraj.koravenciah@bentley.com",
+            "package": "@itwin/reports-config-widget-react",
+            "commit": "fb68ffda26c43a99920e14d53d4d0a70c9a79c38",
+            "comment": "Upgraded insights-client version to 0.10.1, fixed functions using old dependencies"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 21 May 2024 13:26:36 GMT",
+      "version": "0.5.0",
+      "tag": "@itwin/reports-config-widget-react_v0.5.0",
+      "comments": {
+        "none": [
+          {
+            "author": "Guillar1@users.noreply.github.com",
+            "package": "@itwin/reports-config-widget-react",
+            "commit": "60fe54a19b5a2d8354163b137da975cd27be8489",
+            "comment": ""
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 29 Jan 2024 21:37:20 GMT",
+      "version": "0.5.0",
+      "tag": "@itwin/reports-config-widget-react_v0.5.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "Guillar1@users.noreply.github.com",
+            "package": "@itwin/reports-config-widget-react",
+            "commit": "4d4f9d3fc3641ed87537be729e5fffd7312c4402",
+            "comment": "Updated iModels client"
+          }
+        ]
+      }
+    },
     {
       "version": "0.4.0",
       "tag": "@itwin/reports-config-widget-react_v0.4.0",

package/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Change Log - @itwin/reports-config-widget-react
 
-This log was last generated on Thu, 17 Aug 2023 14:42:37 GMT and should not be manually modified.
+This log was last generated on Mon, 10 Jun 2024 17:40:08 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.6.0
+
+Mon, 10 Jun 2024 17:40:08 GMT
+
+### Minor changes
+
+- Upgraded insights-client version to 0.10.1, fixed functions using old dependencies ([#841](https://github.com/iTwin/viewer-components-react/pull/841))
+
+### Patches
+
+- Fixed an issue that caused the extraction state for the mappings in the ReportMappings component to keep appearing after every rerender while in a final state. ([#866](https://github.com/iTwin/viewer-components-react/pull/866))
+
+## 0.5.0
+
+Mon, 29 Jan 2024 21:37:20 GMT
+
+### Minor changes
+
+- Updated iModels client ([#747](https://github.com/iTwin/viewer-components-react/pull/747))
 
 ## 0.4.0
 Thu, 17 Aug 2023 14:42:37 GMT
@@ -106,4 +128,3 @@ Tue, 14 Jun 2022 16:01:06 GMT
 ### Patches
 
 - Initial release of the reports config widget for Reporting Platform
-

package/LICENSE.md

@@ -1,9 +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.
+# 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

@@ -1,38 +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/). 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).
-The 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.
-
-## 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 { ReportsConfigProvider, ReportsConfigWidget } from '@itwin/reports-config-widget-react'
-
-...
-
-await ReportsConfigWidget.initialize(IModelApp.localization);
-
-<Viewer
-  ...
-  uiProviders={[new ReportsConfigProvider()]}
-/>
-```
+# @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/). 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).
+The 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.
+
+## 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 { ReportsConfigProvider, ReportsConfigWidget } from '@itwin/reports-config-widget-react'
+
+...
+
+await ReportsConfigWidget.initialize(IModelApp.localization);
+
+<Viewer
+  ...
+  uiProviders={[new ReportsConfigProvider()]}
+/>
+```

package/__mocks__/fileMock.js

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

package/api/reports-config-widget-react.api.md

@@ -0,0 +1,130 @@
+## API Report File for "@itwin/reports-config-widget-react"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import type { AccessToken } from '@itwin/core-bentley';
+import { ExtractionClient } from '@itwin/insights-client';
+import type { ExtractionRequestDetails } from '@itwin/insights-client';
+import { IModelsClient } from '@itwin/imodels-client-management';
+import type { Localization } from '@itwin/core-common';
+import { MappingsClient } from '@itwin/insights-client';
+import { default as React_2 } from 'react';
+import type { Report } from '@itwin/insights-client';
+import { ReportsClient } from '@itwin/insights-client';
+import { StagePanelLocation } from '@itwin/appui-react';
+import { StagePanelSection } from '@itwin/appui-react';
+import type { UiItemsProvider } from '@itwin/appui-react';
+import type { Widget } from '@itwin/appui-react';
+
+// @public (undocumented)
+export class BulkExtractor {
+    constructor(reportsClient: ReportsClient, extractionClient: ExtractionClient, getAccessToken: () => Promise<AccessToken>, successfulExtractionToast: (iModelName: string, odataFeedUrl: string) => void, failedExtractionToast: (iModelName: string) => void);
+    // (undocumented)
+    getIModelState(iModelId: string, iModelName: string, odataFeedUrl: string): Promise<ExtractionStates>;
+    // (undocumented)
+    getReportState(reportId: string): Promise<ExtractionStates>;
+    // (undocumented)
+    runIModelExtraction(extractionRequestDetails: ExtractionRequestDetails): Promise<void>;
+    // (undocumented)
+    runIModelExtractions(extractionRequestsDetails: ExtractionRequestDetails[]): Promise<void>;
+    // (undocumented)
+    runReportExtractions(reportIds: string[]): Promise<void>;
+    // (undocumented)
+    setHook(setJobRunning: React.Dispatch<React.SetStateAction<boolean>>, iModels: string[]): void;
+}
+
+// @public
+export const ReportAction: ({ report, onSaveSuccess, onClickCancel }: ReportActionProps) => JSX.Element;
+
+// @public
+export interface ReportActionProps {
+    // (undocumented)
+    onClickCancel?: () => void;
+    // (undocumented)
+    onSaveSuccess: () => void;
+    // (undocumented)
+    report?: Report;
+}
+
+// @public
+export const ReportMappings: ({ report, onClickClose, defaultIModelId }: ReportMappingsProps) => JSX.Element | null;
+
+// @public
+export interface ReportMappingsProps {
+    // (undocumented)
+    defaultIModelId?: string;
+    // (undocumented)
+    onClickClose: () => void;
+    // (undocumented)
+    report: Report;
+}
+
+// @public
+export const Reports: ({ onClickAddReport, onClickReportModify, onClickReportTitle }: ReportsProps) => JSX.Element | null;
+
+// @internal (undocumented)
+export const REPORTS_CONFIG_BASE_URL = "https://api.bentley.com";
+
+// @public
+export const ReportsConfigContext: (props: ReportsConfigContextProps) => JSX.Element;
+
+// @public
+export interface ReportsConfigContextProps {
+    // (undocumented)
+    baseUrl?: string;
+    // (undocumented)
+    bulkExtractor?: BulkExtractor;
+    // (undocumented)
+    children?: React_2.ReactNode;
+    // (undocumented)
+    extractionClient?: ExtractionClient;
+    // (undocumented)
+    getAccessToken?: GetAccessTokenFn;
+    // (undocumented)
+    iModelsClient?: IModelsClient;
+    // (undocumented)
+    iTwinId: string;
+    // (undocumented)
+    mappingsClient?: MappingsClient;
+    // (undocumented)
+    reportsClient?: ReportsClient;
+}
+
+// @public
+export class ReportsConfigProvider implements UiItemsProvider {
+    constructor(getAccessToken?: () => Promise<AccessToken>, baseUrl?: string);
+    // (undocumented)
+    readonly id = "ReportsConfigProvider";
+    // (undocumented)
+    provideWidgets(_stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<Widget>;
+}
+
+// @public
+export class ReportsConfigWidget {
+    // (undocumented)
+    static initialize(localization?: Localization): Promise<void>;
+    // (undocumented)
+    static get localization(): Localization;
+    // (undocumented)
+    static get localizationNamespace(): string;
+    // (undocumented)
+    static terminate(): void;
+}
+
+// @public
+export interface ReportsProps {
+    // (undocumented)
+    onClickAddReport?: () => void;
+    // (undocumented)
+    onClickReportModify?: (report: Report) => void;
+    // (undocumented)
+    onClickReportTitle?: (report: Report) => void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api/reports-config-widget-react.exports.csv

@@ -0,0 +1,14 @@
+sep=;
+Release Tag;API Item
+public;BulkExtractor
+public;ReportAction: ({ report, onSaveSuccess, onClickCancel }: ReportActionProps) => JSX.Element
+public;ReportActionProps
+public;ReportMappings: ({ report, onClickClose, defaultIModelId }: ReportMappingsProps) => JSX.Element | null
+public;ReportMappingsProps
+public;Reports: ({ onClickAddReport, onClickReportModify, onClickReportTitle }: ReportsProps) => JSX.Element | null
+internal;REPORTS_CONFIG_BASE_URL = "https://api.bentley.com"
+public;ReportsConfigContext: (props: ReportsConfigContextProps) => JSX.Element
+public;ReportsConfigContextProps
+public;ReportsConfigProvider
+public;ReportsConfigWidget
+public;ReportsProps

package/api/temp/reports-config-widget-react.api.md

@@ -0,0 +1,130 @@
+## API Report File for "@itwin/reports-config-widget-react"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import type { AccessToken } from '@itwin/core-bentley';
+import { ExtractionClient } from '@itwin/insights-client';
+import type { ExtractionRequestDetails } from '@itwin/insights-client';
+import { IModelsClient } from '@itwin/imodels-client-management';
+import type { Localization } from '@itwin/core-common';
+import { MappingsClient } from '@itwin/insights-client';
+import { default as React_2 } from 'react';
+import type { Report } from '@itwin/insights-client';
+import { ReportsClient } from '@itwin/insights-client';
+import { StagePanelLocation } from '@itwin/appui-react';
+import { StagePanelSection } from '@itwin/appui-react';
+import type { UiItemsProvider } from '@itwin/appui-react';
+import type { Widget } from '@itwin/appui-react';
+
+// @public (undocumented)
+export class BulkExtractor {
+    constructor(reportsClient: ReportsClient, extractionClient: ExtractionClient, getAccessToken: () => Promise<AccessToken>, successfulExtractionToast: (iModelName: string, odataFeedUrl: string) => void, failedExtractionToast: (iModelName: string) => void);
+    // (undocumented)
+    getIModelState(iModelId: string, iModelName: string, odataFeedUrl: string): Promise<ExtractionStates>;
+    // (undocumented)
+    getReportState(reportId: string): Promise<ExtractionStates>;
+    // (undocumented)
+    runIModelExtraction(extractionRequestDetails: ExtractionRequestDetails): Promise<void>;
+    // (undocumented)
+    runIModelExtractions(extractionRequestsDetails: ExtractionRequestDetails[]): Promise<void>;
+    // (undocumented)
+    runReportExtractions(reportIds: string[]): Promise<void>;
+    // (undocumented)
+    setHook(setJobRunning: React.Dispatch<React.SetStateAction<boolean>>, iModels: string[]): void;
+}
+
+// @public
+export const ReportAction: ({ report, onSaveSuccess, onClickCancel }: ReportActionProps) => JSX.Element;
+
+// @public
+export interface ReportActionProps {
+    // (undocumented)
+    onClickCancel?: () => void;
+    // (undocumented)
+    onSaveSuccess: () => void;
+    // (undocumented)
+    report?: Report;
+}
+
+// @public
+export const ReportMappings: ({ report, onClickClose, defaultIModelId }: ReportMappingsProps) => JSX.Element | null;
+
+// @public
+export interface ReportMappingsProps {
+    // (undocumented)
+    defaultIModelId?: string;
+    // (undocumented)
+    onClickClose: () => void;
+    // (undocumented)
+    report: Report;
+}
+
+// @public
+export const Reports: ({ onClickAddReport, onClickReportModify, onClickReportTitle }: ReportsProps) => JSX.Element | null;
+
+// @internal (undocumented)
+export const REPORTS_CONFIG_BASE_URL = "https://api.bentley.com";
+
+// @public
+export const ReportsConfigContext: (props: ReportsConfigContextProps) => JSX.Element;
+
+// @public
+export interface ReportsConfigContextProps {
+    // (undocumented)
+    baseUrl?: string;
+    // (undocumented)
+    bulkExtractor?: BulkExtractor;
+    // (undocumented)
+    children?: React_2.ReactNode;
+    // (undocumented)
+    extractionClient?: ExtractionClient;
+    // (undocumented)
+    getAccessToken?: GetAccessTokenFn;
+    // (undocumented)
+    iModelsClient?: IModelsClient;
+    // (undocumented)
+    iTwinId: string;
+    // (undocumented)
+    mappingsClient?: MappingsClient;
+    // (undocumented)
+    reportsClient?: ReportsClient;
+}
+
+// @public
+export class ReportsConfigProvider implements UiItemsProvider {
+    constructor(getAccessToken?: () => Promise<AccessToken>, baseUrl?: string);
+    // (undocumented)
+    readonly id = "ReportsConfigProvider";
+    // (undocumented)
+    provideWidgets(_stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<Widget>;
+}
+
+// @public
+export class ReportsConfigWidget {
+    // (undocumented)
+    static initialize(localization?: Localization): Promise<void>;
+    // (undocumented)
+    static get localization(): Localization;
+    // (undocumented)
+    static get localizationNamespace(): string;
+    // (undocumented)
+    static terminate(): void;
+}
+
+// @public
+export interface ReportsProps {
+    // (undocumented)
+    onClickAddReport?: () => void;
+    // (undocumented)
+    onClickReportModify?: (report: Report) => void;
+    // (undocumented)
+    onClickReportTitle?: (report: Report) => void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```