feat(notifications): make notifications NPM packages public (#1061)

* chore: rename plugins/notifications-frontend to plugins/notifications * feat(notifications): make notifications NPM packages public
janus-idp · Jan 15, 2024 · ecec1db · ecec1db
1 parent 7e7a9ae
commit ecec1db
Show file tree

Hide file tree

Showing 50 changed files with 12 additions and 14 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -27,4 +27,6 @@ yarn.lock                    @janus-idp/maintainers-plugins
 /plugins/tekton/             @janus-idp/maintainers-plugins @debsmita1 @divyanshiGupta
 /plugins/rbac-backend/       @janus-idp/maintainers-plugins @gorkem @AndrienkoAleksandr @PatAKnight
 /plugins/rbac-common/        @janus-idp/maintainers-plugins @gorkem @AndrienkoAleksandr @PatAKnight
-/plugins/notifications-frontend  @janus-idp/maintainers-plugins @mareklibra
+/plugins/notifications       @janus-idp/maintainers-plugins @mareklibra
+/plugins/notifications-backend  @janus-idp/maintainers-plugins @mareklibra @ydayagi
+
diff --git a/packages/app/package.json b/packages/app/package.json
@@ -37,7 +37,6 @@
     "@backstage/plugin-catalog-import": "^0.10.1",
     "@backstage/plugin-catalog-react": "^1.8.5",
     "@backstage/plugin-github-actions": "^0.6.6",
-    "@backstage/plugin-notifications-frontend": "0.1.0",
     "@backstage/plugin-org": "^0.6.15",
     "@backstage/plugin-permission-react": "^0.4.16",
     "@backstage/plugin-scaffolder": "^1.15.1",

diff --git a/packages/backend/package.json b/packages/backend/package.json
@@ -27,7 +27,6 @@
     "@backstage/plugin-auth-backend": "^0.19.3",
     "@backstage/plugin-auth-node": "^0.4.0",
     "@backstage/plugin-catalog-backend": "^1.14.0",
-    "@backstage/plugin-notifications-backend": "^0.1.0",
     "@backstage/plugin-permission-backend": "^0.5.29",
     "@backstage/plugin-permission-common": "^0.7.9",
     "@backstage/plugin-permission-node": "^0.7.17",

diff --git a/plugins/notifications-backend/README.md b/plugins/notifications-backend/README.md
@@ -163,7 +163,7 @@ It is up to particular deployment to provide corresponding permission policies b
 
 #### Service-to-service and External Calls
 
-The notification-backend is expected to be called by FE plugins (including the notifications-frontend), other backend plugins or external services.
+The notification-backend is expected to be called by FE plugins (including the Notifications frontend-end plugin), other backend plugins or external services.
 
 To configure those two flows, refer
 

diff --git a/plugins/notifications-backend/package.json b/plugins/notifications-backend/package.json
@@ -4,7 +4,6 @@
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
-  "private": true,
   "publishConfig": {
     "access": "public",
     "main": "dist/index.cjs.js",

diff --git a/plugins/notifications-frontend/.eslintrc.js → plugins/notifications/.eslintrc.js b/plugins/notifications-frontend/.eslintrc.js → plugins/notifications/.eslintrc.js
diff --git a/plugins/notifications-frontend/README.md → plugins/notifications/README.md b/plugins/notifications-frontend/README.md → plugins/notifications/README.md
@@ -17,15 +17,15 @@ Have `@backstage/plugin-notifications-backend` installed and running.
 
 ```
 cd packages/app
-yarn add @backstage/plugin-notifications-frontend
+yarn add @backstage/plugin-notifications
 ```
 
 ### Add left-side menu item
 
 In the `packages/app/src/components/Root/Root.tsx`:
 
 ```
-import { NotificationsSidebarItem } from '@backstage/plugin-notifications-frontend';
+import { NotificationsSidebarItem } from '@backstage/plugin-notifications';
 
 ...
 export const Root = ({ children }: PropsWithChildren<{}>) => (
@@ -48,7 +48,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
 In the `packages/app/src/App.tsx`:
 
 ```
-import { NOTIFICATIONS_ROUTE, NotificationsPage } from '@backstage/plugin-notifications-frontend';
+import { NOTIFICATIONS_ROUTE, NotificationsPage } from '@backstage/plugin-notifications';
 ...
 
 export const AppBase = () => {
@@ -60,7 +60,7 @@ export const AppBase = () => {
 ## How to use the NotificationApi
 
 ```
-import { notificationsApiRef, Notification } from '@backstage/plugin-notifications-frontend';
+import { notificationsApiRef, Notification } from '@backstage/plugin-notifications';
 
 ...
 

diff --git a/plugins/notifications-frontend/dev/index.tsx → plugins/notifications/dev/index.tsx b/plugins/notifications-frontend/dev/index.tsx → plugins/notifications/dev/index.tsx
diff --git a/.../notifications-frontend/openapitools.json → plugins/notifications/openapitools.json b/.../notifications-frontend/openapitools.json → plugins/notifications/openapitools.json
diff --git a/plugins/notifications-frontend/package.json → plugins/notifications/package.json b/plugins/notifications-frontend/package.json → plugins/notifications/package.json
@@ -1,11 +1,10 @@
 {
-  "name": "@backstage/plugin-notifications-frontend",
+  "name": "@backstage/plugin-notifications",
   "description": "Frontend part of the notifications providing the Notifications API, Notifications page, left-side menu item and other REACT components.",
   "version": "0.1.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
-  "private": true,
   "publishConfig": {
     "access": "public",
     "main": "dist/index.esm.js",

diff --git a/...-frontend/src/api/NotificationsApiImpl.ts → ...fications/src/api/NotificationsApiImpl.ts b/...-frontend/src/api/NotificationsApiImpl.ts → ...fications/src/api/NotificationsApiImpl.ts
diff --git a/...s/notifications-frontend/src/api/index.ts → plugins/notifications/src/api/index.ts b/...s/notifications-frontend/src/api/index.ts → plugins/notifications/src/api/index.ts
diff --git a/...ions-frontend/src/api/notificationsApi.ts → ...notifications/src/api/notificationsApi.ts b/...ions-frontend/src/api/notificationsApi.ts → ...notifications/src/api/notificationsApi.ts
diff --git a/...s/NotificationsPage/NotificationsPage.tsx → ...s/NotificationsPage/NotificationsPage.tsx b/...s/NotificationsPage/NotificationsPage.tsx → ...s/NotificationsPage/NotificationsPage.tsx
diff --git a/...src/components/NotificationsPage/index.ts → ...src/components/NotificationsPage/index.ts b/...src/components/NotificationsPage/index.ts → ...src/components/NotificationsPage/index.ts
diff --git a/...c/components/NotificationsSidebarItem.tsx → ...c/components/NotificationsSidebarItem.tsx b/...c/components/NotificationsSidebarItem.tsx → ...c/components/NotificationsSidebarItem.tsx
diff --git a/...s/NotificationsTable/MarkAsUnreadIcon.tsx → ...s/NotificationsTable/MarkAsUnreadIcon.tsx b/...s/NotificationsTable/MarkAsUnreadIcon.tsx → ...s/NotificationsTable/MarkAsUnreadIcon.tsx
diff --git a/...NotificationsTable/NotificationsTable.tsx → ...NotificationsTable/NotificationsTable.tsx b/...NotificationsTable/NotificationsTable.tsx → ...NotificationsTable/NotificationsTable.tsx
diff --git a/...tificationsTable/NotificationsToolbar.tsx → ...tificationsTable/NotificationsToolbar.tsx b/...tificationsTable/NotificationsToolbar.tsx → ...tificationsTable/NotificationsToolbar.tsx
diff --git a/...rc/components/NotificationsTable/index.ts → ...rc/components/NotificationsTable/index.ts b/...rc/components/NotificationsTable/index.ts → ...rc/components/NotificationsTable/index.ts
diff --git a/...alNotifications/PersonalNotifications.tsx → ...alNotifications/PersonalNotifications.tsx b/...alNotifications/PersonalNotifications.tsx → ...alNotifications/PersonalNotifications.tsx
diff --git a/...components/PersonalNotifications/index.ts → ...components/PersonalNotifications/index.ts b/...components/PersonalNotifications/index.ts → ...components/PersonalNotifications/index.ts
diff --git a/...nts/SendNotification/SendNotification.tsx → ...nts/SendNotification/SendNotification.tsx b/...nts/SendNotification/SendNotification.tsx → ...nts/SendNotification/SendNotification.tsx
diff --git a/.../src/components/SendNotification/index.ts → .../src/components/SendNotification/index.ts b/.../src/components/SendNotification/index.ts → .../src/components/SendNotification/index.ts
diff --git a/...stemNotifications/SystemNotifications.tsx → ...stemNotifications/SystemNotifications.tsx b/...stemNotifications/SystemNotifications.tsx → ...stemNotifications/SystemNotifications.tsx
diff --git a/...c/components/SystemNotifications/index.ts → ...c/components/SystemNotifications/index.ts b/...c/components/SystemNotifications/index.ts → ...c/components/SystemNotifications/index.ts
diff --git a/...ontend/src/components/usePollingEffect.ts → ...ations/src/components/usePollingEffect.ts b/...ontend/src/components/usePollingEffect.ts → ...ations/src/components/usePollingEffect.ts
diff --git a/...s/notifications-frontend/src/constants.ts → plugins/notifications/src/constants.ts b/...s/notifications-frontend/src/constants.ts → plugins/notifications/src/constants.ts
diff --git a/plugins/notifications-frontend/src/index.ts → plugins/notifications/src/index.ts b/plugins/notifications-frontend/src/index.ts → plugins/notifications/src/index.ts
diff --git a/...end/src/openapi/.openapi-generator-ignore → ...ons/src/openapi/.openapi-generator-ignore b/...end/src/openapi/.openapi-generator-ignore → ...ons/src/openapi/.openapi-generator-ignore
diff --git a/...tend/src/openapi/.openapi-generator/FILES → ...ions/src/openapi/.openapi-generator/FILES b/...tend/src/openapi/.openapi-generator/FILES → ...ions/src/openapi/.openapi-generator/FILES
diff --git a/...nd/src/openapi/.openapi-generator/VERSION → ...ns/src/openapi/.openapi-generator/VERSION b/...nd/src/openapi/.openapi-generator/VERSION → ...ns/src/openapi/.openapi-generator/VERSION
diff --git a/...ifications-frontend/src/openapi/README.md → plugins/notifications/src/openapi/README.md b/...ifications-frontend/src/openapi/README.md → plugins/notifications/src/openapi/README.md
@@ -3,6 +3,6 @@ The content of this folder is generated, do not update it manually.
 Generated by:
 
 ```
-cd plugins/notifications-frontend
+cd plugins/notifications
 yarn openapi:generate
 ```
diff --git a/...tend/src/openapi/apis/NotificationsApi.ts → ...ions/src/openapi/apis/NotificationsApi.ts b/...tend/src/openapi/apis/NotificationsApi.ts → ...ions/src/openapi/apis/NotificationsApi.ts
diff --git a/...ations-frontend/src/openapi/apis/index.ts → ...s/notifications/src/openapi/apis/index.ts b/...ations-frontend/src/openapi/apis/index.ts → ...s/notifications/src/openapi/apis/index.ts
diff --git a/...tifications-frontend/src/openapi/index.ts → plugins/notifications/src/openapi/index.ts b/...tifications-frontend/src/openapi/index.ts → plugins/notifications/src/openapi/index.ts
diff --git a/...ons-frontend/src/openapi/models/Action.ts → ...otifications/src/openapi/models/Action.ts b/...ons-frontend/src/openapi/models/Action.ts → ...otifications/src/openapi/models/Action.ts
diff --git a/...frontend/src/openapi/models/CreateBody.ts → ...ications/src/openapi/models/CreateBody.ts b/...frontend/src/openapi/models/CreateBody.ts → ...ications/src/openapi/models/CreateBody.ts
diff --git a/.../openapi/models/CreateBodyActionsInner.ts → .../openapi/models/CreateBodyActionsInner.ts b/.../openapi/models/CreateBodyActionsInner.ts → .../openapi/models/CreateBodyActionsInner.ts
diff --git a/...i/models/CreateNotification200Response.ts → ...i/models/CreateNotification200Response.ts b/...i/models/CreateNotification200Response.ts → ...i/models/CreateNotification200Response.ts
diff --git a/...odels/GetNotificationsCount200Response.ts → ...odels/GetNotificationsCount200Response.ts b/...odels/GetNotificationsCount200Response.ts → ...odels/GetNotificationsCount200Response.ts
diff --git a/...ontend/src/openapi/models/Notification.ts → ...ations/src/openapi/models/Notification.ts b/...ontend/src/openapi/models/Notification.ts → ...ations/src/openapi/models/Notification.ts
diff --git a/...ions-frontend/src/openapi/models/index.ts → ...notifications/src/openapi/models/index.ts b/...ions-frontend/src/openapi/models/index.ts → ...notifications/src/openapi/models/index.ts
diff --git a/...fications-frontend/src/openapi/runtime.ts → plugins/notifications/src/openapi/runtime.ts b/...fications-frontend/src/openapi/runtime.ts → plugins/notifications/src/openapi/runtime.ts
diff --git a/...notifications-frontend/src/plugin.test.ts → plugins/notifications/src/plugin.test.ts b/...notifications-frontend/src/plugin.test.ts → plugins/notifications/src/plugin.test.ts
diff --git a/plugins/notifications-frontend/src/plugin.ts → plugins/notifications/src/plugin.ts b/plugins/notifications-frontend/src/plugin.ts → plugins/notifications/src/plugin.ts
diff --git a/plugins/notifications-frontend/src/routes.ts → plugins/notifications/src/routes.ts b/plugins/notifications-frontend/src/routes.ts → plugins/notifications/src/routes.ts
diff --git a/.../notifications-frontend/src/setupTests.ts → plugins/notifications/src/setupTests.ts b/.../notifications-frontend/src/setupTests.ts → plugins/notifications/src/setupTests.ts
diff --git a/plugins/notifications-frontend/tsconfig.json → plugins/notifications/tsconfig.json b/plugins/notifications-frontend/tsconfig.json → plugins/notifications/tsconfig.json
@@ -3,7 +3,7 @@
   "include": ["src", "dev", "migrations"],
   "exclude": ["node_modules"],
   "compilerOptions": {
-    "outDir": "../../dist-types/plugins/notifications-frontend",
+    "outDir": "../../dist-types/plugins/notifications",
     "rootDir": "."
   }
 }
diff --git a/plugins/notifications-frontend/turbo.json → plugins/notifications/turbo.json b/plugins/notifications-frontend/turbo.json → plugins/notifications/turbo.json
@@ -2,7 +2,7 @@
   "extends": ["//"],
   "pipeline": {
     "tsc": {
-      "outputs": ["../../dist-types/plugins/notifications-frontend/**"],
+      "outputs": ["../../dist-types/plugins/notifications/**"],
       "dependsOn": ["^tsc"]
     }
   }