Markdown Editor Kit

createMdKitTrpcRouter

Function: createMdKitTrpcRouter()

function createMdKitTrpcRouter(store: MdKitTransportStore): BuiltRouter<{
  ctx: object;
  meta: object;
  errorShape: DefaultErrorShape;
  transformer: false;
}, DecorateCreateRouterOptions<{
  listDocumentVersions: QueryProcedure<{
     input: {
        documentId: string;
     };
     output: {
        versions: MdKitDocumentVersionSummary[];
     };
     meta: object;
  }>;
  readDocument: QueryProcedure<{
     input: {
        documentId: string;
     };
     output: MdKitDocumentSnapshot;
     meta: object;
  }>;
  readDocumentVersion: QueryProcedure<{
     input: {
        documentId: string;
        versionId: string;
     };
     output:   | MdKitDocumentVersionDetail
        | null;
     meta: object;
  }>;
  resyncDocument: MutationProcedure<{
     input: {
        documentId: string;
     };
     output: MdKitDocumentSnapshot;
     meta: object;
  }>;
  restoreDocumentVersion: MutationProcedure<{
     input: {
        documentId: string;
        versionId: string;
     };
     output:   | {
        version: MdKitDocumentVersionToken;
        updatedAt?: string | null;
      }
        | {
        conflict: true;
        version?: MdKitDocumentVersionToken;
        updatedAt?: string | null;
      };
     meta: object;
  }>;
  writeDocument: MutationProcedure<{
     input: {
        baseVersion: string | number | null;
        content: string;
        documentId: string;
        force?: boolean;
     };
     output:   | {
        version: MdKitDocumentVersionToken;
        updatedAt?: string | null;
      }
        | {
        conflict: true;
        version?: MdKitDocumentVersionToken;
        updatedAt?: string | null;
      };
     meta: object;
  }>;
}>>;

Defined in: packages/mdkit/src/transport/trpcServer.ts:30

Builds a tRPC router exposing document read/write/resync, checkpoint list/read, and restore over a transport store (typically from createMdKitBackend). Mount it standalone or nested in an app router.

Parameters

ParameterType
storeMdKitTransportStore

Returns

BuiltRouter<{ ctx: object; meta: object; errorShape: DefaultErrorShape; transformer: false; }, DecorateCreateRouterOptions<{ listDocumentVersions: QueryProcedure<{ input: { documentId: string; }; output: { versions: MdKitDocumentVersionSummary[]; }; meta: object; }>; readDocument: QueryProcedure<{ input: { documentId: string; }; output: MdKitDocumentSnapshot; meta: object; }>; readDocumentVersion: QueryProcedure<{ input: { documentId: string; versionId: string; }; output: | MdKitDocumentVersionDetail | null; meta: object; }>; resyncDocument: MutationProcedure<{ input: { documentId: string; }; output: MdKitDocumentSnapshot; meta: object; }>; restoreDocumentVersion: MutationProcedure<{ input: { documentId: string; versionId: string; }; output: | { version: MdKitDocumentVersionToken; updatedAt?: string | null; } | { conflict: true; version?: MdKitDocumentVersionToken; updatedAt?: string | null; }; meta: object; }>; writeDocument: MutationProcedure<{ input: { baseVersion: string | number | null; content: string; documentId: string; force?: boolean; }; output: | { version: MdKitDocumentVersionToken; updatedAt?: string | null; } | { conflict: true; version?: MdKitDocumentVersionToken; updatedAt?: string | null; }; meta: object; }>; }>>

On this page