Module Setup

import { Module } from '@nestjs/common';
import { BoardModule } from '@hfu.digital/boardkit-nestjs';

@Module({
    imports: [
        BoardModule.register({
            // Required
            storage: myBoardStorage,
            assetStorage: myAssetStorage,
            eventLogStorage: myEventLogStorage,
            authGuard: myAuthGuard,

            // Optional
            limits: { maxElementsPerPage: 5000 },
            sync: { batchPersistIntervalMs: 2000 },
            deployment: { mode: 'self-hosted' },
        }),
    ],
})
export class AppModule {}

interface BoardModuleOptions {
    // Required
    storage: BoardStorage;
    assetStorage: AssetStorage;
    eventLogStorage: EventLogStorage;
    authGuard: BoardAuthGuard;

    // Optional
    realtimeTransport?: RealtimeTransport;
    limits?: Partial<{
        maxElementsPerPage: number;
        maxPagesPerBoard: number;
        maxAssetSizeMb: number;
        maxBoardSizeMb: number;
    }>;
    sync?: Partial<{
        batchPersistIntervalMs: number;
        presenceTtlMs: number;
        reconnectWindowMs: number;
        maxMessageRatePerUser: number;
    }>;
    deployment?: {
        mode: 'self-hosted' | 'managed';
        syncServiceUrl?: string;
    };
}