feat: migrate AnnouncementsApi (#215)

Signed-off-by: Kurt King <[email protected]>

Author: kurtaking

plugins/announcements-react/.eslintrc.js

@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

plugins/announcements-react/README.md

@@ -0,0 +1,3 @@
+# @procore-oss/plugin-announcements-react
+
+Welcome to the web library package for the announcements plugin!

plugins/announcements-react/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@procore-oss/plugin-announcements-react",
+  "description": "Web library for the announcements plugin",
+  "version": "0.1.0",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "web-library"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/core-app-api": "^1.11.3",
+    "@backstage/core-plugin-api": "^1.8.2",
+    "@backstage/errors": "^1.2.3",
+    "@material-ui/core": "^4.12.2",
+    "luxon": "^3.4.4"
+  },
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.25.1",
+    "@testing-library/jest-dom": "^5.10.1",
+    "@testing-library/react": "^12.1.3"
+  },
+  "files": [
+    "dist"
+  ]
+}

plugins/announcements-react/src/apis/AnnouncementsApi.ts

@@ -0,0 +1,35 @@
+import { DateTime } from 'luxon';
+import { createApiRef } from '@backstage/core-plugin-api';
+import {
+  AnnouncementsList,
+  Announcement,
+  CreateAnnouncementRequest,
+  Category,
+  CreateCategoryRequest,
+} from './types';
+
+export const announcementsApiRef = createApiRef<AnnouncementsApi>({
+  id: 'plugin.announcements.service',
+});
+
+export interface AnnouncementsApi {
+  announcements(opts: {
+    max?: number;
+    page?: number;
+    category?: string;
+  }): Promise<AnnouncementsList>;
+  announcementByID(id: string): Promise<Announcement>;
+
+  createAnnouncement(request: CreateAnnouncementRequest): Promise<Announcement>;
+  updateAnnouncement(
+    id: string,
+    request: CreateAnnouncementRequest,
+  ): Promise<Announcement>;
+  deleteAnnouncementByID(id: string): Promise<void>;
+
+  categories(): Promise<Category[]>;
+  createCategory(request: CreateCategoryRequest): Promise<void>;
+
+  lastSeenDate(): DateTime;
+  markLastSeenDate(date: DateTime): void;
+}

plugins/announcements-react/src/apis/index.ts

@@ -0,0 +1,2 @@
+export { announcementsApiRef, type AnnouncementsApi } from './AnnouncementsApi';
+export type { CreateAnnouncementRequest, CreateCategoryRequest } from './types';

plugins/announcements-react/src/apis/types.ts

@@ -0,0 +1,30 @@
+export type Category = {
+  slug: string;
+  title: string;
+};
+
+export type Announcement = {
+  id: string;
+  category?: Category;
+  publisher: string;
+  title: string;
+  excerpt: string;
+  body: string;
+  created_at: string;
+};
+
+export type AnnouncementsList = {
+  count: number;
+  results: Announcement[];
+};
+
+export type CreateAnnouncementRequest = Omit<
+  Announcement,
+  'id' | 'category' | 'created_at'
+> & {
+  category?: string;
+};
+
+export type CreateCategoryRequest = {
+  title: string;
+};

plugins/announcements-react/src/index.ts

@@ -0,0 +1,11 @@
+/***/
+/**
+ * Web library for the announcements plugin.
+ *
+ * @packageDocumentation
+ */
+
+// In this package you might for example export components or hooks
+// that are useful to other plugins or modules.
+
+export * from './apis';

plugins/announcements-react/src/setupTests.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';