import { IChangeset, ISheetBlock, ISnapshot, UnitAction, UnitObject, UniverType } from "@univerjs/protocol"; import { IBoardData } from "@univerjs-pro/boards"; import { IPdfUnitData } from "@univerjs-pro/pdfs"; import { ISlideData } from "@univerjs-pro/slides"; import { IBaseSnapshot, IDocumentData, IWorkbookData } from "@univerjs/core"; //#region src/common/types.d.ts type JsonPrimitive = boolean | number | string | null; type JsonValue = JsonPrimitive | JsonObject | readonly JsonValue[]; interface JsonObject { readonly [key: string]: JsonValue; } type CustomData = Record; interface Disposable { dispose(): void; } //#endregion //#region src/snapshots/types.d.ts interface SaveSnapshotInput { readonly snapshot: ISnapshot; readonly sheetBlocks?: readonly ISheetBlock[]; } interface UnitLoadData { readonly snapshot: ISnapshot; readonly changesets: readonly IChangeset[]; readonly targetRevision: number; } interface UnitLoadDataWithBlocks extends UnitLoadData { readonly sheetBlocks: readonly ISheetBlock[]; } interface ISnapshotWithBlocks { snapshot: ISnapshot; sheetBlocks: ISheetBlock[]; } interface SnapshotPolicy { shouldCreate(input: { readonly unitID: string; readonly type: UniverType; readonly revision: number; readonly changesetBytes: number; readonly revisionsSinceLastSnapshot: number; }): boolean; } //#endregion //#region src/request/request.d.ts interface BaseReadUnitDataRequest { readonly unitID: string; readonly type: UniverType; } interface GetUnitLoadDataRequest extends BaseReadUnitDataRequest { readonly revision: number; } interface GetChangesetsRequest extends BaseReadUnitDataRequest { readonly from: number; readonly to: number; } interface GetSheetBlockRequest extends BaseReadUnitDataRequest { readonly blockID: string; } type ReadUnitDataRequest = GetUnitLoadDataRequest | GetChangesetsRequest | GetSheetBlockRequest; interface CreateUnitRequest { readonly snapshot: ISnapshot; readonly sheetBlocks?: readonly ISheetBlock[]; } interface DeleteUnitsRequest { readonly unitIDs: readonly string[]; readonly hardDelete: boolean; } interface RecoverUnitsRequest { readonly unitIDs: readonly string[]; } interface SubmitChangesetRequest { readonly changeset: IChangeset; } type CollabRequest = ReadUnitDataRequest | CreateUnitRequest | DeleteUnitsRequest | RecoverUnitsRequest | SubmitChangesetRequest; //#endregion //#region src/database/adapter.d.ts interface DatabaseContext { readonly userID: string; readonly customData: CustomData; readonly request: TRequest; } interface SubmitDatabaseContext extends DatabaseContext { readonly memberID: string; } interface UnitRecord { readonly unitID: string; readonly type: UniverType; readonly headRevision: number; readonly creatorID: string; readonly createdAt: number; } type SnapshotInfo = Readonly>; interface CreateUnitDatabaseInput { readonly record: UnitRecord; readonly snapshot: ISnapshot; readonly sheetBlocks?: readonly ISheetBlock[]; } type CreateUnitDatabaseResult = { readonly status: "created"; readonly record: UnitRecord; } | { readonly status: "already-exists"; readonly record: UnitRecord; }; type DeleteUnitDatabaseStatus = "soft-deleted" | "already-soft-deleted" | "hard-deleted" | "already-hard-deleted"; interface DeleteUnitsDatabaseInput { readonly unitIDs: readonly string[]; readonly hardDelete: boolean; } interface DeleteUnitsDatabaseResult { readonly units: readonly { readonly unitID: string; readonly status: DeleteUnitDatabaseStatus; }[]; } type RecoverUnitDatabaseStatus = "recovered" | "already-active"; interface RecoverUnitsDatabaseInput { readonly unitIDs: readonly string[]; } interface RecoverUnitsDatabaseResult { readonly units: readonly { readonly unitID: string; readonly status: RecoverUnitDatabaseStatus; }[]; } interface CommitChangesetInput { readonly changeset: IChangeset; } type CommitChangesetResult = { readonly status: "committed"; readonly changeset: IChangeset; readonly headRevision: number; } | { readonly status: "revision-mismatch"; readonly actualHeadRevision: number; }; interface IDatabaseAdapter { getUnit(context: DatabaseContext, unitID: string): Promise; getSnapshotInfo(context: DatabaseContext, unitID: string, options?: { readonly revision?: number; }): Promise; getSnapshot(context: DatabaseContext, unitID: string, options?: { readonly revision?: number; }): Promise; getSheetBlock(context: DatabaseContext, unitID: string, blockID: string): Promise; getChangesets(context: DatabaseContext, unitID: string, range: { readonly from: number; readonly to?: number; }): Promise; commitChangeset(context: SubmitDatabaseContext, input: CommitChangesetInput): Promise; saveSnapshot(context: DatabaseContext, input: SaveSnapshotInput): Promise; createUnit(context: DatabaseContext, input: CreateUnitDatabaseInput): Promise; deleteUnits(context: DatabaseContext, input: DeleteUnitsDatabaseInput): Promise; recoverUnits(context: DatabaseContext, input: RecoverUnitsDatabaseInput): Promise; dispose?(): Promise; } //#endregion //#region src/errors/collab-error.d.ts type CollabErrorCode = "UNAUTHENTICATED" | "INVALID_REQUEST" | "UNIT_NOT_FOUND" | "PERMISSION_DENIED" | "OT_CONFLICT" | "REVISION_MISMATCH" | "ADAPTER_FAILURE" | "INTERNAL_ERROR"; declare class CollabError extends Error { readonly code: CollabErrorCode; readonly retryable: boolean; readonly details?: Readonly; constructor(code: CollabErrorCode, message: string, options?: { retryable?: boolean; details?: Readonly; cause?: unknown; }); } //#endregion //#region src/context/context.d.ts interface CollabContext { readonly userID: string; readonly customData?: CustomData; } interface CollabMemberContext extends CollabContext { readonly memberID: string; } //#endregion //#region src/permissions/required-unit-permission.d.ts interface RequiredUnitPermission { readonly unitID: string; readonly objectID: string; readonly objectType: UnitObject; readonly action: UnitAction; } //#endregion //#region src/middleware/middleware.d.ts type CollabServiceMiddlewareAction = "readUnitData" | "createUnit" | "deleteUnits" | "recoverUnits" | "submitChangeset" | "applyChangeset" | "commitChangeset"; type MiddlewareNext = () => Promise; type Middleware = (ctx: TContext, next: MiddlewareNext) => void | Promise; interface BaseMiddlewareContext { readonly userID: string; readonly customData: CustomData; readonly request: TRequest; } type ReadUnitDataMiddlewareContext = BaseMiddlewareContext; type CreateUnitMiddlewareContext = BaseMiddlewareContext; type DeleteUnitsMiddlewareContext = BaseMiddlewareContext; type RecoverUnitsMiddlewareContext = BaseMiddlewareContext; interface SubmitChangesetMiddlewareContext extends BaseMiddlewareContext { readonly memberID: string; } interface ApplyChangesetMiddlewareContext extends BaseMiddlewareContext { readonly memberID: string; readonly attempt: number; readonly currentRevision: number; readonly changeset: Readonly; } interface CommitChangesetMiddlewareContext extends BaseMiddlewareContext { readonly memberID: string; readonly attempt: number; readonly expectedHeadRevision: number; readonly changeset: Readonly; readonly requiredUnitPermissions: readonly RequiredUnitPermission[]; } interface CollabServiceMiddlewareMap { readonly readUnitData: Middleware; readonly createUnit: Middleware; readonly deleteUnits: Middleware; readonly recoverUnits: Middleware; readonly submitChangeset: Middleware; readonly applyChangeset: Middleware; readonly commitChangeset: Middleware; } //#endregion //#region src/observability/observability.d.ts interface ILogger { debug(message: string, fields?: Readonly): void; info(message: string, fields?: Readonly): void; warn(message: string, fields?: Readonly): void; error(message: string, fields?: Readonly): void; } interface IMetrics { increment(name: string, labels?: Readonly>): void; observe(name: string, value: number, labels?: Readonly>): void; } //#endregion //#region src/operations/operations.d.ts type CreateUnitFromSnapshotInput = ISnapshotWithBlocks; interface CreateUnitResult { readonly status: "created" | "already-exists"; readonly unitID: string; readonly headRevision: number; } interface DeleteUnitsInput { readonly unitIDs: readonly string[]; readonly hardDelete?: boolean; } interface DeleteUnitsResult { readonly units: readonly { readonly unitID: string; readonly status: "soft-deleted" | "already-soft-deleted" | "hard-deleted" | "already-hard-deleted"; }[]; } interface RecoverUnitsInput { readonly unitIDs: readonly string[]; } interface RecoverUnitsResult { readonly units: readonly { readonly unitID: string; readonly status: "recovered" | "already-active"; }[]; } type CreateUnitFromDataInput = { readonly type: UniverType.UNIVER_SHEET; readonly data: IWorkbookData; } | { readonly type: UniverType.UNIVER_DOC; readonly data: IDocumentData; } | { readonly type: UniverType.UNIVER_SLIDE; readonly data: ISlideData; } | { readonly type: UniverType.UNIVER_BOARD; readonly data: IBoardData; } | { readonly type: UniverType.UNIVER_BASE; readonly data: IBaseSnapshot; } | { readonly type: UniverType.UNIVER_PDF; readonly data: IPdfUnitData; }; interface GetUnitLoadDataInput { readonly unitID: string; readonly type: UniverType; readonly revision: number; } interface GetChangesetsInput { readonly unitID: string; readonly type: UniverType; readonly from: number; readonly to: number; } interface GetChangesetsResult { readonly changesets: readonly IChangeset[]; } interface GetSheetBlockInput { readonly unitID: string; readonly type: UniverType; readonly blockID: string; } interface GetSheetBlockResult { readonly block: ISheetBlock | null; } interface SubmitChangesetInput { readonly changeset: IChangeset; } //#endregion //#region src/submit/changeset.d.ts type SubmitChangesetResult = { readonly status: "committed" | "already-committed"; readonly changeset: IChangeset; } | { readonly status: "rejected"; readonly error: CollabError; } | { readonly status: "retry"; readonly error: CollabError; }; //#endregion //#region src/runtime/unit-runtime-config.d.ts interface UnitRuntimeConfig { readonly maxLoadedUnits?: number; readonly idleTimeoutMs?: number; readonly execution?: UnitRuntimeExecution; } type UnitRuntimeExecution = { readonly mode: "in-process"; } | { readonly mode: "worker"; readonly workerCount?: number; readonly operationTimeoutMs?: number; }; //#endregion //#region src/service/service.d.ts declare const MAX_UNIT_LIFECYCLE_BATCH_SIZE = 100; interface UniverCollabServiceOptions { readonly dbAdapter: IDatabaseAdapter; readonly enableUnitPermissionAnalysis?: boolean; readonly snapshotPolicy?: SnapshotPolicy | false; readonly runtime?: UnitRuntimeConfig; readonly logger?: ILogger; readonly metrics?: IMetrics; readonly submitChangeset?: { readonly maxRevisionRetries?: number; }; } interface ChangesetCommittedEvent { readonly userID: string; readonly memberID: string; readonly customData: Record; readonly request: SubmitChangesetRequest; readonly changeset: IChangeset; readonly requiredUnitPermissions: readonly RequiredUnitPermission[]; readonly committedAt: number; } interface UnitCreatedEvent { readonly userID: string; readonly customData: Record; readonly request: CreateUnitRequest; readonly record: UnitRecord; readonly createdAt: number; } interface UnitsDeletedEvent { readonly userID: string; readonly customData: Record; readonly request: DeleteUnitsRequest; readonly result: DeleteUnitsDatabaseResult; readonly deletedAt: number; } interface UnitsRecoveredEvent { readonly userID: string; readonly customData: Record; readonly request: RecoverUnitsRequest; readonly result: RecoverUnitsDatabaseResult; readonly recoveredAt: number; } interface CollabServiceEventMap { readonly changesetCommitted: ChangesetCommittedEvent; readonly unitCreated: UnitCreatedEvent; readonly unitsDeleted: UnitsDeletedEvent; readonly unitsRecovered: UnitsRecoveredEvent; } interface IUniverCollabService { readonly dbAdapter: IDatabaseAdapter; use(action: K, middleware: CollabServiceMiddlewareMap[K]): Disposable; getUnitLoadData(input: GetUnitLoadDataInput, context: CollabContext): Promise; getUnitLoadDataWithBlocks(input: GetUnitLoadDataInput, context: CollabContext): Promise; getChangesets(input: GetChangesetsInput, context: CollabContext): Promise; getSheetBlock(input: GetSheetBlockInput, context: CollabContext): Promise; createUnitFromSnapshot(input: CreateUnitFromSnapshotInput, context: CollabContext): Promise; createUnitFromData(input: CreateUnitFromDataInput, context: CollabContext): Promise; deleteUnits(input: DeleteUnitsInput, context: CollabContext): Promise; recoverUnits(input: RecoverUnitsInput, context: CollabContext): Promise; submitChangeset(input: SubmitChangesetInput, context: CollabMemberContext): Promise; on(event: K, listener: (event: CollabServiceEventMap[K]) => void | Promise): Disposable; dispose(): Promise; } declare class UniverCollabService implements IUniverCollabService { private readonly _dbAdapter; private readonly _middleware; private readonly _lifecycle; private readonly _logger; private readonly _metrics; private readonly _events; private readonly _runtime; private readonly _transformer; private readonly _coordinator; private readonly _submitEngine; private readonly _snapshotSaveQueue; constructor(options: UniverCollabServiceOptions); get dbAdapter(): IDatabaseAdapter; use(action: K, middleware: CollabServiceMiddlewareMap[K]): Disposable; on(event: K, listener: (event: CollabServiceEventMap[K]) => void | Promise): Disposable; getUnitLoadData(input: GetUnitLoadDataInput, context: CollabContext): Promise; getUnitLoadDataWithBlocks(input: GetUnitLoadDataInput, context: CollabContext): Promise; getChangesets(input: GetChangesetsInput, context: CollabContext): Promise; getSheetBlock(input: GetSheetBlockInput, context: CollabContext): Promise; createUnitFromSnapshot(input: CreateUnitFromSnapshotInput, context: CollabContext): Promise; createUnitFromData(input: CreateUnitFromDataInput, context: CollabContext): Promise; deleteUnits(input: DeleteUnitsInput, context: CollabContext): Promise; recoverUnits(input: RecoverUnitsInput, context: CollabContext): Promise; submitChangeset(input: SubmitChangesetInput, context: CollabMemberContext): Promise; dispose(): Promise; private _getUnitLoadData; private _getSnapshotSheetBlocks; private _createUnit; private _requireUnit; private _database; private _call; private _normalizeError; private _assertRunning; } //#endregion //#region src/snapshots/unit-snapshot-materializer.d.ts interface IUnitSnapshotMaterializer { materializeSnapshot(input: UnitLoadDataWithBlocks): Promise; dispose(): Promise; } declare class UnitSnapshotMaterializer implements IUnitSnapshotMaterializer { private readonly _reader; private readonly _runtime; private readonly _coordinator; private readonly _lifecycle; constructor(options?: UnitRuntimeConfig); materializeSnapshot(input: UnitLoadDataWithBlocks): Promise; dispose(): Promise; } //#endregion //#region src/runtime/unit-runtime.d.ts interface UnitHandle { readonly unitID: string; readonly type: UniverType; readonly revision: number; } interface IUnitRuntime { ensureUnit(context: DatabaseContext, unitID: string, type: UniverType): Promise; releaseUnit(handle: UnitHandle): void; applyChangeset(context: DatabaseContext, handle: UnitHandle, changeset: Readonly, options?: ApplyChangesetOptions): Promise; createSnapshot(handle: UnitHandle): Promise; captureSnapshot(handle: UnitHandle): Promise; disposeUnit(unitID: string): void; dispose(): Promise; } interface CapturedSnapshot { readonly revision: number; readonly snapshot: Promise; } interface IUnitRuntimeReader extends Pick { getUnit(context: DatabaseContext, unitID: string): Promise | null>; } interface UnitRuntimeOptions extends UnitRuntimeConfig { readonly reader: IUnitRuntimeReader; } interface ApplyChangesetOptions { readonly collectUnitPermissions?: boolean; } interface ApplyChangesetResult { readonly requiredUnitPermissions: readonly RequiredUnitPermission[]; readonly permissionAnalysisDurationMs?: number; } //#endregion //#region src/runtime/create-unit-runtime.d.ts declare function createUnitRuntime(options: UnitRuntimeOptions): IUnitRuntime; //#endregion export { type ApplyChangesetMiddlewareContext, type BaseMiddlewareContext, type ChangesetCommittedEvent, type CollabContext, CollabError, type CollabErrorCode, type CollabMemberContext, type CollabRequest, type CollabServiceEventMap, type CollabServiceMiddlewareAction, type CollabServiceMiddlewareMap, type CommitChangesetInput, type CommitChangesetMiddlewareContext, type CommitChangesetResult, type CreateUnitDatabaseInput, type CreateUnitDatabaseResult, type CreateUnitFromDataInput, type CreateUnitFromSnapshotInput, type CreateUnitMiddlewareContext, type CreateUnitRequest, type CreateUnitResult, type CustomData, type DatabaseContext, type DeleteUnitDatabaseStatus, type DeleteUnitsDatabaseInput, type DeleteUnitsDatabaseResult, type DeleteUnitsInput, type DeleteUnitsMiddlewareContext, type DeleteUnitsRequest, type DeleteUnitsResult, type Disposable, type GetChangesetsInput, type GetChangesetsRequest, type GetChangesetsResult, type GetSheetBlockInput, type GetSheetBlockRequest, type GetSheetBlockResult, type GetUnitLoadDataInput, type GetUnitLoadDataRequest, type IDatabaseAdapter, type ILogger, type IMetrics, type ISnapshotWithBlocks, type IUnitSnapshotMaterializer, type IUniverCollabService, type JsonObject, MAX_UNIT_LIFECYCLE_BATCH_SIZE, type Middleware, type MiddlewareNext, type ReadUnitDataMiddlewareContext, type ReadUnitDataRequest, type RecoverUnitDatabaseStatus, type RecoverUnitsDatabaseInput, type RecoverUnitsDatabaseResult, type RecoverUnitsInput, type RecoverUnitsMiddlewareContext, type RecoverUnitsRequest, type RecoverUnitsResult, type RequiredUnitPermission, type SaveSnapshotInput, type SnapshotInfo, type SnapshotPolicy, type SubmitChangesetInput, type SubmitChangesetMiddlewareContext, type SubmitChangesetRequest, type SubmitChangesetResult, type SubmitDatabaseContext, type UnitCreatedEvent, type UnitLoadData, type UnitLoadDataWithBlocks, type UnitRecord, type UnitRuntimeConfig, type UnitRuntimeExecution, UnitSnapshotMaterializer, type UnitsDeletedEvent, type UnitsRecoveredEvent, UniverCollabService, type UniverCollabServiceOptions, createUnitRuntime };