@backstage-community/plugin-announcements 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# @backstage-community/plugin-announcements
+
+## 0.1.1
+
+### Patch Changes
+
+- 48094fc: Bump all dependencies to be in line with Backstage v1.34.2. This is the first versioned release of the announcement plugins under the `@backstage-community` scope.
+- Updated dependencies [48094fc]
+  - @backstage-community/plugin-announcements-common@0.1.1
+  - @backstage-community/plugin-announcements-react@0.1.1

package/README.md

@@ -0,0 +1,142 @@
+# announcements
+
+The frontend for the Announcements plugin. This plugin provides:
+
+- a component to display the latest announcements, for example on a homepage
+- pages to list, view, create, edit and delete announcements
+
+## Installation
+
+Add the plugin to your frontend app
+
+```bash
+yarn --cwd packages/app add @backstage-community/plugin-announcements
+```
+
+Expose the announcements page:
+
+```tsx
+// packages/app/src/App.tsx
+import { AnnouncementsPage } from '@backstage-community/plugin-announcements';
+
+// ...
+
+const AppRoutes = () => (
+  <FlatRoutes>
+    // ...
+    <Route path="/announcements" element={<AnnouncementsPage />} />
+    // ...
+  </FlatRoutes>
+);
+```
+
+An interface to create/update/edit/delete announcements is now available at `/announcements`.
+
+## New Frontend System Setup (Alpha)
+
+Add the plugin to your frontend app:
+
+```bash
+yarn --cwd packages/app add @backstage-community/plugin-announcements
+```
+
+Add the plugin to `packages/app/src/App.tsx`:
+
+```tsx
+import announcementsPlugin from '@backstage-community/plugin-announcements/alpha';
+
+// ...
+
+const app = createApp({
+  // ...
+  features: [
+    // ...
+    announcementsPlugin,
+    // ...
+  ],
+  // ...
+});
+```
+
+Add the extensions in `app-config.yaml`:
+
+```yaml
+app:
+  extensions:
+    - entity-card:announcements/announcements
+    - nav-item:announcements
+```
+
+The entity card will only appear on components & systems by default, but you can override that
+behavior by passing a filter into the card extension like so:
+
+```yaml
+app:
+  extensions:
+    - entity-card:announcements/announcements:
+        config:
+          filter: kind:component,system,group,api
+```
+
+## Components
+
+- [Display latest announcements on a page](./docs/latest-announcements-on-page.md)
+- [Display a banner for the latest announcement](./docs/latest-announcement-banner.md)
+- [Display announcements in a timeline](./docs/announcement-timeline.md)
+
+## Customization
+
+### Overriding the AnnouncementCard
+
+It is possible to specify the length of the title for announcements rendered on the `AnnouncementsPage`. You can do this by passing a `cardOptions` prop to the `AnnouncementsPage` component. The `cardOptions` prop accepts an object with the following properties:
+
+```ts
+{
+  titleLength: number; // defaults to 50
+}
+```
+
+Example
+
+```tsx
+<AnnouncementsPage cardOptions={{ titleLength: 10 }} />
+```
+
+### Overriding the AnnouncementsPage
+
+It is possible to specify the Announcements within a specific category rendered on the `AnnouncementsPage`. You can do this by passing a `category` prop to the `AnnouncementsPage` component. The `AnnouncementsPage` prop accepts an value such as:
+
+```ts
+category = 'conferences';
+```
+
+Example
+
+```tsx
+<AnnouncementsPage category="conferences" />
+```
+
+### Overriding the AnnouncementCreateButton
+
+It is possible to specify the text for the "New announcement" button rendered on the `AnnouncementsPage`. You can do this by passing a `buttonOptions` prop to the `AnnouncementsPage` component. The `buttonOptions` prop accepts an object with the following properties:
+
+```ts
+{
+  name: string; // defaults to 'announcement'
+}
+```
+
+## Development
+
+### Getting started
+
+Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/announcements](http://localhost:3000/announcements).
+
+You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
+This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
+It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
+
+## Previously maintained by
+
+- [procore-oss](https://github.com/procore-oss/backstage-plugin-announcements/tree/main/plugins/announcements)
+- [k-phoen](https://github.com/K-Phoen/backstage-plugin-announcements/tree/main/plugins/announcements)

package/dist/alpha/apis.esm.js

@@ -0,0 +1,26 @@
+import { ApiBlueprint, createApiFactory, discoveryApiRef, identityApiRef, fetchApiRef, errorApiRef } from '@backstage/frontend-plugin-api';
+import { announcementsApiRef } from '@backstage-community/plugin-announcements-react';
+import { AnnouncementsClient } from '../api.esm.js';
+
+const announcementsApiExtension = ApiBlueprint.make({
+  params: {
+    factory: createApiFactory({
+      api: announcementsApiRef,
+      deps: {
+        discoveryApi: discoveryApiRef,
+        identityApi: identityApiRef,
+        fetchApi: fetchApiRef,
+        errorApi: errorApiRef
+      },
+      factory: ({ discoveryApi, identityApi, fetchApi, errorApi }) => new AnnouncementsClient({
+        discoveryApi,
+        identityApi,
+        fetchApi,
+        errorApi
+      })
+    })
+  }
+});
+
+export { announcementsApiExtension };
+//# sourceMappingURL=apis.esm.js.map

package/dist/alpha/apis.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apis.esm.js","sources":["../../src/alpha/apis.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  ApiBlueprint,\n  createApiFactory,\n  discoveryApiRef,\n  errorApiRef,\n  fetchApiRef,\n  identityApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { announcementsApiRef } from '@backstage-community/plugin-announcements-react';\nimport { AnnouncementsClient } from '../api';\n\n/**\n * @alpha\n */\nexport const announcementsApiExtension = ApiBlueprint.make({\n  params: {\n    factory: createApiFactory({\n      api: announcementsApiRef,\n      deps: {\n        discoveryApi: discoveryApiRef,\n        identityApi: identityApiRef,\n        fetchApi: fetchApiRef,\n        errorApi: errorApiRef,\n      },\n      factory: ({ discoveryApi, identityApi, fetchApi, errorApi }) =>\n        new AnnouncementsClient({\n          discoveryApi,\n          identityApi,\n          fetchApi,\n          errorApi,\n        }),\n    }),\n  },\n});\n"],"names":[],"mappings":";;;;AA6Ba,MAAA,yBAAA,GAA4B,aAAa,IAAK,CAAA;AAAA,EACzD,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,mBAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,YAAc,EAAA,eAAA;AAAA,QACd,WAAa,EAAA,cAAA;AAAA,QACb,QAAU,EAAA,WAAA;AAAA,QACV,QAAU,EAAA;AAAA,OACZ;AAAA,MACA,OAAA,EAAS,CAAC,EAAE,YAAA,EAAc,aAAa,QAAU,EAAA,QAAA,EAC/C,KAAA,IAAI,mBAAoB,CAAA;AAAA,QACtB,YAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA;AAAA,OACD;AAAA,KACJ;AAAA;AAEL,CAAC;;;;"}

package/dist/alpha/entityCards.esm.js

@@ -0,0 +1,16 @@
+import React__default from 'react';
+import { EntityCardBlueprint } from '@backstage/plugin-catalog-react/alpha';
+
+const entityAnnouncementsCard = EntityCardBlueprint.make({
+  name: "announcements",
+  params: {
+    filter: "kind:component,system",
+    loader: async () => {
+      const { AnnouncementsCard } = await import('../components/AnnouncementsCard/index.esm.js');
+      return /* @__PURE__ */ React__default.createElement(AnnouncementsCard, null);
+    }
+  }
+});
+
+export { entityAnnouncementsCard };
+//# sourceMappingURL=entityCards.esm.js.map

package/dist/alpha/entityCards.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityCards.esm.js","sources":["../../src/alpha/entityCards.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport React from 'react';\nimport { EntityCardBlueprint } from '@backstage/plugin-catalog-react/alpha';\n\n/**\n * @alpha\n */\nexport const entityAnnouncementsCard = EntityCardBlueprint.make({\n  name: 'announcements',\n  params: {\n    filter: 'kind:component,system',\n    loader: async () => {\n      const { AnnouncementsCard } = await import(\n        '../components/AnnouncementsCard'\n      );\n\n      return <AnnouncementsCard />;\n    },\n  },\n});\n"],"names":[],"mappings":";;;AAqBa,MAAA,uBAAA,GAA0B,oBAAoB,IAAK,CAAA;AAAA,EAC9D,IAAM,EAAA,eAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA,uBAAA;AAAA,IACR,QAAQ,YAAY;AAClB,MAAA,MAAM,EAAE,iBAAA,EAAsB,GAAA,MAAM,OAClC,8CACF,CAAA;AAEA,MAAA,oDAAQ,iBAAkB,EAAA,IAAA,CAAA;AAAA;AAC5B;AAEJ,CAAC;;;;"}

package/dist/alpha/navItems.esm.js

@@ -0,0 +1,15 @@
+import { NavItemBlueprint } from '@backstage/frontend-plugin-api/';
+import { convertLegacyRouteRef } from '@backstage/core-compat-api';
+import { rootRouteRef } from '../routes.esm.js';
+import NotificationsIcon from '@material-ui/icons/Notifications';
+
+const announcementsNavItem = NavItemBlueprint.make({
+  params: {
+    title: "Announcements",
+    routeRef: convertLegacyRouteRef(rootRouteRef),
+    icon: NotificationsIcon
+  }
+});
+
+export { announcementsNavItem };
+//# sourceMappingURL=navItems.esm.js.map

package/dist/alpha/navItems.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navItems.esm.js","sources":["../../src/alpha/navItems.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { NavItemBlueprint } from '@backstage/frontend-plugin-api/';\nimport { convertLegacyRouteRef } from '@backstage/core-compat-api';\nimport { rootRouteRef } from '../routes';\nimport NotificationsIcon from '@material-ui/icons/Notifications';\n\n/**\n * @alpha\n */\nexport const announcementsNavItem = NavItemBlueprint.make({\n  params: {\n    title: 'Announcements',\n    routeRef: convertLegacyRouteRef(rootRouteRef),\n    icon: NotificationsIcon,\n  },\n});\n\nexport default [announcementsNavItem];\n"],"names":[],"mappings":";;;;;AAuBa,MAAA,oBAAA,GAAuB,iBAAiB,IAAK,CAAA;AAAA,EACxD,MAAQ,EAAA;AAAA,IACN,KAAO,EAAA,eAAA;AAAA,IACP,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,IAAM,EAAA;AAAA;AAEV,CAAC;;;;"}

package/dist/alpha/pages.esm.js

@@ -0,0 +1,18 @@
+import React__default from 'react';
+import { convertLegacyRouteRef } from '@backstage/core-compat-api';
+import { PageBlueprint } from '@backstage/frontend-plugin-api';
+import { rootRouteRef } from '../routes.esm.js';
+
+const announcementsPage = PageBlueprint.make({
+  params: {
+    defaultPath: "/announcements",
+    routeRef: convertLegacyRouteRef(rootRouteRef),
+    loader: async () => {
+      const { Router } = await import('../components/Router.esm.js');
+      return /* @__PURE__ */ React__default.createElement(Router, null);
+    }
+  }
+});
+
+export { announcementsPage };
+//# sourceMappingURL=pages.esm.js.map

package/dist/alpha/pages.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pages.esm.js","sources":["../../src/alpha/pages.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport React from 'react';\nimport { convertLegacyRouteRef } from '@backstage/core-compat-api';\nimport { PageBlueprint } from '@backstage/frontend-plugin-api';\nimport { rootRouteRef } from '../routes';\n\n/**\n * @alpha\n */\nexport const announcementsPage = PageBlueprint.make({\n  params: {\n    defaultPath: '/announcements',\n    routeRef: convertLegacyRouteRef(rootRouteRef),\n    loader: async () => {\n      const { Router } = await import('../components/Router');\n      return <Router />;\n    },\n  },\n});\n"],"names":[],"mappings":";;;;;AAuBa,MAAA,iBAAA,GAAoB,cAAc,IAAK,CAAA;AAAA,EAClD,MAAQ,EAAA;AAAA,IACN,WAAa,EAAA,gBAAA;AAAA,IACb,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,QAAQ,YAAY;AAClB,MAAA,MAAM,EAAE,MAAA,EAAW,GAAA,MAAM,OAAO,6BAAsB,CAAA;AACtD,MAAA,oDAAQ,MAAO,EAAA,IAAA,CAAA;AAAA;AACjB;AAEJ,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,11 @@
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import { FrontendPlugin } from '@backstage/frontend-plugin-api';
+
+/**
+ * @alpha
+ */
+declare const _default: FrontendPlugin<_backstage_frontend_plugin_api.AnyRoutes, _backstage_frontend_plugin_api.AnyExternalRoutes, {
+    [x: string]: _backstage_frontend_plugin_api.ExtensionDefinition<_backstage_frontend_plugin_api.ExtensionDefinitionParameters>;
+}>;
+
+export { _default as default };

package/dist/alpha.esm.js

@@ -0,0 +1,23 @@
+import { convertLegacyRouteRefs } from '@backstage/core-compat-api';
+import { createFrontendPlugin } from '@backstage/frontend-plugin-api';
+import { announcementsApiExtension } from './alpha/apis.esm.js';
+import { entityAnnouncementsCard } from './alpha/entityCards.esm.js';
+import { announcementsNavItem } from './alpha/navItems.esm.js';
+import { announcementsPage } from './alpha/pages.esm.js';
+import { rootRouteRef } from './routes.esm.js';
+
+var alpha = createFrontendPlugin({
+  id: "announcements",
+  routes: convertLegacyRouteRefs({
+    root: rootRouteRef
+  }),
+  extensions: [
+    announcementsApiExtension,
+    entityAnnouncementsCard,
+    announcementsPage,
+    announcementsNavItem
+  ]
+});
+
+export { alpha as default };
+//# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { convertLegacyRouteRefs } from '@backstage/core-compat-api';\nimport {\n  createFrontendPlugin,\n  FrontendPlugin,\n} from '@backstage/frontend-plugin-api';\nimport { announcementsApiExtension } from './alpha/apis';\nimport { entityAnnouncementsCard } from './alpha/entityCards';\nimport { announcementsNavItem } from './alpha/navItems';\nimport { announcementsPage } from './alpha/pages';\nimport { rootRouteRef } from './routes';\n\n/**\n * @alpha\n */\nexport default createFrontendPlugin({\n  id: 'announcements',\n  routes: convertLegacyRouteRefs({\n    root: rootRouteRef,\n  }),\n  extensions: [\n    announcementsApiExtension,\n    entityAnnouncementsCard,\n    announcementsPage,\n    announcementsNavItem,\n  ],\n}) as FrontendPlugin;\n"],"names":[],"mappings":";;;;;;;;AA6BA,YAAe,oBAAqB,CAAA;AAAA,EAClC,EAAI,EAAA,eAAA;AAAA,EACJ,QAAQ,sBAAuB,CAAA;AAAA,IAC7B,IAAM,EAAA;AAAA,GACP,CAAA;AAAA,EACD,UAAY,EAAA;AAAA,IACV,yBAAA;AAAA,IACA,uBAAA;AAAA,IACA,iBAAA;AAAA,IACA;AAAA;AAEJ,CAAC,CAAA;;;;"}

package/dist/api.esm.js

@@ -0,0 +1,117 @@
+import { DateTime } from 'luxon';
+import { WebStorage } from '@backstage/core-app-api';
+import { ResponseError } from '@backstage/errors';
+
+const lastSeenKey = "user_last_seen_date";
+class AnnouncementsClient {
+  discoveryApi;
+  identityApi;
+  webStorage;
+  fetchApi;
+  constructor(opts) {
+    this.discoveryApi = opts.discoveryApi;
+    this.identityApi = opts.identityApi;
+    this.webStorage = new WebStorage("announcements", opts.errorApi);
+    this.fetchApi = opts.fetchApi;
+  }
+  async fetch(input, init) {
+    const baseApiUrl = await this.discoveryApi.getBaseUrl("announcements");
+    const { token } = await this.identityApi.getCredentials();
+    const headers = new Headers(init?.headers);
+    if (token && !headers.has("authorization")) {
+      headers.set("authorization", `Bearer ${token}`);
+    }
+    return this.fetchApi.fetch(`${baseApiUrl}${input}`, {
+      ...init,
+      headers
+    }).then(async (response) => {
+      if (!response.ok) {
+        throw await ResponseError.fromResponse(response);
+      }
+      return response.json();
+    });
+  }
+  async delete(input, init) {
+    const baseApiUrl = await this.discoveryApi.getBaseUrl("announcements");
+    const { token } = await this.identityApi.getCredentials();
+    const headers = new Headers(init?.headers);
+    if (token && !headers.has("authorization")) {
+      headers.set("authorization", `Bearer ${token}`);
+    }
+    return this.fetchApi.fetch(`${baseApiUrl}${input}`, {
+      ...{ method: "DELETE" },
+      headers
+    }).then(async (response) => {
+      if (!response.ok) {
+        throw await ResponseError.fromResponse(response);
+      }
+    });
+  }
+  async announcements({
+    max,
+    page,
+    category,
+    active
+  }) {
+    const params = new URLSearchParams();
+    if (category) {
+      params.append("category", category);
+    }
+    if (max) {
+      params.append("max", max.toString());
+    }
+    if (page) {
+      params.append("page", page.toString());
+    }
+    if (active) {
+      params.append("active", active.toString());
+    }
+    return this.fetch(`/announcements?${params.toString()}`);
+  }
+  async announcementByID(id) {
+    return this.fetch(`/announcements/${id}`);
+  }
+  async createAnnouncement(request) {
+    return await this.fetch(`/announcements`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(request)
+    });
+  }
+  async updateAnnouncement(id, request) {
+    return this.fetch(`/announcements/${id}`, {
+      method: "PUT",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(request)
+    });
+  }
+  async deleteAnnouncementByID(id) {
+    return this.delete(`/announcements/${id}`, { method: "DELETE" });
+  }
+  async categories() {
+    return this.fetch("/categories");
+  }
+  async deleteCategory(slug) {
+    return this.delete(`/categories/${slug}`, { method: "DELETE" });
+  }
+  async createCategory(request) {
+    await this.fetch(`/categories`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(request)
+    });
+  }
+  lastSeenDate() {
+    const lastSeen = this.webStorage.get(lastSeenKey);
+    if (!lastSeen) {
+      return DateTime.fromISO("1990-01-01");
+    }
+    return DateTime.fromISO(lastSeen);
+  }
+  markLastSeenDate(date) {
+    this.webStorage.set(lastSeenKey, date.toISO());
+  }
+}
+
+export { AnnouncementsClient };
+//# sourceMappingURL=api.esm.js.map

package/dist/api.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.esm.js","sources":["../src/api.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { DateTime } from 'luxon';\nimport { WebStorage } from '@backstage/core-app-api';\nimport {\n  DiscoveryApi,\n  ErrorApi,\n  IdentityApi,\n  FetchApi,\n} from '@backstage/core-plugin-api';\nimport { ResponseError } from '@backstage/errors';\nimport {\n  CreateAnnouncementRequest,\n  CreateCategoryRequest,\n  AnnouncementsApi,\n} from '@backstage-community/plugin-announcements-react';\nimport {\n  Announcement,\n  AnnouncementsList,\n  Category,\n} from '@backstage-community/plugin-announcements-common';\n\nconst lastSeenKey = 'user_last_seen_date';\n\ntype AnnouncementsClientOptions = {\n  discoveryApi: DiscoveryApi;\n  identityApi: IdentityApi;\n  errorApi: ErrorApi;\n  fetchApi: FetchApi;\n};\n\nexport class AnnouncementsClient implements AnnouncementsApi {\n  private readonly discoveryApi: DiscoveryApi;\n  private readonly identityApi: IdentityApi;\n  private readonly webStorage: WebStorage;\n  private readonly fetchApi: FetchApi;\n\n  constructor(opts: AnnouncementsClientOptions) {\n    this.discoveryApi = opts.discoveryApi;\n    this.identityApi = opts.identityApi;\n    this.webStorage = new WebStorage('announcements', opts.errorApi);\n    this.fetchApi = opts.fetchApi;\n  }\n\n  private async fetch<T = any>(input: string, init?: RequestInit): Promise<T> {\n    const baseApiUrl = await this.discoveryApi.getBaseUrl('announcements');\n    const { token } = await this.identityApi.getCredentials();\n\n    const headers: HeadersInit = new Headers(init?.headers);\n    if (token && !headers.has('authorization')) {\n      headers.set('authorization', `Bearer ${token}`);\n    }\n\n    return this.fetchApi\n      .fetch(`${baseApiUrl}${input}`, {\n        ...init,\n        headers,\n      })\n      .then(async response => {\n        if (!response.ok) {\n          throw await ResponseError.fromResponse(response);\n        }\n\n        return response.json() as Promise<T>;\n      });\n  }\n\n  private async delete(input: string, init?: RequestInit): Promise<void> {\n    const baseApiUrl = await this.discoveryApi.getBaseUrl('announcements');\n    const { token } = await this.identityApi.getCredentials();\n\n    const headers: HeadersInit = new Headers(init?.headers);\n    if (token && !headers.has('authorization')) {\n      headers.set('authorization', `Bearer ${token}`);\n    }\n\n    return this.fetchApi\n      .fetch(`${baseApiUrl}${input}`, {\n        ...{ method: 'DELETE' },\n        headers,\n      })\n      .then(async response => {\n        if (!response.ok) {\n          throw await ResponseError.fromResponse(response);\n        }\n      });\n  }\n\n  async announcements({\n    max,\n    page,\n    category,\n    active,\n  }: {\n    max?: number;\n    page?: number;\n    category?: string;\n    active?: boolean;\n  }): Promise<AnnouncementsList> {\n    const params = new URLSearchParams();\n    if (category) {\n      params.append('category', category);\n    }\n    if (max) {\n      params.append('max', max.toString());\n    }\n    if (page) {\n      params.append('page', page.toString());\n    }\n    if (active) {\n      params.append('active', active.toString());\n    }\n\n    return this.fetch<AnnouncementsList>(`/announcements?${params.toString()}`);\n  }\n\n  async announcementByID(id: string): Promise<Announcement> {\n    return this.fetch<Announcement>(`/announcements/${id}`);\n  }\n\n  async createAnnouncement(\n    request: CreateAnnouncementRequest,\n  ): Promise<Announcement> {\n    return await this.fetch<Announcement>(`/announcements`, {\n      method: 'POST',\n      headers: { 'Content-Type': 'application/json' },\n      body: JSON.stringify(request),\n    });\n  }\n\n  async updateAnnouncement(\n    id: string,\n    request: CreateAnnouncementRequest,\n  ): Promise<Announcement> {\n    return this.fetch<Announcement>(`/announcements/${id}`, {\n      method: 'PUT',\n      headers: { 'Content-Type': 'application/json' },\n      body: JSON.stringify(request),\n    });\n  }\n\n  async deleteAnnouncementByID(id: string): Promise<void> {\n    return this.delete(`/announcements/${id}`, { method: 'DELETE' });\n  }\n\n  async categories(): Promise<Category[]> {\n    return this.fetch<Category[]>('/categories');\n  }\n\n  async deleteCategory(slug: string): Promise<void> {\n    return this.delete(`/categories/${slug}`, { method: 'DELETE' });\n  }\n\n  async createCategory(request: CreateCategoryRequest): Promise<void> {\n    await this.fetch<Category>(`/categories`, {\n      method: 'POST',\n      headers: { 'Content-Type': 'application/json' },\n      body: JSON.stringify(request),\n    });\n  }\n\n  lastSeenDate(): DateTime {\n    const lastSeen = this.webStorage.get<string>(lastSeenKey);\n    if (!lastSeen) {\n      // magic default date, probably enough in the past to consider every announcement as \"not seen\"\n      return DateTime.fromISO('1990-01-01');\n    }\n\n    return DateTime.fromISO(lastSeen);\n  }\n\n  markLastSeenDate(date: DateTime): void {\n    this.webStorage.set<string>(lastSeenKey, date.toISO()!);\n  }\n}\n"],"names":[],"mappings":";;;;AAmCA,MAAM,WAAc,GAAA,qBAAA;AASb,MAAM,mBAAgD,CAAA;AAAA,EAC1C,YAAA;AAAA,EACA,WAAA;AAAA,EACA,UAAA;AAAA,EACA,QAAA;AAAA,EAEjB,YAAY,IAAkC,EAAA;AAC5C,IAAA,IAAA,CAAK,eAAe,IAAK,CAAA,YAAA;AACzB,IAAA,IAAA,CAAK,cAAc,IAAK,CAAA,WAAA;AACxB,IAAA,IAAA,CAAK,UAAa,GAAA,IAAI,UAAW,CAAA,eAAA,EAAiB,KAAK,QAAQ,CAAA;AAC/D,IAAA,IAAA,CAAK,WAAW,IAAK,CAAA,QAAA;AAAA;AACvB,EAEA,MAAc,KAAe,CAAA,KAAA,EAAe,IAAgC,EAAA;AAC1E,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,eAAe,CAAA;AACrE,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,YAAY,cAAe,EAAA;AAExD,IAAA,MAAM,OAAuB,GAAA,IAAI,OAAQ,CAAA,IAAA,EAAM,OAAO,CAAA;AACtD,IAAA,IAAI,KAAS,IAAA,CAAC,OAAQ,CAAA,GAAA,CAAI,eAAe,CAAG,EAAA;AAC1C,MAAA,OAAA,CAAQ,GAAI,CAAA,eAAA,EAAiB,CAAU,OAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AAAA;AAGhD,IAAA,OAAO,KAAK,QACT,CAAA,KAAA,CAAM,GAAG,UAAU,CAAA,EAAG,KAAK,CAAI,CAAA,EAAA;AAAA,MAC9B,GAAG,IAAA;AAAA,MACH;AAAA,KACD,CAAA,CACA,IAAK,CAAA,OAAM,QAAY,KAAA;AACtB,MAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,QAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAGjD,MAAA,OAAO,SAAS,IAAK,EAAA;AAAA,KACtB,CAAA;AAAA;AACL,EAEA,MAAc,MAAO,CAAA,KAAA,EAAe,IAAmC,EAAA;AACrE,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,eAAe,CAAA;AACrE,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,YAAY,cAAe,EAAA;AAExD,IAAA,MAAM,OAAuB,GAAA,IAAI,OAAQ,CAAA,IAAA,EAAM,OAAO,CAAA;AACtD,IAAA,IAAI,KAAS,IAAA,CAAC,OAAQ,CAAA,GAAA,CAAI,eAAe,CAAG,EAAA;AAC1C,MAAA,OAAA,CAAQ,GAAI,CAAA,eAAA,EAAiB,CAAU,OAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AAAA;AAGhD,IAAA,OAAO,KAAK,QACT,CAAA,KAAA,CAAM,GAAG,UAAU,CAAA,EAAG,KAAK,CAAI,CAAA,EAAA;AAAA,MAC9B,GAAG,EAAE,MAAA,EAAQ,QAAS,EAAA;AAAA,MACtB;AAAA,KACD,CAAA,CACA,IAAK,CAAA,OAAM,QAAY,KAAA;AACtB,MAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,QAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AACjD,KACD,CAAA;AAAA;AACL,EAEA,MAAM,aAAc,CAAA;AAAA,IAClB,GAAA;AAAA,IACA,IAAA;AAAA,IACA,QAAA;AAAA,IACA;AAAA,GAM6B,EAAA;AAC7B,IAAM,MAAA,MAAA,GAAS,IAAI,eAAgB,EAAA;AACnC,IAAA,IAAI,QAAU,EAAA;AACZ,MAAO,MAAA,CAAA,MAAA,CAAO,YAAY,QAAQ,CAAA;AAAA;AAEpC,IAAA,IAAI,GAAK,EAAA;AACP,MAAA,MAAA,CAAO,MAAO,CAAA,KAAA,EAAO,GAAI,CAAA,QAAA,EAAU,CAAA;AAAA;AAErC,IAAA,IAAI,IAAM,EAAA;AACR,MAAA,MAAA,CAAO,MAAO,CAAA,MAAA,EAAQ,IAAK,CAAA,QAAA,EAAU,CAAA;AAAA;AAEvC,IAAA,IAAI,MAAQ,EAAA;AACV,MAAA,MAAA,CAAO,MAAO,CAAA,QAAA,EAAU,MAAO,CAAA,QAAA,EAAU,CAAA;AAAA;AAG3C,IAAA,OAAO,KAAK,KAAyB,CAAA,CAAA,eAAA,EAAkB,MAAO,CAAA,QAAA,EAAU,CAAE,CAAA,CAAA;AAAA;AAC5E,EAEA,MAAM,iBAAiB,EAAmC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,KAAA,CAAoB,CAAkB,eAAA,EAAA,EAAE,CAAE,CAAA,CAAA;AAAA;AACxD,EAEA,MAAM,mBACJ,OACuB,EAAA;AACvB,IAAO,OAAA,MAAM,IAAK,CAAA,KAAA,CAAoB,CAAkB,cAAA,CAAA,EAAA;AAAA,MACtD,MAAQ,EAAA,MAAA;AAAA,MACR,OAAA,EAAS,EAAE,cAAA,EAAgB,kBAAmB,EAAA;AAAA,MAC9C,IAAA,EAAM,IAAK,CAAA,SAAA,CAAU,OAAO;AAAA,KAC7B,CAAA;AAAA;AACH,EAEA,MAAM,kBACJ,CAAA,EAAA,EACA,OACuB,EAAA;AACvB,IAAA,OAAO,IAAK,CAAA,KAAA,CAAoB,CAAkB,eAAA,EAAA,EAAE,CAAI,CAAA,EAAA;AAAA,MACtD,MAAQ,EAAA,KAAA;AAAA,MACR,OAAA,EAAS,EAAE,cAAA,EAAgB,kBAAmB,EAAA;AAAA,MAC9C,IAAA,EAAM,IAAK,CAAA,SAAA,CAAU,OAAO;AAAA,KAC7B,CAAA;AAAA;AACH,EAEA,MAAM,uBAAuB,EAA2B,EAAA;AACtD,IAAO,OAAA,IAAA,CAAK,OAAO,CAAkB,eAAA,EAAA,EAAE,IAAI,EAAE,MAAA,EAAQ,UAAU,CAAA;AAAA;AACjE,EAEA,MAAM,UAAkC,GAAA;AACtC,IAAO,OAAA,IAAA,CAAK,MAAkB,aAAa,CAAA;AAAA;AAC7C,EAEA,MAAM,eAAe,IAA6B,EAAA;AAChD,IAAO,OAAA,IAAA,CAAK,OAAO,CAAe,YAAA,EAAA,IAAI,IAAI,EAAE,MAAA,EAAQ,UAAU,CAAA;AAAA;AAChE,EAEA,MAAM,eAAe,OAA+C,EAAA;AAClE,IAAM,MAAA,IAAA,CAAK,MAAgB,CAAe,WAAA,CAAA,EAAA;AAAA,MACxC,MAAQ,EAAA,MAAA;AAAA,MACR,OAAA,EAAS,EAAE,cAAA,EAAgB,kBAAmB,EAAA;AAAA,MAC9C,IAAA,EAAM,IAAK,CAAA,SAAA,CAAU,OAAO;AAAA,KAC7B,CAAA;AAAA;AACH,EAEA,YAAyB,GAAA;AACvB,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,UAAW,CAAA,GAAA,CAAY,WAAW,CAAA;AACxD,IAAA,IAAI,CAAC,QAAU,EAAA;AAEb,MAAO,OAAA,QAAA,CAAS,QAAQ,YAAY,CAAA;AAAA;AAGtC,IAAO,OAAA,QAAA,CAAS,QAAQ,QAAQ,CAAA;AAAA;AAClC,EAEA,iBAAiB,IAAsB,EAAA;AACrC,IAAA,IAAA,CAAK,UAAW,CAAA,GAAA,CAAY,WAAa,EAAA,IAAA,CAAK,OAAQ,CAAA;AAAA;AAE1D;;;;"}

package/dist/components/Admin/AdminPortal/AdminPortal.esm.js

@@ -0,0 +1,51 @@
+import React__default, { useState } from 'react';
+import { Page, Header, Content } from '@backstage/core-components';
+import { AnnouncementsContent } from '../AnnouncementsContent/AnnouncementsContent.esm.js';
+import { CategoriesContent } from '../CategoriesContent/CategoriesContent.esm.js';
+import { RequirePermission } from '@backstage/plugin-permission-react';
+import { useAnnouncementsTranslation } from '@backstage-community/plugin-announcements-react';
+import { makeStyles, Tab } from '@material-ui/core';
+import { TabContext, TabList, TabPanel } from '@material-ui/lab';
+import { announcementCreatePermission } from '@backstage-community/plugin-announcements-common';
+
+const useStyles = makeStyles(() => ({
+  tabPanel: {
+    paddingLeft: "0px",
+    paddingRight: "0px"
+  }
+}));
+const AdminPortalContent = () => {
+  const classes = useStyles();
+  const [tab, setTab] = useState("announcements");
+  const { t } = useAnnouncementsTranslation();
+  const handleChange = (_event, tabValue) => {
+    setTab(tabValue);
+  };
+  return /* @__PURE__ */ React__default.createElement(TabContext, { value: tab }, /* @__PURE__ */ React__default.createElement(TabList, { onChange: handleChange }, /* @__PURE__ */ React__default.createElement(
+    Tab,
+    {
+      label: t("admin.adminPortal.announcementsLabels"),
+      value: "announcements"
+    }
+  ), /* @__PURE__ */ React__default.createElement(
+    Tab,
+    {
+      label: t("admin.adminPortal.categoriesLabel"),
+      value: "categories"
+    }
+  )), /* @__PURE__ */ React__default.createElement(TabPanel, { value: "announcements", className: classes.tabPanel }, /* @__PURE__ */ React__default.createElement(AnnouncementsContent, null)), /* @__PURE__ */ React__default.createElement(TabPanel, { value: "categories", className: classes.tabPanel }, /* @__PURE__ */ React__default.createElement(CategoriesContent, null)));
+};
+const AdminPortal = (props) => {
+  const { title, subtitle, themeId } = props ?? {};
+  const { t } = useAnnouncementsTranslation();
+  return /* @__PURE__ */ React__default.createElement(Page, { themeId: themeId ?? "tool" }, /* @__PURE__ */ React__default.createElement(
+    Header,
+    {
+      title: title ?? t("admin.adminPortal.title"),
+      subtitle: subtitle ?? t("admin.adminPortal.title")
+    }
+  ), /* @__PURE__ */ React__default.createElement(RequirePermission, { permission: announcementCreatePermission }, /* @__PURE__ */ React__default.createElement(Content, null, /* @__PURE__ */ React__default.createElement(AdminPortalContent, null))));
+};
+
+export { AdminPortal };
+//# sourceMappingURL=AdminPortal.esm.js.map

package/dist/components/Admin/AdminPortal/AdminPortal.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdminPortal.esm.js","sources":["../../../../src/components/Admin/AdminPortal/AdminPortal.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport React, { useState } from 'react';\nimport { Page, Header, Content } from '@backstage/core-components';\nimport { AnnouncementsContent } from '../AnnouncementsContent';\nimport { CategoriesContent } from '../CategoriesContent';\nimport { RequirePermission } from '@backstage/plugin-permission-react';\nimport { useAnnouncementsTranslation } from '@backstage-community/plugin-announcements-react';\nimport { makeStyles, Tab } from '@material-ui/core';\nimport { TabContext, TabList, TabPanel } from '@material-ui/lab';\nimport { announcementCreatePermission } from '@backstage-community/plugin-announcements-common';\n\nconst useStyles = makeStyles(() => ({\n  tabPanel: {\n    paddingLeft: '0px',\n    paddingRight: '0px',\n  },\n}));\n\ntype AdminPortalProps = {\n  themeId?: string;\n  title?: string;\n  subtitle?: string;\n};\n\nconst AdminPortalContent = () => {\n  const classes = useStyles();\n  const [tab, setTab] = useState('announcements');\n  const { t } = useAnnouncementsTranslation();\n  const handleChange = (_event: React.ChangeEvent<{}>, tabValue: string) => {\n    setTab(tabValue);\n  };\n\n  return (\n    <TabContext value={tab}>\n      <TabList onChange={handleChange}>\n        <Tab\n          label={t('admin.adminPortal.announcementsLabels')}\n          value=\"announcements\"\n        />\n        <Tab\n          label={t('admin.adminPortal.categoriesLabel')}\n          value=\"categories\"\n        />\n      </TabList>\n      <TabPanel value=\"announcements\" className={classes.tabPanel}>\n        <AnnouncementsContent />\n      </TabPanel>\n      <TabPanel value=\"categories\" className={classes.tabPanel}>\n        <CategoriesContent />\n      </TabPanel>\n    </TabContext>\n  );\n};\n\n/** @public */\nexport const AdminPortal = (props?: AdminPortalProps) => {\n  const { title, subtitle, themeId } = props ?? {};\n  const { t } = useAnnouncementsTranslation();\n\n  return (\n    <Page themeId={themeId ?? 'tool'}>\n      <Header\n        title={title ?? t('admin.adminPortal.title')}\n        subtitle={subtitle ?? t('admin.adminPortal.title')}\n      />\n      <RequirePermission permission={announcementCreatePermission}>\n        <Content>\n          <AdminPortalContent />\n        </Content>\n      </RequirePermission>\n    </Page>\n  );\n};\n"],"names":["React"],"mappings":";;;;;;;;;;AAyBA,MAAM,SAAA,GAAY,WAAW,OAAO;AAAA,EAClC,QAAU,EAAA;AAAA,IACR,WAAa,EAAA,KAAA;AAAA,IACb,YAAc,EAAA;AAAA;AAElB,CAAE,CAAA,CAAA;AAQF,MAAM,qBAAqB,MAAM;AAC/B,EAAA,MAAM,UAAU,SAAU,EAAA;AAC1B,EAAA,MAAM,CAAC,GAAA,EAAK,MAAM,CAAA,GAAI,SAAS,eAAe,CAAA;AAC9C,EAAM,MAAA,EAAE,CAAE,EAAA,GAAI,2BAA4B,EAAA;AAC1C,EAAM,MAAA,YAAA,GAAe,CAAC,MAAA,EAA+B,QAAqB,KAAA;AACxE,IAAA,MAAA,CAAO,QAAQ,CAAA;AAAA,GACjB;AAEA,EAAA,oDACG,UAAW,EAAA,EAAA,KAAA,EAAO,uBAChBA,cAAA,CAAA,aAAA,CAAA,OAAA,EAAA,EAAQ,UAAU,YACjB,EAAA,kBAAAA,cAAA,CAAA,aAAA;AAAA,IAAC,GAAA;AAAA,IAAA;AAAA,MACC,KAAA,EAAO,EAAE,uCAAuC,CAAA;AAAA,MAChD,KAAM,EAAA;AAAA;AAAA,GAER,kBAAAA,cAAA,CAAA,aAAA;AAAA,IAAC,GAAA;AAAA,IAAA;AAAA,MACC,KAAA,EAAO,EAAE,mCAAmC,CAAA;AAAA,MAC5C,KAAM,EAAA;AAAA;AAAA,GAEV,mBACCA,cAAA,CAAA,aAAA,CAAA,QAAA,EAAA,EAAS,OAAM,eAAgB,EAAA,SAAA,EAAW,OAAQ,CAAA,QAAA,EAAA,kBAChDA,cAAA,CAAA,aAAA,CAAA,oBAAA,EAAA,IAAqB,CACxB,CACA,kBAAAA,cAAA,CAAA,aAAA,CAAC,QAAS,EAAA,EAAA,KAAA,EAAM,YAAa,EAAA,SAAA,EAAW,QAAQ,QAC9C,EAAA,kBAAAA,cAAA,CAAA,aAAA,CAAC,iBAAkB,EAAA,IAAA,CACrB,CACF,CAAA;AAEJ,CAAA;AAGa,MAAA,WAAA,GAAc,CAAC,KAA6B,KAAA;AACvD,EAAA,MAAM,EAAE,KAAO,EAAA,QAAA,EAAU,OAAQ,EAAA,GAAI,SAAS,EAAC;AAC/C,EAAM,MAAA,EAAE,CAAE,EAAA,GAAI,2BAA4B,EAAA;AAE1C,EAAA,uBACGA,cAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,OAAS,EAAA,OAAA,IAAW,MACxB,EAAA,kBAAAA,cAAA,CAAA,aAAA;AAAA,IAAC,MAAA;AAAA,IAAA;AAAA,MACC,KAAA,EAAO,KAAS,IAAA,CAAA,CAAE,yBAAyB,CAAA;AAAA,MAC3C,QAAA,EAAU,QAAY,IAAA,CAAA,CAAE,yBAAyB;AAAA;AAAA,GACnD,kBACCA,cAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,UAAY,EAAA,4BAAA,EAAA,kBAC5BA,cAAA,CAAA,aAAA,CAAA,OAAA,EAAA,IAAA,kBACEA,cAAA,CAAA,aAAA,CAAA,kBAAA,EAAA,IAAmB,CACtB,CACF,CACF,CAAA;AAEJ;;;;"}