@backstage/plugin-home 0.8.8-next.3 → 0.8.8

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @backstage/plugin-home
 
+## 0.8.8
+
+### Patch Changes
+
+- f7ca0fe: Added the Catalog presentation API to the HomePageRecentlyVisited and HomePageTopVisited components
+- fb58f20: Internal update to use the new `pluginId` option of `createFrontendPlugin`.
+- eddd96c: Added optional title prop to `customHomePageGrid`
+- 16eb4bf: Export ContentModal from `@backstage/plugin-home-react` so people can use this in other scenarios.
+  Renamed `CatalogReactComponentsNameToClassKey` to `PluginHomeComponentsNameToClassKey` in `overridableComponents.ts`
+
+  Made QuickStartCard `docsLinkTitle` prop more flexible to allow for any React.JSX.Element instead of just a string.
+  Added QuickStartCard prop `additionalContent` which can eventually replace the prop `video`.
+
+- 2c1761f: Added a `variant` prop to the `WelcomeTitle` component making it work with the Customizable Home page feature. Adding it like this `<WelcomeTitle variant='h1' />` to the list of items under `CustomHomepageGrid` will allow it to render with a size that works well.
+- 195323f: Export root page route from the home plugin to enable adding links/nav to it from outside the plugin
+- 72d019d: Removed various typos
+- d710d74: docs: Update default for `preventCollision` prop
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.10.2
+  - @backstage/theme@0.6.6
+  - @backstage/core-app-api@1.17.0
+  - @backstage/core-components@0.17.2
+  - @backstage/catalog-model@1.7.4
+  - @backstage/core-compat-api@0.4.2
+  - @backstage/plugin-home-react@0.1.26
+  - @backstage/plugin-catalog-react@1.18.0
+  - @backstage/core-plugin-api@1.10.7
+  - @backstage/catalog-client@1.10.0
+  - @backstage/config@1.3.2
+
 ## 0.8.8-next.3
 
 ### Patch Changes

package/dist/homePageComponents/WelcomeTitle/WelcomeTitle.esm.js

@@ -6,7 +6,10 @@ import { useMemo, useEffect } from 'react';
 import useAsync from 'react-use/esm/useAsync';
 import { getTimeBasedGreeting } from './timeUtil.esm.js';
 
-const WelcomeTitle = ({ language }) => {
+const WelcomeTitle = ({
+  language,
+  variant
+}) => {
   const identityApi = useApi(identityApiRef);
   const alertApi = useApi(alertApiRef);
   const greeting = useMemo(() => getTimeBasedGreeting(language), [language]);
@@ -21,7 +24,7 @@ const WelcomeTitle = ({ language }) => {
       });
     }
   }, [error, alertApi]);
-  return /* @__PURE__ */ jsx(Tooltip, { title: greeting.language, children: /* @__PURE__ */ jsx(Typography, { component: "span", variant: "inherit", children: `${greeting.greeting}${profile?.displayName ? `, ${profile?.displayName}` : ""}!` }) });
+  return /* @__PURE__ */ jsx(Tooltip, { title: greeting.language, children: /* @__PURE__ */ jsx(Typography, { component: "span", variant, children: `${greeting.greeting}${profile?.displayName ? `, ${profile?.displayName}` : ""}!` }) });
 };
 
 export { WelcomeTitle };

package/dist/homePageComponents/WelcomeTitle/WelcomeTitle.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"WelcomeTitle.esm.js","sources":["../../../src/homePageComponents/WelcomeTitle/WelcomeTitle.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 {\n  alertApiRef,\n  identityApiRef,\n  useApi,\n} from '@backstage/core-plugin-api';\nimport Tooltip from '@material-ui/core/Tooltip';\nimport Typography from '@material-ui/core/Typography';\nimport { useEffect, useMemo } from 'react';\nimport useAsync from 'react-use/esm/useAsync';\nimport { getTimeBasedGreeting } from './timeUtil';\n\n/** @public */\nexport type WelcomeTitleLanguageProps = {\n  language?: string[];\n};\n\nexport const WelcomeTitle = ({ language }: WelcomeTitleLanguageProps) => {\n  const identityApi = useApi(identityApiRef);\n  const alertApi = useApi(alertApiRef);\n  const greeting = useMemo(() => getTimeBasedGreeting(language), [language]);\n\n  const { value: profile, error } = useAsync(() =>\n    identityApi.getProfileInfo(),\n  );\n\n  useEffect(() => {\n    if (error) {\n      alertApi.post({\n        message: `Failed to load user identity: ${error}`,\n        severity: 'error',\n      });\n    }\n  }, [error, alertApi]);\n\n  return (\n    <Tooltip title={greeting.language}>\n      <Typography component=\"span\" variant=\"inherit\">{`${greeting.greeting}${\n        profile?.displayName ? `, ${profile?.displayName}` : ''\n      }!`}</Typography>\n    </Tooltip>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AA+BO,MAAM,YAAe,GAAA,CAAC,EAAE,QAAA,EAA0C,KAAA;AACvE,EAAM,MAAA,WAAA,GAAc,OAAO,cAAc,CAAA;AACzC,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA;AACnC,EAAM,MAAA,QAAA,GAAW,QAAQ,MAAM,oBAAA,CAAqB,QAAQ,CAAG,EAAA,CAAC,QAAQ,CAAC,CAAA;AAEzE,EAAA,MAAM,EAAE,KAAA,EAAO,OAAS,EAAA,KAAA,EAAU,GAAA,QAAA;AAAA,IAAS,MACzC,YAAY,cAAe;AAAA,GAC7B;AAEA,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,QAAA,CAAS,IAAK,CAAA;AAAA,QACZ,OAAA,EAAS,iCAAiC,KAAK,CAAA,CAAA;AAAA,QAC/C,QAAU,EAAA;AAAA,OACX,CAAA;AAAA;AACH,GACC,EAAA,CAAC,KAAO,EAAA,QAAQ,CAAC,CAAA;AAEpB,EACE,uBAAA,GAAA,CAAC,WAAQ,KAAO,EAAA,QAAA,CAAS,UACvB,QAAC,kBAAA,GAAA,CAAA,UAAA,EAAA,EAAW,SAAU,EAAA,MAAA,EAAO,OAAQ,EAAA,SAAA,EAAW,aAAG,QAAS,CAAA,QAAQ,CAClE,EAAA,OAAA,EAAS,WAAc,GAAA,CAAA,EAAA,EAAK,SAAS,WAAW,CAAA,CAAA,GAAK,EACvD,CAAA,CAAA,CAAA,EAAI,CACN,EAAA,CAAA;AAEJ;;;;"}
+{"version":3,"file":"WelcomeTitle.esm.js","sources":["../../../src/homePageComponents/WelcomeTitle/WelcomeTitle.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 {\n  alertApiRef,\n  identityApiRef,\n  useApi,\n} from '@backstage/core-plugin-api';\nimport Tooltip from '@material-ui/core/Tooltip';\nimport Typography from '@material-ui/core/Typography';\nimport { useEffect, useMemo } from 'react';\nimport useAsync from 'react-use/esm/useAsync';\nimport { getTimeBasedGreeting } from './timeUtil';\nimport { Variant } from '@material-ui/core/styles/createTypography';\n\n/** @public */\nexport type WelcomeTitleLanguageProps = {\n  language?: string[];\n  variant?: Variant | 'inherit';\n};\n\nexport const WelcomeTitle = ({\n  language,\n  variant,\n}: WelcomeTitleLanguageProps) => {\n  const identityApi = useApi(identityApiRef);\n  const alertApi = useApi(alertApiRef);\n  const greeting = useMemo(() => getTimeBasedGreeting(language), [language]);\n\n  const { value: profile, error } = useAsync(() =>\n    identityApi.getProfileInfo(),\n  );\n\n  useEffect(() => {\n    if (error) {\n      alertApi.post({\n        message: `Failed to load user identity: ${error}`,\n        severity: 'error',\n      });\n    }\n  }, [error, alertApi]);\n\n  return (\n    <Tooltip title={greeting.language}>\n      <Typography component=\"span\" variant={variant}>{`${greeting.greeting}${\n        profile?.displayName ? `, ${profile?.displayName}` : ''\n      }!`}</Typography>\n    </Tooltip>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AAiCO,MAAM,eAAe,CAAC;AAAA,EAC3B,QAAA;AAAA,EACA;AACF,CAAiC,KAAA;AAC/B,EAAM,MAAA,WAAA,GAAc,OAAO,cAAc,CAAA;AACzC,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA;AACnC,EAAM,MAAA,QAAA,GAAW,QAAQ,MAAM,oBAAA,CAAqB,QAAQ,CAAG,EAAA,CAAC,QAAQ,CAAC,CAAA;AAEzE,EAAA,MAAM,EAAE,KAAA,EAAO,OAAS,EAAA,KAAA,EAAU,GAAA,QAAA;AAAA,IAAS,MACzC,YAAY,cAAe;AAAA,GAC7B;AAEA,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,QAAA,CAAS,IAAK,CAAA;AAAA,QACZ,OAAA,EAAS,iCAAiC,KAAK,CAAA,CAAA;AAAA,QAC/C,QAAU,EAAA;AAAA,OACX,CAAA;AAAA;AACH,GACC,EAAA,CAAC,KAAO,EAAA,QAAQ,CAAC,CAAA;AAEpB,EACE,uBAAA,GAAA,CAAC,WAAQ,KAAO,EAAA,QAAA,CAAS,UACvB,QAAC,kBAAA,GAAA,CAAA,UAAA,EAAA,EAAW,SAAU,EAAA,MAAA,EAAO,OAAmB,EAAA,QAAA,EAAA,CAAA,EAAG,SAAS,QAAQ,CAAA,EAClE,SAAS,WAAc,GAAA,CAAA,EAAA,EAAK,SAAS,WAAW,CAAA,CAAA,GAAK,EACvD,CAAA,CAAA,CAAA,EAAI,CACN,EAAA,CAAA;AAEJ;;;;"}

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { createCardExtension as createCardExtension$1, CardExtensionProps as Car
 import * as react from 'react';
 import { ReactNode, JSX as JSX$1, CSSProperties, ReactElement } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Variant } from '@material-ui/core/styles/createTypography';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
 import { StorageApi, IdentityApi, ErrorApi } from '@backstage/core-plugin-api';
 import { EntityFilterQuery } from '@backstage/catalog-client';
@@ -32,6 +33,7 @@ type ClockConfig = {
 /** @public */
 type WelcomeTitleLanguageProps = {
     language?: string[];
+    variant?: Variant | 'inherit';
 };
 
 /**
@@ -290,7 +292,7 @@ declare const ComponentTab: (props: {
  *
  * @public
  */
-declare const WelcomeTitle: ({ language }: WelcomeTitleLanguageProps) => react_jsx_runtime.JSX.Element;
+declare const WelcomeTitle: ({ language, variant, }: WelcomeTitleLanguageProps) => react_jsx_runtime.JSX.Element;
 /**
  * A component to display a company logo for the user.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-home",
-  "version": "0.8.8-next.3",
+  "version": "0.8.8",
   "description": "A Backstage plugin that helps you build a home page",
   "backstage": {
     "role": "frontend-plugin",
@@ -68,17 +68,17 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "1.10.0-next.0",
-    "@backstage/catalog-model": "1.7.3",
-    "@backstage/config": "1.3.2",
-    "@backstage/core-app-api": "1.17.0-next.1",
-    "@backstage/core-compat-api": "0.4.2-next.3",
-    "@backstage/core-components": "0.17.2-next.1",
-    "@backstage/core-plugin-api": "1.10.7-next.0",
-    "@backstage/frontend-plugin-api": "0.10.2-next.1",
-    "@backstage/plugin-catalog-react": "1.18.0-next.3",
-    "@backstage/plugin-home-react": "0.1.26-next.2",
-    "@backstage/theme": "0.6.6-next.0",
+    "@backstage/catalog-client": "^1.10.0",
+    "@backstage/catalog-model": "^1.7.4",
+    "@backstage/config": "^1.3.2",
+    "@backstage/core-app-api": "^1.17.0",
+    "@backstage/core-compat-api": "^0.4.2",
+    "@backstage/core-components": "^0.17.2",
+    "@backstage/core-plugin-api": "^1.10.7",
+    "@backstage/frontend-plugin-api": "^0.10.2",
+    "@backstage/plugin-catalog-react": "^1.18.0",
+    "@backstage/plugin-home-react": "^0.1.26",
+    "@backstage/theme": "^0.6.6",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -94,9 +94,9 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.32.1-next.3",
-    "@backstage/dev-utils": "1.1.10-next.3",
-    "@backstage/test-utils": "1.7.8-next.2",
+    "@backstage/cli": "^0.32.1",
+    "@backstage/dev-utils": "^1.1.10",
+    "@backstage/test-utils": "^1.7.8",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",