@backstage/plugin-home 0.8.8-next.0 → 0.8.8-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,41 @@
1
1
  # @backstage/plugin-home
2
2
 
3
+ ## 0.8.8-next.2
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/core-app-api@1.16.2-next.0
9
+ - @backstage/core-plugin-api@1.10.7-next.0
10
+ - @backstage/config@1.3.2
11
+ - @backstage/core-compat-api@0.4.2-next.2
12
+ - @backstage/core-components@0.17.2-next.1
13
+ - @backstage/frontend-plugin-api@0.10.2-next.1
14
+ - @backstage/plugin-catalog-react@1.18.0-next.2
15
+ - @backstage/plugin-home-react@0.1.26-next.1
16
+ - @backstage/catalog-client@1.10.0-next.0
17
+ - @backstage/catalog-model@1.7.3
18
+ - @backstage/theme@0.6.6-next.0
19
+
20
+ ## 0.8.8-next.1
21
+
22
+ ### Patch Changes
23
+
24
+ - fb58f20: Internal update to use the new `pluginId` option of `createFrontendPlugin`.
25
+ - 72d019d: Removed various typos
26
+ - Updated dependencies
27
+ - @backstage/theme@0.6.6-next.0
28
+ - @backstage/core-components@0.17.2-next.0
29
+ - @backstage/frontend-plugin-api@0.10.2-next.0
30
+ - @backstage/core-compat-api@0.4.2-next.1
31
+ - @backstage/plugin-catalog-react@1.18.0-next.1
32
+ - @backstage/plugin-home-react@0.1.26-next.0
33
+ - @backstage/catalog-client@1.10.0-next.0
34
+ - @backstage/catalog-model@1.7.3
35
+ - @backstage/config@1.3.2
36
+ - @backstage/core-app-api@1.16.1
37
+ - @backstage/core-plugin-api@1.10.6
38
+
3
39
  ## 0.8.8-next.0
4
40
 
5
41
  ### Patch Changes
package/README.md CHANGED
@@ -170,7 +170,7 @@ Available home page properties that are used for homepage widgets are:
170
170
  To define settings that the users can change for your component, you should define the `layout` and `settings`
171
171
  properties. The `settings.schema` object should follow
172
172
  [react-jsonschema-form](https://rjsf-team.github.io/react-jsonschema-form/docs/) definition and the type of the schema
173
- must be `object`. As well, the `uiSchema` can be defined if a certain UI style needs to be applied fo any of the defined
173
+ must be `object`. As well, the `uiSchema` can be defined if a certain UI style needs to be applied for any of the defined
174
174
  properties. More documentation [here](https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/uiSchema).
175
175
 
176
176
  If you want to hide the card title, you can do it by setting a `name` and leaving the `title` empty.
package/dist/alpha.esm.js CHANGED
@@ -38,7 +38,7 @@ const homePage = PageBlueprint.makeWithOverrides({
38
38
  }
39
39
  });
40
40
  var alpha = createFrontendPlugin({
41
- id: "home",
41
+ pluginId: "home",
42
42
  extensions: [homePage]
43
43
  });
44
44
 
@@ -1 +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} from '@backstage/frontend-plugin-api';\nimport { compatWrapper } from '@backstage/core-compat-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 defaultPath: '/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\n/**\n * @alpha\n */\nexport default createFrontendPlugin({\n id: 'home',\n extensions: [homePage],\n});\n"],"names":[],"mappings":";;;;AA0BA,MAAM,eAAe,cAAe,EAAA;AAKvB,MAAA,qBAAA,GAAwB,sBAA+B,EAAA,CAAE,IAAK,CAAA;AAAA,EACzE,EAAI,EAAA;AACN,CAAC;AAED,MAAM,QAAA,GAAW,cAAc,iBAAkB,CAAA;AAAA,EAC/C,MAAQ,EAAA;AAAA,IACN,KAAO,EAAA,oBAAA;AAAA,MACL;AAAA,QACE,iBAAA,CAAkB,aAAa,QAAS,EAAA;AAAA,QACxC,sBAAsB,QAAS;AAAA,OACjC;AAAA,MACA;AAAA,QACE,SAAW,EAAA,IAAA;AAAA,QACX,QAAU,EAAA;AAAA;AACZ;AACF,GACF;AAAA,EACA,OAAS,EAAA,CAAC,eAAiB,EAAA,EAAE,QAAa,KAAA;AACxC,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,WAAa,EAAA,OAAA;AAAA,MACb,QAAU,EAAA,YAAA;AAAA,MACV,MAAQ,EAAA,MACN,OAAO,2BAAe,CAAE,CAAA,IAAA;AAAA,QAAK,CAC3B,CAAA,KAAA,aAAA;AAAA,0BACE,GAAA;AAAA,YAAC,CAAE,CAAA,uBAAA;AAAA,YAAF;AAAA,cACC,QAAU,EAAA,MAAA,CAAO,KAAO,EAAA,GAAA,CAAI,kBAAkB,YAAY,CAAA;AAAA,cAC1D,KAAO,EAAA,MAAA,CAAO,KAAO,EAAA,GAAA,CAAI,qBAAqB;AAAA;AAAA;AAChD;AACF;AACF,KACH,CAAA;AAAA;AAEL,CAAC,CAAA;AAKD,YAAe,oBAAqB,CAAA;AAAA,EAClC,EAAI,EAAA,MAAA;AAAA,EACJ,UAAA,EAAY,CAAC,QAAQ;AACvB,CAAC,CAAA;;;;"}
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} from '@backstage/frontend-plugin-api';\nimport { compatWrapper } from '@backstage/core-compat-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 defaultPath: '/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\n/**\n * @alpha\n */\nexport default createFrontendPlugin({\n pluginId: 'home',\n extensions: [homePage],\n});\n"],"names":[],"mappings":";;;;AA0BA,MAAM,eAAe,cAAe,EAAA;AAKvB,MAAA,qBAAA,GAAwB,sBAA+B,EAAA,CAAE,IAAK,CAAA;AAAA,EACzE,EAAI,EAAA;AACN,CAAC;AAED,MAAM,QAAA,GAAW,cAAc,iBAAkB,CAAA;AAAA,EAC/C,MAAQ,EAAA;AAAA,IACN,KAAO,EAAA,oBAAA;AAAA,MACL;AAAA,QACE,iBAAA,CAAkB,aAAa,QAAS,EAAA;AAAA,QACxC,sBAAsB,QAAS;AAAA,OACjC;AAAA,MACA;AAAA,QACE,SAAW,EAAA,IAAA;AAAA,QACX,QAAU,EAAA;AAAA;AACZ;AACF,GACF;AAAA,EACA,OAAS,EAAA,CAAC,eAAiB,EAAA,EAAE,QAAa,KAAA;AACxC,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,WAAa,EAAA,OAAA;AAAA,MACb,QAAU,EAAA,YAAA;AAAA,MACV,MAAQ,EAAA,MACN,OAAO,2BAAe,CAAE,CAAA,IAAA;AAAA,QAAK,CAC3B,CAAA,KAAA,aAAA;AAAA,0BACE,GAAA;AAAA,YAAC,CAAE,CAAA,uBAAA;AAAA,YAAF;AAAA,cACC,QAAU,EAAA,MAAA,CAAO,KAAO,EAAA,GAAA,CAAI,kBAAkB,YAAY,CAAA;AAAA,cAC1D,KAAO,EAAA,MAAA,CAAO,KAAO,EAAA,GAAA,CAAI,qBAAqB;AAAA;AAAA;AAChD;AACF;AACF,KACH,CAAA;AAAA;AAEL,CAAC,CAAA;AAKD,YAAe,oBAAqB,CAAA;AAAA,EAClC,QAAU,EAAA,MAAA;AAAA,EACV,UAAA,EAAY,CAAC,QAAQ;AACvB,CAAC,CAAA;;;;"}
@@ -1 +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 storaged 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,kBAAqB,GAAA,CAAA;AAQpB,MAAM,gBAAsC,CAAA;AAAA,EAChC,KAAA;AAAA,EACA,UAAA;AAAA,EACA,gBAAmB,GAAA,+BAAA;AAAA,EACnB,WAAA;AAAA,EAEjB,OAAO,OAAO,OAAkC,EAAA;AAC9C,IAAO,OAAA,IAAI,iBAAiB,OAAO,CAAA;AAAA;AACrC,EAEQ,YAAY,OAAkC,EAAA;AACpD,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAA,CAAK,GAAI,CAAA,OAAA,CAAQ,SAAS,GAAG,CAAA;AAC1C,IAAA,IAAA,CAAK,aAAa,OAAQ,CAAA,UAAA;AAC1B,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA;AAAA;AAC7B;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,WAAsD,EAAA;AAC/D,IAAA,IAAI,SAAS,CAAC,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAG3C,IAAA,CAAC,aAAa,OAAW,IAAA,IAAI,OAAQ,EAAA,CAAE,QAAQ,CAAS,KAAA,KAAA;AACtD,MAAI,IAAA,KAAA,CAAM,cAAc,KAAO,EAAA;AAC7B,QAAO,MAAA,CAAA,IAAA,CAAK,CAAC,CAAG,EAAA,CAAA,KAAM,KAAK,OAAQ,CAAA,KAAA,EAAO,CAAG,EAAA,CAAC,CAAC,CAAA;AAAA,OAC1C,MAAA;AACL,QAAO,MAAA,CAAA,IAAA,CAAK,CAAC,CAAG,EAAA,CAAA,KAAM,KAAK,OAAQ,CAAA,KAAA,EAAO,CAAG,EAAA,CAAC,CAAC,CAAA;AAAA;AACjD,KACD,CAAA;AAGD,IAAA,CAAC,aAAa,QAAY,IAAA,IAAI,OAAQ,EAAA,CAAE,QAAQ,CAAU,MAAA,KAAA;AACxD,MAAS,MAAA,GAAA,MAAA,CAAO,OAAO,CAAS,KAAA,KAAA;AAC9B,QAAM,MAAA,KAAA,GAAQ,KAAM,CAAA,MAAA,CAAO,KAAK,CAAA;AAChC,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,GAAK,EAAA,OAAO,QAAQ,MAAO,CAAA,KAAA;AACnD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,IAAM,EAAA,OAAO,SAAS,MAAO,CAAA,KAAA;AACrD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,GAAK,EAAA,OAAO,QAAQ,MAAO,CAAA,KAAA;AACnD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,IAAM,EAAA,OAAO,SAAS,MAAO,CAAA,KAAA;AACrD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,IAAM,EAAA,OAAO,UAAU,MAAO,CAAA,KAAA;AACtD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,IAAM,EAAA,OAAO,UAAU,MAAO,CAAA,KAAA;AACtD,QAAA,IAAI,OAAO,QAAa,KAAA,UAAA;AACtB,UAAA,OAAO,GAAG,KAAK,CAAA,CAAA,CAAG,SAAS,CAAG,EAAA,MAAA,CAAO,KAAK,CAAE,CAAA,CAAA;AAC9C,QAAO,OAAA,KAAA;AAAA,OACR,CAAA;AAAA,KACF,CAAA;AAED,IAAA,OAAO,MAAO,CAAA,KAAA,CAAM,CAAG,EAAA,WAAA,EAAa,SAAS,kBAAkB,CAAA;AAAA;AACjE;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,UAAiD,EAAA;AAC1D,IAAA,MAAM,SAAkB,CAAC,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAEtD,IAAA,MAAM,KAAe,GAAA;AAAA,MACnB,GAAG,UAAW,CAAA,KAAA;AAAA,MACd,EAAA,EAAI,MAAO,CAAA,MAAA,CAAO,UAAW,EAAA;AAAA,MAC7B,IAAM,EAAA,CAAA;AAAA,MACN,SAAA,EAAW,KAAK,GAAI;AAAA,KACtB;AAGA,IAAA,MAAM,aAAa,MAAO,CAAA,SAAA,CAAU,OAAK,CAAE,CAAA,QAAA,KAAa,MAAM,QAAQ,CAAA;AACtE,IAAA,IAAI,cAAc,CAAG,EAAA;AACnB,MAAM,KAAA,CAAA,EAAA,GAAK,MAAO,CAAA,UAAU,CAAE,CAAA,EAAA;AAC9B,MAAA,KAAA,CAAM,IAAO,GAAA,MAAA,CAAO,UAAU,CAAA,CAAE,IAAO,GAAA,CAAA;AACvC,MAAA,MAAA,CAAO,UAAU,CAAI,GAAA,KAAA;AAAA,KAChB,MAAA;AACL,MAAA,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA;AAInB,IAAA,MAAA,CAAO,KAAK,CAAC,CAAA,EAAG,MAAM,CAAE,CAAA,SAAA,GAAY,EAAE,SAAS,CAAA;AAE/C,IAAA,MAAM,KAAK,UAAW,CAAA,MAAA,CAAO,OAAO,CAAG,EAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAClD,IAAO,OAAA,KAAA;AAAA;AACT,EAEA,MAAc,WAAW,MAAsB,EAAA;AAC7C,IAAM,MAAA,UAAA,GAAa,MAAM,IAAA,CAAK,aAAc,EAAA;AAC5C,IAAA,OAAO,IAAK,CAAA,UAAA,CAAW,GAAkB,CAAA,UAAA,EAAY,MAAM,CAAA;AAAA;AAC7D,EAEA,MAAc,WAAqC,GAAA;AACjD,IAAM,MAAA,UAAA,GAAa,MAAM,IAAA,CAAK,aAAc,EAAA;AAE5C,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,UAAW,CAAA,QAAA,CAAuB,UAAU,CAAA;AAClE,IAAI,IAAA,QAAA,EAAU,aAAa,SAAW,EAAA;AACpC,MAAO,OAAA,QAAA,EAAU,SAAS,EAAC;AAAA;AAG7B,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AACtC,MAAA,MAAM,eAAe,IAAK,CAAA,UAAA,CACvB,QAAkB,CAAA,UAAU,EAC5B,SAAU,CAAA;AAAA,QACT,MAAM,CAAQ,IAAA,KAAA;AACZ,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,KAAA,IAAS,EAAC;AAC9B,UAAA,YAAA,CAAa,WAAY,EAAA;AACzB,UAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,SAChB;AAAA,QACA,OAAO,CAAO,GAAA,KAAA;AACZ,UAAA,YAAA,CAAa,WAAY,EAAA;AACzB,UAAA,MAAA,CAAO,GAAG,CAAA;AAAA;AACZ,OACD,CAAA;AAAA,KACJ,CAAA;AAAA;AACH,EAEA,MAAc,aAAiC,GAAA;AAC7C,IAAA,MAAM,EAAE,aAAc,EAAA,GAAI,MAAM,IAAA,CAAK,YAAY,oBAAqB,EAAA;AACtE,IAAA,MAAM,UAAa,GAAA,CAAA,EAAG,IAAK,CAAA,gBAAgB,IAAI,aAAa,CAAA,CAAA;AAC5D,IAAO,OAAA,UAAA;AAAA;AACT;AAAA,EAGQ,OAAA,CACN,KACA,EAAA,CAAA,EACA,CACQ,EAAA;AACR,IAAA,MAAM,QAAW,GAAA,OAAO,CAAE,CAAA,KAAA,CAAM,KAAK,CAAM,KAAA,QAAA;AAC3C,IAAO,OAAA,QAAA,GACF,EAAE,KAAM,CAAA,KAAK,IAAgB,CAAE,CAAA,KAAA,CAAM,KAAK,CAC3C,GAAA,CAAA,EAAG,EAAE,KAAM,CAAA,KAAK,CAAC,CAAG,CAAA,CAAA,aAAA,CAAc,GAAG,CAAE,CAAA,KAAA,CAAM,KAAK,CAAC,CAAE,CAAA,CAAA;AAAA;AAE7D;;;;"}
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,kBAAqB,GAAA,CAAA;AAQpB,MAAM,gBAAsC,CAAA;AAAA,EAChC,KAAA;AAAA,EACA,UAAA;AAAA,EACA,gBAAmB,GAAA,+BAAA;AAAA,EACnB,WAAA;AAAA,EAEjB,OAAO,OAAO,OAAkC,EAAA;AAC9C,IAAO,OAAA,IAAI,iBAAiB,OAAO,CAAA;AAAA;AACrC,EAEQ,YAAY,OAAkC,EAAA;AACpD,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAA,CAAK,GAAI,CAAA,OAAA,CAAQ,SAAS,GAAG,CAAA;AAC1C,IAAA,IAAA,CAAK,aAAa,OAAQ,CAAA,UAAA;AAC1B,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA;AAAA;AAC7B;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,WAAsD,EAAA;AAC/D,IAAA,IAAI,SAAS,CAAC,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAG3C,IAAA,CAAC,aAAa,OAAW,IAAA,IAAI,OAAQ,EAAA,CAAE,QAAQ,CAAS,KAAA,KAAA;AACtD,MAAI,IAAA,KAAA,CAAM,cAAc,KAAO,EAAA;AAC7B,QAAO,MAAA,CAAA,IAAA,CAAK,CAAC,CAAG,EAAA,CAAA,KAAM,KAAK,OAAQ,CAAA,KAAA,EAAO,CAAG,EAAA,CAAC,CAAC,CAAA;AAAA,OAC1C,MAAA;AACL,QAAO,MAAA,CAAA,IAAA,CAAK,CAAC,CAAG,EAAA,CAAA,KAAM,KAAK,OAAQ,CAAA,KAAA,EAAO,CAAG,EAAA,CAAC,CAAC,CAAA;AAAA;AACjD,KACD,CAAA;AAGD,IAAA,CAAC,aAAa,QAAY,IAAA,IAAI,OAAQ,EAAA,CAAE,QAAQ,CAAU,MAAA,KAAA;AACxD,MAAS,MAAA,GAAA,MAAA,CAAO,OAAO,CAAS,KAAA,KAAA;AAC9B,QAAM,MAAA,KAAA,GAAQ,KAAM,CAAA,MAAA,CAAO,KAAK,CAAA;AAChC,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,GAAK,EAAA,OAAO,QAAQ,MAAO,CAAA,KAAA;AACnD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,IAAM,EAAA,OAAO,SAAS,MAAO,CAAA,KAAA;AACrD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,GAAK,EAAA,OAAO,QAAQ,MAAO,CAAA,KAAA;AACnD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,IAAM,EAAA,OAAO,SAAS,MAAO,CAAA,KAAA;AACrD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,IAAM,EAAA,OAAO,UAAU,MAAO,CAAA,KAAA;AACtD,QAAA,IAAI,MAAO,CAAA,QAAA,KAAa,IAAM,EAAA,OAAO,UAAU,MAAO,CAAA,KAAA;AACtD,QAAA,IAAI,OAAO,QAAa,KAAA,UAAA;AACtB,UAAA,OAAO,GAAG,KAAK,CAAA,CAAA,CAAG,SAAS,CAAG,EAAA,MAAA,CAAO,KAAK,CAAE,CAAA,CAAA;AAC9C,QAAO,OAAA,KAAA;AAAA,OACR,CAAA;AAAA,KACF,CAAA;AAED,IAAA,OAAO,MAAO,CAAA,KAAA,CAAM,CAAG,EAAA,WAAA,EAAa,SAAS,kBAAkB,CAAA;AAAA;AACjE;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,UAAiD,EAAA;AAC1D,IAAA,MAAM,SAAkB,CAAC,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAEtD,IAAA,MAAM,KAAe,GAAA;AAAA,MACnB,GAAG,UAAW,CAAA,KAAA;AAAA,MACd,EAAA,EAAI,MAAO,CAAA,MAAA,CAAO,UAAW,EAAA;AAAA,MAC7B,IAAM,EAAA,CAAA;AAAA,MACN,SAAA,EAAW,KAAK,GAAI;AAAA,KACtB;AAGA,IAAA,MAAM,aAAa,MAAO,CAAA,SAAA,CAAU,OAAK,CAAE,CAAA,QAAA,KAAa,MAAM,QAAQ,CAAA;AACtE,IAAA,IAAI,cAAc,CAAG,EAAA;AACnB,MAAM,KAAA,CAAA,EAAA,GAAK,MAAO,CAAA,UAAU,CAAE,CAAA,EAAA;AAC9B,MAAA,KAAA,CAAM,IAAO,GAAA,MAAA,CAAO,UAAU,CAAA,CAAE,IAAO,GAAA,CAAA;AACvC,MAAA,MAAA,CAAO,UAAU,CAAI,GAAA,KAAA;AAAA,KAChB,MAAA;AACL,MAAA,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA;AAInB,IAAA,MAAA,CAAO,KAAK,CAAC,CAAA,EAAG,MAAM,CAAE,CAAA,SAAA,GAAY,EAAE,SAAS,CAAA;AAE/C,IAAA,MAAM,KAAK,UAAW,CAAA,MAAA,CAAO,OAAO,CAAG,EAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAClD,IAAO,OAAA,KAAA;AAAA;AACT,EAEA,MAAc,WAAW,MAAsB,EAAA;AAC7C,IAAM,MAAA,UAAA,GAAa,MAAM,IAAA,CAAK,aAAc,EAAA;AAC5C,IAAA,OAAO,IAAK,CAAA,UAAA,CAAW,GAAkB,CAAA,UAAA,EAAY,MAAM,CAAA;AAAA;AAC7D,EAEA,MAAc,WAAqC,GAAA;AACjD,IAAM,MAAA,UAAA,GAAa,MAAM,IAAA,CAAK,aAAc,EAAA;AAE5C,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,UAAW,CAAA,QAAA,CAAuB,UAAU,CAAA;AAClE,IAAI,IAAA,QAAA,EAAU,aAAa,SAAW,EAAA;AACpC,MAAO,OAAA,QAAA,EAAU,SAAS,EAAC;AAAA;AAG7B,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AACtC,MAAA,MAAM,eAAe,IAAK,CAAA,UAAA,CACvB,QAAkB,CAAA,UAAU,EAC5B,SAAU,CAAA;AAAA,QACT,MAAM,CAAQ,IAAA,KAAA;AACZ,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,KAAA,IAAS,EAAC;AAC9B,UAAA,YAAA,CAAa,WAAY,EAAA;AACzB,UAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,SAChB;AAAA,QACA,OAAO,CAAO,GAAA,KAAA;AACZ,UAAA,YAAA,CAAa,WAAY,EAAA;AACzB,UAAA,MAAA,CAAO,GAAG,CAAA;AAAA;AACZ,OACD,CAAA;AAAA,KACJ,CAAA;AAAA;AACH,EAEA,MAAc,aAAiC,GAAA;AAC7C,IAAA,MAAM,EAAE,aAAc,EAAA,GAAI,MAAM,IAAA,CAAK,YAAY,oBAAqB,EAAA;AACtE,IAAA,MAAM,UAAa,GAAA,CAAA,EAAG,IAAK,CAAA,gBAAgB,IAAI,aAAa,CAAA,CAAA;AAC5D,IAAO,OAAA,UAAA;AAAA;AACT;AAAA,EAGQ,OAAA,CACN,KACA,EAAA,CAAA,EACA,CACQ,EAAA;AACR,IAAA,MAAM,QAAW,GAAA,OAAO,CAAE,CAAA,KAAA,CAAM,KAAK,CAAM,KAAA,QAAA;AAC3C,IAAO,OAAA,QAAA,GACF,EAAE,KAAM,CAAA,KAAK,IAAgB,CAAE,CAAA,KAAA,CAAM,KAAK,CAC3C,GAAA,CAAA,EAAG,EAAE,KAAM,CAAA,KAAK,CAAC,CAAG,CAAA,CAAA,aAAA,CAAc,GAAG,CAAE,CAAA,KAAA,CAAM,KAAK,CAAC,CAAE,CAAA,CAAA;AAAA;AAE7D;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-home",
3
- "version": "0.8.8-next.0",
3
+ "version": "0.8.8-next.2",
4
4
  "description": "A Backstage plugin that helps you build a home page",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -71,14 +71,14 @@
71
71
  "@backstage/catalog-client": "1.10.0-next.0",
72
72
  "@backstage/catalog-model": "1.7.3",
73
73
  "@backstage/config": "1.3.2",
74
- "@backstage/core-app-api": "1.16.1",
75
- "@backstage/core-compat-api": "0.4.2-next.0",
76
- "@backstage/core-components": "0.17.1",
77
- "@backstage/core-plugin-api": "1.10.6",
78
- "@backstage/frontend-plugin-api": "0.10.1",
79
- "@backstage/plugin-catalog-react": "1.18.0-next.0",
80
- "@backstage/plugin-home-react": "0.1.25",
81
- "@backstage/theme": "0.6.5",
74
+ "@backstage/core-app-api": "1.16.2-next.0",
75
+ "@backstage/core-compat-api": "0.4.2-next.2",
76
+ "@backstage/core-components": "0.17.2-next.1",
77
+ "@backstage/core-plugin-api": "1.10.7-next.0",
78
+ "@backstage/frontend-plugin-api": "0.10.2-next.1",
79
+ "@backstage/plugin-catalog-react": "1.18.0-next.2",
80
+ "@backstage/plugin-home-react": "0.1.26-next.1",
81
+ "@backstage/theme": "0.6.6-next.0",
82
82
  "@material-ui/core": "^4.12.2",
83
83
  "@material-ui/icons": "^4.9.1",
84
84
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -94,9 +94,9 @@
94
94
  "zod": "^3.22.4"
95
95
  },
96
96
  "devDependencies": {
97
- "@backstage/cli": "0.32.1-next.0",
98
- "@backstage/dev-utils": "1.1.10-next.0",
99
- "@backstage/test-utils": "1.7.7",
97
+ "@backstage/cli": "0.32.1-next.2",
98
+ "@backstage/dev-utils": "1.1.10-next.2",
99
+ "@backstage/test-utils": "1.7.8-next.1",
100
100
  "@testing-library/dom": "^10.0.0",
101
101
  "@testing-library/jest-dom": "^6.0.0",
102
102
  "@testing-library/react": "^16.0.0",