refactor(server): plugin modules (#5630)

- [x] separates modules into `fundamental`, `core`, `plugins`
- [x] optional modules with `@OptionalModule` decorator to install modules with requirements met(`requires`, `if`)
- [x] `module.contributesTo` defines optional features that will be enabled if module registered
- [x] `AFFiNE.plugins.use('payment', {})` to enable a optional/plugin module
- [x] `PaymentModule` is the first plugin module
- [x] GraphQLSchema will not be generated for non-included modules
- [x] Frontend can use `ServerConfigType` query to detect which features are enabled
- [x] override existing provider globally

packages/backend/server/src/fundamentals/event/def.ts

@@ -0,0 +1,51 @@
+import type { Snapshot, User, Workspace } from '@prisma/client';
+
+import { Flatten, Payload } from './types';
+
+export interface WorkspaceEvents {
+  deleted: Payload<Workspace['id']>;
+  blob: {
+    deleted: Payload<{
+      workspaceId: Workspace['id'];
+      name: string;
+    }>;
+  };
+}
+
+export interface DocEvents {
+  updated: Payload<
+    Pick<Snapshot, 'id' | 'workspaceId'> & {
+      previous: Pick<Snapshot, 'blob' | 'state' | 'updatedAt'>;
+    }
+  >;
+  deleted: Payload<Pick<Snapshot, 'id' | 'workspaceId'>>;
+}
+
+export interface UserEvents {
+  deleted: Payload<User>;
+}
+
+/**
+ * Event definitions can be extended by
+ *
+ * @example
+ *
+ * declare module './event/def' {
+ *   interface UserEvents {
+ *     created: Payload<User>;
+ *   }
+ * }
+ *
+ * assert<Event, 'user.created'>()
+ */
+export interface EventDefinitions {
+  workspace: WorkspaceEvents;
+  snapshot: DocEvents;
+  user: UserEvents;
+}
+
+export type EventKV = Flatten<EventDefinitions>;
+
+export type Event = keyof EventKV;
+export type EventPayload<E extends Event> = EventKV[E];
+export type { Payload };

packages/backend/server/src/fundamentals/event/events.ts

@@ -1,33 +0,0 @@
-import type { Snapshot, User, Workspace } from '@prisma/client';
-
-import { Flatten, Payload } from './types';
-
-interface EventDefinitions {
-  workspace: {
-    deleted: Payload<Workspace['id']>;
-    blob: {
-      deleted: Payload<{
-        workspaceId: Workspace['id'];
-        name: string;
-      }>;
-    };
-  };
-
-  snapshot: {
-    updated: Payload<
-      Pick<Snapshot, 'id' | 'workspaceId'> & {
-        previous: Pick<Snapshot, 'blob' | 'state' | 'updatedAt'>;
-      }
-    >;
-    deleted: Payload<Pick<Snapshot, 'id' | 'workspaceId'>>;
-  };
-
-  user: {
-    deleted: Payload<User>;
-  };
-}
-
-export type EventKV = Flatten<EventDefinitions>;
-
-export type Event = keyof EventKV;
-export type EventPayload<E extends Event> = EventKV[E];

packages/backend/server/src/fundamentals/event/index.ts

@@ -5,7 +5,7 @@ import {
   OnEvent as RawOnEvent,
 } from '@nestjs/event-emitter';
 
-import type { Event, EventPayload } from './events';
+import type { Event, EventPayload } from './def';
 
 @Injectable()
 export class EventEmitter {
@@ -40,4 +40,4 @@ export const OnEvent = RawOnEvent as (
   exports: [EventEmitter],
 })
 export class EventModule {}
-export { EventPayload };
+export { Event, EventPayload };