@backstage-community/plugin-tech-insights-react 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# @backstage-community/plugin-tech-insights-react
+
+## 1.1.0
+
+### Minor Changes
+
+- e919e53: Backstage version bump to v1.35.1
+
+### Patch Changes
+
+- Updated dependencies [f015469]
+- Updated dependencies [e919e53]
+- Updated dependencies [c107e0f]
+  - @backstage-community/plugin-tech-insights-common@0.5.0

package/README.md

@@ -0,0 +1,120 @@
+# @backstage-community/plugin-tech-insights-react
+
+The tech-insights web library contains reusable frontend components and a reference implementation for the tech-insights api.
+
+## Rendering custom tech insights views
+
+If you create a custom view which renders tech-insights results, you can use the `ResultCheckIcon`, which also (by default) is clickable and opens a popup menu with links for this particular check and entity.
+
+You can also render the icon using the tech-insights renderer or pass the `disableLinksMenu` prop to `ResultCheckIcon` to disable the menu, and render it elsewhere, by importing `ResultLinksMenu`.
+
+### Render the check icon with a popup menu for links
+
+```tsx
+import { ResultCheckIcon } from '@backstage-community/plugin-tech-insights-react';
+
+export const MyComponent = () => {
+  const entity = getEntitySomehow();
+  const result = getCheckResultSomehow();
+
+  return <ResultCheckIcon result={result} entity={entity} />;
+};
+```
+
+### Render the popup menu for links
+
+You can render a custom component (like a button) which opens the popup menu with links.
+
+The menu will be anchored to an element, likely the button being pressed, or icon being clicked. The `setMenu` prop is used to get a function to open the menu.
+
+```tsx
+import {
+  TechInsightsLinksMenu,
+  ResultLinksMenuInfo,
+} from '@backstage-community/plugin-tech-insights';
+
+export const MyComponent = () => {
+  const entity = getEntitySomehow();
+  const result = getCheckResultSomehow();
+
+  const [menu, setMenu] = useState<ResultLinksMenuInfo | undefined>();
+
+  return (
+    <>
+      <Button
+        title="Show links"
+        disabled={!menu}
+        onClick={event => menu?.open(event.currentTarget)}
+      />
+      <TechInsightsLinksMenu
+        result={result}
+        entity={entity}
+        setMenu={setMenu}
+      />
+    </>
+  );
+};
+```
+
+### Adding custom rendering components
+
+Default implementation displays only `json-rules-engine` check results. If you would like to support different types, you need to inject custom rendering components to the `TechInsightsClient` constructor.
+
+```ts
+// packages/app/src/apis.ts
+
+export const apis: AnyApiFactory[] = [
+...
+  createApiFactory({
+    api: techInsightsApiRef,
+    deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef },
+    factory: ({ discoveryApi, identityApi }) =>
+      new TechInsightsClient({
+        discoveryApi,
+        identityApi,
+        renderers: [
+          jsonRulesEngineCheckResultRenderer, // default json-rules-engine renderer
+          myCustomBooleanRenderer, // custom renderer
+        ],
+      }),
+  }),
+...
+];
+```
+
+```tsx
+// packages/app/src/components/myCustomBooleanRenderer.tsx
+import { BooleanCheck } from '@backstage-community/plugin-tech-insights-react';
+...
+
+export const myCustomBooleanRenderer: CheckResultRenderer = {
+  type: 'boolean',
+  component: (checkResult: CheckResult) => (
+    <BooleanCheck checkResult={checkResult} />
+  ),
+};
+```
+
+### Customizing the description
+
+It's possible to customize the description with either a string or a React component. For example, displaying additional information if the check has failed.
+
+```tsx
+// packages/app/src/components/myCustomBooleanRenderer.tsx
+
+export const myCustomBooleanRenderer: CheckResultRenderer = {
+  type: 'boolean',
+  component: (checkResult: CheckResult) => (
+    <BooleanCheck checkResult={checkResult} />
+  ),
+  description: (checkResult: CheckResult) => (
+    <>
+      {
+        checkResult.result
+          ? checkResult.check.description // In case of success, return the same description
+          : `The check has failed! ${checkResult.check.description}` // Add a prefix text if the check failed
+      }
+    </>
+  ),
+};
+```

package/dist/api/TechInsightsApi.esm.js

@@ -0,0 +1,8 @@
+import { createApiRef } from '@backstage/core-plugin-api';
+
+const techInsightsApiRef = createApiRef({
+  id: "plugin.techinsights.service"
+});
+
+export { techInsightsApiRef };
+//# sourceMappingURL=TechInsightsApi.esm.js.map

package/dist/api/TechInsightsApi.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TechInsightsApi.esm.js","sources":["../../src/api/TechInsightsApi.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createApiRef } from '@backstage/core-plugin-api';\nimport {\n  CheckResult,\n  BulkCheckResponse,\n  FactSchema,\n  CheckLink,\n  Check,\n  InsightFacts,\n} from '@backstage-community/plugin-tech-insights-common';\nimport { CheckResultRenderer } from '../components/CheckResultRenderer';\nimport { CompoundEntityRef, Entity } from '@backstage/catalog-model';\n\n/**\n * {@link @backstage/core-plugin-api#ApiRef} for the {@link TechInsightsApi}\n *\n * @public\n */\nexport const techInsightsApiRef = createApiRef<TechInsightsApi>({\n  id: 'plugin.techinsights.service',\n});\n\n/**\n * Tech Insights API client interface\n *\n * @public\n */\nexport interface TechInsightsApi {\n  getCheckResultRenderers: (types: string[]) => CheckResultRenderer[];\n  isCheckResultFailed: (check: CheckResult) => boolean;\n  getAllChecks(): Promise<Check[]>;\n  runChecks(\n    entityParams: CompoundEntityRef,\n    checks?: string[],\n  ): Promise<CheckResult[]>;\n  runBulkChecks(\n    entities: CompoundEntityRef[],\n    checks?: Check[],\n  ): Promise<BulkCheckResponse>;\n  getFacts(entity: CompoundEntityRef, facts: string[]): Promise<InsightFacts>;\n  getFactSchemas(): Promise<FactSchema[]>;\n  getLinksForEntity(\n    result: CheckResult,\n    entity: Entity,\n    options?: { includeStaticLinks?: boolean },\n  ): CheckLink[];\n}\n"],"names":[],"mappings":";;AAiCO,MAAM,qBAAqB,YAA8B,CAAA;AAAA,EAC9D,EAAI,EAAA;AACN,CAAC;;;;"}

package/dist/api/TechInsightsClient.esm.js

@@ -0,0 +1,61 @@
+import { TechInsightsClient as TechInsightsClient$1 } from '@backstage-community/plugin-tech-insights-common/client';
+import { jsonRulesEngineCheckResultRenderer } from '../components/CheckResultRenderer.esm.js';
+
+class TechInsightsClient extends TechInsightsClient$1 {
+  renderers;
+  customGetEntityLinks;
+  constructor(options) {
+    super(options);
+    this.renderers = options.renderers;
+    this.customGetEntityLinks = options.getEntityLinks ?? (() => []);
+  }
+  /**
+   * Get the check result renderers for the given check types.
+   *
+   * @param types - The types of checks to get renderers for
+   * @returns An array of check result renderers
+   *
+   * @public
+   */
+  getCheckResultRenderers(types) {
+    const renderers = this.renderers ?? [jsonRulesEngineCheckResultRenderer];
+    return renderers.filter((d) => types.includes(d.type));
+  }
+  /**
+   * Determine if a check result represents a failure.
+   *
+   * @param check - The check result to evaluate
+   * @returns true if the check result represents a failure, false otherwise
+   *
+   * @public
+   */
+  isCheckResultFailed(check) {
+    const checkResultRenderers = this.getCheckResultRenderers([
+      check.check.type
+    ]);
+    if (checkResultRenderers[0] && checkResultRenderers[0].isFailed) {
+      return checkResultRenderers[0].isFailed(check);
+    }
+    return true;
+  }
+  /**
+   * Get the links for a given check result and entity.
+   *
+   * @param result - The check result to get links for
+   * @param entity - The entity to get links for
+   * @param options - Optional options for the links
+   * @returns An array of check links
+   *
+   * @public
+   */
+  getLinksForEntity(result, entity, options = {}) {
+    const links = this.customGetEntityLinks(result, entity);
+    if (options.includeStaticLinks) {
+      links.push(...result.check.links ?? []);
+    }
+    return links;
+  }
+}
+
+export { TechInsightsClient };
+//# sourceMappingURL=TechInsightsClient.esm.js.map

package/dist/api/TechInsightsClient.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TechInsightsClient.esm.js","sources":["../../src/api/TechInsightsClient.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { TechInsightsApi } from './TechInsightsApi';\nimport { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';\nimport { TechInsightsClient as TechInsightsClientBase } from '@backstage-community/plugin-tech-insights-common/client';\nimport {\n  CheckLink,\n  CheckResult,\n} from '@backstage-community/plugin-tech-insights-common';\nimport {\n  CheckResultRenderer,\n  jsonRulesEngineCheckResultRenderer,\n} from '../components/CheckResultRenderer';\nimport { Entity } from '@backstage/catalog-model';\n\n/**\n * Implementation of the {@link TechInsightsApi} interface.\n *\n * @public\n */\nexport class TechInsightsClient\n  extends TechInsightsClientBase\n  implements TechInsightsApi\n{\n  private readonly renderers?: CheckResultRenderer[];\n  private readonly customGetEntityLinks: (\n    result: CheckResult,\n    entity: Entity,\n  ) => CheckLink[];\n\n  constructor(options: {\n    discoveryApi: DiscoveryApi;\n    identityApi: IdentityApi;\n    renderers?: CheckResultRenderer[];\n    getEntityLinks?: (result: CheckResult, entity: Entity) => CheckLink[];\n  }) {\n    super(options);\n    this.renderers = options.renderers;\n    this.customGetEntityLinks = options.getEntityLinks ?? (() => []);\n  }\n\n  /**\n   * Get the check result renderers for the given check types.\n   *\n   * @param types - The types of checks to get renderers for\n   * @returns An array of check result renderers\n   *\n   * @public\n   */\n  getCheckResultRenderers(types: string[]): CheckResultRenderer[] {\n    const renderers = this.renderers ?? [jsonRulesEngineCheckResultRenderer];\n    return renderers.filter(d => types.includes(d.type));\n  }\n\n  /**\n   * Determine if a check result represents a failure.\n   *\n   * @param check - The check result to evaluate\n   * @returns true if the check result represents a failure, false otherwise\n   *\n   * @public\n   */\n  isCheckResultFailed(check: CheckResult) {\n    const checkResultRenderers = this.getCheckResultRenderers([\n      check.check.type,\n    ]);\n    if (checkResultRenderers[0] && checkResultRenderers[0].isFailed) {\n      return checkResultRenderers[0].isFailed(check);\n    }\n    return true;\n  }\n\n  /**\n   * Get the links for a given check result and entity.\n   *\n   * @param result - The check result to get links for\n   * @param entity - The entity to get links for\n   * @param options - Optional options for the links\n   * @returns An array of check links\n   *\n   * @public\n   */\n  getLinksForEntity(\n    result: CheckResult,\n    entity: Entity,\n    options: { includeStaticLinks?: boolean } = {},\n  ): CheckLink[] {\n    const links = this.customGetEntityLinks(result, entity);\n    if (options.includeStaticLinks) {\n      links.push(...(result.check.links ?? []));\n    }\n    return links;\n  }\n}\n"],"names":["TechInsightsClientBase"],"mappings":";;;AAkCO,MAAM,2BACHA,oBAEV,CAAA;AAAA,EACmB,SAAA;AAAA,EACA,oBAAA;AAAA,EAKjB,YAAY,OAKT,EAAA;AACD,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA;AACzB,IAAA,IAAA,CAAK,oBAAuB,GAAA,OAAA,CAAQ,cAAmB,KAAA,MAAM,EAAC,CAAA;AAAA;AAChE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,wBAAwB,KAAwC,EAAA;AAC9D,IAAA,MAAM,SAAY,GAAA,IAAA,CAAK,SAAa,IAAA,CAAC,kCAAkC,CAAA;AACvE,IAAA,OAAO,UAAU,MAAO,CAAA,CAAA,CAAA,KAAK,MAAM,QAAS,CAAA,CAAA,CAAE,IAAI,CAAC,CAAA;AAAA;AACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,oBAAoB,KAAoB,EAAA;AACtC,IAAM,MAAA,oBAAA,GAAuB,KAAK,uBAAwB,CAAA;AAAA,MACxD,MAAM,KAAM,CAAA;AAAA,KACb,CAAA;AACD,IAAA,IAAI,qBAAqB,CAAC,CAAA,IAAK,oBAAqB,CAAA,CAAC,EAAE,QAAU,EAAA;AAC/D,MAAA,OAAO,oBAAqB,CAAA,CAAC,CAAE,CAAA,QAAA,CAAS,KAAK,CAAA;AAAA;AAE/C,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,iBACE,CAAA,MAAA,EACA,MACA,EAAA,OAAA,GAA4C,EAC/B,EAAA;AACb,IAAA,MAAM,KAAQ,GAAA,IAAA,CAAK,oBAAqB,CAAA,MAAA,EAAQ,MAAM,CAAA;AACtD,IAAA,IAAI,QAAQ,kBAAoB,EAAA;AAC9B,MAAA,KAAA,CAAM,KAAK,GAAI,MAAA,CAAO,KAAM,CAAA,KAAA,IAAS,EAAG,CAAA;AAAA;AAE1C,IAAO,OAAA,KAAA;AAAA;AAEX;;;;"}

package/dist/components/BooleanCheck/BooleanCheck.esm.js

@@ -0,0 +1,11 @@
+import React from 'react';
+import CheckCircleOutline from '@material-ui/icons/CheckCircleOutline';
+import ErrorOutlineIcon from '@material-ui/icons/ErrorOutline';
+
+const BooleanCheck = (props) => {
+  return !!props.checkResult.result ? /* @__PURE__ */ React.createElement(CheckCircleOutline, { color: "primary" }) : /* @__PURE__ */ React.createElement(ErrorOutlineIcon, { color: "error" });
+};
+const isBooleanCheckFailed = (checkResult) => !checkResult.result;
+
+export { BooleanCheck, isBooleanCheckFailed };
+//# sourceMappingURL=BooleanCheck.esm.js.map

package/dist/components/BooleanCheck/BooleanCheck.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BooleanCheck.esm.js","sources":["../../../src/components/BooleanCheck/BooleanCheck.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport React from 'react';\nimport CheckCircleOutline from '@material-ui/icons/CheckCircleOutline';\nimport ErrorOutlineIcon from '@material-ui/icons/ErrorOutline';\nimport { CheckResult } from '@backstage-community/plugin-tech-insights-common';\n\n/**\n * A component that renders a boolean check result as either a success or failure icon.\n *\n * @public\n */\nexport const BooleanCheck = (props: { checkResult: CheckResult }) => {\n  return !!props.checkResult.result ? (\n    <CheckCircleOutline color=\"primary\" />\n  ) : (\n    <ErrorOutlineIcon color=\"error\" />\n  );\n};\n\n/**\n * Helper function to determine if a boolean check result represents a failure.\n *\n * @returns true if the check result represents a failure (result is false), false otherwise\n *\n * @public\n */\nexport const isBooleanCheckFailed = (checkResult: CheckResult) =>\n  !checkResult.result;\n"],"names":[],"mappings":";;;;AAyBa,MAAA,YAAA,GAAe,CAAC,KAAwC,KAAA;AACnE,EAAA,OAAO,CAAC,CAAC,KAAM,CAAA,WAAA,CAAY,MACzB,mBAAA,KAAA,CAAA,aAAA,CAAC,kBAAmB,EAAA,EAAA,KAAA,EAAM,SAAU,EAAA,CAAA,mBAEnC,KAAA,CAAA,aAAA,CAAA,gBAAA,EAAA,EAAiB,OAAM,OAAQ,EAAA,CAAA;AAEpC;AASO,MAAM,oBAAuB,GAAA,CAAC,WACnC,KAAA,CAAC,WAAY,CAAA;;;;"}

package/dist/components/CheckResultRenderer.esm.js

@@ -0,0 +1,11 @@
+import React from 'react';
+import { BooleanCheck, isBooleanCheckFailed } from './BooleanCheck/BooleanCheck.esm.js';
+
+const jsonRulesEngineCheckResultRenderer = {
+  type: "json-rules-engine",
+  component: (checkResult) => /* @__PURE__ */ React.createElement(BooleanCheck, { checkResult }),
+  isFailed: isBooleanCheckFailed
+};
+
+export { jsonRulesEngineCheckResultRenderer };
+//# sourceMappingURL=CheckResultRenderer.esm.js.map

package/dist/components/CheckResultRenderer.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CheckResultRenderer.esm.js","sources":["../../src/components/CheckResultRenderer.tsx"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport React from 'react';\nimport { CheckResult } from '@backstage-community/plugin-tech-insights-common';\nimport { BooleanCheck, isBooleanCheckFailed } from './BooleanCheck';\n\n/**\n * Defines a react component that is responsible for rendering a result of a given type.\n *\n * @public\n */\nexport type CheckResultRenderer = {\n  type: string;\n  component: (check: CheckResult) => React.ReactElement;\n  description?: (check: CheckResult) => string | React.ReactElement;\n  isFailed?: (check: CheckResult) => boolean;\n};\n\n/**\n * Default renderer for json-rules-engine check results.\n *\n * @public\n */\nexport const jsonRulesEngineCheckResultRenderer: CheckResultRenderer = {\n  type: 'json-rules-engine',\n  component: (checkResult: CheckResult) => (\n    <BooleanCheck checkResult={checkResult} />\n  ),\n  isFailed: isBooleanCheckFailed,\n};\n"],"names":[],"mappings":";;;AAqCO,MAAM,kCAA0D,GAAA;AAAA,EACrE,IAAM,EAAA,mBAAA;AAAA,EACN,SAAW,EAAA,CAAC,WACV,qBAAA,KAAA,CAAA,aAAA,CAAC,gBAAa,WAA0B,EAAA,CAAA;AAAA,EAE1C,QAAU,EAAA;AACZ;;;;"}

package/dist/components/ResultCheckIcon/ResultCheckIcon.esm.js

@@ -0,0 +1,45 @@
+import React, { useState } from 'react';
+import { useApi } from '@backstage/core-plugin-api';
+import IconButton from '@material-ui/core/IconButton';
+import Alert from '@material-ui/lab/Alert';
+import { techInsightsApiRef } from '../../api/TechInsightsApi.esm.js';
+import '@backstage-community/plugin-tech-insights-common/client';
+import '@material-ui/icons/CheckCircleOutline';
+import '@material-ui/icons/ErrorOutline';
+import { ResultLinksMenu } from '../ResultLinksMenu/ResultLinksMenu.esm.js';
+
+const ResultCheckIcon = (props) => {
+  const {
+    result,
+    entity,
+    disableLinksMenu,
+    component,
+    componentProps,
+    missingRendererComponent = /* @__PURE__ */ React.createElement(Alert, { severity: "error" }, "Unknown type.")
+  } = props;
+  const api = useApi(techInsightsApiRef);
+  const checkResultRenderer = props.checkResultRenderer ?? api.getCheckResultRenderers([result.check.type])[0];
+  const [menu, setMenu] = useState();
+  const iconComponent = checkResultRenderer?.component(result);
+  const onClick = (event) => {
+    menu?.open(event.currentTarget);
+  };
+  const wrapActions = (inner) => {
+    if (!menu) {
+      if (component) {
+        const Component = component;
+        return /* @__PURE__ */ React.createElement(Component, { ...componentProps }, inner);
+      }
+      return inner;
+    }
+    if (component) {
+      const Component = component;
+      return /* @__PURE__ */ React.createElement(Component, { ...componentProps, onClick }, /* @__PURE__ */ React.createElement(IconButton, { edge: "end", "aria-label": "icon" }, inner));
+    }
+    return /* @__PURE__ */ React.createElement(IconButton, { edge: "end", "aria-label": "icon", onClick }, inner);
+  };
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, !disableLinksMenu && /* @__PURE__ */ React.createElement(ResultLinksMenu, { result, entity, setMenu }), wrapActions(iconComponent ?? missingRendererComponent));
+};
+
+export { ResultCheckIcon };
+//# sourceMappingURL=ResultCheckIcon.esm.js.map

package/dist/components/ResultCheckIcon/ResultCheckIcon.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultCheckIcon.esm.js","sources":["../../../src/components/ResultCheckIcon/ResultCheckIcon.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport React, {\n  ElementType,\n  MouseEventHandler,\n  PropsWithChildren,\n  ReactNode,\n  useState,\n} from 'react';\nimport { useApi } from '@backstage/core-plugin-api';\nimport { CheckResult } from '@backstage-community/plugin-tech-insights-common';\nimport { Entity } from '@backstage/catalog-model';\nimport IconButton from '@material-ui/core/IconButton';\nimport Alert from '@material-ui/lab/Alert';\nimport { techInsightsApiRef } from '../../api';\nimport { ResultLinksMenu, ResultLinksMenuInfo } from '../ResultLinksMenu';\nimport { CheckResultRenderer } from '../CheckResultRenderer';\n\n/** @public */\nexport type ResultCheckIconBaseComponentProps = PropsWithChildren<{\n  onClick?: MouseEventHandler;\n}>;\n\n/**\n * ResultCheckIcon props\n *\n * The only necessary prop is {@link ResultCheckIconProps.result}, but if\n * {@link ResultCheckIconProps.entity} is provided, the popup menu with links\n * will also include links specifically for this entity.\n *\n * @public\n */\nexport interface ResultCheckIconProps<\n  P extends ResultCheckIconBaseComponentProps,\n> {\n  /**\n   * The CheckResult object to create an icon for\n   */\n  result: CheckResult;\n  /**\n   * The entity for which this check result is created. This is optional, but if\n   * provided, entity-specific links will be added to the popup menu, if any.\n   */\n  entity?: Entity;\n  /**\n   * This can optionally be provided, with a small performance improvement, if\n   * it is already cashed upstream.\n   */\n  checkResultRenderer?: CheckResultRenderer;\n  /**\n   * Will disable the popup menu\n   */\n  disableLinksMenu?: boolean;\n  /**\n   * The icon is rendered with an `IconButton` which handles the onClick.\n   * To wrap this in another component, handling the onClick, pass a component,\n   * such as `ListItemSecondaryAction` which handles the `onClick` to open the\n   * popup menu.\n   *\n   * The {@link ResultCheckIconProps.componentProps} prop can be specified to\n   * add props to the wrapping component.\n   */\n  component?: ElementType<P>;\n  /**\n   * Props to provide to the wrapping component\n   * {@link ResultCheckIconProps.component}.\n   */\n  componentProps?: Omit<P, 'onClick' | 'children'>;\n  /**\n   * Override the component used to display instead of a result icon, when no\n   * renderer was found for this check type.\n   */\n  missingRendererComponent?: ReactNode;\n}\n\n/**\n * A component that renders an icon representing a check result, optionally with a popup menu\n * containing links related to the check.\n *\n * @public\n */\nexport const ResultCheckIcon = <P extends ResultCheckIconBaseComponentProps>(\n  props: ResultCheckIconProps<P>,\n) => {\n  const {\n    result,\n    entity,\n    disableLinksMenu,\n    component,\n    componentProps,\n    missingRendererComponent = <Alert severity=\"error\">Unknown type.</Alert>,\n  } = props;\n\n  const api = useApi(techInsightsApiRef);\n\n  const checkResultRenderer =\n    props.checkResultRenderer ??\n    api.getCheckResultRenderers([result.check.type])[0];\n\n  const [menu, setMenu] = useState<ResultLinksMenuInfo | undefined>();\n\n  const iconComponent = checkResultRenderer?.component(result);\n\n  const onClick: MouseEventHandler = event => {\n    menu?.open(event.currentTarget);\n  };\n\n  const wrapActions = (inner: React.ReactElement): ReactNode => {\n    if (!menu) {\n      if (component) {\n        const Component =\n          component as ElementType<ResultCheckIconBaseComponentProps>;\n        return <Component {...componentProps}>{inner}</Component>;\n      }\n      return inner;\n    }\n\n    if (component) {\n      const Component =\n        component as ElementType<ResultCheckIconBaseComponentProps>;\n      return (\n        <Component {...componentProps} onClick={onClick}>\n          <IconButton edge=\"end\" aria-label=\"icon\">\n            {inner}\n          </IconButton>\n        </Component>\n      );\n    }\n    return (\n      <IconButton edge=\"end\" aria-label=\"icon\" onClick={onClick}>\n        {inner}\n      </IconButton>\n    );\n  };\n\n  return (\n    <>\n      {!disableLinksMenu && (\n        <ResultLinksMenu result={result} entity={entity} setMenu={setMenu} />\n      )}\n      {wrapActions(iconComponent ?? missingRendererComponent)}\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;AA8Fa,MAAA,eAAA,GAAkB,CAC7B,KACG,KAAA;AACH,EAAM,MAAA;AAAA,IACJ,MAAA;AAAA,IACA,MAAA;AAAA,IACA,gBAAA;AAAA,IACA,SAAA;AAAA,IACA,cAAA;AAAA,IACA,wBAA2B,mBAAA,KAAA,CAAA,aAAA,CAAC,KAAM,EAAA,EAAA,QAAA,EAAS,WAAQ,eAAa;AAAA,GAC9D,GAAA,KAAA;AAEJ,EAAM,MAAA,GAAA,GAAM,OAAO,kBAAkB,CAAA;AAErC,EAAM,MAAA,mBAAA,GACJ,KAAM,CAAA,mBAAA,IACN,GAAI,CAAA,uBAAA,CAAwB,CAAC,MAAA,CAAO,KAAM,CAAA,IAAI,CAAC,CAAA,CAAE,CAAC,CAAA;AAEpD,EAAA,MAAM,CAAC,IAAA,EAAM,OAAO,CAAA,GAAI,QAA0C,EAAA;AAElE,EAAM,MAAA,aAAA,GAAgB,mBAAqB,EAAA,SAAA,CAAU,MAAM,CAAA;AAE3D,EAAA,MAAM,UAA6B,CAAS,KAAA,KAAA;AAC1C,IAAM,IAAA,EAAA,IAAA,CAAK,MAAM,aAAa,CAAA;AAAA,GAChC;AAEA,EAAM,MAAA,WAAA,GAAc,CAAC,KAAyC,KAAA;AAC5D,IAAA,IAAI,CAAC,IAAM,EAAA;AACT,MAAA,IAAI,SAAW,EAAA;AACb,QAAA,MAAM,SACJ,GAAA,SAAA;AACF,QAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,SAAA,EAAA,EAAW,GAAG,cAAA,EAAA,EAAiB,KAAM,CAAA;AAAA;AAE/C,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,IAAI,SAAW,EAAA;AACb,MAAA,MAAM,SACJ,GAAA,SAAA;AACF,MAAA,uBACG,KAAA,CAAA,aAAA,CAAA,SAAA,EAAA,EAAW,GAAG,cAAA,EAAgB,OAC7B,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,UAAW,EAAA,EAAA,IAAA,EAAK,KAAM,EAAA,YAAA,EAAW,MAC/B,EAAA,EAAA,KACH,CACF,CAAA;AAAA;AAGJ,IAAA,2CACG,UAAW,EAAA,EAAA,IAAA,EAAK,OAAM,YAAW,EAAA,MAAA,EAAO,WACtC,KACH,CAAA;AAAA,GAEJ;AAEA,EAAA,uBAEK,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EAAA,CAAC,gBACA,oBAAA,KAAA,CAAA,aAAA,CAAC,eAAgB,EAAA,EAAA,MAAA,EAAgB,MAAgB,EAAA,OAAA,EAAkB,CAEpE,EAAA,WAAA,CAAY,aAAiB,IAAA,wBAAwB,CACxD,CAAA;AAEJ;;;;"}

package/dist/components/ResultLinksMenu/ResultLinksMenu.esm.js

@@ -0,0 +1,66 @@
+import React, { useMemo, useEffect, useCallback } from 'react';
+import { useApi } from '@backstage/core-plugin-api';
+import Menu from '@material-ui/core/Menu';
+import MenuItem from '@material-ui/core/MenuItem';
+import { techInsightsApiRef } from '../../api/TechInsightsApi.esm.js';
+import '@backstage-community/plugin-tech-insights-common/client';
+import '@material-ui/icons/CheckCircleOutline';
+import '@material-ui/icons/ErrorOutline';
+import { stringifyEntityRef } from '@backstage/catalog-model';
+
+const ResultLinksMenu = (props) => {
+  const { result, entity, setMenu } = props;
+  const api = useApi(techInsightsApiRef);
+  const links = useMemo(
+    () => entity ? api.getLinksForEntity(result, entity, {
+      includeStaticLinks: true
+    }) : result.check.links ?? [],
+    [api, result, entity]
+  );
+  const menuId = `menu-${result.check.id}-${entity ? stringifyEntityRef(entity) : "unknown"}`;
+  const [anchorEl, setAnchorEl] = React.useState(
+    void 0
+  );
+  useEffect(() => {
+    if (links.length === 0) {
+      setMenu(void 0);
+      return;
+    }
+    setMenu({
+      open: (elem) => {
+        setAnchorEl(elem);
+      }
+    });
+  }, [setMenu, links]);
+  const handleClose = useCallback(() => {
+    setAnchorEl(void 0);
+  }, [setAnchorEl]);
+  if (links.length === 0) {
+    return null;
+  }
+  return /* @__PURE__ */ React.createElement(
+    Menu,
+    {
+      id: menuId,
+      anchorEl: anchorEl ?? null,
+      keepMounted: true,
+      open: Boolean(anchorEl),
+      onClose: handleClose
+    },
+    links.map((link, i) => /* @__PURE__ */ React.createElement(
+      MenuItem,
+      {
+        key: `${i}-${link.url}`,
+        button: true,
+        component: "a",
+        href: link.url,
+        target: link.url.startsWith("/") ? void 0 : "_blank",
+        onClick: handleClose
+      },
+      link.title
+    ))
+  );
+};
+
+export { ResultLinksMenu };
+//# sourceMappingURL=ResultLinksMenu.esm.js.map

package/dist/components/ResultLinksMenu/ResultLinksMenu.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultLinksMenu.esm.js","sources":["../../../src/components/ResultLinksMenu/ResultLinksMenu.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport React, {\n  PropsWithChildren,\n  useCallback,\n  useEffect,\n  useMemo,\n} from 'react';\nimport { useApi } from '@backstage/core-plugin-api';\nimport Menu from '@material-ui/core/Menu';\nimport MenuItem from '@material-ui/core/MenuItem';\nimport { techInsightsApiRef } from '../../api';\nimport { CheckResult } from '@backstage-community/plugin-tech-insights-common';\nimport { Entity, stringifyEntityRef } from '@backstage/catalog-model';\n\n/**\n * ResultLinksMenu setMenu receiver.\n *\n * This object contains an {@link ResultLinksMenuInfo.open | open} function,\n * which can be used to open the popup menu. It closes automatically on\n * click-away.\n *\n * @public\n */\nexport type ResultLinksMenuInfo = {\n  /**\n   * Call this function to open the popup menu. The element argument should be\n   * an element which is used as an anchor for the menu - where to display it.\n   */\n  open: (element: Element) => void;\n};\n\n/**\n * A component that renders a popup menu with links related to a check result.\n *\n * @public\n */\nexport const ResultLinksMenu = (\n  props: PropsWithChildren<{\n    result: CheckResult;\n    entity?: Entity;\n    setMenu(opener: ResultLinksMenuInfo | undefined): void;\n  }>,\n) => {\n  const { result, entity, setMenu } = props;\n  const api = useApi(techInsightsApiRef);\n\n  const links = useMemo(\n    () =>\n      entity\n        ? api.getLinksForEntity(result, entity, {\n            includeStaticLinks: true,\n          })\n        : result.check.links ?? [],\n    [api, result, entity],\n  );\n\n  const menuId = `menu-${result.check.id}-${\n    entity ? stringifyEntityRef(entity) : 'unknown'\n  }`;\n\n  const [anchorEl, setAnchorEl] = React.useState<Element | undefined>(\n    undefined,\n  );\n\n  useEffect(() => {\n    if (links.length === 0) {\n      setMenu(undefined);\n      return;\n    }\n    setMenu({\n      open: (elem: Element) => {\n        setAnchorEl(elem);\n      },\n    });\n  }, [setMenu, links]);\n\n  const handleClose = useCallback(() => {\n    setAnchorEl(undefined);\n  }, [setAnchorEl]);\n\n  if (links.length === 0) {\n    return null;\n  }\n\n  return (\n    <Menu\n      id={menuId}\n      anchorEl={anchorEl ?? null}\n      keepMounted\n      open={Boolean(anchorEl)}\n      onClose={handleClose}\n    >\n      {links.map((link, i) => (\n        <MenuItem\n          key={`${i}-${link.url}`}\n          button\n          component=\"a\"\n          href={link.url}\n          target={link.url.startsWith('/') ? undefined : '_blank'}\n          onClick={handleClose}\n        >\n          {link.title}\n        </MenuItem>\n      ))}\n    </Menu>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;AAmDa,MAAA,eAAA,GAAkB,CAC7B,KAKG,KAAA;AACH,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,OAAA,EAAY,GAAA,KAAA;AACpC,EAAM,MAAA,GAAA,GAAM,OAAO,kBAAkB,CAAA;AAErC,EAAA,MAAM,KAAQ,GAAA,OAAA;AAAA,IACZ,MACE,MAAA,GACI,GAAI,CAAA,iBAAA,CAAkB,QAAQ,MAAQ,EAAA;AAAA,MACpC,kBAAoB,EAAA;AAAA,KACrB,CAAA,GACD,MAAO,CAAA,KAAA,CAAM,SAAS,EAAC;AAAA,IAC7B,CAAC,GAAK,EAAA,MAAA,EAAQ,MAAM;AAAA,GACtB;AAEA,EAAM,MAAA,MAAA,GAAS,CAAQ,KAAA,EAAA,MAAA,CAAO,KAAM,CAAA,EAAE,IACpC,MAAS,GAAA,kBAAA,CAAmB,MAAM,CAAA,GAAI,SACxC,CAAA,CAAA;AAEA,EAAA,MAAM,CAAC,QAAA,EAAU,WAAW,CAAA,GAAI,KAAM,CAAA,QAAA;AAAA,IACpC,KAAA;AAAA,GACF;AAEA,EAAA,SAAA,CAAU,MAAM;AACd,IAAI,IAAA,KAAA,CAAM,WAAW,CAAG,EAAA;AACtB,MAAA,OAAA,CAAQ,KAAS,CAAA,CAAA;AACjB,MAAA;AAAA;AAEF,IAAQ,OAAA,CAAA;AAAA,MACN,IAAA,EAAM,CAAC,IAAkB,KAAA;AACvB,QAAA,WAAA,CAAY,IAAI,CAAA;AAAA;AAClB,KACD,CAAA;AAAA,GACA,EAAA,CAAC,OAAS,EAAA,KAAK,CAAC,CAAA;AAEnB,EAAM,MAAA,WAAA,GAAc,YAAY,MAAM;AACpC,IAAA,WAAA,CAAY,KAAS,CAAA,CAAA;AAAA,GACvB,EAAG,CAAC,WAAW,CAAC,CAAA;AAEhB,EAAI,IAAA,KAAA,CAAM,WAAW,CAAG,EAAA;AACtB,IAAO,OAAA,IAAA;AAAA;AAGT,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,IAAA;AAAA,IAAA;AAAA,MACC,EAAI,EAAA,MAAA;AAAA,MACJ,UAAU,QAAY,IAAA,IAAA;AAAA,MACtB,WAAW,EAAA,IAAA;AAAA,MACX,IAAA,EAAM,QAAQ,QAAQ,CAAA;AAAA,MACtB,OAAS,EAAA;AAAA,KAAA;AAAA,IAER,KAAM,CAAA,GAAA,CAAI,CAAC,IAAA,EAAM,CAChB,qBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,QAAA;AAAA,MAAA;AAAA,QACC,GAAK,EAAA,CAAA,EAAG,CAAC,CAAA,CAAA,EAAI,KAAK,GAAG,CAAA,CAAA;AAAA,QACrB,MAAM,EAAA,IAAA;AAAA,QACN,SAAU,EAAA,GAAA;AAAA,QACV,MAAM,IAAK,CAAA,GAAA;AAAA,QACX,QAAQ,IAAK,CAAA,GAAA,CAAI,UAAW,CAAA,GAAG,IAAI,KAAY,CAAA,GAAA,QAAA;AAAA,QAC/C,OAAS,EAAA;AAAA,OAAA;AAAA,MAER,IAAK,CAAA;AAAA,KAET;AAAA,GACH;AAEJ;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,202 @@
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
+import { CheckResult, Check, BulkCheckResponse, InsightFacts, FactSchema, CheckLink } from '@backstage-community/plugin-tech-insights-common';
+import React, { PropsWithChildren, MouseEventHandler, ElementType, ReactNode } from 'react';
+import { CompoundEntityRef, Entity } from '@backstage/catalog-model';
+import { TechInsightsClient as TechInsightsClient$1 } from '@backstage-community/plugin-tech-insights-common/client';
+
+/**
+ * Defines a react component that is responsible for rendering a result of a given type.
+ *
+ * @public
+ */
+type CheckResultRenderer = {
+    type: string;
+    component: (check: CheckResult) => React.ReactElement;
+    description?: (check: CheckResult) => string | React.ReactElement;
+    isFailed?: (check: CheckResult) => boolean;
+};
+/**
+ * Default renderer for json-rules-engine check results.
+ *
+ * @public
+ */
+declare const jsonRulesEngineCheckResultRenderer: CheckResultRenderer;
+
+/**
+ * {@link @backstage/core-plugin-api#ApiRef} for the {@link TechInsightsApi}
+ *
+ * @public
+ */
+declare const techInsightsApiRef: _backstage_core_plugin_api.ApiRef<TechInsightsApi>;
+/**
+ * Tech Insights API client interface
+ *
+ * @public
+ */
+interface TechInsightsApi {
+    getCheckResultRenderers: (types: string[]) => CheckResultRenderer[];
+    isCheckResultFailed: (check: CheckResult) => boolean;
+    getAllChecks(): Promise<Check[]>;
+    runChecks(entityParams: CompoundEntityRef, checks?: string[]): Promise<CheckResult[]>;
+    runBulkChecks(entities: CompoundEntityRef[], checks?: Check[]): Promise<BulkCheckResponse>;
+    getFacts(entity: CompoundEntityRef, facts: string[]): Promise<InsightFacts>;
+    getFactSchemas(): Promise<FactSchema[]>;
+    getLinksForEntity(result: CheckResult, entity: Entity, options?: {
+        includeStaticLinks?: boolean;
+    }): CheckLink[];
+}
+
+/**
+ * Implementation of the {@link TechInsightsApi} interface.
+ *
+ * @public
+ */
+declare class TechInsightsClient extends TechInsightsClient$1 implements TechInsightsApi {
+    private readonly renderers?;
+    private readonly customGetEntityLinks;
+    constructor(options: {
+        discoveryApi: DiscoveryApi;
+        identityApi: IdentityApi;
+        renderers?: CheckResultRenderer[];
+        getEntityLinks?: (result: CheckResult, entity: Entity) => CheckLink[];
+    });
+    /**
+     * Get the check result renderers for the given check types.
+     *
+     * @param types - The types of checks to get renderers for
+     * @returns An array of check result renderers
+     *
+     * @public
+     */
+    getCheckResultRenderers(types: string[]): CheckResultRenderer[];
+    /**
+     * Determine if a check result represents a failure.
+     *
+     * @param check - The check result to evaluate
+     * @returns true if the check result represents a failure, false otherwise
+     *
+     * @public
+     */
+    isCheckResultFailed(check: CheckResult): boolean;
+    /**
+     * Get the links for a given check result and entity.
+     *
+     * @param result - The check result to get links for
+     * @param entity - The entity to get links for
+     * @param options - Optional options for the links
+     * @returns An array of check links
+     *
+     * @public
+     */
+    getLinksForEntity(result: CheckResult, entity: Entity, options?: {
+        includeStaticLinks?: boolean;
+    }): CheckLink[];
+}
+
+/**
+ * A component that renders a boolean check result as either a success or failure icon.
+ *
+ * @public
+ */
+declare const BooleanCheck: (props: {
+    checkResult: CheckResult;
+}) => React.JSX.Element;
+/**
+ * Helper function to determine if a boolean check result represents a failure.
+ *
+ * @returns true if the check result represents a failure (result is false), false otherwise
+ *
+ * @public
+ */
+declare const isBooleanCheckFailed: (checkResult: CheckResult) => boolean;
+
+/** @public */
+type ResultCheckIconBaseComponentProps = PropsWithChildren<{
+    onClick?: MouseEventHandler;
+}>;
+/**
+ * ResultCheckIcon props
+ *
+ * The only necessary prop is {@link ResultCheckIconProps.result}, but if
+ * {@link ResultCheckIconProps.entity} is provided, the popup menu with links
+ * will also include links specifically for this entity.
+ *
+ * @public
+ */
+interface ResultCheckIconProps<P extends ResultCheckIconBaseComponentProps> {
+    /**
+     * The CheckResult object to create an icon for
+     */
+    result: CheckResult;
+    /**
+     * The entity for which this check result is created. This is optional, but if
+     * provided, entity-specific links will be added to the popup menu, if any.
+     */
+    entity?: Entity;
+    /**
+     * This can optionally be provided, with a small performance improvement, if
+     * it is already cashed upstream.
+     */
+    checkResultRenderer?: CheckResultRenderer;
+    /**
+     * Will disable the popup menu
+     */
+    disableLinksMenu?: boolean;
+    /**
+     * The icon is rendered with an `IconButton` which handles the onClick.
+     * To wrap this in another component, handling the onClick, pass a component,
+     * such as `ListItemSecondaryAction` which handles the `onClick` to open the
+     * popup menu.
+     *
+     * The {@link ResultCheckIconProps.componentProps} prop can be specified to
+     * add props to the wrapping component.
+     */
+    component?: ElementType<P>;
+    /**
+     * Props to provide to the wrapping component
+     * {@link ResultCheckIconProps.component}.
+     */
+    componentProps?: Omit<P, 'onClick' | 'children'>;
+    /**
+     * Override the component used to display instead of a result icon, when no
+     * renderer was found for this check type.
+     */
+    missingRendererComponent?: ReactNode;
+}
+/**
+ * A component that renders an icon representing a check result, optionally with a popup menu
+ * containing links related to the check.
+ *
+ * @public
+ */
+declare const ResultCheckIcon: <P extends ResultCheckIconBaseComponentProps>(props: ResultCheckIconProps<P>) => React.JSX.Element;
+
+/**
+ * ResultLinksMenu setMenu receiver.
+ *
+ * This object contains an {@link ResultLinksMenuInfo.open | open} function,
+ * which can be used to open the popup menu. It closes automatically on
+ * click-away.
+ *
+ * @public
+ */
+type ResultLinksMenuInfo = {
+    /**
+     * Call this function to open the popup menu. The element argument should be
+     * an element which is used as an anchor for the menu - where to display it.
+     */
+    open: (element: Element) => void;
+};
+/**
+ * A component that renders a popup menu with links related to a check result.
+ *
+ * @public
+ */
+declare const ResultLinksMenu: (props: React.PropsWithChildren<{
+    result: CheckResult;
+    entity?: Entity | undefined;
+    setMenu(opener: ResultLinksMenuInfo | undefined): void;
+}>) => React.JSX.Element | null;
+
+export { BooleanCheck, type CheckResultRenderer, ResultCheckIcon, type ResultCheckIconBaseComponentProps, type ResultCheckIconProps, ResultLinksMenu, type ResultLinksMenuInfo, type TechInsightsApi, TechInsightsClient, isBooleanCheckFailed, jsonRulesEngineCheckResultRenderer, techInsightsApiRef };

package/dist/index.esm.js

@@ -0,0 +1,7 @@
+export { techInsightsApiRef } from './api/TechInsightsApi.esm.js';
+export { TechInsightsClient } from './api/TechInsightsClient.esm.js';
+export { BooleanCheck, isBooleanCheckFailed } from './components/BooleanCheck/BooleanCheck.esm.js';
+export { jsonRulesEngineCheckResultRenderer } from './components/CheckResultRenderer.esm.js';
+export { ResultCheckIcon } from './components/ResultCheckIcon/ResultCheckIcon.esm.js';
+export { ResultLinksMenu } from './components/ResultLinksMenu/ResultLinksMenu.esm.js';
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@backstage-community/plugin-tech-insights-react",
+  "description": "Web library for the tech-insights plugin",
+  "version": "1.1.0",
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/tech-insights/plugins/tech-insights-react"
+  },
+  "backstage": {
+    "role": "web-library",
+    "pluginId": "tech-insights",
+    "pluginPackages": [
+      "@backstage-community/plugin-tech-insights",
+      "@backstage-community/plugin-tech-insights-backend",
+      "@backstage-community/plugin-tech-insights-common",
+      "@backstage-community/plugin-tech-insights-maturity",
+      "@backstage-community/plugin-tech-insights-maturity-common",
+      "@backstage-community/plugin-tech-insights-node",
+      "@backstage-community/plugin-tech-insights-react"
+    ]
+  },
+  "sideEffects": false,
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage-community/plugin-tech-insights-common": "^0.5.0",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/core-plugin-api": "^1.10.3",
+    "@backstage/types": "^1.2.1",
+    "@material-ui/core": "^4.9.13",
+    "@material-ui/icons": "^4.9.1",
+    "@material-ui/lab": "4.0.0-alpha.61"
+  },
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.29.6",
+    "@backstage/test-utils": "^1.7.4",
+    "@testing-library/jest-dom": "^6.0.0",
+    "@testing-library/react": "^14.0.0",
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ]
+    }
+  },
+  "module": "./dist/index.esm.js"
+}