@univerjs/protocol 0.1.0

package/lib/types/ts/v1/comb.d.ts

@@ -0,0 +1,109 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+import type { Empty } from "../google/protobuf/empty";
+import type { Changeset } from "../univer/changeset";
+import type { CollaMsg } from "../univer/colla_msg";
+import type { Error } from "../univer/constants/errors";
+import type { UniverType } from "../univer/constants/univer";
+export declare const protobufPackage = "universer.v1";
+/** more details: https://c3fgartrp2.feishu.cn/docx/OS47dk8BCo1ZeKxXiNvcDLuZn2g#PymGdupuyoYfvTxv1EBciV7in9b */
+export declare enum CombCmd {
+    /** UNKNOWN_CMD - unknown cmd */
+    UNKNOWN_CMD = 0,
+    /** HELLO - call hello to get comb info, this is essential after you connect to the server */
+    HELLO = 1,
+    /** JOIN - call join to join couple of rooms */
+    JOIN = 2,
+    /** LEAVE - call leave to leave a room */
+    LEAVE = 3,
+    /** INGEST - call ingest to broadcast a message to a room */
+    INGEST = 4,
+    /** HEARTBEAT - call heartbeat to keep the connection alive */
+    HEARTBEAT = 5,
+    /**
+     * RECV - RECV not a cmd actually, you never call a RECV cmd.
+     * when you receive a message from comb(may be created by another user), the cmd will be RECV
+     */
+    RECV = 6,
+    UNRECOGNIZED = -1
+}
+export declare enum CmdRspCode {
+    UNKNOWN_CODE = 0,
+    OK = 1,
+    FAIL = 2,
+    UNRECOGNIZED = -1
+}
+export interface ConnectResponse {
+    error: Error | undefined;
+    memberID: string;
+}
+export interface BroadcastRequest {
+    roomID: string;
+    message: string;
+}
+export interface NewChangesRequest {
+    unitID: string;
+    memberID: string;
+    type: UniverType;
+    changeset: Changeset | undefined;
+}
+export interface NewChangesResponse {
+    error: Error | undefined;
+}
+export interface CombMsg {
+    cmd: CombCmd;
+    /** route key is used to route the message to the right room */
+    routeKey: string;
+    code: CmdRspCode;
+    reason: string;
+    traceID: string;
+    rule: Rule | undefined;
+    collaMsg?: CollaMsg | undefined;
+    infoRsp?: CombInfoResponse | undefined;
+    joinRsp?: CombJoinResponse | undefined;
+    joinReq?: CombJoinRequest | undefined;
+    leaveReq?: CombLeaveRequest | undefined;
+}
+export interface CombJoinInfo {
+    roomID: string;
+    /** extra args for joining the room */
+    args: string;
+}
+export interface CombJoinRequest {
+    rooms: CombJoinInfo[];
+}
+export interface CombJoinResponse {
+    roomInfos: {
+        [key: string]: CombJoinResponse_RoomInfo;
+    };
+}
+export interface CombJoinResponse_RoomInfo {
+    roomID: string;
+    members: Member[];
+}
+export interface CombJoinResponse_RoomInfosEntry {
+    key: string;
+    value: CombJoinResponse_RoomInfo | undefined;
+}
+export interface CombInfoResponse {
+    memberID: string;
+}
+export interface CombLeaveRequest {
+    roomID: string;
+    /** extra args for leaving the room */
+    args: string;
+}
+export interface Member {
+    memberID: string;
+    name: string;
+}
+export interface Rule {
+    /** exclude member */
+    excludeMember: string[];
+    /** only member */
+    onlyMember: string[];
+}
+export interface CombService {
+    NewChanges(request: NewChangesRequest, metadata?: Metadata): Observable<NewChangesResponse>;
+    Broadcast(request: BroadcastRequest, metadata?: Metadata): Observable<Empty>;
+}

package/lib/types/ts/v1/conf.d.ts

@@ -0,0 +1,88 @@
+import type { Duration } from "../google/protobuf/duration";
+export declare const protobufPackage = "universer.v1";
+export interface Bootstrap {
+    server: Server | undefined;
+    data: Data | undefined;
+    service: Service | undefined;
+    admin: Admin[];
+    extra: ExtraConf | undefined;
+}
+export interface Server {
+    http: Server_HTTP | undefined;
+    grpc: Server_GRPC | undefined;
+}
+export interface Server_HTTP {
+    network: string;
+    addr: string;
+    timeout: Duration | undefined;
+}
+export interface Server_GRPC {
+    network: string;
+    addr: string;
+    timeout: Duration | undefined;
+}
+export interface S3 {
+    accessKeyID: string;
+    accessKeySecret: string;
+    region: string;
+    endpoint: string;
+    usePathStyle: boolean;
+    presignExpires: Duration | undefined;
+}
+export interface Data {
+    database: Data_Database | undefined;
+    redis: Data_Redis | undefined;
+    rabbitmq: Data_Rabbitmq | undefined;
+    clickhouse: Data_Clickhouse | undefined;
+    temporal: Data_Temporal | undefined;
+    s3: S3 | undefined;
+}
+export interface Data_Database {
+    driver: string;
+    database: string;
+    dsn: string;
+}
+export interface Data_Redis {
+    network: string;
+    addr: string;
+    readTimeout: Duration | undefined;
+    writeTimeout: Duration | undefined;
+}
+export interface Data_Rabbitmq {
+    addr: string;
+}
+export interface Data_Clickhouse {
+    dsn: string;
+}
+export interface Data_Temporal {
+    addr: string;
+    namespace: string;
+    workerTaskQueue: string;
+}
+export interface Service {
+    transform: Service_RpcService | undefined;
+    apply: Service_RpcService | undefined;
+    nodeSnapshot: Service_RpcService | undefined;
+}
+export interface Service_RpcService {
+    addr: string;
+    network: string;
+    timeout: Duration | undefined;
+}
+export interface Admin {
+    user: string;
+    password: string;
+}
+export interface ExtraConf {
+    celldataMaxSize: number;
+}
+export interface LicenseArgs {
+    maxUnits: number;
+    maxMemberInRoom: number;
+    concurrentUnits: number;
+}
+export interface VersionType {
+    type: string;
+    confDir: string;
+    confName: string;
+}

package/lib/types/ts/v1/connector.d.ts

@@ -0,0 +1,74 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+import type { Error } from "../univer/constants/errors";
+import type { RowData } from "../univer/workbook";
+import type { DisplayerConfig } from "./source_connector/displayer";
+import type { SelectColumn, WhereGroup as WhereGroup1 } from "./source_connector/stream_view";
+export declare const protobufPackage = "universer.v1";
+export interface Connector {
+    connectorID: string;
+    name: string;
+}
+export interface Displayer {
+    diplayerID: string;
+    name: string;
+}
+export interface WhereGroup {
+    group: string;
+    conditions: WhereCondition[];
+}
+export interface WhereCondition {
+    column: string;
+    value: any[];
+}
+export interface ListDisplayersRequest {
+}
+export interface ListDisplayersResponse {
+    error: Error | undefined;
+    displayers: Displayer[];
+}
+export interface GetDisplayerRequest {
+    displayerID: string;
+}
+export interface GetDisplayerResponse {
+    error: Error | undefined;
+    display: DisplayerConfig | undefined;
+}
+export interface GetStreamViewRequest {
+    viewID: string;
+}
+export interface GetStreamViewResponse {
+    error: Error | undefined;
+    select: SelectColumn[];
+    where: WhereGroup1[];
+}
+export interface GetStreamViewRownumResponse {
+    error: Error | undefined;
+    rownum: number;
+}
+export interface StreamViewQueryRequest {
+    viewID: string;
+    schedule: string;
+    select: string[];
+    where: WhereGroup[];
+}
+export interface QueryResponse {
+    error: Error | undefined;
+    nextCursor: string;
+    dataformID: string;
+    celldatas: RowData[];
+    columns: string[];
+}
+export interface DataformQueryRequest {
+    dataformID: string;
+    cursor: string;
+}
+export interface ConnectorService {
+    ListDisplayers(request: ListDisplayersRequest, metadata?: Metadata): Observable<ListDisplayersResponse>;
+    GetDisplayer(request: GetDisplayerRequest, metadata?: Metadata): Observable<GetDisplayerResponse>;
+    GetStreamView(request: GetStreamViewRequest, metadata?: Metadata): Observable<GetStreamViewResponse>;
+    GetStreamViewRownum(request: StreamViewQueryRequest, metadata?: Metadata): Observable<GetStreamViewRownumResponse>;
+    StreamViewPreview(request: StreamViewQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
+    StreamViewQuery(request: StreamViewQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
+    DataformQuery(request: DataformQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
+}

package/lib/types/ts/v1/exchange.d.ts

@@ -0,0 +1,83 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+import type { Error } from "../univer/constants/errors";
+import type { UniverType } from "../univer/constants/univer";
+import type { Snapshot } from "../univer/snapshot";
+import type { SheetBlock } from "../univer/workbook";
+export declare const protobufPackage = "universer.v1";
+export declare enum ImportOutputType {
+    UNDEFINED = 0,
+    /** UNIT - Import to univer unit, unit is store in the database */
+    UNIT = 1,
+    /** JSON - Import and convert to a json file which represents a univer unit, not store in the database */
+    JSON = 2,
+    UNRECOGNIZED = -1
+}
+export interface ImportRequest {
+    fileID: string;
+    type: UniverType;
+    outputType: ImportOutputType;
+    /** not supported yet */
+    fileUrl: string;
+}
+export interface ImportResponse {
+    error: Error | undefined;
+    taskID: string;
+}
+export interface ExportRequest {
+    /** if unitID is specified, the input is the unit in the database */
+    unitID: string;
+    /** if jsonID is specified, the input is the json file which represents a univer unit */
+    jsonID: string;
+    type: UniverType;
+}
+export interface ExportResponse {
+    error: Error | undefined;
+    taskID: string;
+}
+export interface GetTaskRequest {
+    taskID: string;
+}
+export interface GetTaskResponse {
+    error: Error | undefined;
+    taskID: string;
+    status: string;
+    import?: ImportTaskResult | undefined;
+    export?: ExportTaskResult | undefined;
+}
+export interface ImportTaskResult {
+    outputType: ImportOutputType;
+    unitID: string;
+    jsonID: string;
+}
+export interface ExportTaskResult {
+    fileID: string;
+    fileUrl: string;
+}
+export interface UpdateTaskRequest {
+    taskID: string;
+    status: string;
+    data: Uint8Array;
+}
+export interface UpdateTaskResponse {
+    error: Error | undefined;
+}
+/** The json file which represents a univer unit */
+export interface UniverFileInJsonFmt {
+    /** TODO: need to consider more than one snapshot in a univer file */
+    snapshot: Snapshot | undefined;
+    /** key is the sheetID, value is the sheet block */
+    sheetBlocks: {
+        [key: string]: SheetBlock;
+    };
+}
+export interface UniverFileInJsonFmt_SheetBlocksEntry {
+    key: string;
+    value: SheetBlock | undefined;
+}
+export interface ExchangeService {
+    Import(request: ImportRequest, metadata?: Metadata): Observable<ImportResponse>;
+    Export(request: ExportRequest, metadata?: Metadata): Observable<ExportResponse>;
+    GetTask(request: GetTaskRequest, metadata?: Metadata): Observable<GetTaskResponse>;
+    UpdateTask(request: UpdateTaskRequest, metadata?: Metadata): Observable<UpdateTaskResponse>;
+}

package/lib/types/ts/v1/file.d.ts

@@ -0,0 +1,14 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+import type { Error } from "../univer/constants/errors";
+export declare const protobufPackage = "universer.v1";
+export interface SignUrlRequest {
+    fileID: string;
+}
+export interface SignUrlResponse {
+    error: Error | undefined;
+    url: string;
+}
+export interface FileService {
+    SignUrl(request: SignUrlRequest, metadata?: Metadata): Observable<SignUrlResponse>;
+}

package/lib/types/ts/v1/snapshot.d.ts

@@ -0,0 +1,130 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+import type { Changeset } from "../univer/changeset";
+import type { Error } from "../univer/constants/errors";
+import type { UniverType } from "../univer/constants/univer";
+import type { Resource } from "../univer/resource";
+import type { Snapshot } from "../univer/snapshot";
+import type { CustomCellTemplate } from "../univer/unit_template";
+import type { SheetBlock } from "../univer/workbook";
+export declare const protobufPackage = "universer.v1";
+export interface EnsureSnapshotRequest {
+    unitID: string;
+    type: UniverType;
+    revision: number;
+}
+export interface EnsureSnapshotResponse {
+    error: Error | undefined;
+    snapshot: Snapshot | undefined;
+}
+export interface CreateUnitRequest {
+    type: UniverType;
+    name: string;
+    creator: string;
+    locale: string;
+    snapshot: Snapshot | undefined;
+    templateID: string;
+    customCell?: CustomCellTemplate | undefined;
+}
+export interface CreateUnitResponse {
+    error: Error | undefined;
+    unitID: string;
+}
+export interface SaveChangesetRequest {
+    changeset: Changeset | undefined;
+    type: UniverType;
+}
+export interface SaveChangesetResponse {
+    error: Error | undefined;
+    /** concurrent is the changesets need to follow up. */
+    concurrent: Changeset[];
+}
+export interface FetchMissingChangesetsRequest {
+    /** unitID of the Univer document */
+    unitID: string;
+    type: UniverType;
+    /** exclude from revision, will return (from, latest] */
+    from: number;
+    /** include to revision, if to == 0 , will return (from, +inf] */
+    to: number;
+}
+export interface FetchMissingChangesetsResponse {
+    error: Error | undefined;
+    changesets: Changeset[];
+}
+export interface SaveSnapshotRequest {
+    unitID: string;
+    type: UniverType;
+    snapshot: Snapshot | undefined;
+}
+export interface SaveSnapshotResponse {
+    error: Error | undefined;
+}
+export interface GetSnapshotRequest {
+    unitID: string;
+    type: UniverType;
+    revision: number;
+}
+export interface GetSnapshotResponse {
+    error: Error | undefined;
+    snapshot: Snapshot | undefined;
+}
+export interface GetUnitOnRevRequest {
+    unitID: string;
+    type: UniverType;
+    revision: number;
+}
+export interface GetUnitOnRevResponse {
+    error: Error | undefined;
+    /** the snapshot closest to revision */
+    snapshot: Snapshot | undefined;
+    /** the changesets need to follow up */
+    changesets: Changeset[];
+}
+export interface SaveSheetBlockRequest {
+    unitID: string;
+    type: UniverType;
+    block: SheetBlock | undefined;
+}
+export interface SaveSheetBlockResponse {
+    error: Error | undefined;
+    blockID: string;
+}
+export interface GetSheetBlockRequest {
+    unitID: string;
+    type: UniverType;
+    /** string sheetID = 3; */
+    blockID: string;
+}
+export interface GetSheetBlockResponse {
+    error: Error | undefined;
+    block: SheetBlock | undefined;
+}
+export interface GetResourcesRequest {
+    unitID: string;
+    type: UniverType;
+    resourceIDs: string[];
+}
+export interface GetResourcesResponse {
+    error: Error | undefined;
+    /** key is resource id */
+    resources: {
+        [key: string]: Resource;
+    };
+}
+export interface GetResourcesResponse_ResourcesEntry {
+    key: string;
+    value: Resource | undefined;
+}
+export interface SnapshotService {
+    CreateUnit(request: CreateUnitRequest, metadata?: Metadata): Observable<CreateUnitResponse>;
+    SaveChangeset(request: SaveChangesetRequest, metadata?: Metadata): Observable<SaveChangesetResponse>;
+    FetchMissingChangesets(request: FetchMissingChangesetsRequest, metadata?: Metadata): Observable<FetchMissingChangesetsResponse>;
+    SaveSnapshot(request: SaveSnapshotRequest, metadata?: Metadata): Observable<SaveSnapshotResponse>;
+    GetSnapshot(request: GetSnapshotRequest, metadata?: Metadata): Observable<GetSnapshotResponse>;
+    SaveSheetBlock(request: SaveSheetBlockRequest, metadata?: Metadata): Observable<SaveSheetBlockResponse>;
+    GetSheetBlock(request: GetSheetBlockRequest, metadata?: Metadata): Observable<GetSheetBlockResponse>;
+    GetUnitOnRev(request: GetUnitOnRevRequest, metadata?: Metadata): Observable<GetUnitOnRevResponse>;
+    GetResources(request: GetResourcesRequest, metadata?: Metadata): Observable<GetResourcesResponse>;
+    EnsureSnapshot(request: EnsureSnapshotRequest, metadata?: Metadata): Observable<EnsureSnapshotResponse>;
+}

package/lib/types/ts/v1/source_connector/api.d.ts

@@ -0,0 +1,110 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface ModelConnector {
+    uuid: string;
+    config: string;
+    name: string;
+}
+export interface ModelStreamView {
+    uuid: string;
+    config: string;
+    name: string;
+}
+export interface ModelDisplayer {
+    uuid: string;
+    config: string;
+    name: string;
+}
+export interface CreateConnectorRequest {
+    config: string;
+    name: string;
+}
+export interface CreateConnectorResponse {
+}
+export interface ListConnectorsRequest {
+    all: boolean;
+    uuids: string[];
+}
+export interface ListConnectorsResponse {
+    connectors: ModelConnector[];
+}
+export interface UpdateConnectorRequest {
+    uuid: string;
+    config: string;
+    name: string;
+}
+export interface UpdateConnectorResponse {
+}
+export interface DeleteConnectorRequest {
+    uuid: string;
+}
+export interface DeleteConnectorResponse {
+}
+export interface CreateStreamViewRequest {
+    config: string;
+}
+export interface CreateStreamViewResponse {
+}
+export interface ListStreamViewsRequest {
+    all: boolean;
+    uuids: string[];
+}
+export interface ListStreamViewsResponse {
+    streamViews: ModelStreamView[];
+}
+export interface UpdateStreamViewRequest {
+    uuid: string;
+    config: string;
+}
+export interface UpdateStreamViewResponse {
+}
+export interface DeleteStreamViewRequest {
+    uuid: string;
+}
+export interface DeleteStreamViewResponse {
+}
+export interface StreamViewTestRequest {
+    config: string;
+}
+export interface StreamViewTestResponse {
+    result: string;
+}
+export interface CreateDisplayerRequest {
+    config: string;
+}
+export interface CreateDisplayerResponse {
+}
+export interface ListDisplayersRequest {
+    all: boolean;
+    uuids: string[];
+}
+export interface ListDisplayersResponse {
+    displayers: ModelDisplayer[];
+}
+export interface UpdateDisplayerRequest {
+    uuid: string;
+    config: string;
+}
+export interface UpdateDisplayerResponse {
+}
+export interface DeleteDisplayerRequest {
+    uuid: string;
+}
+export interface DeleteDisplayerResponse {
+}
+export interface ConnectorService {
+    CreateConnector(request: CreateConnectorRequest, metadata?: Metadata): Observable<CreateConnectorResponse>;
+    ListConnectors(request: ListConnectorsRequest, metadata?: Metadata): Observable<ListConnectorsResponse>;
+    UpdateConnector(request: UpdateConnectorRequest, metadata?: Metadata): Observable<UpdateConnectorResponse>;
+    DeleteConnector(request: DeleteConnectorRequest, metadata?: Metadata): Observable<DeleteConnectorResponse>;
+    CreateStreamView(request: CreateStreamViewRequest, metadata?: Metadata): Observable<CreateStreamViewResponse>;
+    ListStreamViews(request: ListStreamViewsRequest, metadata?: Metadata): Observable<ListStreamViewsResponse>;
+    UpdateStreamView(request: UpdateStreamViewRequest, metadata?: Metadata): Observable<UpdateStreamViewResponse>;
+    DeleteStreamView(request: DeleteStreamViewRequest, metadata?: Metadata): Observable<DeleteStreamViewResponse>;
+    StreamViewTest(request: StreamViewTestRequest, metadata?: Metadata): Observable<StreamViewTestResponse>;
+    CreateDisplayer(request: CreateDisplayerRequest, metadata?: Metadata): Observable<CreateDisplayerResponse>;
+    ListDisplayers(request: ListDisplayersRequest, metadata?: Metadata): Observable<ListDisplayersResponse>;
+    UpdateDisplayer(request: UpdateDisplayerRequest, metadata?: Metadata): Observable<UpdateDisplayerResponse>;
+    DeleteDisplayer(request: DeleteDisplayerRequest, metadata?: Metadata): Observable<DeleteDisplayerResponse>;
+}

package/lib/types/ts/v1/source_connector/conf.d.ts

@@ -0,0 +1,29 @@
+import type { Airtable, BigQuery, GoogleSheet, Mysql, Notion, Postgresql, Salesforce, SpacexApi } from "./source";
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface ConnectorConfig {
+    connector: Connector | undefined;
+    streams: Stream[];
+}
+export interface Connector {
+    type: string;
+    schedule: string;
+    postgresql?: Postgresql | undefined;
+    mysql?: Mysql | undefined;
+    airtable?: Airtable | undefined;
+    googleSheet?: GoogleSheet | undefined;
+    salesforce?: Salesforce | undefined;
+    notion?: Notion | undefined;
+    bigquery?: BigQuery | undefined;
+    spacexApi?: SpacexApi | undefined;
+}
+export interface StreamSchema {
+    name: string;
+    displayName: string;
+    type: string;
+    value: string[];
+}
+export interface Stream {
+    name: string;
+    displayName: string;
+    schema: StreamSchema[];
+}

package/lib/types/ts/v1/source_connector/displayer.d.ts

@@ -0,0 +1,16 @@
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface DisplayerConfig {
+    type: string;
+    name: string;
+    uuid: string;
+    nodes: Node[];
+}
+export interface Node {
+    name: string;
+    child: Node[];
+    views: View[];
+}
+export interface View {
+    viewID: string;
+    name: string;
+}

package/lib/types/ts/v1/source_connector/source.d.ts

@@ -0,0 +1,46 @@
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface Postgresql {
+    host: string;
+    port: number;
+    schema: string;
+    database: string;
+    username: string;
+    password: string;
+    replicationMethod: Postgresql_ReplicationMethod | undefined;
+}
+export interface Postgresql_ReplicationMethod {
+    method: string;
+    replicationSlot: string;
+    publication: string;
+}
+export interface Mysql {
+    host: string;
+    port: number;
+    database: string;
+    username: string;
+    password: string;
+}
+export interface Airtable {
+    token: string;
+}
+export interface GoogleSheet {
+    sheetShareUrl: string;
+    serviceAccountInfo: string;
+}
+export interface Salesforce {
+    clientID: string;
+    clientSecret: string;
+    refreshToken: string;
+}
+export interface Notion {
+    token: string;
+}
+export interface BigQuery {
+    projectID: string;
+    datasetID: string;
+    credentialsJson: string;
+}
+export interface SpacexApi {
+    clientID: string;
+    options: string;
+}