feat(ee): bases

Table and kanban UI, formula engine package, and the base-embed editor extension

apps/server/src/ws/base-realtime.bridge.ts

@@ -0,0 +1,49 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { Server, Socket } from 'socket.io';
+
+@Injectable()
+export class BaseRealtimeBridge {
+  private readonly logger = new Logger(BaseRealtimeBridge.name);
+  private resolved = false;
+  private svc: any = null;
+
+  constructor(private readonly moduleRef: ModuleRef) {}
+
+  protected loadServiceClass(): any {
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
+      return require('../ee/base/realtime/base-ws.service').BaseWsService;
+    } catch {
+      this.logger.debug(
+        'Base realtime requested but enterprise module not bundled in this build',
+      );
+      return null;
+    }
+  }
+
+  private resolve(): any {
+    if (this.resolved) return this.svc;
+    this.resolved = true;
+    const ServiceClass = this.loadServiceClass();
+    if (!ServiceClass) return null;
+    this.svc = this.moduleRef.get(ServiceClass, { strict: false });
+    return this.svc;
+  }
+
+  setServer(server: Server): void {
+    this.resolve()?.setServer(server);
+  }
+
+  isBaseEvent(data: any): boolean {
+    return this.resolve()?.isBaseEvent(data) ?? false;
+  }
+
+  async handleInbound(client: Socket, data: any): Promise<void> {
+    await this.resolve()?.handleInbound(client, data);
+  }
+
+  async handleDisconnect(client: Socket): Promise<void> {
+    await this.resolve()?.handleDisconnect(client);
+  }
+}

apps/server/src/ws/ws.gateway.ts

@@ -1,6 +1,7 @@
 import {
   MessageBody,
   OnGatewayConnection,
+  OnGatewayDisconnect,
   OnGatewayInit,
   SubscribeMessage,
   WebSocketGateway,
@@ -13,6 +14,7 @@ import { OnModuleDestroy } from '@nestjs/common';
 import { SpaceMemberRepo } from '@docmost/db/repos/space/space-member.repo';
 import { WsService } from './ws.service';
 import { getSpaceRoomName, getUserRoomName } from './ws.utils';
+import { BaseRealtimeBridge } from './base-realtime.bridge';
 import * as cookie from 'cookie';
 
 @WebSocketGateway({
@@ -20,7 +22,11 @@ import * as cookie from 'cookie';
   transports: ['websocket'],
 })
 export class WsGateway
-  implements OnGatewayConnection, OnGatewayInit, OnModuleDestroy
+  implements
+    OnGatewayConnection,
+    OnGatewayDisconnect,
+    OnGatewayInit,
+    OnModuleDestroy
 {
   @WebSocketServer()
   server: Server;
@@ -29,10 +35,12 @@ export class WsGateway
     private tokenService: TokenService,
     private spaceMemberRepo: SpaceMemberRepo,
     private wsService: WsService,
+    private baseRealtime: BaseRealtimeBridge,
   ) {}
 
   afterInit(server: Server): void {
     this.wsService.setServer(server);
+    this.baseRealtime.setServer(server);
   }
 
   async handleConnection(client: Socket, ...args: any[]): Promise<void> {
@@ -47,6 +55,7 @@ export class WsGateway
       const workspaceId = token.workspaceId;
 
       client.data.userId = userId;
+      client.data.workspaceId = workspaceId;
 
       const userSpaceIds = await this.spaceMemberRepo.getUserSpaceIds(userId);
 
@@ -61,10 +70,19 @@ export class WsGateway
     }
   }
 
+  async handleDisconnect(client: Socket): Promise<void> {
+    await this.baseRealtime.handleDisconnect(client);
+  }
+
   @SubscribeMessage('message')
   async handleMessage(client: Socket, data: any): Promise<void> {
     if (this.wsService.isTreeEvent(data)) {
       await this.wsService.handleTreeEvent(client, data);
+      return;
+    }
+    if (this.baseRealtime.isBaseEvent(data)) {
+      await this.baseRealtime.handleInbound(client, data);
+      return;
     }
   }
 

apps/server/src/ws/ws.module.ts

@@ -3,11 +3,12 @@ import { WsGateway } from './ws.gateway';
 import { WsService } from './ws.service';
 import { WsTreeService } from './ws-tree.service';
 import { TokenModule } from '../core/auth/token.module';
+import { BaseRealtimeBridge } from './base-realtime.bridge';
 
 @Global()
 @Module({
   imports: [TokenModule],
-  providers: [WsGateway, WsService, WsTreeService],
+  providers: [WsGateway, WsService, WsTreeService, BaseRealtimeBridge],
   exports: [WsGateway, WsService, WsTreeService],
 })
 export class WsModule {}

apps/server/src/ws/ws.utils.ts

@@ -16,3 +16,14 @@ export const TREE_EVENTS = new Set([
   'deleteTreeNode',
   'refetchRootTreeNodeEvent',
 ]);
+
+export function getBaseRoomName(pageId: string): string {
+  return `base-${pageId}`;
+}
+
+export const BASE_INBOUND_EVENTS = new Set([
+  'base:subscribe',
+  'base:unsubscribe',
+  'base:presence',
+  'base:presence:leave',
+]);