CommentAdapter | @sheetwrite/core

Host persistence contract for versioned comment threads.

Package: @sheetwrite/core
Source: packages/core/src/collaboration.ts#L431

Members 3

listComments

listComments(documentId: string, signal?: AbortSignal): Promise<CommentListResultinterface CommentListResult {
  version: number;
  threads: readonly CommentThread[];
}interface CommentListResult {
  version: number;
  threads: readonly CommentThread[];
}interface CommentListResult {
  version: number;
  threads: readonly CommentThread[];
}Versioned comment-thread listing returned by a host adapter.API reference →>;

mutateComment

mutateComment(request: CommentMutationRequestinterface CommentMutationRequest {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  mutation: CommentMutation;
  signal?: AbortSignal;
}interface CommentMutationRequest {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  mutation: CommentMutation;
  signal?: AbortSignal;
}interface CommentMutationRequest {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  mutation: CommentMutation;
  signal?: AbortSignal;
}Versioned comment mutation submitted to a host adapter.API reference →): Promise<CommentMutationResponsetype CommentMutationResponse =
  | {
      status: "applied";
      version: number;
      clientMutationId: string;
      thread: CommentThread;
    }
  | {
      status: "duplicate";
      version: number;
      clientMutationId: string;
    }
  | { status: "conflict"; currentVersion: number };type CommentMutationResponse =
  | {
      status: "applied";
      version: number;
      clientMutationId: string;
      thread: CommentThread;
    }
  | {
      status: "duplicate";
      version: number;
      clientMutationId: string;
    }
  | { status: "conflict"; currentVersion: number };type CommentMutationResponse =
  | {
      status: "applied";
      version: number;
      clientMutationId: string;
      thread: CommentThread;
    }
  | {
      status: "duplicate";
      version: number;
      clientMutationId: string;
    }
  | {
      status: "conflict";
      currentVersion: number;
    };Applied, duplicate, or conflict acknowledgement for a comment mutation.API reference →>;

subscribeComments

subscribeComments?( documentId: string, listener: (event: VersionedCommentEventinterface VersionedCommentEvent {
  version: number;
  thread: CommentThread;
  clientMutationId?: string;
}interface VersionedCommentEvent {
  version: number;
  thread: CommentThread;
  clientMutationId?: string;
}interface VersionedCommentEvent {
  version: number;
  thread: CommentThread;
  clientMutationId?: string;
}Comment mutation paired with its assigned server version.API reference →) => void, signal?: AbortSignal, ): undefined | (() => void);

Declaration

View full TypeScript declaration

export interface CommentAdapter {
  listComments(
    documentId: string,
    signal?: AbortSignal,
  ): Promise<CommentListResultinterface CommentListResult {
  version: number;
  threads: readonly CommentThread[];
}interface CommentListResult {
  version: number;
  threads: readonly CommentThread[];
}interface CommentListResult {
  version: number;
  threads: readonly CommentThread[];
}Versioned comment-thread listing returned by a host adapter.API reference →>;
  mutateComment(
    request: CommentMutationRequestinterface CommentMutationRequest {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  mutation: CommentMutation;
  signal?: AbortSignal;
}interface CommentMutationRequest {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  mutation: CommentMutation;
  signal?: AbortSignal;
}interface CommentMutationRequest {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  mutation: CommentMutation;
  signal?: AbortSignal;
}Versioned comment mutation submitted to a host adapter.API reference →,
  ): Promise<CommentMutationResponsetype CommentMutationResponse =
  | {
      status: "applied";
      version: number;
      clientMutationId: string;
      thread: CommentThread;
    }
  | {
      status: "duplicate";
      version: number;
      clientMutationId: string;
    }
  | { status: "conflict"; currentVersion: number };type CommentMutationResponse =
  | {
      status: "applied";
      version: number;
      clientMutationId: string;
      thread: CommentThread;
    }
  | {
      status: "duplicate";
      version: number;
      clientMutationId: string;
    }
  | { status: "conflict"; currentVersion: number };type CommentMutationResponse =
  | {
      status: "applied";
      version: number;
      clientMutationId: string;
      thread: CommentThread;
    }
  | {
      status: "duplicate";
      version: number;
      clientMutationId: string;
    }
  | {
      status: "conflict";
      currentVersion: number;
    };Applied, duplicate, or conflict acknowledgement for a comment mutation.API reference →>;
  subscribeComments?(
    documentId: string,
    listener: (event: VersionedCommentEventinterface VersionedCommentEvent {
  version: number;
  thread: CommentThread;
  clientMutationId?: string;
}interface VersionedCommentEvent {
  version: number;
  thread: CommentThread;
  clientMutationId?: string;
}interface VersionedCommentEvent {
  version: number;
  thread: CommentThread;
  clientMutationId?: string;
}Comment mutation paired with its assigned server version.API reference →) => void,
    signal?: AbortSignal,
  ): undefined | (() => void);
}