@backstage/plugin-home 0.8.14-next.0 → 0.8.14-next.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @backstage/plugin-home
 
+## 0.8.14-next.1
+
+### Patch Changes
+
+- 2ac5d29: Allow customization of VisitList by adding optional enrichVisit, transformPathname, canSave functions to VisitsStorageApi, along with VisitDisplayProvider for colors, labels
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.21.3-next.2
+  - @backstage/frontend-plugin-api@0.12.2-next.2
+  - @backstage/core-components@0.18.3-next.2
+
 ## 0.8.14-next.0
 
 ### Patch Changes

package/README.md

@@ -132,7 +132,7 @@ export const RandomJokeHomePageComponent = homePlugin.provide(
 );
 ```
 
-These settings can also be defined for components that use `createReactExtension` instead `createCardExtension` by using
+These settings can also be defined for components that use `createReactExtension` instead of `createCardExtension` by using
 the data property:
 
 ```tsx
@@ -356,13 +356,189 @@ home:
 
 In order to validate the config you can use `backstage/cli config:check`
 
+### Customizing the VisitList
+
+If you want more control over the recent and top visited lists, you can write your own functions to transform the pathnames and determine which visits to save. You can also enrich each visit with other fields and customize the chip colors/labels in the visit lists.
+
+#### Transform Pathname Function
+
+Provide a `transformPathname` function to transform the pathname before it's processed for visit tracking. This can be used for transforming the pathname for the visit (before any other consideration). As an example, you can treat multiple sub-path visits to be counted as a singular path, e.g. `/entity-path/sub1` , `/entity-path/sub-2`, `/entity-path/sub-2/sub-sub-2` can all be mapped to `/entity-path` so visits to any of those routes are all counted as the same.
+
+```tsx
+import {
+  AnyApiFactory,
+  createApiFactory,
+  identityApiRef,
+  storageApiRef,
+} from '@backstage/core-plugin-api';
+import { VisitsStorageApi } from '@backstage/plugin-home';
+
+const transformPathname = (pathname: string) => {
+  const pathnameParts = pathname.split('/').filter(part => part !== '');
+  const rootPathFromPathname = pathnameParts[0] ?? '';
+  if (rootPathFromPathname === 'catalog' && pathnameParts.length >= 4) {
+    return `/${pathnameParts.slice(0, 4).join('/')}`;
+  }
+  return pathname;
+};
+
+export const apis: AnyApiFactory[] = [
+  createApiFactory({
+    api: visitsApiRef,
+    deps: {
+      storageApi: storageApiRef,
+      identityApi: identityApiRef,
+    },
+    factory: ({ storageApi, identityApi }) =>
+      VisitsStorageApi.create({
+        storageApi,
+        identityApi,
+        transformPathname,
+      }),
+  }),
+];
+```
+
+#### Can Save Function
+
+Provide a `canSave` function to determine which visits should be tracked and saved. This allows you to conditionally save visits to the list:
+
+```tsx
+import {
+  AnyApiFactory,
+  createApiFactory,
+  identityApiRef,
+  storageApiRef,
+} from '@backstage/core-plugin-api';
+import { VisitInput, VisitsStorageApi } from '@backstage/plugin-home';
+
+const canSave = (visit: VisitInput) => {
+  // Don't save visits to admin or settings pages
+  return (
+    !visit.pathname.startsWith('/admin') &&
+    !visit.pathname.startsWith('/settings')
+  );
+};
+
+export const apis: AnyApiFactory[] = [
+  createApiFactory({
+    api: visitsApiRef,
+    deps: {
+      storageApi: storageApiRef,
+      identityApi: identityApiRef,
+    },
+    factory: ({ storageApi, identityApi }) =>
+      VisitsStorageApi.create({
+        storageApi,
+        identityApi,
+        canSave,
+      }),
+  }),
+];
+```
+
+#### Enrich Visit Function
+
+You can also add the `enrichVisit` function to put additional values on each `Visit`. The values could later be used to customize the chips in the `VisitList`. For example, you could add the entity `type` on the `Visit` so that `type` is used for labels instead of `kind`.
+
+```tsx
+import {
+  AnyApiFactory,
+  createApiFactory,
+  identityApiRef,
+  storageApiRef,
+} from '@backstage/core-plugin-api';
+import { CatalogApi, catalogApiRef } from '@backstage/plugin-catalog-react';
+import { VisitsStorageApi } from '@backstage/plugin-home';
+
+type EnrichedVisit = VisitInput & {
+  type?: string;
+};
+
+const createEnrichVisit =
+  (catalogApi: CatalogApi) =>
+  async (visit: VisitInput): Promise<EnrichedVisit> => {
+    if (!visit.entityRef) {
+      return visit;
+    }
+    try {
+      const entity = await catalogApi.getEntityByRef(visit.entityRef);
+      const type = entity?.spec?.type?.toString();
+      return { ...visit, type };
+    } catch (error) {
+      return visit;
+    }
+  };
+
+export const apis: AnyApiFactory[] = [
+  createApiFactory({
+    api: visitsApiRef,
+    deps: {
+      storageApi: storageApiRef,
+      identityApi: identityApiRef,
+      catalogApi: catalogApiRef,
+    },
+    factory: ({ storageApi, identityApi, catalogApi }) =>
+      VisitsStorageApi.create({
+        storageApi,
+        identityApi,
+        enrichVisit: createEnrichVisit(catalogApi),
+      }),
+  }),
+];
+```
+
+#### Custom Chip Colors and Labels
+
+To provide your own chip colors and/or labels for the recent and top visited lists, wrap the components in `VisitDisplayProvider` with `getChipColor` and `getChipLabel` functions. The colors provided will be used instead of the hard coded [colorVariants](https://github.com/backstage/backstage/blob/2da352043425bcab4c4422e4d2820c26c0a83382/packages/theme/src/base/pageTheme.ts#L46) provided via `@backstage/theme`.
+
+```tsx
+import {
+  CustomHomepageGrid,
+  HomePageTopVisited,
+  HomePageRecentlyVisited,
+  VisitDisplayProvider,
+} from '@backstage/plugin-home';
+
+const getChipColor = (visit: any) => {
+  const type = visit.type;
+  switch (type) {
+    case 'application':
+      return '#b39ddb';
+    case 'service':
+      return '#90caf9';
+    case 'account':
+      return '#a5d6a7';
+    case 'suite':
+      return '#fff59d';
+    default:
+      return '#ef9a9a';
+  }
+};
+
+const getChipLabel = (visit?: any) => {
+  return visit?.type ? visit.type : 'Other';
+};
+
+export default function HomePage() {
+  return (
+    <VisitDisplayProvider getChipColor={getChipColor} getLabel={getChipLabel}>
+      <CustomHomepageGrid title="Your Dashboard">
+        <HomePageRecentlyVisited />
+        <HomePageTopVisited />
+      </CustomHomepageGrid>
+    </VisitDisplayProvider>
+  );
+}
+```
+
 ## Contributing
 
 ### Homepage Components
 
-We believe that people have great ideas for what makes a useful Home Page, and we want to make it easy for every to benefit from the effort you put in to create something cool for the Home Page. Therefore, a great way of contributing is by simply creating more Home Page Components, than can then be used by everyone when composing their own Home Page. If they are tightly coupled to an existing plugin, it is recommended to allow them to live within that plugin, for convenience and to limit complex dependencies. On the other hand, if there's no clear plugin that the component is based on, it's also fine to contribute them into the [home plugin](/plugins/home/src/homePageComponents)
+We believe that people have great ideas for what makes a useful Home Page, and we want to make it easy for everyone to benefit from the effort you put in to create something cool for the Home Page. Therefore, a great way of contributing is by simply creating more Home Page Components that can then be used by everyone when composing their own Home Page. If they are tightly coupled to an existing plugin, it is recommended to allow them to live within that plugin, for convenience and to limit complex dependencies. On the other hand, if there's no clear plugin that the component is based on, it's also fine to contribute them into the [home plugin](/plugins/home/src/homePageComponents)
 
-Additionally, the API is at a very early state, so contributing with additional use cases may expose weaknesses in the current solution that we may iterate on, to provide more flexibility and ease of use for those who wish to develop components for the Home Page.
+Additionally, the API is at a very early state, so contributing additional use cases may expose weaknesses in the current solution that we may iterate on to provide more flexibility and ease of use for those who wish to develop components for the Home Page.
 
 ### Homepage Templates
 

package/dist/alpha.esm.js

@@ -4,6 +4,7 @@ import { compatWrapper } from '@backstage/core-compat-api';
 import 'react-router-dom';
 import './components/CustomHomepage/CustomHomepageGrid.esm.js';
 import { VisitListener } from './components/VisitListener.esm.js';
+import './components/VisitList/Context.esm.js';
 import { VisitsStorageApi } from './api/VisitsStorageApi.esm.js';
 import '@backstage/core-app-api';
 import { visitsApiRef } from './api/VisitsApi.esm.js';

package/dist/alpha.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  coreExtensionData,\n  createExtensionDataRef,\n  createExtensionInput,\n  PageBlueprint,\n  createFrontendPlugin,\n  createRouteRef,\n  AppRootElementBlueprint,\n  identityApiRef,\n  storageApiRef,\n  ApiBlueprint,\n} from '@backstage/frontend-plugin-api';\nimport { compatWrapper } from '@backstage/core-compat-api';\nimport { VisitListener } from './components/';\nimport { visitsApiRef, VisitsStorageApi } from './api';\n\nconst rootRouteRef = createRouteRef();\n\n/**\n * @alpha\n */\nexport const titleExtensionDataRef = createExtensionDataRef<string>().with({\n  id: 'title',\n});\n\nconst homePage = PageBlueprint.makeWithOverrides({\n  inputs: {\n    props: createExtensionInput(\n      [\n        coreExtensionData.reactElement.optional(),\n        titleExtensionDataRef.optional(),\n      ],\n      {\n        singleton: true,\n        optional: true,\n      },\n    ),\n  },\n  factory: (originalFactory, { inputs }) => {\n    return originalFactory({\n      path: '/home',\n      routeRef: rootRouteRef,\n      loader: () =>\n        import('./components/').then(m =>\n          compatWrapper(\n            <m.HomepageCompositionRoot\n              children={inputs.props?.get(coreExtensionData.reactElement)}\n              title={inputs.props?.get(titleExtensionDataRef)}\n            />,\n          ),\n        ),\n    });\n  },\n});\n\nconst visitListenerAppRootElement = AppRootElementBlueprint.make({\n  name: 'visit-listener',\n  params: {\n    element: <VisitListener />,\n  },\n});\n\nconst visitsApi = ApiBlueprint.make({\n  name: 'visits',\n  params: defineParams =>\n    defineParams({\n      api: visitsApiRef,\n      deps: {\n        storageApi: storageApiRef,\n        identityApi: identityApiRef,\n      },\n      factory: ({ storageApi, identityApi }) =>\n        VisitsStorageApi.create({ storageApi, identityApi }),\n    }),\n});\n\n/**\n * @alpha\n */\nexport default createFrontendPlugin({\n  pluginId: 'home',\n  info: { packageJson: () => import('../package.json') },\n  extensions: [homePage, visitsApi, visitListenerAppRootElement],\n  routes: {\n    root: rootRouteRef,\n  },\n});\n\nexport { homeTranslationRef } from './translation';\n"],"names":[],"mappings":";;;;;;;;;;;AAgCA,MAAM,eAAe,cAAA,EAAe;AAK7B,MAAM,qBAAA,GAAwB,sBAAA,EAA+B,CAAE,IAAA,CAAK;AAAA,EACzE,EAAA,EAAI;AACN,CAAC;AAED,MAAM,QAAA,GAAW,cAAc,iBAAA,CAAkB;AAAA,EAC/C,MAAA,EAAQ;AAAA,IACN,KAAA,EAAO,oBAAA;AAAA,MACL;AAAA,QACE,iBAAA,CAAkB,aAAa,QAAA,EAAS;AAAA,QACxC,sBAAsB,QAAA;AAAS,OACjC;AAAA,MACA;AAAA,QACE,SAAA,EAAW,IAAA;AAAA,QACX,QAAA,EAAU;AAAA;AACZ;AACF,GACF;AAAA,EACA,OAAA,EAAS,CAAC,eAAA,EAAiB,EAAE,QAAO,KAAM;AACxC,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,OAAA;AAAA,MACN,QAAA,EAAU,YAAA;AAAA,MACV,MAAA,EAAQ,MACN,OAAO,2BAAe,CAAA,CAAE,IAAA;AAAA,QAAK,CAAA,CAAA,KAC3B,aAAA;AAAA,0BACE,GAAA;AAAA,YAAC,CAAA,CAAE,uBAAA;AAAA,YAAF;AAAA,cACC,QAAA,EAAU,MAAA,CAAO,KAAA,EAAO,GAAA,CAAI,kBAAkB,YAAY,CAAA;AAAA,cAC1D,KAAA,EAAO,MAAA,CAAO,KAAA,EAAO,GAAA,CAAI,qBAAqB;AAAA;AAAA;AAChD;AACF;AACF,KACH,CAAA;AAAA,EACH;AACF,CAAC,CAAA;AAED,MAAM,2BAAA,GAA8B,wBAAwB,IAAA,CAAK;AAAA,EAC/D,IAAA,EAAM,gBAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,OAAA,sBAAU,aAAA,EAAA,EAAc;AAAA;AAE5B,CAAC,CAAA;AAED,MAAM,SAAA,GAAY,aAAa,IAAA,CAAK;AAAA,EAClC,IAAA,EAAM,QAAA;AAAA,EACN,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,YAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,UAAA,EAAY,aAAA;AAAA,MACZ,WAAA,EAAa;AAAA,KACf;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,UAAA,EAAY,WAAA,EAAY,KAClC,gBAAA,CAAiB,MAAA,CAAO,EAAE,UAAA,EAAY,WAAA,EAAa;AAAA,GACtD;AACL,CAAC,CAAA;AAKD,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,MAAA;AAAA,EACV,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,uBAAiB,CAAA,EAAE;AAAA,EACrD,UAAA,EAAY,CAAC,QAAA,EAAU,SAAA,EAAW,2BAA2B,CAAA;AAAA,EAC7D,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA;AAEV,CAAC,CAAA;;;;"}
+{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  coreExtensionData,\n  createExtensionDataRef,\n  createExtensionInput,\n  PageBlueprint,\n  createFrontendPlugin,\n  createRouteRef,\n  AppRootElementBlueprint,\n  identityApiRef,\n  storageApiRef,\n  ApiBlueprint,\n} from '@backstage/frontend-plugin-api';\nimport { compatWrapper } from '@backstage/core-compat-api';\nimport { VisitListener } from './components/';\nimport { visitsApiRef, VisitsStorageApi } from './api';\n\nconst rootRouteRef = createRouteRef();\n\n/**\n * @alpha\n */\nexport const titleExtensionDataRef = createExtensionDataRef<string>().with({\n  id: 'title',\n});\n\nconst homePage = PageBlueprint.makeWithOverrides({\n  inputs: {\n    props: createExtensionInput(\n      [\n        coreExtensionData.reactElement.optional(),\n        titleExtensionDataRef.optional(),\n      ],\n      {\n        singleton: true,\n        optional: true,\n      },\n    ),\n  },\n  factory: (originalFactory, { inputs }) => {\n    return originalFactory({\n      path: '/home',\n      routeRef: rootRouteRef,\n      loader: () =>\n        import('./components/').then(m =>\n          compatWrapper(\n            <m.HomepageCompositionRoot\n              children={inputs.props?.get(coreExtensionData.reactElement)}\n              title={inputs.props?.get(titleExtensionDataRef)}\n            />,\n          ),\n        ),\n    });\n  },\n});\n\nconst visitListenerAppRootElement = AppRootElementBlueprint.make({\n  name: 'visit-listener',\n  params: {\n    element: <VisitListener />,\n  },\n});\n\nconst visitsApi = ApiBlueprint.make({\n  name: 'visits',\n  params: defineParams =>\n    defineParams({\n      api: visitsApiRef,\n      deps: {\n        storageApi: storageApiRef,\n        identityApi: identityApiRef,\n      },\n      factory: ({ storageApi, identityApi }) =>\n        VisitsStorageApi.create({ storageApi, identityApi }),\n    }),\n});\n\n/**\n * @alpha\n */\nexport default createFrontendPlugin({\n  pluginId: 'home',\n  info: { packageJson: () => import('../package.json') },\n  extensions: [homePage, visitsApi, visitListenerAppRootElement],\n  routes: {\n    root: rootRouteRef,\n  },\n});\n\nexport { homeTranslationRef } from './translation';\n"],"names":[],"mappings":";;;;;;;;;;;;AAgCA,MAAM,eAAe,cAAA,EAAe;AAK7B,MAAM,qBAAA,GAAwB,sBAAA,EAA+B,CAAE,IAAA,CAAK;AAAA,EACzE,EAAA,EAAI;AACN,CAAC;AAED,MAAM,QAAA,GAAW,cAAc,iBAAA,CAAkB;AAAA,EAC/C,MAAA,EAAQ;AAAA,IACN,KAAA,EAAO,oBAAA;AAAA,MACL;AAAA,QACE,iBAAA,CAAkB,aAAa,QAAA,EAAS;AAAA,QACxC,sBAAsB,QAAA;AAAS,OACjC;AAAA,MACA;AAAA,QACE,SAAA,EAAW,IAAA;AAAA,QACX,QAAA,EAAU;AAAA;AACZ;AACF,GACF;AAAA,EACA,OAAA,EAAS,CAAC,eAAA,EAAiB,EAAE,QAAO,KAAM;AACxC,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,OAAA;AAAA,MACN,QAAA,EAAU,YAAA;AAAA,MACV,MAAA,EAAQ,MACN,OAAO,2BAAe,CAAA,CAAE,IAAA;AAAA,QAAK,CAAA,CAAA,KAC3B,aAAA;AAAA,0BACE,GAAA;AAAA,YAAC,CAAA,CAAE,uBAAA;AAAA,YAAF;AAAA,cACC,QAAA,EAAU,MAAA,CAAO,KAAA,EAAO,GAAA,CAAI,kBAAkB,YAAY,CAAA;AAAA,cAC1D,KAAA,EAAO,MAAA,CAAO,KAAA,EAAO,GAAA,CAAI,qBAAqB;AAAA;AAAA;AAChD;AACF;AACF,KACH,CAAA;AAAA,EACH;AACF,CAAC,CAAA;AAED,MAAM,2BAAA,GAA8B,wBAAwB,IAAA,CAAK;AAAA,EAC/D,IAAA,EAAM,gBAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,OAAA,sBAAU,aAAA,EAAA,EAAc;AAAA;AAE5B,CAAC,CAAA;AAED,MAAM,SAAA,GAAY,aAAa,IAAA,CAAK;AAAA,EAClC,IAAA,EAAM,QAAA;AAAA,EACN,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,YAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,UAAA,EAAY,aAAA;AAAA,MACZ,WAAA,EAAa;AAAA,KACf;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,UAAA,EAAY,WAAA,EAAY,KAClC,gBAAA,CAAiB,MAAA,CAAO,EAAE,UAAA,EAAY,WAAA,EAAa;AAAA,GACtD;AACL,CAAC,CAAA;AAKD,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,MAAA;AAAA,EACV,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,uBAAiB,CAAA,EAAE;AAAA,EACrD,UAAA,EAAY,CAAC,QAAA,EAAU,SAAA,EAAW,2BAA2B,CAAA;AAAA,EAC7D,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA;AAEV,CAAC,CAAA;;;;"}

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

@@ -1 +1 @@
-{"version":3,"file":"VisitsApi.esm.js","sources":["../../src/api/VisitsApi.ts"],"sourcesContent":["/*\n * Copyright 2023 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';\n\n/**\n * @public\n * The operators that can be used in filter.\n */\nexport type Operators = '<' | '<=' | '==' | '!=' | '>' | '>=' | 'contains';\n\n/**\n * @public\n * Type guard for operators.\n */\nexport const isOperator = (s: string): s is Operators => {\n  return ['<', '<=', '==', '!=', '>', '>=', 'contains'].includes(s);\n};\n\n/**\n * @public\n * Model for a visit entity.\n */\nexport type Visit = {\n  /**\n   * The auto-generated visit identification.\n   */\n  id: string;\n  /**\n   * The visited entity, usually an entity id.\n   */\n  name: string;\n  /**\n   * The visited url pathname, usually the entity route.\n   */\n  pathname: string;\n  /**\n   * An individual view count.\n   */\n  hits: number;\n  /**\n   * Last date and time of visit. Format: unix epoch in ms.\n   */\n  timestamp: number;\n  /**\n   * Optional entity reference. See stringifyEntityRef from catalog-model.\n   */\n  entityRef?: string;\n};\n\n/**\n * @public\n * This data structure represents the parameters associated with search queries for visits.\n */\nexport type VisitsApiQueryParams = {\n  /**\n   * Limits the number of results returned. The default is 8.\n   */\n  limit?: number;\n  /**\n   * Allows ordering visits on entity properties.\n   * @example\n   * Sort ascending by the timestamp field.\n   * ```\n   * { orderBy: [{ field: 'timestamp', direction: 'asc' }] }\n   * ```\n   */\n  orderBy?: Array<{\n    field: keyof Visit;\n    direction: 'asc' | 'desc';\n  }>;\n  /**\n   * Allows filtering visits on entity properties.\n   * @example\n   * Most popular docs on the past 7 days\n   * ```\n   * {\n   *   orderBy: [{ field: 'hits', direction: 'desc' }],\n   *   filterBy: [\n   *     { field: 'timestamp', operator: '>=', value: <date> },\n   *     { field: 'entityRef', operator: 'contains', value: 'docs' }\n   *   ]\n   * }\n   * ```\n   */\n  filterBy?: Array<{\n    field: keyof Visit;\n    operator: Operators;\n    value: string | number;\n  }>;\n};\n\n/**\n * @public\n * This data structure represents the parameters associated with saving visits.\n */\nexport type VisitsApiSaveParams = {\n  visit: Omit<Visit, 'id' | 'hits' | 'timestamp'>;\n};\n\n/**\n * @public\n * Visits API public contract.\n */\nexport interface VisitsApi {\n  /**\n   * Persist a new visit.\n   * @param pageVisit - a new visit data\n   */\n  save(saveParams: VisitsApiSaveParams): Promise<Visit>;\n  /**\n   * Get user visits.\n   * @param queryParams - optional search query params.\n   */\n  list(queryParams?: VisitsApiQueryParams): Promise<Visit[]>;\n}\n\n/** @public */\nexport const visitsApiRef = createApiRef<VisitsApi>({\n  id: 'homepage.visits',\n});\n"],"names":[],"mappings":";;AA4BO,MAAM,UAAA,GAAa,CAAC,CAAA,KAA8B;AACvD,EAAA,OAAO,CAAC,GAAA,EAAK,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,KAAK,IAAA,EAAM,UAAU,CAAA,CAAE,QAAA,CAAS,CAAC,CAAA;AAClE;AAqGO,MAAM,eAAe,YAAA,CAAwB;AAAA,EAClD,EAAA,EAAI;AACN,CAAC;;;;"}
+{"version":3,"file":"VisitsApi.esm.js","sources":["../../src/api/VisitsApi.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { VisitInput } from './VisitsStorageApi';\n\n/**\n * @public\n * The operators that can be used in filter.\n */\nexport type Operators = '<' | '<=' | '==' | '!=' | '>' | '>=' | 'contains';\n\n/**\n * @public\n * Type guard for operators.\n */\nexport const isOperator = (s: string): s is Operators => {\n  return ['<', '<=', '==', '!=', '>', '>=', 'contains'].includes(s);\n};\n\n/**\n * @public\n * Model for a visit entity.\n */\nexport type Visit = {\n  /**\n   * The auto-generated visit identification.\n   */\n  id: string;\n  /**\n   * The visited entity, usually an entity id.\n   */\n  name: string;\n  /**\n   * The visited url pathname, usually the entity route.\n   */\n  pathname: string;\n  /**\n   * An individual view count.\n   */\n  hits: number;\n  /**\n   * Last date and time of visit. Format: unix epoch in ms.\n   */\n  timestamp: number;\n  /**\n   * Optional entity reference. See stringifyEntityRef from catalog-model.\n   */\n  entityRef?: string;\n};\n\n/**\n * @public\n * This data structure represents the parameters associated with search queries for visits.\n */\nexport type VisitsApiQueryParams = {\n  /**\n   * Limits the number of results returned. The default is 8.\n   */\n  limit?: number;\n  /**\n   * Allows ordering visits on entity properties.\n   * @example\n   * Sort ascending by the timestamp field.\n   * ```\n   * { orderBy: [{ field: 'timestamp', direction: 'asc' }] }\n   * ```\n   */\n  orderBy?: Array<{\n    field: keyof Visit;\n    direction: 'asc' | 'desc';\n  }>;\n  /**\n   * Allows filtering visits on entity properties.\n   * @example\n   * Most popular docs on the past 7 days\n   * ```\n   * {\n   *   orderBy: [{ field: 'hits', direction: 'desc' }],\n   *   filterBy: [\n   *     { field: 'timestamp', operator: '>=', value: <date> },\n   *     { field: 'entityRef', operator: 'contains', value: 'docs' }\n   *   ]\n   * }\n   * ```\n   */\n  filterBy?: Array<{\n    field: keyof Visit;\n    operator: Operators;\n    value: string | number;\n  }>;\n};\n\n/**\n * @public\n * This data structure represents the parameters associated with saving visits.\n */\nexport type VisitsApiSaveParams = {\n  visit: Omit<Visit, 'id' | 'hits' | 'timestamp'>;\n};\n\n/**\n * @public\n * Visits API public contract.\n */\nexport interface VisitsApi {\n  /**\n   * Persist a new visit.\n   * @param pageVisit - a new visit data\n   */\n  save(saveParams: VisitsApiSaveParams): Promise<Visit>;\n  /**\n   * Get user visits.\n   * @param queryParams - optional search query params.\n   */\n  list(queryParams?: VisitsApiQueryParams): Promise<Visit[]>;\n  /**\n   * Transform the pathname before it is considered for any other processing.\n   * @param pathname - the original pathname\n   */\n  transformPathname?(pathname: string): string;\n  /**\n   * Determine whether a visit should be saved.\n   * @param visit - page visit data\n   */\n  canSave?(visit: VisitInput): boolean | Promise<boolean>;\n  /**\n   * Add additional data to the visit before saving.\n   * @param visit - page visit data\n   */\n  enrichVisit?(\n    visit: VisitInput,\n  ): Promise<Record<string, any>> | Record<string, any>;\n}\n\n/** @public */\nexport const visitsApiRef = createApiRef<VisitsApi>({\n  id: 'homepage.visits',\n});\n"],"names":[],"mappings":";;AA6BO,MAAM,UAAA,GAAa,CAAC,CAAA,KAA8B;AACvD,EAAA,OAAO,CAAC,GAAA,EAAK,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,KAAK,IAAA,EAAM,UAAU,CAAA,CAAE,QAAA,CAAS,CAAC,CAAA;AAClE;AAsHO,MAAM,eAAe,YAAA,CAAwB;AAAA,EAClD,EAAA,EAAI;AACN,CAAC;;;;"}

package/dist/api/VisitsStorageApi.esm.js

@@ -4,6 +4,9 @@ class VisitsStorageApi {
   storageApi;
   storageKeyPrefix = "@backstage/plugin-home:visits";
   identityApi;
+  transformPathnameImpl;
+  canSaveImpl;
+  enrichVisitImpl;
   static create(options) {
     return new VisitsStorageApi(options);
   }
@@ -11,6 +14,9 @@ class VisitsStorageApi {
     this.limit = Math.abs(options.limit ?? 100);
     this.storageApi = options.storageApi;
     this.identityApi = options.identityApi;
+    this.transformPathnameImpl = options.transformPathname;
+    this.canSaveImpl = options.canSave;
+    this.enrichVisitImpl = options.enrichVisit;
   }
   /**
    * Returns a list of visits through the visitsApi
@@ -40,28 +46,73 @@ class VisitsStorageApi {
     });
     return visits.slice(0, queryParams?.limit ?? DEFAULT_LIST_LIMIT);
   }
+  /**
+   * Transform the pathname before it is considered for any other processing.
+   * @param pathname - the original pathname
+   * @returns the transformed pathname
+   */
+  transformPathname(pathname) {
+    return this.transformPathnameImpl?.(pathname) ?? pathname;
+  }
+  /**
+   * Determine whether a visit should be saved.
+   * @param visit - page visit data
+   */
+  async canSave(visit) {
+    if (!this.canSaveImpl) {
+      return true;
+    }
+    return Promise.resolve(this.canSaveImpl(visit));
+  }
+  /**
+   * Add additional data to the visit before saving.
+   * @param visit - page visit data
+   */
+  async enrichVisit(visit) {
+    if (!this.enrichVisitImpl) {
+      return {};
+    }
+    return Promise.resolve(this.enrichVisitImpl(visit));
+  }
   /**
    * Saves a visit through the visitsApi
    */
   async save(saveParams) {
+    let visit = saveParams.visit;
+    visit = {
+      ...visit,
+      pathname: this.transformPathname(visit.pathname)
+    };
+    if (!await this.canSave(visit)) {
+      return {
+        ...visit,
+        id: "",
+        hits: 0,
+        timestamp: Date.now()
+      };
+    }
+    const enrichedData = await this.enrichVisit(visit);
+    const enrichedVisit = { ...visit, ...enrichedData };
     const visits = [...await this.retrieveAll()];
-    const visit = {
-      ...saveParams.visit,
+    const visitToSave = {
+      ...enrichedVisit,
       id: window.crypto.randomUUID(),
       hits: 1,
       timestamp: Date.now()
     };
-    const visitIndex = visits.findIndex((e) => e.pathname === visit.pathname);
+    const visitIndex = visits.findIndex(
+      (e) => e.pathname === visitToSave.pathname
+    );
     if (visitIndex >= 0) {
-      visit.id = visits[visitIndex].id;
-      visit.hits = visits[visitIndex].hits + 1;
-      visits[visitIndex] = visit;
+      visitToSave.id = visits[visitIndex].id;
+      visitToSave.hits = visits[visitIndex].hits + 1;
+      visits[visitIndex] = visitToSave;
     } else {
-      visits.push(visit);
+      visits.push(visitToSave);
     }
     visits.sort((a, b) => b.timestamp - a.timestamp);
     await this.persistAll(visits.splice(0, this.limit));
-    return visit;
+    return visitToSave;
   }
   async persistAll(visits) {
     const storageKey = await this.getStorageKey();

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

@@ -1 +1 @@
-{"version":3,"file":"VisitsStorageApi.esm.js","sources":["../../src/api/VisitsStorageApi.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { IdentityApi, StorageApi } from '@backstage/core-plugin-api';\nimport {\n  Visit,\n  VisitsApi,\n  VisitsApiQueryParams,\n  VisitsApiSaveParams,\n} from './VisitsApi';\n\n/** @public */\nexport type VisitsStorageApiOptions = {\n  limit?: number;\n  storageApi: StorageApi;\n  identityApi: IdentityApi;\n};\n\ntype ArrayElement<A> = A extends readonly (infer T)[] ? T : never;\n\nconst DEFAULT_LIST_LIMIT = 8;\n\n/**\n * @public\n * This is an implementation of VisitsApi that relies on a StorageApi.\n * Beware that filtering and ordering are done in memory therefore it is\n * prudent to keep limit to a reasonable size.\n */\nexport class VisitsStorageApi implements VisitsApi {\n  private readonly limit: number;\n  private readonly storageApi: StorageApi;\n  private readonly storageKeyPrefix = '@backstage/plugin-home:visits';\n  private readonly identityApi: IdentityApi;\n\n  static create(options: VisitsStorageApiOptions) {\n    return new VisitsStorageApi(options);\n  }\n\n  private constructor(options: VisitsStorageApiOptions) {\n    this.limit = Math.abs(options.limit ?? 100);\n    this.storageApi = options.storageApi;\n    this.identityApi = options.identityApi;\n  }\n\n  /**\n   * Returns a list of visits through the visitsApi\n   */\n  async list(queryParams?: VisitsApiQueryParams): Promise<Visit[]> {\n    let visits = [...(await this.retrieveAll())];\n\n    // reversing order to guarantee orderBy priority\n    (queryParams?.orderBy ?? []).reverse().forEach(order => {\n      if (order.direction === 'asc') {\n        visits.sort((a, b) => this.compare(order, a, b));\n      } else {\n        visits.sort((a, b) => this.compare(order, b, a));\n      }\n    });\n\n    // reversing order to guarantee filterBy priority\n    (queryParams?.filterBy ?? []).reverse().forEach(filter => {\n      visits = visits.filter(visit => {\n        const field = visit[filter.field] as number | string;\n        if (filter.operator === '>') return field > filter.value;\n        if (filter.operator === '>=') return field >= filter.value;\n        if (filter.operator === '<') return field < filter.value;\n        if (filter.operator === '<=') return field <= filter.value;\n        if (filter.operator === '==') return field === filter.value;\n        if (filter.operator === '!=') return field !== filter.value;\n        if (filter.operator === 'contains')\n          return `${field}`.includes(`${filter.value}`);\n        return false;\n      });\n    });\n\n    return visits.slice(0, queryParams?.limit ?? DEFAULT_LIST_LIMIT);\n  }\n\n  /**\n   * Saves a visit through the visitsApi\n   */\n  async save(saveParams: VisitsApiSaveParams): Promise<Visit> {\n    const visits: Visit[] = [...(await this.retrieveAll())];\n\n    const visit: Visit = {\n      ...saveParams.visit,\n      id: window.crypto.randomUUID(),\n      hits: 1,\n      timestamp: Date.now(),\n    };\n\n    // Updates entry if pathname is already registered\n    const visitIndex = visits.findIndex(e => e.pathname === visit.pathname);\n    if (visitIndex >= 0) {\n      visit.id = visits[visitIndex].id;\n      visit.hits = visits[visitIndex].hits + 1;\n      visits[visitIndex] = visit;\n    } else {\n      visits.push(visit);\n    }\n\n    // Sort by time, most recent first\n    visits.sort((a, b) => b.timestamp - a.timestamp);\n    // Keep the most recent items up to limit\n    await this.persistAll(visits.splice(0, this.limit));\n    return visit;\n  }\n\n  private async persistAll(visits: Array<Visit>) {\n    const storageKey = await this.getStorageKey();\n    return this.storageApi.set<Array<Visit>>(storageKey, visits);\n  }\n\n  private async retrieveAll(): Promise<Array<Visit>> {\n    const storageKey = await this.getStorageKey();\n    // Handles for case when snapshot is and is not referenced per storage type used\n    const snapshot = this.storageApi.snapshot<Array<Visit>>(storageKey);\n    if (snapshot?.presence !== 'unknown') {\n      return snapshot?.value ?? [];\n    }\n\n    return new Promise((resolve, reject) => {\n      const subscription = this.storageApi\n        .observe$<Visit[]>(storageKey)\n        .subscribe({\n          next: next => {\n            const visits = next.value ?? [];\n            subscription.unsubscribe();\n            resolve(visits);\n          },\n          error: err => {\n            subscription.unsubscribe();\n            reject(err);\n          },\n        });\n    });\n  }\n\n  private async getStorageKey(): Promise<string> {\n    const { userEntityRef } = await this.identityApi.getBackstageIdentity();\n    const storageKey = `${this.storageKeyPrefix}:${userEntityRef}`;\n    return storageKey;\n  }\n\n  // This assumes Visit fields are either numbers or strings\n  private compare(\n    order: ArrayElement<VisitsApiQueryParams['orderBy']>,\n    a: Visit,\n    b: Visit,\n  ): number {\n    const isNumber = typeof a[order.field] === 'number';\n    return isNumber\n      ? (a[order.field] as number) - (b[order.field] as number)\n      : `${a[order.field]}`.localeCompare(`${b[order.field]}`);\n  }\n}\n"],"names":[],"mappings":"AAgCA,MAAM,kBAAA,GAAqB,CAAA;AAQpB,MAAM,gBAAA,CAAsC;AAAA,EAChC,KAAA;AAAA,EACA,UAAA;AAAA,EACA,gBAAA,GAAmB,+BAAA;AAAA,EACnB,WAAA;AAAA,EAEjB,OAAO,OAAO,OAAA,EAAkC;AAC9C,IAAA,OAAO,IAAI,iBAAiB,OAAO,CAAA;AAAA,EACrC;AAAA,EAEQ,YAAY,OAAA,EAAkC;AACpD,IAAA,IAAA,CAAK,KAAA,GAAQ,IAAA,CAAK,GAAA,CAAI,OAAA,CAAQ,SAAS,GAAG,CAAA;AAC1C,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,UAAA;AAC1B,IAAA,IAAA,CAAK,cAAc,OAAA,CAAQ,WAAA;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,WAAA,EAAsD;AAC/D,IAAA,IAAI,SAAS,CAAC,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAG3C,IAAA,CAAC,aAAa,OAAA,IAAW,IAAI,OAAA,EAAQ,CAAE,QAAQ,CAAA,KAAA,KAAS;AACtD,MAAA,IAAI,KAAA,CAAM,cAAc,KAAA,EAAO;AAC7B,QAAA,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,KAAK,OAAA,CAAQ,KAAA,EAAO,CAAA,EAAG,CAAC,CAAC,CAAA;AAAA,MACjD,CAAA,MAAO;AACL,QAAA,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,KAAK,OAAA,CAAQ,KAAA,EAAO,CAAA,EAAG,CAAC,CAAC,CAAA;AAAA,MACjD;AAAA,IACF,CAAC,CAAA;AAGD,IAAA,CAAC,aAAa,QAAA,IAAY,IAAI,OAAA,EAAQ,CAAE,QAAQ,CAAA,MAAA,KAAU;AACxD,MAAA,MAAA,GAAS,MAAA,CAAO,OAAO,CAAA,KAAA,KAAS;AAC9B,QAAA,MAAM,KAAA,GAAQ,KAAA,CAAM,MAAA,CAAO,KAAK,CAAA;AAChC,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,GAAA,EAAK,OAAO,QAAQ,MAAA,CAAO,KAAA;AACnD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,IAAA,EAAM,OAAO,SAAS,MAAA,CAAO,KAAA;AACrD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,GAAA,EAAK,OAAO,QAAQ,MAAA,CAAO,KAAA;AACnD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,IAAA,EAAM,OAAO,SAAS,MAAA,CAAO,KAAA;AACrD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,IAAA,EAAM,OAAO,UAAU,MAAA,CAAO,KAAA;AACtD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,IAAA,EAAM,OAAO,UAAU,MAAA,CAAO,KAAA;AACtD,QAAA,IAAI,OAAO,QAAA,KAAa,UAAA;AACtB,UAAA,OAAO,GAAG,KAAK,CAAA,CAAA,CAAG,SAAS,CAAA,EAAG,MAAA,CAAO,KAAK,CAAA,CAAE,CAAA;AAC9C,QAAA,OAAO,KAAA;AAAA,MACT,CAAC,CAAA;AAAA,IACH,CAAC,CAAA;AAED,IAAA,OAAO,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,WAAA,EAAa,SAAS,kBAAkB,CAAA;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,UAAA,EAAiD;AAC1D,IAAA,MAAM,SAAkB,CAAC,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAEtD,IAAA,MAAM,KAAA,GAAe;AAAA,MACnB,GAAG,UAAA,CAAW,KAAA;AAAA,MACd,EAAA,EAAI,MAAA,CAAO,MAAA,CAAO,UAAA,EAAW;AAAA,MAC7B,IAAA,EAAM,CAAA;AAAA,MACN,SAAA,EAAW,KAAK,GAAA;AAAI,KACtB;AAGA,IAAA,MAAM,aAAa,MAAA,CAAO,SAAA,CAAU,OAAK,CAAA,CAAE,QAAA,KAAa,MAAM,QAAQ,CAAA;AACtE,IAAA,IAAI,cAAc,CAAA,EAAG;AACnB,MAAA,KAAA,CAAM,EAAA,GAAK,MAAA,CAAO,UAAU,CAAA,CAAE,EAAA;AAC9B,MAAA,KAAA,CAAM,IAAA,GAAO,MAAA,CAAO,UAAU,CAAA,CAAE,IAAA,GAAO,CAAA;AACvC,MAAA,MAAA,CAAO,UAAU,CAAA,GAAI,KAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA,IACnB;AAGA,IAAA,MAAA,CAAO,KAAK,CAAC,CAAA,EAAG,MAAM,CAAA,CAAE,SAAA,GAAY,EAAE,SAAS,CAAA;AAE/C,IAAA,MAAM,KAAK,UAAA,CAAW,MAAA,CAAO,OAAO,CAAA,EAAG,IAAA,CAAK,KAAK,CAAC,CAAA;AAClD,IAAA,OAAO,KAAA;AAAA,EACT;AAAA,EAEA,MAAc,WAAW,MAAA,EAAsB;AAC7C,IAAA,MAAM,UAAA,GAAa,MAAM,IAAA,CAAK,aAAA,EAAc;AAC5C,IAAA,OAAO,IAAA,CAAK,UAAA,CAAW,GAAA,CAAkB,UAAA,EAAY,MAAM,CAAA;AAAA,EAC7D;AAAA,EAEA,MAAc,WAAA,GAAqC;AACjD,IAAA,MAAM,UAAA,GAAa,MAAM,IAAA,CAAK,aAAA,EAAc;AAE5C,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,UAAA,CAAW,QAAA,CAAuB,UAAU,CAAA;AAClE,IAAA,IAAI,QAAA,EAAU,aAAa,SAAA,EAAW;AACpC,MAAA,OAAO,QAAA,EAAU,SAAS,EAAC;AAAA,IAC7B;AAEA,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAA,KAAW;AACtC,MAAA,MAAM,eAAe,IAAA,CAAK,UAAA,CACvB,QAAA,CAAkB,UAAU,EAC5B,SAAA,CAAU;AAAA,QACT,MAAM,CAAA,IAAA,KAAQ;AACZ,UAAA,MAAM,MAAA,GAAS,IAAA,CAAK,KAAA,IAAS,EAAC;AAC9B,UAAA,YAAA,CAAa,WAAA,EAAY;AACzB,UAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,QAChB,CAAA;AAAA,QACA,OAAO,CAAA,GAAA,KAAO;AACZ,UAAA,YAAA,CAAa,WAAA,EAAY;AACzB,UAAA,MAAA,CAAO,GAAG,CAAA;AAAA,QACZ;AAAA,OACD,CAAA;AAAA,IACL,CAAC,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,aAAA,GAAiC;AAC7C,IAAA,MAAM,EAAE,aAAA,EAAc,GAAI,MAAM,IAAA,CAAK,YAAY,oBAAA,EAAqB;AACtE,IAAA,MAAM,UAAA,GAAa,CAAA,EAAG,IAAA,CAAK,gBAAgB,IAAI,aAAa,CAAA,CAAA;AAC5D,IAAA,OAAO,UAAA;AAAA,EACT;AAAA;AAAA,EAGQ,OAAA,CACN,KAAA,EACA,CAAA,EACA,CAAA,EACQ;AACR,IAAA,MAAM,QAAA,GAAW,OAAO,CAAA,CAAE,KAAA,CAAM,KAAK,CAAA,KAAM,QAAA;AAC3C,IAAA,OAAO,QAAA,GACF,EAAE,KAAA,CAAM,KAAK,IAAgB,CAAA,CAAE,KAAA,CAAM,KAAK,CAAA,GAC3C,CAAA,EAAG,EAAE,KAAA,CAAM,KAAK,CAAC,CAAA,CAAA,CAAG,aAAA,CAAc,GAAG,CAAA,CAAE,KAAA,CAAM,KAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAC3D;AACF;;;;"}
+{"version":3,"file":"VisitsStorageApi.esm.js","sources":["../../src/api/VisitsStorageApi.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { IdentityApi, StorageApi } from '@backstage/core-plugin-api';\nimport {\n  Visit,\n  VisitsApi,\n  VisitsApiQueryParams,\n  VisitsApiSaveParams,\n} from './VisitsApi';\n\n/**\n * @public\n * Type definition for visit data before it's saved (without auto-generated fields)\n */\nexport type VisitInput = {\n  name: string;\n  pathname: string;\n  entityRef?: string;\n};\n\n/** @public */\nexport type VisitsStorageApiOptions = {\n  limit?: number;\n  storageApi: StorageApi;\n  identityApi: IdentityApi;\n  transformPathname?: (pathname: string) => string;\n  canSave?: (visit: VisitInput) => boolean | Promise<boolean>;\n  enrichVisit?: (\n    visit: VisitInput,\n  ) => Promise<Record<string, any>> | Record<string, any>;\n};\n\ntype ArrayElement<A> = A extends readonly (infer T)[] ? T : never;\n\nconst DEFAULT_LIST_LIMIT = 8;\n\n/**\n * @public\n * This is an implementation of VisitsApi that relies on a StorageApi.\n * Beware that filtering and ordering are done in memory therefore it is\n * prudent to keep limit to a reasonable size.\n */\nexport class VisitsStorageApi implements VisitsApi {\n  private readonly limit: number;\n  private readonly storageApi: StorageApi;\n  private readonly storageKeyPrefix = '@backstage/plugin-home:visits';\n  private readonly identityApi: IdentityApi;\n  private readonly transformPathnameImpl?: (pathname: string) => string;\n  private readonly canSaveImpl?: (\n    visit: VisitInput,\n  ) => boolean | Promise<boolean>;\n  private readonly enrichVisitImpl?: (\n    visit: VisitInput,\n  ) => Promise<Record<string, any>> | Record<string, any>;\n\n  static create(options: VisitsStorageApiOptions) {\n    return new VisitsStorageApi(options);\n  }\n\n  private constructor(options: VisitsStorageApiOptions) {\n    this.limit = Math.abs(options.limit ?? 100);\n    this.storageApi = options.storageApi;\n    this.identityApi = options.identityApi;\n    this.transformPathnameImpl = options.transformPathname;\n    this.canSaveImpl = options.canSave;\n    this.enrichVisitImpl = options.enrichVisit;\n  }\n\n  /**\n   * Returns a list of visits through the visitsApi\n   */\n  async list(queryParams?: VisitsApiQueryParams): Promise<Visit[]> {\n    let visits = [...(await this.retrieveAll())];\n\n    // reversing order to guarantee orderBy priority\n    (queryParams?.orderBy ?? []).reverse().forEach(order => {\n      if (order.direction === 'asc') {\n        visits.sort((a, b) => this.compare(order, a, b));\n      } else {\n        visits.sort((a, b) => this.compare(order, b, a));\n      }\n    });\n\n    // reversing order to guarantee filterBy priority\n    (queryParams?.filterBy ?? []).reverse().forEach(filter => {\n      visits = visits.filter(visit => {\n        const field = visit[filter.field] as number | string;\n        if (filter.operator === '>') return field > filter.value;\n        if (filter.operator === '>=') return field >= filter.value;\n        if (filter.operator === '<') return field < filter.value;\n        if (filter.operator === '<=') return field <= filter.value;\n        if (filter.operator === '==') return field === filter.value;\n        if (filter.operator === '!=') return field !== filter.value;\n        if (filter.operator === 'contains')\n          return `${field}`.includes(`${filter.value}`);\n        return false;\n      });\n    });\n\n    return visits.slice(0, queryParams?.limit ?? DEFAULT_LIST_LIMIT);\n  }\n\n  /**\n   * Transform the pathname before it is considered for any other processing.\n   * @param pathname - the original pathname\n   * @returns the transformed pathname\n   */\n  transformPathname(pathname: string): string {\n    return this.transformPathnameImpl?.(pathname) ?? pathname;\n  }\n\n  /**\n   * Determine whether a visit should be saved.\n   * @param visit - page visit data\n   */\n  async canSave(visit: VisitInput): Promise<boolean> {\n    if (!this.canSaveImpl) {\n      return true;\n    }\n    return Promise.resolve(this.canSaveImpl(visit));\n  }\n\n  /**\n   * Add additional data to the visit before saving.\n   * @param visit - page visit data\n   */\n  async enrichVisit(visit: VisitInput): Promise<Record<string, any>> {\n    if (!this.enrichVisitImpl) {\n      return {};\n    }\n    return Promise.resolve(this.enrichVisitImpl(visit));\n  }\n\n  /**\n   * Saves a visit through the visitsApi\n   */\n  async save(saveParams: VisitsApiSaveParams): Promise<Visit> {\n    let visit = saveParams.visit;\n\n    // Transform pathname if needed\n    visit = {\n      ...visit,\n      pathname: this.transformPathname(visit.pathname),\n    };\n\n    // Check if visit should be saved\n    if (!(await this.canSave(visit))) {\n      // Return a minimal visit object without saving\n      return {\n        ...visit,\n        id: '',\n        hits: 0,\n        timestamp: Date.now(),\n      };\n    }\n\n    // Enrich the visit\n    const enrichedData = await this.enrichVisit(visit);\n    const enrichedVisit = { ...visit, ...enrichedData };\n\n    const visits: Visit[] = [...(await this.retrieveAll())];\n\n    const visitToSave: Visit = {\n      ...enrichedVisit,\n      id: window.crypto.randomUUID(),\n      hits: 1,\n      timestamp: Date.now(),\n    };\n\n    // Updates entry if pathname is already registered\n    const visitIndex = visits.findIndex(\n      e => e.pathname === visitToSave.pathname,\n    );\n    if (visitIndex >= 0) {\n      visitToSave.id = visits[visitIndex].id;\n      visitToSave.hits = visits[visitIndex].hits + 1;\n      visits[visitIndex] = visitToSave;\n    } else {\n      visits.push(visitToSave);\n    }\n\n    // Sort by time, most recent first\n    visits.sort((a, b) => b.timestamp - a.timestamp);\n    // Keep the most recent items up to limit\n    await this.persistAll(visits.splice(0, this.limit));\n    return visitToSave;\n  }\n\n  private async persistAll(visits: Array<Visit>) {\n    const storageKey = await this.getStorageKey();\n    return this.storageApi.set<Array<Visit>>(storageKey, visits);\n  }\n\n  private async retrieveAll(): Promise<Array<Visit>> {\n    const storageKey = await this.getStorageKey();\n    // Handles for case when snapshot is and is not referenced per storage type used\n    const snapshot = this.storageApi.snapshot<Array<Visit>>(storageKey);\n    if (snapshot?.presence !== 'unknown') {\n      return snapshot?.value ?? [];\n    }\n\n    return new Promise((resolve, reject) => {\n      const subscription = this.storageApi\n        .observe$<Visit[]>(storageKey)\n        .subscribe({\n          next: next => {\n            const visits = next.value ?? [];\n            subscription.unsubscribe();\n            resolve(visits);\n          },\n          error: err => {\n            subscription.unsubscribe();\n            reject(err);\n          },\n        });\n    });\n  }\n\n  private async getStorageKey(): Promise<string> {\n    const { userEntityRef } = await this.identityApi.getBackstageIdentity();\n    const storageKey = `${this.storageKeyPrefix}:${userEntityRef}`;\n    return storageKey;\n  }\n\n  // This assumes Visit fields are either numbers or strings\n  private compare(\n    order: ArrayElement<VisitsApiQueryParams['orderBy']>,\n    a: Visit,\n    b: Visit,\n  ): number {\n    const isNumber = typeof a[order.field] === 'number';\n    return isNumber\n      ? (a[order.field] as number) - (b[order.field] as number)\n      : `${a[order.field]}`.localeCompare(`${b[order.field]}`);\n  }\n}\n"],"names":[],"mappings":"AA+CA,MAAM,kBAAA,GAAqB,CAAA;AAQpB,MAAM,gBAAA,CAAsC;AAAA,EAChC,KAAA;AAAA,EACA,UAAA;AAAA,EACA,gBAAA,GAAmB,+BAAA;AAAA,EACnB,WAAA;AAAA,EACA,qBAAA;AAAA,EACA,WAAA;AAAA,EAGA,eAAA;AAAA,EAIjB,OAAO,OAAO,OAAA,EAAkC;AAC9C,IAAA,OAAO,IAAI,iBAAiB,OAAO,CAAA;AAAA,EACrC;AAAA,EAEQ,YAAY,OAAA,EAAkC;AACpD,IAAA,IAAA,CAAK,KAAA,GAAQ,IAAA,CAAK,GAAA,CAAI,OAAA,CAAQ,SAAS,GAAG,CAAA;AAC1C,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,UAAA;AAC1B,IAAA,IAAA,CAAK,cAAc,OAAA,CAAQ,WAAA;AAC3B,IAAA,IAAA,CAAK,wBAAwB,OAAA,CAAQ,iBAAA;AACrC,IAAA,IAAA,CAAK,cAAc,OAAA,CAAQ,OAAA;AAC3B,IAAA,IAAA,CAAK,kBAAkB,OAAA,CAAQ,WAAA;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,WAAA,EAAsD;AAC/D,IAAA,IAAI,SAAS,CAAC,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAG3C,IAAA,CAAC,aAAa,OAAA,IAAW,IAAI,OAAA,EAAQ,CAAE,QAAQ,CAAA,KAAA,KAAS;AACtD,MAAA,IAAI,KAAA,CAAM,cAAc,KAAA,EAAO;AAC7B,QAAA,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,KAAK,OAAA,CAAQ,KAAA,EAAO,CAAA,EAAG,CAAC,CAAC,CAAA;AAAA,MACjD,CAAA,MAAO;AACL,QAAA,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,KAAK,OAAA,CAAQ,KAAA,EAAO,CAAA,EAAG,CAAC,CAAC,CAAA;AAAA,MACjD;AAAA,IACF,CAAC,CAAA;AAGD,IAAA,CAAC,aAAa,QAAA,IAAY,IAAI,OAAA,EAAQ,CAAE,QAAQ,CAAA,MAAA,KAAU;AACxD,MAAA,MAAA,GAAS,MAAA,CAAO,OAAO,CAAA,KAAA,KAAS;AAC9B,QAAA,MAAM,KAAA,GAAQ,KAAA,CAAM,MAAA,CAAO,KAAK,CAAA;AAChC,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,GAAA,EAAK,OAAO,QAAQ,MAAA,CAAO,KAAA;AACnD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,IAAA,EAAM,OAAO,SAAS,MAAA,CAAO,KAAA;AACrD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,GAAA,EAAK,OAAO,QAAQ,MAAA,CAAO,KAAA;AACnD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,IAAA,EAAM,OAAO,SAAS,MAAA,CAAO,KAAA;AACrD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,IAAA,EAAM,OAAO,UAAU,MAAA,CAAO,KAAA;AACtD,QAAA,IAAI,MAAA,CAAO,QAAA,KAAa,IAAA,EAAM,OAAO,UAAU,MAAA,CAAO,KAAA;AACtD,QAAA,IAAI,OAAO,QAAA,KAAa,UAAA;AACtB,UAAA,OAAO,GAAG,KAAK,CAAA,CAAA,CAAG,SAAS,CAAA,EAAG,MAAA,CAAO,KAAK,CAAA,CAAE,CAAA;AAC9C,QAAA,OAAO,KAAA;AAAA,MACT,CAAC,CAAA;AAAA,IACH,CAAC,CAAA;AAED,IAAA,OAAO,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,WAAA,EAAa,SAAS,kBAAkB,CAAA;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,kBAAkB,QAAA,EAA0B;AAC1C,IAAA,OAAO,IAAA,CAAK,qBAAA,GAAwB,QAAQ,CAAA,IAAK,QAAA;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,QAAQ,KAAA,EAAqC;AACjD,IAAA,IAAI,CAAC,KAAK,WAAA,EAAa;AACrB,MAAA,OAAO,IAAA;AAAA,IACT;AACA,IAAA,OAAO,OAAA,CAAQ,OAAA,CAAQ,IAAA,CAAK,WAAA,CAAY,KAAK,CAAC,CAAA;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,YAAY,KAAA,EAAiD;AACjE,IAAA,IAAI,CAAC,KAAK,eAAA,EAAiB;AACzB,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,OAAO,OAAA,CAAQ,OAAA,CAAQ,IAAA,CAAK,eAAA,CAAgB,KAAK,CAAC,CAAA;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,UAAA,EAAiD;AAC1D,IAAA,IAAI,QAAQ,UAAA,CAAW,KAAA;AAGvB,IAAA,KAAA,GAAQ;AAAA,MACN,GAAG,KAAA;AAAA,MACH,QAAA,EAAU,IAAA,CAAK,iBAAA,CAAkB,KAAA,CAAM,QAAQ;AAAA,KACjD;AAGA,IAAA,IAAI,CAAE,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,CAAA,EAAI;AAEhC,MAAA,OAAO;AAAA,QACL,GAAG,KAAA;AAAA,QACH,EAAA,EAAI,EAAA;AAAA,QACJ,IAAA,EAAM,CAAA;AAAA,QACN,SAAA,EAAW,KAAK,GAAA;AAAI,OACtB;AAAA,IACF;AAGA,IAAA,MAAM,YAAA,GAAe,MAAM,IAAA,CAAK,WAAA,CAAY,KAAK,CAAA;AACjD,IAAA,MAAM,aAAA,GAAgB,EAAE,GAAG,KAAA,EAAO,GAAG,YAAA,EAAa;AAElD,IAAA,MAAM,SAAkB,CAAC,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAEtD,IAAA,MAAM,WAAA,GAAqB;AAAA,MACzB,GAAG,aAAA;AAAA,MACH,EAAA,EAAI,MAAA,CAAO,MAAA,CAAO,UAAA,EAAW;AAAA,MAC7B,IAAA,EAAM,CAAA;AAAA,MACN,SAAA,EAAW,KAAK,GAAA;AAAI,KACtB;AAGA,IAAA,MAAM,aAAa,MAAA,CAAO,SAAA;AAAA,MACxB,CAAA,CAAA,KAAK,CAAA,CAAE,QAAA,KAAa,WAAA,CAAY;AAAA,KAClC;AACA,IAAA,IAAI,cAAc,CAAA,EAAG;AACnB,MAAA,WAAA,CAAY,EAAA,GAAK,MAAA,CAAO,UAAU,CAAA,CAAE,EAAA;AACpC,MAAA,WAAA,CAAY,IAAA,GAAO,MAAA,CAAO,UAAU,CAAA,CAAE,IAAA,GAAO,CAAA;AAC7C,MAAA,MAAA,CAAO,UAAU,CAAA,GAAI,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAA,CAAO,KAAK,WAAW,CAAA;AAAA,IACzB;AAGA,IAAA,MAAA,CAAO,KAAK,CAAC,CAAA,EAAG,MAAM,CAAA,CAAE,SAAA,GAAY,EAAE,SAAS,CAAA;AAE/C,IAAA,MAAM,KAAK,UAAA,CAAW,MAAA,CAAO,OAAO,CAAA,EAAG,IAAA,CAAK,KAAK,CAAC,CAAA;AAClD,IAAA,OAAO,WAAA;AAAA,EACT;AAAA,EAEA,MAAc,WAAW,MAAA,EAAsB;AAC7C,IAAA,MAAM,UAAA,GAAa,MAAM,IAAA,CAAK,aAAA,EAAc;AAC5C,IAAA,OAAO,IAAA,CAAK,UAAA,CAAW,GAAA,CAAkB,UAAA,EAAY,MAAM,CAAA;AAAA,EAC7D;AAAA,EAEA,MAAc,WAAA,GAAqC;AACjD,IAAA,MAAM,UAAA,GAAa,MAAM,IAAA,CAAK,aAAA,EAAc;AAE5C,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,UAAA,CAAW,QAAA,CAAuB,UAAU,CAAA;AAClE,IAAA,IAAI,QAAA,EAAU,aAAa,SAAA,EAAW;AACpC,MAAA,OAAO,QAAA,EAAU,SAAS,EAAC;AAAA,IAC7B;AAEA,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAA,KAAW;AACtC,MAAA,MAAM,eAAe,IAAA,CAAK,UAAA,CACvB,QAAA,CAAkB,UAAU,EAC5B,SAAA,CAAU;AAAA,QACT,MAAM,CAAA,IAAA,KAAQ;AACZ,UAAA,MAAM,MAAA,GAAS,IAAA,CAAK,KAAA,IAAS,EAAC;AAC9B,UAAA,YAAA,CAAa,WAAA,EAAY;AACzB,UAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,QAChB,CAAA;AAAA,QACA,OAAO,CAAA,GAAA,KAAO;AACZ,UAAA,YAAA,CAAa,WAAA,EAAY;AACzB,UAAA,MAAA,CAAO,GAAG,CAAA;AAAA,QACZ;AAAA,OACD,CAAA;AAAA,IACL,CAAC,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,aAAA,GAAiC;AAC7C,IAAA,MAAM,EAAE,aAAA,EAAc,GAAI,MAAM,IAAA,CAAK,YAAY,oBAAA,EAAqB;AACtE,IAAA,MAAM,UAAA,GAAa,CAAA,EAAG,IAAA,CAAK,gBAAgB,IAAI,aAAa,CAAA,CAAA;AAC5D,IAAA,OAAO,UAAA;AAAA,EACT;AAAA;AAAA,EAGQ,OAAA,CACN,KAAA,EACA,CAAA,EACA,CAAA,EACQ;AACR,IAAA,MAAM,QAAA,GAAW,OAAO,CAAA,CAAE,KAAA,CAAM,KAAK,CAAA,KAAM,QAAA;AAC3C,IAAA,OAAO,QAAA,GACF,EAAE,KAAA,CAAM,KAAK,IAAgB,CAAA,CAAE,KAAA,CAAM,KAAK,CAAA,GAC3C,CAAA,EAAG,EAAE,KAAA,CAAM,KAAK,CAAC,CAAA,CAAA,CAAG,aAAA,CAAc,GAAG,CAAA,CAAE,KAAA,CAAM,KAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAC3D;AACF;;;;"}

package/dist/components/VisitList/Context.esm.js

@@ -0,0 +1,68 @@
+import { jsx } from 'react/jsx-runtime';
+import { useContext, createContext } from 'react';
+import { parseEntityRef } from '@backstage/catalog-model';
+import { colorVariants } from '@backstage/theme';
+
+const getColorByIndex = (index) => {
+  const variants = Object.keys(colorVariants);
+  const variantIndex = index % variants.length;
+  return colorVariants[variants[variantIndex]][0];
+};
+const maybeEntity = (visit) => {
+  try {
+    return parseEntityRef(visit?.entityRef ?? "");
+  } catch (e) {
+    return void 0;
+  }
+};
+const defaultGetChipColor = (visit) => {
+  const defaultColor = getColorByIndex(0);
+  const entity = maybeEntity(visit);
+  if (!entity) return defaultColor;
+  const entityKinds = [
+    "component",
+    "template",
+    "api",
+    "group",
+    "user",
+    "resource",
+    "system",
+    "domain",
+    "location"
+  ];
+  const foundIndex = entityKinds.indexOf(
+    entity.kind.toLocaleLowerCase("en-US")
+  );
+  return foundIndex === -1 ? defaultColor : getColorByIndex(foundIndex + 1);
+};
+const defaultGetLabel = (visit) => {
+  const entity = maybeEntity(visit);
+  return (entity?.kind ?? "Other").toLocaleLowerCase("en-US");
+};
+const VisitDisplayContext = createContext({
+  getChipColor: defaultGetChipColor,
+  getLabel: defaultGetLabel
+});
+const VisitDisplayProvider = ({
+  children,
+  getChipColor = defaultGetChipColor,
+  getLabel = defaultGetLabel
+}) => {
+  const value = {
+    getChipColor,
+    getLabel
+  };
+  return /* @__PURE__ */ jsx(VisitDisplayContext.Provider, { value, children });
+};
+const useVisitDisplay = () => {
+  const context = useContext(VisitDisplayContext);
+  if (!context) {
+    throw new Error(
+      "useVisitDisplay must be used within a VisitDisplayProvider"
+    );
+  }
+  return context;
+};
+
+export { VisitDisplayProvider, useVisitDisplay };
+//# sourceMappingURL=Context.esm.js.map

package/dist/components/VisitList/Context.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Context.esm.js","sources":["../../../src/components/VisitList/Context.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 { createContext, useContext, ReactNode } from 'react';\nimport { CompoundEntityRef, parseEntityRef } from '@backstage/catalog-model';\nimport { colorVariants } from '@backstage/theme';\nimport { Visit } from '../../api/VisitsApi';\n\n/**\n * Type definition for the chip color function\n * @public\n */\nexport type GetChipColorFunction = (visit: Visit) => string;\n\n/**\n * Type definition for the label function\n * @public\n */\nexport type GetLabelFunction = (visit: Visit) => string;\n\n/**\n * Context value interface\n * @public\n */\nexport interface VisitDisplayContextValue {\n  getChipColor: GetChipColorFunction;\n  getLabel: GetLabelFunction;\n}\n\n/**\n * Props for the VisitDisplayProvider\n * @public\n */\nexport interface VisitDisplayProviderProps {\n  children: ReactNode;\n  getChipColor?: GetChipColorFunction;\n  getLabel?: GetLabelFunction;\n}\n\n// Default implementations\nconst getColorByIndex = (index: number) => {\n  const variants = Object.keys(colorVariants);\n  const variantIndex = index % variants.length;\n  return colorVariants[variants[variantIndex]][0];\n};\n\nconst maybeEntity = (visit: Visit): CompoundEntityRef | undefined => {\n  try {\n    return parseEntityRef(visit?.entityRef ?? '');\n  } catch (e) {\n    return undefined;\n  }\n};\n\nconst defaultGetChipColor: GetChipColorFunction = (visit: Visit): string => {\n  const defaultColor = getColorByIndex(0);\n  const entity = maybeEntity(visit);\n  if (!entity) return defaultColor;\n\n  // IDEA: Use or replicate useAllKinds hook thus supporting all software catalog\n  //       registered kinds. See:\n  //       plugins/catalog-react/src/components/EntityKindPicker/kindFilterUtils.ts\n  //       Provide extension point to register your own color code.\n  const entityKinds = [\n    'component',\n    'template',\n    'api',\n    'group',\n    'user',\n    'resource',\n    'system',\n    'domain',\n    'location',\n  ];\n  const foundIndex = entityKinds.indexOf(\n    entity.kind.toLocaleLowerCase('en-US'),\n  );\n  return foundIndex === -1 ? defaultColor : getColorByIndex(foundIndex + 1);\n};\n\nconst defaultGetLabel: GetLabelFunction = (visit: Visit): string => {\n  const entity = maybeEntity(visit);\n  return (entity?.kind ?? 'Other').toLocaleLowerCase('en-US');\n};\n\n// Create the context\nconst VisitDisplayContext = createContext<VisitDisplayContextValue>({\n  getChipColor: defaultGetChipColor,\n  getLabel: defaultGetLabel,\n});\n\n/**\n * Provider component for VisitDisplay customization\n * @public\n */\nexport const VisitDisplayProvider = ({\n  children,\n  getChipColor = defaultGetChipColor,\n  getLabel = defaultGetLabel,\n}: VisitDisplayProviderProps) => {\n  const value: VisitDisplayContextValue = {\n    getChipColor,\n    getLabel,\n  };\n\n  return (\n    <VisitDisplayContext.Provider value={value}>\n      {children}\n    </VisitDisplayContext.Provider>\n  );\n};\n\n/**\n * Hook to use the VisitDisplay context\n * @public\n */\nexport const useVisitDisplay = (): VisitDisplayContextValue => {\n  const context = useContext(VisitDisplayContext);\n  if (!context) {\n    throw new Error(\n      'useVisitDisplay must be used within a VisitDisplayProvider',\n    );\n  }\n  return context;\n};\n"],"names":[],"mappings":";;;;;AAqDA,MAAM,eAAA,GAAkB,CAAC,KAAA,KAAkB;AACzC,EAAA,MAAM,QAAA,GAAW,MAAA,CAAO,IAAA,CAAK,aAAa,CAAA;AAC1C,EAAA,MAAM,YAAA,GAAe,QAAQ,QAAA,CAAS,MAAA;AACtC,EAAA,OAAO,aAAA,CAAc,QAAA,CAAS,YAAY,CAAC,EAAE,CAAC,CAAA;AAChD,CAAA;AAEA,MAAM,WAAA,GAAc,CAAC,KAAA,KAAgD;AACnE,EAAA,IAAI;AACF,IAAA,OAAO,cAAA,CAAe,KAAA,EAAO,SAAA,IAAa,EAAE,CAAA;AAAA,EAC9C,SAAS,CAAA,EAAG;AACV,IAAA,OAAO,MAAA;AAAA,EACT;AACF,CAAA;AAEA,MAAM,mBAAA,GAA4C,CAAC,KAAA,KAAyB;AAC1E,EAAA,MAAM,YAAA,GAAe,gBAAgB,CAAC,CAAA;AACtC,EAAA,MAAM,MAAA,GAAS,YAAY,KAAK,CAAA;AAChC,EAAA,IAAI,CAAC,QAAQ,OAAO,YAAA;AAMpB,EAAA,MAAM,WAAA,GAAc;AAAA,IAClB,WAAA;AAAA,IACA,UAAA;AAAA,IACA,KAAA;AAAA,IACA,OAAA;AAAA,IACA,MAAA;AAAA,IACA,UAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,MAAM,aAAa,WAAA,CAAY,OAAA;AAAA,IAC7B,MAAA,CAAO,IAAA,CAAK,iBAAA,CAAkB,OAAO;AAAA,GACvC;AACA,EAAA,OAAO,UAAA,KAAe,EAAA,GAAK,YAAA,GAAe,eAAA,CAAgB,aAAa,CAAC,CAAA;AAC1E,CAAA;AAEA,MAAM,eAAA,GAAoC,CAAC,KAAA,KAAyB;AAClE,EAAA,MAAM,MAAA,GAAS,YAAY,KAAK,CAAA;AAChC,EAAA,OAAA,CAAQ,MAAA,EAAQ,IAAA,IAAQ,OAAA,EAAS,iBAAA,CAAkB,OAAO,CAAA;AAC5D,CAAA;AAGA,MAAM,sBAAsB,aAAA,CAAwC;AAAA,EAClE,YAAA,EAAc,mBAAA;AAAA,EACd,QAAA,EAAU;AACZ,CAAC,CAAA;AAMM,MAAM,uBAAuB,CAAC;AAAA,EACnC,QAAA;AAAA,EACA,YAAA,GAAe,mBAAA;AAAA,EACf,QAAA,GAAW;AACb,CAAA,KAAiC;AAC/B,EAAA,MAAM,KAAA,GAAkC;AAAA,IACtC,YAAA;AAAA,IACA;AAAA,GACF;AAEA,EAAA,uBACE,GAAA,CAAC,mBAAA,CAAoB,QAAA,EAApB,EAA6B,OAC3B,QAAA,EACH,CAAA;AAEJ;AAMO,MAAM,kBAAkB,MAAgC;AAC7D,EAAA,MAAM,OAAA,GAAU,WAAW,mBAAmB,CAAA;AAC9C,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;;;;"}

package/dist/components/VisitList/ItemCategory.esm.js

@@ -1,8 +1,7 @@
 import { jsx } from 'react/jsx-runtime';
 import Chip from '@material-ui/core/Chip';
 import { makeStyles } from '@material-ui/core/styles';
-import { colorVariants } from '@backstage/theme';
-import { parseEntityRef } from '@backstage/catalog-model';
+import { useVisitDisplay } from './Context.esm.js';
 
 const useStyles = makeStyles((theme) => ({
   chip: {
@@ -11,47 +10,16 @@ const useStyles = makeStyles((theme) => ({
     margin: 0
   }
 }));
-const maybeEntity = (visit) => {
-  try {
-    return parseEntityRef(visit?.entityRef ?? "");
-  } catch (e) {
-    return void 0;
-  }
-};
-const getColorByIndex = (index) => {
-  const variants = Object.keys(colorVariants);
-  const variantIndex = index % variants.length;
-  return colorVariants[variants[variantIndex]][0];
-};
-const getChipColor = (entity) => {
-  const defaultColor = getColorByIndex(0);
-  if (!entity) return defaultColor;
-  const entityKinds = [
-    "component",
-    "template",
-    "api",
-    "group",
-    "user",
-    "resource",
-    "system",
-    "domain",
-    "location"
-  ];
-  const foundIndex = entityKinds.indexOf(
-    entity.kind.toLocaleLowerCase("en-US")
-  );
-  return foundIndex === -1 ? defaultColor : getColorByIndex(foundIndex + 1);
-};
 const ItemCategory = ({ visit }) => {
   const classes = useStyles();
-  const entity = maybeEntity(visit);
+  const { getChipColor, getLabel } = useVisitDisplay();
   return /* @__PURE__ */ jsx(
     Chip,
     {
       size: "small",
       className: classes.chip,
-      label: (entity?.kind ?? "Other").toLocaleLowerCase("en-US"),
-      style: { background: getChipColor(entity) }
+      label: getLabel(visit),
+      style: { background: getChipColor(visit) }
     }
   );
 };

package/dist/components/VisitList/ItemCategory.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"ItemCategory.esm.js","sources":["../../../src/components/VisitList/ItemCategory.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 Chip from '@material-ui/core/Chip';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { colorVariants } from '@backstage/theme';\nimport { Visit } from '../../api/VisitsApi';\nimport { CompoundEntityRef, parseEntityRef } from '@backstage/catalog-model';\n\nconst useStyles = makeStyles(theme => ({\n  chip: {\n    color: theme.palette.common.white,\n    fontWeight: 'bold',\n    margin: 0,\n  },\n}));\nconst maybeEntity = (visit: Visit): CompoundEntityRef | undefined => {\n  try {\n    return parseEntityRef(visit?.entityRef ?? '');\n  } catch (e) {\n    return undefined;\n  }\n};\nconst getColorByIndex = (index: number) => {\n  const variants = Object.keys(colorVariants);\n  const variantIndex = index % variants.length;\n  return colorVariants[variants[variantIndex]][0];\n};\nconst getChipColor = (entity: CompoundEntityRef | undefined): string => {\n  const defaultColor = getColorByIndex(0);\n  if (!entity) return defaultColor;\n\n  // IDEA: Use or replicate useAllKinds hook thus supporting all software catalog\n  //       registered kinds. See:\n  //       plugins/catalog-react/src/components/EntityKindPicker/kindFilterUtils.ts\n  //       Provide extension point to register your own color code.\n  const entityKinds = [\n    'component',\n    'template',\n    'api',\n    'group',\n    'user',\n    'resource',\n    'system',\n    'domain',\n    'location',\n  ];\n  const foundIndex = entityKinds.indexOf(\n    entity.kind.toLocaleLowerCase('en-US'),\n  );\n  return foundIndex === -1 ? defaultColor : getColorByIndex(foundIndex + 1);\n};\n\nexport const ItemCategory = ({ visit }: { visit: Visit }) => {\n  const classes = useStyles();\n  const entity = maybeEntity(visit);\n\n  return (\n    <Chip\n      size=\"small\"\n      className={classes.chip}\n      label={(entity?.kind ?? 'Other').toLocaleLowerCase('en-US')}\n      style={{ background: getChipColor(entity) }}\n    />\n  );\n};\n"],"names":[],"mappings":";;;;;;AAsBA,MAAM,SAAA,GAAY,WAAW,CAAA,KAAA,MAAU;AAAA,EACrC,IAAA,EAAM;AAAA,IACJ,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,KAAA;AAAA,IAC5B,UAAA,EAAY,MAAA;AAAA,IACZ,MAAA,EAAQ;AAAA;AAEZ,CAAA,CAAE,CAAA;AACF,MAAM,WAAA,GAAc,CAAC,KAAA,KAAgD;AACnE,EAAA,IAAI;AACF,IAAA,OAAO,cAAA,CAAe,KAAA,EAAO,SAAA,IAAa,EAAE,CAAA;AAAA,EAC9C,SAAS,CAAA,EAAG;AACV,IAAA,OAAO,MAAA;AAAA,EACT;AACF,CAAA;AACA,MAAM,eAAA,GAAkB,CAAC,KAAA,KAAkB;AACzC,EAAA,MAAM,QAAA,GAAW,MAAA,CAAO,IAAA,CAAK,aAAa,CAAA;AAC1C,EAAA,MAAM,YAAA,GAAe,QAAQ,QAAA,CAAS,MAAA;AACtC,EAAA,OAAO,aAAA,CAAc,QAAA,CAAS,YAAY,CAAC,EAAE,CAAC,CAAA;AAChD,CAAA;AACA,MAAM,YAAA,GAAe,CAAC,MAAA,KAAkD;AACtE,EAAA,MAAM,YAAA,GAAe,gBAAgB,CAAC,CAAA;AACtC,EAAA,IAAI,CAAC,QAAQ,OAAO,YAAA;AAMpB,EAAA,MAAM,WAAA,GAAc;AAAA,IAClB,WAAA;AAAA,IACA,UAAA;AAAA,IACA,KAAA;AAAA,IACA,OAAA;AAAA,IACA,MAAA;AAAA,IACA,UAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,MAAM,aAAa,WAAA,CAAY,OAAA;AAAA,IAC7B,MAAA,CAAO,IAAA,CAAK,iBAAA,CAAkB,OAAO;AAAA,GACvC;AACA,EAAA,OAAO,UAAA,KAAe,EAAA,GAAK,YAAA,GAAe,eAAA,CAAgB,aAAa,CAAC,CAAA;AAC1E,CAAA;AAEO,MAAM,YAAA,GAAe,CAAC,EAAE,KAAA,EAAM,KAAwB;AAC3D,EAAA,MAAM,UAAU,SAAA,EAAU;AAC1B,EAAA,MAAM,MAAA,GAAS,YAAY,KAAK,CAAA;AAEhC,EAAA,uBACE,GAAA;AAAA,IAAC,IAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,OAAA;AAAA,MACL,WAAW,OAAA,CAAQ,IAAA;AAAA,MACnB,KAAA,EAAA,CAAQ,MAAA,EAAQ,IAAA,IAAQ,OAAA,EAAS,kBAAkB,OAAO,CAAA;AAAA,MAC1D,KAAA,EAAO,EAAE,UAAA,EAAY,YAAA,CAAa,MAAM,CAAA;AAAE;AAAA,GAC5C;AAEJ;;;;"}
+{"version":3,"file":"ItemCategory.esm.js","sources":["../../../src/components/VisitList/ItemCategory.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 Chip from '@material-ui/core/Chip';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { Visit } from '../../api/VisitsApi';\nimport { useVisitDisplay } from './Context';\n\nconst useStyles = makeStyles(theme => ({\n  chip: {\n    color: theme.palette.common.white,\n    fontWeight: 'bold',\n    margin: 0,\n  },\n}));\n\nexport const ItemCategory = ({ visit }: { visit: Visit }) => {\n  const classes = useStyles();\n  const { getChipColor, getLabel } = useVisitDisplay();\n\n  return (\n    <Chip\n      size=\"small\"\n      className={classes.chip}\n      label={getLabel(visit)}\n      style={{ background: getChipColor(visit) }}\n    />\n  );\n};\n"],"names":[],"mappings":";;;;;AAqBA,MAAM,SAAA,GAAY,WAAW,CAAA,KAAA,MAAU;AAAA,EACrC,IAAA,EAAM;AAAA,IACJ,KAAA,EAAO,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,KAAA;AAAA,IAC5B,UAAA,EAAY,MAAA;AAAA,IACZ,MAAA,EAAQ;AAAA;AAEZ,CAAA,CAAE,CAAA;AAEK,MAAM,YAAA,GAAe,CAAC,EAAE,KAAA,EAAM,KAAwB;AAC3D,EAAA,MAAM,UAAU,SAAA,EAAU;AAC1B,EAAA,MAAM,EAAE,YAAA,EAAc,QAAA,EAAS,GAAI,eAAA,EAAgB;AAEnD,EAAA,uBACE,GAAA;AAAA,IAAC,IAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,OAAA;AAAA,MACL,WAAW,OAAA,CAAQ,IAAA;AAAA,MACnB,KAAA,EAAO,SAAS,KAAK,CAAA;AAAA,MACrB,KAAA,EAAO,EAAE,UAAA,EAAY,YAAA,CAAa,KAAK,CAAA;AAAE;AAAA,GAC3C;AAEJ;;;;"}

package/dist/components/VisitList/ItemDetail.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"ItemDetail.esm.js","sources":["../../../src/components/VisitList/ItemDetail.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 Typography from '@material-ui/core/Typography';\nimport { Visit } from '../../api/VisitsApi';\nimport { DateTime } from 'luxon';\n\nconst ItemDetailHits = ({ visit }: { visit: Visit }) => (\n  <Typography component=\"span\" variant=\"caption\" color=\"textSecondary\">\n    {visit.hits} time{visit.hits > 1 ? 's' : ''}\n  </Typography>\n);\n\nconst ItemDetailTimeAgo = ({ visit }: { visit: Visit }) => {\n  const visitDate = DateTime.fromMillis(visit.timestamp);\n\n  return (\n    <Typography\n      component=\"time\"\n      variant=\"caption\"\n      color=\"textSecondary\"\n      dateTime={visitDate.toISO() ?? undefined}\n    >\n      {visitDate.toRelative()}\n    </Typography>\n  );\n};\n\nexport type ItemDetailType = 'time-ago' | 'hits';\n\nexport const ItemDetail = ({\n  visit,\n  type,\n}: {\n  visit: Visit;\n  type: ItemDetailType;\n}) =>\n  type === 'time-ago' ? (\n    <ItemDetailTimeAgo visit={visit} />\n  ) : (\n    <ItemDetailHits visit={visit} />\n  );\n"],"names":[],"mappings":";;;;AAoBA,MAAM,cAAA,GAAiB,CAAC,EAAE,KAAA,EAAM,qBAC9B,IAAA,CAAC,UAAA,EAAA,EAAW,SAAA,EAAU,MAAA,EAAO,OAAA,EAAQ,SAAA,EAAU,KAAA,EAAM,eAAA,EAClD,QAAA,EAAA;AAAA,EAAA,KAAA,CAAM,IAAA;AAAA,EAAK,OAAA;AAAA,EAAM,KAAA,CAAM,IAAA,GAAO,CAAA,GAAI,GAAA,GAAM;AAAA,CAAA,EAC3C,CAAA;AAGF,MAAM,iBAAA,GAAoB,CAAC,EAAE,KAAA,EAAM,KAAwB;AACzD,EAAA,MAAM,SAAA,GAAY,QAAA,CAAS,UAAA,CAAW,KAAA,CAAM,SAAS,CAAA;AAErD,EAAA,uBACE,GAAA;AAAA,IAAC,UAAA;AAAA,IAAA;AAAA,MACC,SAAA,EAAU,MAAA;AAAA,MACV,OAAA,EAAQ,SAAA;AAAA,MACR,KAAA,EAAM,eAAA;AAAA,MACN,QAAA,EAAU,SAAA,CAAU,KAAA,EAAM,IAAK,MAAA;AAAA,MAE9B,oBAAU,UAAA;AAAW;AAAA,GACxB;AAEJ,CAAA;AAIO,MAAM,aAAa,CAAC;AAAA,EACzB,KAAA;AAAA,EACA;AACF,CAAA,KAIE,IAAA,KAAS,6BACP,GAAA,CAAC,iBAAA,EAAA,EAAkB,OAAc,CAAA,mBAEjC,GAAA,CAAC,kBAAe,KAAA,EAAc;;;;"}
+{"version":3,"file":"ItemDetail.esm.js","sources":["../../../src/components/VisitList/ItemDetail.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 Typography from '@material-ui/core/Typography';\nimport { Visit } from '../../api/VisitsApi';\nimport { DateTime } from 'luxon';\n\nconst ItemDetailHits = ({ visit }: { visit: Visit }) => (\n  <Typography component=\"span\" variant=\"caption\" color=\"textSecondary\">\n    {visit.hits} time{visit.hits > 1 ? 's' : ''}\n  </Typography>\n);\n\nconst ItemDetailTimeAgo = ({ visit }: { visit: Visit }) => {\n  const visitDate = DateTime.fromMillis(visit.timestamp);\n\n  return (\n    <Typography\n      component=\"time\"\n      variant=\"caption\"\n      color=\"textSecondary\"\n      dateTime={visitDate.toISO() ?? undefined}\n    >\n      {visitDate.toRelative()}\n    </Typography>\n  );\n};\n\n/**\n * @internal\n */\nexport type ItemDetailType = 'time-ago' | 'hits';\n\nexport const ItemDetail = ({\n  visit,\n  type,\n}: {\n  visit: Visit;\n  type: ItemDetailType;\n}) =>\n  type === 'time-ago' ? (\n    <ItemDetailTimeAgo visit={visit} />\n  ) : (\n    <ItemDetailHits visit={visit} />\n  );\n"],"names":[],"mappings":";;;;AAoBA,MAAM,cAAA,GAAiB,CAAC,EAAE,KAAA,EAAM,qBAC9B,IAAA,CAAC,UAAA,EAAA,EAAW,SAAA,EAAU,MAAA,EAAO,OAAA,EAAQ,SAAA,EAAU,KAAA,EAAM,eAAA,EAClD,QAAA,EAAA;AAAA,EAAA,KAAA,CAAM,IAAA;AAAA,EAAK,OAAA;AAAA,EAAM,KAAA,CAAM,IAAA,GAAO,CAAA,GAAI,GAAA,GAAM;AAAA,CAAA,EAC3C,CAAA;AAGF,MAAM,iBAAA,GAAoB,CAAC,EAAE,KAAA,EAAM,KAAwB;AACzD,EAAA,MAAM,SAAA,GAAY,QAAA,CAAS,UAAA,CAAW,KAAA,CAAM,SAAS,CAAA;AAErD,EAAA,uBACE,GAAA;AAAA,IAAC,UAAA;AAAA,IAAA;AAAA,MACC,SAAA,EAAU,MAAA;AAAA,MACV,OAAA,EAAQ,SAAA;AAAA,MACR,KAAA,EAAM,eAAA;AAAA,MACN,QAAA,EAAU,SAAA,CAAU,KAAA,EAAM,IAAK,MAAA;AAAA,MAE9B,oBAAU,UAAA;AAAW;AAAA,GACxB;AAEJ,CAAA;AAOO,MAAM,aAAa,CAAC;AAAA,EACzB,KAAA;AAAA,EACA;AACF,CAAA,KAIE,IAAA,KAAS,6BACP,GAAA,CAAC,iBAAA,EAAA,EAAkB,OAAc,CAAA,mBAEjC,GAAA,CAAC,kBAAe,KAAA,EAAc;;;;"}

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

@@ -1 +1 @@
-{"version":3,"file":"VisitList.esm.js","sources":["../../../src/components/VisitList/VisitList.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 { ReactElement } from 'react';\nimport Collapse from '@material-ui/core/Collapse';\nimport List from '@material-ui/core/List';\nimport { Visit } from '../../api/VisitsApi';\nimport { VisitListItem } from './VisitListItem';\nimport { ItemDetailType } from './ItemDetail';\nimport { VisitListEmpty } from './VisitListEmpty';\nimport { VisitListFew } from './VisitListFew';\nimport { VisitListSkeleton } from './VisitListSkeleton';\n\nexport const VisitList = ({\n  detailType,\n  visits = [],\n  numVisitsOpen = 3,\n  numVisitsTotal = 8,\n  collapsed = true,\n  loading = false,\n  title = '',\n}: {\n  detailType: ItemDetailType;\n  visits?: Visit[];\n  numVisitsOpen?: number;\n  numVisitsTotal?: number;\n  collapsed?: boolean;\n  loading?: boolean;\n  title?: string;\n}) => {\n  let listBody: ReactElement = <></>;\n  if (loading) {\n    listBody = (\n      <VisitListSkeleton\n        numVisitsOpen={numVisitsOpen}\n        numVisitsTotal={numVisitsTotal}\n        collapsed={collapsed}\n      />\n    );\n  } else if (visits.length === 0) {\n    listBody = <VisitListEmpty />;\n  } else if (visits.length < numVisitsOpen) {\n    listBody = (\n      <>\n        {visits.map((visit, index) => (\n          <VisitListItem visit={visit} key={index} detailType={detailType} />\n        ))}\n        <VisitListFew />\n      </>\n    );\n  } else {\n    listBody = (\n      <>\n        {visits.slice(0, numVisitsOpen).map((visit, index) => (\n          <VisitListItem visit={visit} key={index} detailType={detailType} />\n        ))}\n        {visits.length > numVisitsOpen && (\n          <Collapse in={!collapsed}>\n            {visits.slice(numVisitsOpen, numVisitsTotal).map((visit, index) => (\n              <VisitListItem\n                visit={visit}\n                key={index}\n                detailType={detailType}\n              />\n            ))}\n          </Collapse>\n        )}\n      </>\n    );\n  }\n\n  return (\n    <>\n      {title && <h5>{title}</h5>}\n      <List dense disablePadding>\n        {listBody}\n      </List>\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AA0BO,MAAM,YAAY,CAAC;AAAA,EACxB,UAAA;AAAA,EACA,SAAS,EAAC;AAAA,EACV,aAAA,GAAgB,CAAA;AAAA,EAChB,cAAA,GAAiB,CAAA;AAAA,EACjB,SAAA,GAAY,IAAA;AAAA,EACZ,OAAA,GAAU,KAAA;AAAA,EACV,KAAA,GAAQ;AACV,CAAA,KAQM;AACJ,EAAA,IAAI,2BAAyB,GAAA,CAAA,QAAA,EAAA,EAAE,CAAA;AAC/B,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,QAAA,mBACE,GAAA;AAAA,MAAC,iBAAA;AAAA,MAAA;AAAA,QACC,aAAA;AAAA,QACA,cAAA;AAAA,QACA;AAAA;AAAA,KACF;AAAA,EAEJ,CAAA,MAAA,IAAW,MAAA,CAAO,MAAA,KAAW,CAAA,EAAG;AAC9B,IAAA,QAAA,uBAAY,cAAA,EAAA,EAAe,CAAA;AAAA,EAC7B,CAAA,MAAA,IAAW,MAAA,CAAO,MAAA,GAAS,aAAA,EAAe;AACxC,IAAA,QAAA,mBACE,IAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA;AAAA,MAAA,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,EAAO,KAAA,yBACjB,aAAA,EAAA,EAAc,KAAA,EAA0B,UAAA,EAAA,EAAP,KAA+B,CAClE,CAAA;AAAA,0BACA,YAAA,EAAA,EAAa;AAAA,KAAA,EAChB,CAAA;AAAA,EAEJ,CAAA,MAAO;AACL,IAAA,QAAA,mBACE,IAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA;AAAA,MAAA,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,aAAa,CAAA,CAAE,GAAA,CAAI,CAAC,KAAA,EAAO,KAAA,qBAC1C,GAAA,CAAC,aAAA,EAAA,EAAc,KAAA,EAA0B,UAAA,EAAA,EAAP,KAA+B,CAClE,CAAA;AAAA,MACA,OAAO,MAAA,GAAS,aAAA,oBACf,GAAA,CAAC,QAAA,EAAA,EAAS,IAAI,CAAC,SAAA,EACZ,QAAA,EAAA,MAAA,CAAO,KAAA,CAAM,eAAe,cAAc,CAAA,CAAE,GAAA,CAAI,CAAC,OAAO,KAAA,qBACvD,GAAA;AAAA,QAAC,aAAA;AAAA,QAAA;AAAA,UACC,KAAA;AAAA,UAEA;AAAA,SAAA;AAAA,QADK;AAAA,OAGR,CAAA,EACH;AAAA,KAAA,EAEJ,CAAA;AAAA,EAEJ;AAEA,EAAA,uBACE,IAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA;AAAA,IAAA,KAAA,oBAAS,GAAA,CAAC,QAAI,QAAA,EAAA,KAAA,EAAM,CAAA;AAAA,wBACpB,IAAA,EAAA,EAAK,KAAA,EAAK,IAAA,EAAC,cAAA,EAAc,MACvB,QAAA,EAAA,QAAA,EACH;AAAA,GAAA,EACF,CAAA;AAEJ;;;;"}
+{"version":3,"file":"VisitList.esm.js","sources":["../../../src/components/VisitList/VisitList.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 { ReactElement } from 'react';\nimport Collapse from '@material-ui/core/Collapse';\nimport List from '@material-ui/core/List';\nimport { Visit } from '../../api/VisitsApi';\nimport { VisitListItem } from './VisitListItem';\nimport { ItemDetailType } from './ItemDetail';\nimport { VisitListEmpty } from './VisitListEmpty';\nimport { VisitListFew } from './VisitListFew';\nimport { VisitListSkeleton } from './VisitListSkeleton';\n\n/**\n * @internal\n */\nexport const VisitList = ({\n  detailType,\n  visits = [],\n  numVisitsOpen = 3,\n  numVisitsTotal = 8,\n  collapsed = true,\n  loading = false,\n  title = '',\n}: {\n  detailType: ItemDetailType;\n  visits?: Visit[];\n  numVisitsOpen?: number;\n  numVisitsTotal?: number;\n  collapsed?: boolean;\n  loading?: boolean;\n  title?: string;\n}) => {\n  let listBody: ReactElement = <></>;\n  if (loading) {\n    listBody = (\n      <VisitListSkeleton\n        numVisitsOpen={numVisitsOpen}\n        numVisitsTotal={numVisitsTotal}\n        collapsed={collapsed}\n      />\n    );\n  } else if (visits.length === 0) {\n    listBody = <VisitListEmpty />;\n  } else if (visits.length < numVisitsOpen) {\n    listBody = (\n      <>\n        {visits.map((visit, index) => (\n          <VisitListItem visit={visit} key={index} detailType={detailType} />\n        ))}\n        <VisitListFew />\n      </>\n    );\n  } else {\n    listBody = (\n      <>\n        {visits.slice(0, numVisitsOpen).map((visit, index) => (\n          <VisitListItem visit={visit} key={index} detailType={detailType} />\n        ))}\n        {visits.length > numVisitsOpen && (\n          <Collapse in={!collapsed}>\n            {visits.slice(numVisitsOpen, numVisitsTotal).map((visit, index) => (\n              <VisitListItem\n                visit={visit}\n                key={index}\n                detailType={detailType}\n              />\n            ))}\n          </Collapse>\n        )}\n      </>\n    );\n  }\n\n  return (\n    <>\n      {title && <h5>{title}</h5>}\n      <List dense disablePadding>\n        {listBody}\n      </List>\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AA6BO,MAAM,YAAY,CAAC;AAAA,EACxB,UAAA;AAAA,EACA,SAAS,EAAC;AAAA,EACV,aAAA,GAAgB,CAAA;AAAA,EAChB,cAAA,GAAiB,CAAA;AAAA,EACjB,SAAA,GAAY,IAAA;AAAA,EACZ,OAAA,GAAU,KAAA;AAAA,EACV,KAAA,GAAQ;AACV,CAAA,KAQM;AACJ,EAAA,IAAI,2BAAyB,GAAA,CAAA,QAAA,EAAA,EAAE,CAAA;AAC/B,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,QAAA,mBACE,GAAA;AAAA,MAAC,iBAAA;AAAA,MAAA;AAAA,QACC,aAAA;AAAA,QACA,cAAA;AAAA,QACA;AAAA;AAAA,KACF;AAAA,EAEJ,CAAA,MAAA,IAAW,MAAA,CAAO,MAAA,KAAW,CAAA,EAAG;AAC9B,IAAA,QAAA,uBAAY,cAAA,EAAA,EAAe,CAAA;AAAA,EAC7B,CAAA,MAAA,IAAW,MAAA,CAAO,MAAA,GAAS,aAAA,EAAe;AACxC,IAAA,QAAA,mBACE,IAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA;AAAA,MAAA,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,EAAO,KAAA,yBACjB,aAAA,EAAA,EAAc,KAAA,EAA0B,UAAA,EAAA,EAAP,KAA+B,CAClE,CAAA;AAAA,0BACA,YAAA,EAAA,EAAa;AAAA,KAAA,EAChB,CAAA;AAAA,EAEJ,CAAA,MAAO;AACL,IAAA,QAAA,mBACE,IAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA;AAAA,MAAA,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,aAAa,CAAA,CAAE,GAAA,CAAI,CAAC,KAAA,EAAO,KAAA,qBAC1C,GAAA,CAAC,aAAA,EAAA,EAAc,KAAA,EAA0B,UAAA,EAAA,EAAP,KAA+B,CAClE,CAAA;AAAA,MACA,OAAO,MAAA,GAAS,aAAA,oBACf,GAAA,CAAC,QAAA,EAAA,EAAS,IAAI,CAAC,SAAA,EACZ,QAAA,EAAA,MAAA,CAAO,KAAA,CAAM,eAAe,cAAc,CAAA,CAAE,GAAA,CAAI,CAAC,OAAO,KAAA,qBACvD,GAAA;AAAA,QAAC,aAAA;AAAA,QAAA;AAAA,UACC,KAAA;AAAA,UAEA;AAAA,SAAA;AAAA,QADK;AAAA,OAGR,CAAA,EACH;AAAA,KAAA,EAEJ,CAAA;AAAA,EAEJ;AAEA,EAAA,uBACE,IAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA;AAAA,IAAA,KAAA,oBAAS,GAAA,CAAC,QAAI,QAAA,EAAA,KAAA,EAAM,CAAA;AAAA,wBACpB,IAAA,EAAA,EAAK,KAAA,EAAK,IAAA,EAAC,cAAA,EAAc,MACvB,QAAA,EAAA,QAAA,EACH;AAAA,GAAA,EACF,CAAA;AAEJ;;;;"}

package/dist/components/index.esm.js

@@ -1,4 +1,5 @@
 export { HomepageCompositionRoot } from './HomepageCompositionRoot.esm.js';
 export { CustomHomepageGrid } from './CustomHomepage/CustomHomepageGrid.esm.js';
 export { VisitListener } from './VisitListener.esm.js';
+export { VisitDisplayProvider, useVisitDisplay } from './VisitList/Context.esm.js';
 //# sourceMappingURL=index.esm.js.map

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

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

package/dist/homePageComponents/VisitedByType/Context.esm.js

@@ -32,9 +32,9 @@ const getFilteredSet = (setContext, contextKey) => (e) => setContext((state) =>
   [contextKey]: typeof e === "function" ? e(state[contextKey]) : e
 }));
 const ContextProvider = ({ children }) => {
-  const [context, setContext] = useState(
-    defaultContextValueOnly
-  );
+  const [context, setContext] = useState({
+    ...defaultContextValueOnly
+  });
   const {
     setCollapsed,
     setNumVisitsOpen,

package/dist/homePageComponents/VisitedByType/Context.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"Context.esm.js","sources":["../../../src/homePageComponents/VisitedByType/Context.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  Dispatch,\n  SetStateAction,\n  createContext,\n  useMemo,\n  useState,\n  useContext as useReactContext,\n} from 'react';\nimport { Visit } from '../../api/VisitsApi';\nimport { VisitedByTypeKind } from './Content';\n\nexport type ContextValueOnly = {\n  collapsed: boolean;\n  numVisitsOpen: number;\n  numVisitsTotal: number;\n  visits: Array<Visit>;\n  loading: boolean;\n  kind: VisitedByTypeKind;\n};\n\nexport type ContextValue = ContextValueOnly & {\n  setCollapsed: Dispatch<SetStateAction<boolean>>;\n  setNumVisitsOpen: Dispatch<SetStateAction<number>>;\n  setNumVisitsTotal: Dispatch<SetStateAction<number>>;\n  setVisits: Dispatch<SetStateAction<Array<Visit>>>;\n  setLoading: Dispatch<SetStateAction<boolean>>;\n  setKind: Dispatch<SetStateAction<VisitedByTypeKind>>;\n  setContext: Dispatch<SetStateAction<ContextValueOnly>>;\n};\n\nconst defaultContextValueOnly: ContextValueOnly = {\n  collapsed: true,\n  numVisitsOpen: 3,\n  numVisitsTotal: 8,\n  visits: [],\n  loading: true,\n  kind: 'recent',\n};\n\nexport const defaultContextValue: ContextValue = {\n  ...defaultContextValueOnly,\n  setCollapsed: () => {},\n  setNumVisitsOpen: () => {},\n  setNumVisitsTotal: () => {},\n  setVisits: () => {},\n  setLoading: () => {},\n  setKind: () => {},\n  setContext: () => {},\n};\n\nexport const Context = createContext<ContextValue>(defaultContextValue);\n\nconst getFilteredSet =\n  <T,>(\n    setContext: Dispatch<SetStateAction<ContextValueOnly>>,\n    contextKey: keyof ContextValueOnly,\n  ) =>\n  (e: SetStateAction<T>) =>\n    setContext(state => ({\n      ...state,\n      [contextKey]:\n        typeof e === 'function' ? (e as Function)(state[contextKey]) : e,\n    }));\n\nexport const ContextProvider = ({ children }: { children: JSX.Element }) => {\n  const [context, setContext] = useState<ContextValueOnly>(\n    defaultContextValueOnly,\n  );\n  const {\n    setCollapsed,\n    setNumVisitsOpen,\n    setNumVisitsTotal,\n    setVisits,\n    setLoading,\n    setKind,\n  } = useMemo(\n    () => ({\n      setCollapsed: getFilteredSet(setContext, 'collapsed'),\n      setNumVisitsOpen: getFilteredSet(setContext, 'numVisitsOpen'),\n      setNumVisitsTotal: getFilteredSet(setContext, 'numVisitsTotal'),\n      setVisits: getFilteredSet(setContext, 'visits'),\n      setLoading: getFilteredSet(setContext, 'loading'),\n      setKind: getFilteredSet(setContext, 'kind'),\n    }),\n    [setContext],\n  );\n\n  const value: ContextValue = {\n    ...context,\n    setContext,\n    setCollapsed,\n    setNumVisitsOpen,\n    setNumVisitsTotal,\n    setVisits,\n    setLoading,\n    setKind,\n  };\n\n  return <Context.Provider value={value}>{children}</Context.Provider>;\n};\n\nexport const useContext = () => {\n  const value = useReactContext(Context);\n\n  if (value === undefined)\n    throw new Error(\n      'VisitedByType useContext found undefined ContextValue, <ContextProvider/> could be missing',\n    );\n\n  return value;\n};\n\nexport default Context;\n"],"names":["useReactContext"],"mappings":";;;AA8CA,MAAM,uBAAA,GAA4C;AAAA,EAChD,SAAA,EAAW,IAAA;AAAA,EACX,aAAA,EAAe,CAAA;AAAA,EACf,cAAA,EAAgB,CAAA;AAAA,EAChB,QAAQ,EAAC;AAAA,EACT,OAAA,EAAS,IAAA;AAAA,EACT,IAAA,EAAM;AACR,CAAA;AAEO,MAAM,mBAAA,GAAoC;AAAA,EAC/C,GAAG,uBAAA;AAAA,EACH,cAAc,MAAM;AAAA,EAAC,CAAA;AAAA,EACrB,kBAAkB,MAAM;AAAA,EAAC,CAAA;AAAA,EACzB,mBAAmB,MAAM;AAAA,EAAC,CAAA;AAAA,EAC1B,WAAW,MAAM;AAAA,EAAC,CAAA;AAAA,EAClB,YAAY,MAAM;AAAA,EAAC,CAAA;AAAA,EACnB,SAAS,MAAM;AAAA,EAAC,CAAA;AAAA,EAChB,YAAY,MAAM;AAAA,EAAC;AACrB;AAEO,MAAM,OAAA,GAAU,cAA4B,mBAAmB;AAEtE,MAAM,iBACJ,CACE,UAAA,EACA,eAEF,CAAC,CAAA,KACC,WAAW,CAAA,KAAA,MAAU;AAAA,EACnB,GAAG,KAAA;AAAA,EACH,CAAC,UAAU,GACT,OAAO,CAAA,KAAM,aAAc,CAAA,CAAe,KAAA,CAAM,UAAU,CAAC,CAAA,GAAI;AACnE,CAAA,CAAE,CAAA;AAEC,MAAM,eAAA,GAAkB,CAAC,EAAE,QAAA,EAAS,KAAiC;AAC1E,EAAA,MAAM,CAAC,OAAA,EAAS,UAAU,CAAA,GAAI,QAAA;AAAA,IAC5B;AAAA,GACF;AACA,EAAA,MAAM;AAAA,IACJ,YAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,SAAA;AAAA,IACA,UAAA;AAAA,IACA;AAAA,GACF,GAAI,OAAA;AAAA,IACF,OAAO;AAAA,MACL,YAAA,EAAc,cAAA,CAAe,UAAA,EAAY,WAAW,CAAA;AAAA,MACpD,gBAAA,EAAkB,cAAA,CAAe,UAAA,EAAY,eAAe,CAAA;AAAA,MAC5D,iBAAA,EAAmB,cAAA,CAAe,UAAA,EAAY,gBAAgB,CAAA;AAAA,MAC9D,SAAA,EAAW,cAAA,CAAe,UAAA,EAAY,QAAQ,CAAA;AAAA,MAC9C,UAAA,EAAY,cAAA,CAAe,UAAA,EAAY,SAAS,CAAA;AAAA,MAChD,OAAA,EAAS,cAAA,CAAe,UAAA,EAAY,MAAM;AAAA,KAC5C,CAAA;AAAA,IACA,CAAC,UAAU;AAAA,GACb;AAEA,EAAA,MAAM,KAAA,GAAsB;AAAA,IAC1B,GAAG,OAAA;AAAA,IACH,UAAA;AAAA,IACA,YAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,SAAA;AAAA,IACA,UAAA;AAAA,IACA;AAAA,GACF;AAEA,EAAA,uBAAO,GAAA,CAAC,OAAA,CAAQ,QAAA,EAAR,EAAiB,OAAe,QAAA,EAAS,CAAA;AACnD;AAEO,MAAM,aAAa,MAAM;AAC9B,EAAA,MAAM,KAAA,GAAQA,aAAgB,OAAO,CAAA;AAErC,EAAA,IAAI,KAAA,KAAU,MAAA;AACZ,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAEF,EAAA,OAAO,KAAA;AACT;;;;"}
+{"version":3,"file":"Context.esm.js","sources":["../../../src/homePageComponents/VisitedByType/Context.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  Dispatch,\n  SetStateAction,\n  createContext,\n  useMemo,\n  useState,\n  useContext as useReactContext,\n} from 'react';\nimport { Visit } from '../../api/VisitsApi';\nimport { VisitedByTypeKind } from './Content';\n\nexport type ContextValueOnly<T = Visit> = {\n  collapsed: boolean;\n  numVisitsOpen: number;\n  numVisitsTotal: number;\n  visits: Array<T>;\n  loading: boolean;\n  kind: VisitedByTypeKind;\n};\n\nexport type ContextValue<T = Visit> = ContextValueOnly<T> & {\n  setCollapsed: Dispatch<SetStateAction<boolean>>;\n  setNumVisitsOpen: Dispatch<SetStateAction<number>>;\n  setNumVisitsTotal: Dispatch<SetStateAction<number>>;\n  setVisits: Dispatch<SetStateAction<Array<T>>>;\n  setLoading: Dispatch<SetStateAction<boolean>>;\n  setKind: Dispatch<SetStateAction<VisitedByTypeKind>>;\n  setContext: Dispatch<SetStateAction<ContextValueOnly<T>>>;\n};\n\nconst defaultContextValueOnly: ContextValueOnly = {\n  collapsed: true,\n  numVisitsOpen: 3,\n  numVisitsTotal: 8,\n  visits: [],\n  loading: true,\n  kind: 'recent',\n};\n\nexport const defaultContextValue: ContextValue = {\n  ...defaultContextValueOnly,\n  setCollapsed: () => {},\n  setNumVisitsOpen: () => {},\n  setNumVisitsTotal: () => {},\n  setVisits: () => {},\n  setLoading: () => {},\n  setKind: () => {},\n  setContext: () => {},\n};\n\nexport const Context = createContext<ContextValue>(defaultContextValue);\n\nconst getFilteredSet =\n  <T,>(\n    setContext: Dispatch<SetStateAction<ContextValueOnly>>,\n    contextKey: keyof ContextValueOnly,\n  ) =>\n  (e: SetStateAction<T>) =>\n    setContext(state => ({\n      ...state,\n      [contextKey]:\n        typeof e === 'function' ? (e as Function)(state[contextKey]) : e,\n    }));\n\nexport const ContextProvider = ({ children }: { children: JSX.Element }) => {\n  const [context, setContext] = useState<ContextValueOnly>({\n    ...defaultContextValueOnly,\n  });\n  const {\n    setCollapsed,\n    setNumVisitsOpen,\n    setNumVisitsTotal,\n    setVisits,\n    setLoading,\n    setKind,\n  } = useMemo(\n    () => ({\n      setCollapsed: getFilteredSet(setContext, 'collapsed'),\n      setNumVisitsOpen: getFilteredSet(setContext, 'numVisitsOpen'),\n      setNumVisitsTotal: getFilteredSet(setContext, 'numVisitsTotal'),\n      setVisits: getFilteredSet(setContext, 'visits'),\n      setLoading: getFilteredSet(setContext, 'loading'),\n      setKind: getFilteredSet(setContext, 'kind'),\n    }),\n    [setContext],\n  );\n\n  const value: ContextValue = {\n    ...context,\n    setContext,\n    setCollapsed,\n    setNumVisitsOpen,\n    setNumVisitsTotal,\n    setVisits,\n    setLoading,\n    setKind,\n  };\n\n  return <Context.Provider value={value}>{children}</Context.Provider>;\n};\n\nexport const useContext = () => {\n  const value = useReactContext(Context);\n\n  if (value === undefined)\n    throw new Error(\n      'VisitedByType useContext found undefined ContextValue, <ContextProvider/> could be missing',\n    );\n\n  return value;\n};\n\nexport default Context;\n"],"names":["useReactContext"],"mappings":";;;AA8CA,MAAM,uBAAA,GAA4C;AAAA,EAChD,SAAA,EAAW,IAAA;AAAA,EACX,aAAA,EAAe,CAAA;AAAA,EACf,cAAA,EAAgB,CAAA;AAAA,EAChB,QAAQ,EAAC;AAAA,EACT,OAAA,EAAS,IAAA;AAAA,EACT,IAAA,EAAM;AACR,CAAA;AAEO,MAAM,mBAAA,GAAoC;AAAA,EAC/C,GAAG,uBAAA;AAAA,EACH,cAAc,MAAM;AAAA,EAAC,CAAA;AAAA,EACrB,kBAAkB,MAAM;AAAA,EAAC,CAAA;AAAA,EACzB,mBAAmB,MAAM;AAAA,EAAC,CAAA;AAAA,EAC1B,WAAW,MAAM;AAAA,EAAC,CAAA;AAAA,EAClB,YAAY,MAAM;AAAA,EAAC,CAAA;AAAA,EACnB,SAAS,MAAM;AAAA,EAAC,CAAA;AAAA,EAChB,YAAY,MAAM;AAAA,EAAC;AACrB;AAEO,MAAM,OAAA,GAAU,cAA4B,mBAAmB;AAEtE,MAAM,iBACJ,CACE,UAAA,EACA,eAEF,CAAC,CAAA,KACC,WAAW,CAAA,KAAA,MAAU;AAAA,EACnB,GAAG,KAAA;AAAA,EACH,CAAC,UAAU,GACT,OAAO,CAAA,KAAM,aAAc,CAAA,CAAe,KAAA,CAAM,UAAU,CAAC,CAAA,GAAI;AACnE,CAAA,CAAE,CAAA;AAEC,MAAM,eAAA,GAAkB,CAAC,EAAE,QAAA,EAAS,KAAiC;AAC1E,EAAA,MAAM,CAAC,OAAA,EAAS,UAAU,CAAA,GAAI,QAAA,CAA2B;AAAA,IACvD,GAAG;AAAA,GACJ,CAAA;AACD,EAAA,MAAM;AAAA,IACJ,YAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,SAAA;AAAA,IACA,UAAA;AAAA,IACA;AAAA,GACF,GAAI,OAAA;AAAA,IACF,OAAO;AAAA,MACL,YAAA,EAAc,cAAA,CAAe,UAAA,EAAY,WAAW,CAAA;AAAA,MACpD,gBAAA,EAAkB,cAAA,CAAe,UAAA,EAAY,eAAe,CAAA;AAAA,MAC5D,iBAAA,EAAmB,cAAA,CAAe,UAAA,EAAY,gBAAgB,CAAA;AAAA,MAC9D,SAAA,EAAW,cAAA,CAAe,UAAA,EAAY,QAAQ,CAAA;AAAA,MAC9C,UAAA,EAAY,cAAA,CAAe,UAAA,EAAY,SAAS,CAAA;AAAA,MAChD,OAAA,EAAS,cAAA,CAAe,UAAA,EAAY,MAAM;AAAA,KAC5C,CAAA;AAAA,IACA,CAAC,UAAU;AAAA,GACb;AAEA,EAAA,MAAM,KAAA,GAAsB;AAAA,IAC1B,GAAG,OAAA;AAAA,IACH,UAAA;AAAA,IACA,YAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,SAAA;AAAA,IACA,UAAA;AAAA,IACA;AAAA,GACF;AAEA,EAAA,uBAAO,GAAA,CAAC,OAAA,CAAQ,QAAA,EAAR,EAAiB,OAAe,QAAA,EAAS,CAAA;AACnD;AAEO,MAAM,aAAa,MAAM;AAC9B,EAAA,MAAM,KAAA,GAAQA,aAAgB,OAAO,CAAA;AAErC,EAAA,IAAI,KAAA,KAAU,MAAA;AACZ,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAEF,EAAA,OAAO,KAAA;AACT;;;;"}

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

@@ -1 +1 @@
-{"version":3,"file":"VisitedByType.esm.js","sources":["../../../src/homePageComponents/VisitedByType/VisitedByType.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 { VisitList } from '../../components/VisitList';\nimport { useContext } from './Context';\n\nexport const VisitedByType = () => {\n  const { collapsed, numVisitsOpen, numVisitsTotal, visits, loading, kind } =\n    useContext();\n\n  return (\n    <VisitList\n      visits={visits}\n      detailType={kind === 'top' ? 'hits' : 'time-ago'}\n      collapsed={collapsed}\n      numVisitsOpen={numVisitsOpen}\n      numVisitsTotal={numVisitsTotal}\n      loading={loading}\n    />\n  );\n};\n"],"names":[],"mappings":";;;;AAmBO,MAAM,gBAAgB,MAAM;AACjC,EAAA,MAAM,EAAE,WAAW,aAAA,EAAe,cAAA,EAAgB,QAAQ,OAAA,EAAS,IAAA,KACjE,UAAA,EAAW;AAEb,EAAA,uBACE,GAAA;AAAA,IAAC,SAAA;AAAA,IAAA;AAAA,MACC,MAAA;AAAA,MACA,UAAA,EAAY,IAAA,KAAS,KAAA,GAAQ,MAAA,GAAS,UAAA;AAAA,MACtC,SAAA;AAAA,MACA,aAAA;AAAA,MACA,cAAA;AAAA,MACA;AAAA;AAAA,GACF;AAEJ;;;;"}
+{"version":3,"file":"VisitedByType.esm.js","sources":["../../../src/homePageComponents/VisitedByType/VisitedByType.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 { VisitList } from '../../components/VisitList/VisitList';\nimport { useContext } from './Context';\n\nexport const VisitedByType = () => {\n  const { collapsed, numVisitsOpen, numVisitsTotal, visits, loading, kind } =\n    useContext();\n\n  return (\n    <VisitList\n      visits={visits}\n      detailType={kind === 'top' ? 'hits' : 'time-ago'}\n      collapsed={collapsed}\n      numVisitsOpen={numVisitsOpen}\n      numVisitsTotal={numVisitsTotal}\n      loading={loading}\n    />\n  );\n};\n"],"names":[],"mappings":";;;;AAmBO,MAAM,gBAAgB,MAAM;AACjC,EAAA,MAAM,EAAE,WAAW,aAAA,EAAe,cAAA,EAAgB,QAAQ,OAAA,EAAS,IAAA,KACjE,UAAA,EAAW;AAEb,EAAA,uBACE,GAAA;AAAA,IAAC,SAAA;AAAA,IAAA;AAAA,MACC,MAAA;AAAA,MACA,UAAA,EAAY,IAAA,KAAS,KAAA,GAAQ,MAAA,GAAS,UAAA;AAAA,MACtC,SAAA;AAAA,MACA,aAAA;AAAA,MACA,cAAA;AAAA,MACA;AAAA;AAAA,GACF;AAEJ;;;;"}

package/dist/index.d.ts

@@ -139,15 +139,42 @@ interface VisitsApi {
      * @param queryParams - optional search query params.
      */
     list(queryParams?: VisitsApiQueryParams): Promise<Visit[]>;
+    /**
+     * Transform the pathname before it is considered for any other processing.
+     * @param pathname - the original pathname
+     */
+    transformPathname?(pathname: string): string;
+    /**
+     * Determine whether a visit should be saved.
+     * @param visit - page visit data
+     */
+    canSave?(visit: VisitInput): boolean | Promise<boolean>;
+    /**
+     * Add additional data to the visit before saving.
+     * @param visit - page visit data
+     */
+    enrichVisit?(visit: VisitInput): Promise<Record<string, any>> | Record<string, any>;
 }
 /** @public */
 declare const visitsApiRef: _backstage_core_plugin_api.ApiRef<VisitsApi>;
 
+/**
+ * @public
+ * Type definition for visit data before it's saved (without auto-generated fields)
+ */
+type VisitInput = {
+    name: string;
+    pathname: string;
+    entityRef?: string;
+};
 /** @public */
 type VisitsStorageApiOptions = {
     limit?: number;
     storageApi: StorageApi;
     identityApi: IdentityApi;
+    transformPathname?: (pathname: string) => string;
+    canSave?: (visit: VisitInput) => boolean | Promise<boolean>;
+    enrichVisit?: (visit: VisitInput) => Promise<Record<string, any>> | Record<string, any>;
 };
 /**
  * @public
@@ -160,12 +187,31 @@ declare class VisitsStorageApi implements VisitsApi {
     private readonly storageApi;
     private readonly storageKeyPrefix;
     private readonly identityApi;
+    private readonly transformPathnameImpl?;
+    private readonly canSaveImpl?;
+    private readonly enrichVisitImpl?;
     static create(options: VisitsStorageApiOptions): VisitsStorageApi;
     private constructor();
     /**
      * Returns a list of visits through the visitsApi
      */
     list(queryParams?: VisitsApiQueryParams): Promise<Visit[]>;
+    /**
+     * Transform the pathname before it is considered for any other processing.
+     * @param pathname - the original pathname
+     * @returns the transformed pathname
+     */
+    transformPathname(pathname: string): string;
+    /**
+     * Determine whether a visit should be saved.
+     * @param visit - page visit data
+     */
+    canSave(visit: VisitInput): Promise<boolean>;
+    /**
+     * Add additional data to the visit before saving.
+     * @param visit - page visit data
+     */
+    enrichVisit(visit: VisitInput): Promise<Record<string, any>>;
     /**
      * Saves a visit through the visitsApi
      */
@@ -466,6 +512,44 @@ declare const VisitListener: ({ children, toEntityRef, visitName, }: {
     }) => string;
 }) => JSX.Element;
 
+/**
+ * Type definition for the chip color function
+ * @public
+ */
+type GetChipColorFunction = (visit: Visit) => string;
+/**
+ * Type definition for the label function
+ * @public
+ */
+type GetLabelFunction = (visit: Visit) => string;
+/**
+ * Context value interface
+ * @public
+ */
+interface VisitDisplayContextValue {
+    getChipColor: GetChipColorFunction;
+    getLabel: GetLabelFunction;
+}
+/**
+ * Props for the VisitDisplayProvider
+ * @public
+ */
+interface VisitDisplayProviderProps {
+    children: ReactNode;
+    getChipColor?: GetChipColorFunction;
+    getLabel?: GetLabelFunction;
+}
+/**
+ * Provider component for VisitDisplay customization
+ * @public
+ */
+declare const VisitDisplayProvider: ({ children, getChipColor, getLabel, }: VisitDisplayProviderProps) => react_jsx_runtime.JSX.Element;
+/**
+ * Hook to use the VisitDisplay context
+ * @public
+ */
+declare const useVisitDisplay: () => VisitDisplayContextValue;
+
 /** @public */
 declare const TemplateBackstageLogo: (props: {
     classes: {
@@ -528,4 +612,4 @@ declare const SettingsModal: (props: {
     children: JSX.Element;
 }) => react_jsx_runtime.JSX.Element;
 
-export { type Breakpoint, type CardConfig, type CardExtensionProps, type CardLayout, type CardSettings, type ClockConfig, ComponentAccordion, type ComponentParts, type ComponentRenderer, ComponentTab, ComponentTabs, CustomHomepageGrid, type CustomHomepageGridProps, FeaturedDocsCard, type FeaturedDocsCardProps, HeaderWorldClock, HomePageCompanyLogo, HomePageRandomJoke, HomePageRecentlyVisited, HomePageStarredEntities, HomePageToolkit, HomePageTopVisited, HomepageCompositionRoot, type LayoutConfiguration, type Operators, QuickStartCard, type QuickStartCardProps, type RendererProps, SettingsModal, type StarredEntitiesProps, TemplateBackstageLogo, TemplateBackstageLogoIcon, type Tool, type ToolkitContentProps, type Visit, VisitListener, type VisitedByTypeKind, type VisitedByTypeProps, type VisitsApi, type VisitsApiQueryParams, type VisitsApiSaveParams, VisitsStorageApi, type VisitsStorageApiOptions, VisitsWebStorageApi, type VisitsWebStorageApiOptions, WelcomeTitle, type WelcomeTitleLanguageProps, createCardExtension, homePlugin, isOperator, visitsApiRef };
+export { type Breakpoint, type CardConfig, type CardExtensionProps, type CardLayout, type CardSettings, type ClockConfig, ComponentAccordion, type ComponentParts, type ComponentRenderer, ComponentTab, ComponentTabs, CustomHomepageGrid, type CustomHomepageGridProps, FeaturedDocsCard, type FeaturedDocsCardProps, type GetChipColorFunction, type GetLabelFunction, HeaderWorldClock, HomePageCompanyLogo, HomePageRandomJoke, HomePageRecentlyVisited, HomePageStarredEntities, HomePageToolkit, HomePageTopVisited, HomepageCompositionRoot, type LayoutConfiguration, type Operators, QuickStartCard, type QuickStartCardProps, type RendererProps, SettingsModal, type StarredEntitiesProps, TemplateBackstageLogo, TemplateBackstageLogoIcon, type Tool, type ToolkitContentProps, type Visit, type VisitDisplayContextValue, VisitDisplayProvider, type VisitDisplayProviderProps, type VisitInput, VisitListener, type VisitedByTypeKind, type VisitedByTypeProps, type VisitsApi, type VisitsApiQueryParams, type VisitsApiSaveParams, VisitsStorageApi, type VisitsStorageApiOptions, VisitsWebStorageApi, type VisitsWebStorageApiOptions, WelcomeTitle, type WelcomeTitleLanguageProps, createCardExtension, homePlugin, isOperator, useVisitDisplay, visitsApiRef };

package/dist/index.esm.js

@@ -3,6 +3,7 @@ import 'react/jsx-runtime';
 import 'react-router-dom';
 export { CustomHomepageGrid } from './components/CustomHomepage/CustomHomepageGrid.esm.js';
 export { VisitListener } from './components/VisitListener.esm.js';
+export { VisitDisplayProvider, useVisitDisplay } from './components/VisitList/Context.esm.js';
 export { TemplateBackstageLogo } from './assets/TemplateBackstageLogo.esm.js';
 export { TemplateBackstageLogoIcon } from './assets/TemplateBackstageLogoIcon.esm.js';
 export { SettingsModal, createCardExtension } from './deprecated.esm.js';

package/dist/index.esm.js.map

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

package/dist/package.json.esm.js

@@ -1,5 +1,5 @@
 var name = "@backstage/plugin-home";
-var version = "0.8.14-next.0";
+var version = "0.8.14-next.1";
 var description = "A Backstage plugin that helps you build a home page";
 var backstage = {
 	role: "frontend-plugin",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-home",
-  "version": "0.8.14-next.0",
+  "version": "0.8.14-next.1",
   "description": "A Backstage plugin that helps you build a home page",
   "backstage": {
     "role": "frontend-plugin",
@@ -71,12 +71,12 @@
     "@backstage/catalog-client": "1.12.1-next.0",
     "@backstage/catalog-model": "1.7.6-next.0",
     "@backstage/config": "1.3.6-next.0",
-    "@backstage/core-app-api": "1.19.2-next.0",
+    "@backstage/core-app-api": "1.19.2-next.1",
     "@backstage/core-compat-api": "0.5.4-next.0",
-    "@backstage/core-components": "0.18.3-next.0",
-    "@backstage/core-plugin-api": "1.11.2-next.0",
-    "@backstage/frontend-plugin-api": "0.12.2-next.0",
-    "@backstage/plugin-catalog-react": "1.21.3-next.0",
+    "@backstage/core-components": "0.18.3-next.2",
+    "@backstage/core-plugin-api": "1.11.2-next.1",
+    "@backstage/frontend-plugin-api": "0.12.2-next.2",
+    "@backstage/plugin-catalog-react": "1.21.3-next.2",
     "@backstage/plugin-home-react": "0.1.32-next.0",
     "@backstage/theme": "0.7.0",
     "@material-ui/core": "^4.12.2",
@@ -94,8 +94,8 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.34.5-next.0",
-    "@backstage/dev-utils": "1.1.17-next.0",
+    "@backstage/cli": "0.34.5-next.1",
+    "@backstage/dev-utils": "1.1.17-next.1",
     "@backstage/test-utils": "1.7.13-next.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",