@scipen/ot-protocol

Type definitions, OT algorithm (TextOperation), and adapter interfaces for the OT SDK.

Foundation package that every other @scipen/ot-* package depends on. Zero runtime dependencies.

Install

pnpm add @scipen/ot-protocol

What's inside

Type definitions (. export)

• OTClientConfig, OTClientState, OTConnectionState, OTClientEvents
• WSClientMessage, WSServerMessage — WebSocket protocol
• StoredFileOp — persistence layer types
• Project, ProjectFile, ProjectFolder — domain types (reserved for future project-level collaboration)

import type { OTClientConfig, WSServerMessage } from '@scipen/ot-protocol';

OT algorithm (./ot export)

• TextOperation class — the core OT primitive with apply, compose, transform
• RawOp — serialized op format: number > 0 = retain, number < 0 = remove, string = insert

import { TextOperation } from '@scipen/ot-protocol/ot';

const op = new TextOperation().retain(3).insert('hello').remove(2);
op.apply('abcdef'); // 'abchellof'

const [a, b] = TextOperation.transform(opA, opB);
// apply(apply(s, opA), b) === apply(apply(s, opB), a)  (TP1 convergence)

Testing

pnpm test  # runs tests/text-operation.test.ts — 47 cases covering apply/compose/transform/serialization

Critical: modifying TextOperation.apply / compose / transform MUST come with new test cases. See root CONTRIBUTING.md.

Dependency graph

@scipen/ot-protocol  (this package)
      ↑
  ot-core, ot-adapter-browser, ot-adapter-electron-main, ot-react

License

MIT © SciPen Team