@univerjs/protocol 0.1.33-alpha.0 → 0.1.34

package/lib/cjs/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var N=(E=>(E[E.UNDEFINED=0]="UNDEFINED",E[E.OK=1]="OK",E[E.INTERNAL_ERROR=2]="INTERNAL_ERROR",E[E.PERMISSION_DENIED=3]="PERMISSION_DENIED",E[E.NOT_FOUND=4]="NOT_FOUND",E[E.UNAUTHENTICATED=5]="UNAUTHENTICATED",E[E.ALREADY_EXISTS=6]="ALREADY_EXISTS",E[E.INVALID_ARGUMENT=7]="INVALID_ARGUMENT",E[E.TOO_MANY_REQUESTS=8]="TOO_MANY_REQUESTS",E[E.CHANGESET_REVISION_CONFILICT=5001]="CHANGESET_REVISION_CONFILICT",E[E.SNAPSHOT_INVALID_SNAPSHOT=6001]="SNAPSHOT_INVALID_SNAPSHOT",E[E.APPLY_REJECT=7001]="APPLY_REJECT",E[E.APPLY_NON_SEQUENTIAL_REVISION=7002]="APPLY_NON_SEQUENTIAL_REVISION",E[E.APPLY_REVISION_CONFILICT=7003]="APPLY_REVISION_CONFILICT",E[E.APPLY_PERMISSION_DENIED=7004]="APPLY_PERMISSION_DENIED",E[E.CONNECTOR_DATA_TOO_LARGE=8001]="CONNECTOR_DATA_TOO_LARGE",E[E.LICENSE_MAX_UNITS_EXCEEDED=9001]="LICENSE_MAX_UNITS_EXCEEDED",E[E.LICENSE_MAX_MEMBERS_PER_UNIT_EXCEEDED=9002]="LICENSE_MAX_MEMBERS_PER_UNIT_EXCEEDED",E[E.LICENSE_IMPORT_SIZE_EXCEEDED=9003]="LICENSE_IMPORT_SIZE_EXCEEDED",E[E.LICENSE_EXPORT_SIZE_EXCEEDED=9004]="LICENSE_EXPORT_SIZE_EXCEEDED",E[E.LICENSE_DISTRO_REJECTED=9005]="LICENSE_DISTRO_REJECTED",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(N||{});function T(E){return!!(E&&E.code&&E.code!==N.OK&&E.code!=="OK")}var I=(E=>(E[E.UNIVER_UNKNOWN=0]="UNIVER_UNKNOWN",E[E.UNIVER_DOC=1]="UNIVER_DOC",E[E.UNIVER_SHEET=2]="UNIVER_SHEET",E[E.UNIVER_SLIDE=3]="UNIVER_SLIDE",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(I||{}),S=(E=>(E[E.UNKNOWN=0]="UNKNOWN",E[E.STRING=1]="STRING",E[E.NUMBER=2]="NUMBER",E[E.BOOLEAN=3]="BOOLEAN",E[E.FORCE_STRING=4]="FORCE_STRING",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(S||{}),e=(E=>(E[E.UNKNOWN_CMD=0]="UNKNOWN_CMD",E[E.HELLO=1]="HELLO",E[E.JOIN=2]="JOIN",E[E.LEAVE=3]="LEAVE",E[E.INGEST=4]="INGEST",E[E.HEARTBEAT=5]="HEARTBEAT",E[E.RECV=6]="RECV",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(e||{}),_=(E=>(E[E.UNKNOWN_CODE=0]="UNKNOWN_CODE",E[E.OK=1]="OK",E[E.FAIL=2]="FAIL",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(_||{}),R=(E=>(E[E.View=0]="View",E[E.Edit=1]="Edit",E[E.ManageCollaborator=2]="ManageCollaborator",E[E.Print=3]="Print",E[E.Duplicate=4]="Duplicate",E[E.Comment=5]="Comment",E[E.Copy=6]="Copy",E[E.Share=7]="Share",E[E.Export=8]="Export",E[E.MoveWorksheet=9]="MoveWorksheet",E[E.DeleteWorksheet=10]="DeleteWorksheet",E[E.HideWorksheet=11]="HideWorksheet",E[E.RenameWorksheet=12]="RenameWorksheet",E[E.CreateWorksheet=13]="CreateWorksheet",E[E.SetWorksheetStyle=14]="SetWorksheetStyle",E[E.EditWorksheetCell=15]="EditWorksheetCell",E[E.InsertHyperlink=16]="InsertHyperlink",E[E.Sort=17]="Sort",E[E.Filter=18]="Filter",E[E.PivotTable=19]="PivotTable",E[E.FloatImg=20]="FloatImg",E[E.History=21]="History",E[E.RwHgtClWdt=22]="RwHgtClWdt",E[E.ViemRwHgtClWdt=23]="ViemRwHgtClWdt",E[E.ViewFilter=24]="ViewFilter",E[E.MoveSheet=25]="MoveSheet",E[E.DeleteSheet=26]="DeleteSheet",E[E.HideSheet=27]="HideSheet",E[E.CopySheet=28]="CopySheet",E[E.RenameSheet=29]="RenameSheet",E[E.CreateSheet=30]="CreateSheet",E[E.SelectProtectedCells=31]="SelectProtectedCells",E[E.SelectUnProtectedCells=32]="SelectUnProtectedCells",E[E.SetCellStyle=33]="SetCellStyle",E[E.SetCellValue=34]="SetCellValue",E[E.SetRowStyle=35]="SetRowStyle",E[E.SetColumnStyle=36]="SetColumnStyle",E[E.InsertRow=37]="InsertRow",E[E.InsertColumn=38]="InsertColumn",E[E.DeleteRow=39]="DeleteRow",E[E.DeleteColumn=40]="DeleteColumn",E[E.EditExtraObject=41]="EditExtraObject",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(R||{}),O=(E=>(E[E.Reader=0]="Reader",E[E.Editor=1]="Editor",E[E.Owner=2]="Owner",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(O||{}),D=(E=>(E[E.Unkonwn=0]="Unkonwn",E[E.Workbook=1]="Workbook",E[E.Worksheet=2]="Worksheet",E[E.SelectRange=3]="SelectRange",E[E.Document=4]="Document",E[E.Slide=5]="Slide",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(D||{});exports.CellValueType=S;exports.CmdRspCode=_;exports.CombCmd=e;exports.ErrorCode=N;exports.UnitAction=R;exports.UnitObject=D;exports.UnitRole=O;exports.UniverType=I;exports.isError=T;

package/lib/es/index.js

@@ -0,0 +1,16 @@
+var N = /* @__PURE__ */ ((E) => (E[E.UNDEFINED = 0] = "UNDEFINED", E[E.OK = 1] = "OK", E[E.INTERNAL_ERROR = 2] = "INTERNAL_ERROR", E[E.PERMISSION_DENIED = 3] = "PERMISSION_DENIED", E[E.NOT_FOUND = 4] = "NOT_FOUND", E[E.UNAUTHENTICATED = 5] = "UNAUTHENTICATED", E[E.ALREADY_EXISTS = 6] = "ALREADY_EXISTS", E[E.INVALID_ARGUMENT = 7] = "INVALID_ARGUMENT", E[E.TOO_MANY_REQUESTS = 8] = "TOO_MANY_REQUESTS", E[E.CHANGESET_REVISION_CONFILICT = 5001] = "CHANGESET_REVISION_CONFILICT", E[E.SNAPSHOT_INVALID_SNAPSHOT = 6001] = "SNAPSHOT_INVALID_SNAPSHOT", E[E.APPLY_REJECT = 7001] = "APPLY_REJECT", E[E.APPLY_NON_SEQUENTIAL_REVISION = 7002] = "APPLY_NON_SEQUENTIAL_REVISION", E[E.APPLY_REVISION_CONFILICT = 7003] = "APPLY_REVISION_CONFILICT", E[E.APPLY_PERMISSION_DENIED = 7004] = "APPLY_PERMISSION_DENIED", E[E.CONNECTOR_DATA_TOO_LARGE = 8001] = "CONNECTOR_DATA_TOO_LARGE", E[E.LICENSE_MAX_UNITS_EXCEEDED = 9001] = "LICENSE_MAX_UNITS_EXCEEDED", E[E.LICENSE_MAX_MEMBERS_PER_UNIT_EXCEEDED = 9002] = "LICENSE_MAX_MEMBERS_PER_UNIT_EXCEEDED", E[E.LICENSE_IMPORT_SIZE_EXCEEDED = 9003] = "LICENSE_IMPORT_SIZE_EXCEEDED", E[E.LICENSE_EXPORT_SIZE_EXCEEDED = 9004] = "LICENSE_EXPORT_SIZE_EXCEEDED", E[E.LICENSE_DISTRO_REJECTED = 9005] = "LICENSE_DISTRO_REJECTED", E[E.UNRECOGNIZED = -1] = "UNRECOGNIZED", E))(N || {});
+function L(E) {
+  return !!(E && E.code && E.code !== N.OK && E.code !== "OK");
+}
+var I = /* @__PURE__ */ ((E) => (E[E.UNIVER_UNKNOWN = 0] = "UNIVER_UNKNOWN", E[E.UNIVER_DOC = 1] = "UNIVER_DOC", E[E.UNIVER_SHEET = 2] = "UNIVER_SHEET", E[E.UNIVER_SLIDE = 3] = "UNIVER_SLIDE", E[E.UNRECOGNIZED = -1] = "UNRECOGNIZED", E))(I || {}), S = /* @__PURE__ */ ((E) => (E[E.UNKNOWN = 0] = "UNKNOWN", E[E.STRING = 1] = "STRING", E[E.NUMBER = 2] = "NUMBER", E[E.BOOLEAN = 3] = "BOOLEAN", E[E.FORCE_STRING = 4] = "FORCE_STRING", E[E.UNRECOGNIZED = -1] = "UNRECOGNIZED", E))(S || {}), _ = /* @__PURE__ */ ((E) => (E[E.UNKNOWN_CMD = 0] = "UNKNOWN_CMD", E[E.HELLO = 1] = "HELLO", E[E.JOIN = 2] = "JOIN", E[E.LEAVE = 3] = "LEAVE", E[E.INGEST = 4] = "INGEST", E[E.HEARTBEAT = 5] = "HEARTBEAT", E[E.RECV = 6] = "RECV", E[E.UNRECOGNIZED = -1] = "UNRECOGNIZED", E))(_ || {}), e = /* @__PURE__ */ ((E) => (E[E.UNKNOWN_CODE = 0] = "UNKNOWN_CODE", E[E.OK = 1] = "OK", E[E.FAIL = 2] = "FAIL", E[E.UNRECOGNIZED = -1] = "UNRECOGNIZED", E))(e || {}), R = /* @__PURE__ */ ((E) => (E[E.View = 0] = "View", E[E.Edit = 1] = "Edit", E[E.ManageCollaborator = 2] = "ManageCollaborator", E[E.Print = 3] = "Print", E[E.Duplicate = 4] = "Duplicate", E[E.Comment = 5] = "Comment", E[E.Copy = 6] = "Copy", E[E.Share = 7] = "Share", E[E.Export = 8] = "Export", E[E.MoveWorksheet = 9] = "MoveWorksheet", E[E.DeleteWorksheet = 10] = "DeleteWorksheet", E[E.HideWorksheet = 11] = "HideWorksheet", E[E.RenameWorksheet = 12] = "RenameWorksheet", E[E.CreateWorksheet = 13] = "CreateWorksheet", E[E.SetWorksheetStyle = 14] = "SetWorksheetStyle", E[E.EditWorksheetCell = 15] = "EditWorksheetCell", E[E.InsertHyperlink = 16] = "InsertHyperlink", E[E.Sort = 17] = "Sort", E[E.Filter = 18] = "Filter", E[E.PivotTable = 19] = "PivotTable", E[E.FloatImg = 20] = "FloatImg", E[E.History = 21] = "History", E[E.RwHgtClWdt = 22] = "RwHgtClWdt", E[E.ViemRwHgtClWdt = 23] = "ViemRwHgtClWdt", E[E.ViewFilter = 24] = "ViewFilter", E[E.MoveSheet = 25] = "MoveSheet", E[E.DeleteSheet = 26] = "DeleteSheet", E[E.HideSheet = 27] = "HideSheet", E[E.CopySheet = 28] = "CopySheet", E[E.RenameSheet = 29] = "RenameSheet", E[E.CreateSheet = 30] = "CreateSheet", E[E.SelectProtectedCells = 31] = "SelectProtectedCells", E[E.SelectUnProtectedCells = 32] = "SelectUnProtectedCells", E[E.SetCellStyle = 33] = "SetCellStyle", E[E.SetCellValue = 34] = "SetCellValue", E[E.SetRowStyle = 35] = "SetRowStyle", E[E.SetColumnStyle = 36] = "SetColumnStyle", E[E.InsertRow = 37] = "InsertRow", E[E.InsertColumn = 38] = "InsertColumn", E[E.DeleteRow = 39] = "DeleteRow", E[E.DeleteColumn = 40] = "DeleteColumn", E[E.EditExtraObject = 41] = "EditExtraObject", E[E.UNRECOGNIZED = -1] = "UNRECOGNIZED", E))(R || {}), D = /* @__PURE__ */ ((E) => (E[E.Reader = 0] = "Reader", E[E.Editor = 1] = "Editor", E[E.Owner = 2] = "Owner", E[E.UNRECOGNIZED = -1] = "UNRECOGNIZED", E))(D || {}), O = /* @__PURE__ */ ((E) => (E[E.Unkonwn = 0] = "Unkonwn", E[E.Workbook = 1] = "Workbook", E[E.Worksheet = 2] = "Worksheet", E[E.SelectRange = 3] = "SelectRange", E[E.Document = 4] = "Document", E[E.Slide = 5] = "Slide", E[E.UNRECOGNIZED = -1] = "UNRECOGNIZED", E))(O || {});
+export {
+  S as CellValueType,
+  e as CmdRspCode,
+  _ as CombCmd,
+  N as ErrorCode,
+  R as UnitAction,
+  O as UnitObject,
+  D as UnitRole,
+  I as UniverType,
+  L as isError
+};

package/lib/types/index.d.ts

@@ -0,0 +1,20 @@
+export { isError } from './utils';
+export type { Changeset as IChangeset, Mutation as IMutation, Command as ICommand } from './ts/univer/changeset';
+export { ErrorCode, type Error as IError } from './ts/univer/constants/errors';
+export { UniverType } from './ts/univer/constants/univer';
+export type { DocumentMeta as IDocumentMeta } from './ts/univer/doc';
+export type { Resource as IResource } from './ts/univer/resource';
+export type { Snapshot as ISnapshot } from './ts/univer/snapshot';
+export { CellValueType, type CellData as ICellData, type CellValue as ICellValue, type RowData as IRowData, type RowData_ItemsEntry as IRowDataItemsEntry, type SheetBlock as ISheetBlock, type SheetBlockMeta as ISheetBlockMeta, type WorkbookMeta as IWorkbookMeta, type WorkbookMeta_BlockMetaEntry as IWorkbookMeta_BlockMetaEntry, type WorkbookMeta_SheetsEntry as IWorkbookMeta_SheetsEntry, type WorksheetMeta as IWorksheetMeta, } from './ts/univer/workbook';
+export { type ApplyRequest as IApplyRequest, type ApplyResponse as IApplyResponse, type CreateUnitRequest as ICreateUnitRequest, type CreateUnitResponse as ICreateUnitResponse, type DisposeRequest as IDisposeRequest, type DisposeResponse as IDisposeResponse, type WorkbookCreateMeta as IWorkbookCreateMeta, type EnsureSnapshotRequest as IEnsureSnapshotRequest, type EnsureSnapshotResponse as IEnsureSnapshotResponse, type DirectWriteBody as IDirectWriteBody, type DirectWriteRequest as IDirectWriteRequest, type DirectWriteResponse as IDirectWriteResponse, } from './ts/v1/apply';
+export { CmdRspCode, CombCmd, type CombInfoResponse as ICombInfoResponse, type CombJoinInfo as ICombJoinInfo, type CombJoinRequest as ICombJoinRequest, type CombJoinResponse as ICombJoinResponse, type CombJoinResponse_RoomInfo as ICombJoinResponseRoomInfo, type CombJoinResponse_RoomInfosEntry as ICombJoinResponseRoomInfosEntry, type CombLeaveRequest as ICombLeaveRequest, type CombService as ICombService, type ConnectResponse as IConnectResponse, type Member as IMember, type NewChangesRequest as INewChangesRequest, type NewChangesResponse as INewChangesResponse, } from './ts/v1/comb';
+export { type FetchMissingChangesetsRequest as IFetchMissingChangesetsRequest, type FetchMissingChangesetsResponse as IFetchMissingChangesetsResponse, type GetResourcesRequest as IGetResourcesRequest, type GetResourcesResponse as IGetResourcesResponse, type GetSheetBlockRequest as IGetSheetBlockRequest, type GetSheetBlockResponse as IGetSheetBlockResponse, type GetSnapshotRequest as IGetSnapshotRequest, type GetSnapshotResponse as IGetSnapshotResponse, type GetUnitOnRevRequest as IGetUnitOnRevRequest, type GetUnitOnRevResponse as IGetUnitOnRevResponse, type SaveChangesetRequest as ISaveChangesetRequest, type SaveChangesetResponse as ISaveChangesetResponse, type SaveSheetBlockRequest as ISaveSheetBlockRequest, type SaveSheetBlockResponse as ISaveSheetBlockResponse, type SaveSnapshotRequest as ISaveSnapshotRequest, type SaveSnapshotResponse as ISaveSnapshotResponse, type UpdateUnitRequest as IUpdateUnitRequest, type UpdateUnitResponse as IUpdateUnitResponse, type SnapshotService as ISnapshotService, } from './ts/v1/snapshot';
+export { type CollaMsg as ICollaMsg, type CollaMsgJoin as ICollaMsgJoin, type CollaMsgLeave as ICollaMsgLeave, type UpdateCursor as IUpdateCursor, type LiveShareRequestHost as ILiveShareRequestHost, type LiveShareNewHost as ILiveShareNewHost, type LiveShareOperation as ILiveShareOperation, type LiveShareOperation_Operation as ILiveShareOperation_Operation, type LiveShareOperation_OperationsEntry as ILiveShareOperation_OperationsEntry, type LiveShareTerminate as ILiveShareTerminate, type CollaMsgErrorEvent as ICollaMsgErrorEvent, } from './ts/univer/colla_msg';
+export { type FileService as IFileService, type FileUploadMeta as IuploadFileRequestMeta, type FileUploadRequest as IFileUploadRequest, type UploadResponse as IUploadResponse, } from './ts/v1/file';
+export type { GetUserResponse as IGetUserResponse, User as IUser, GetUserRequest as IGetUserRequest } from './ts/v1/user';
+export type { Collaborator as ICollaborator, CreateRequest as ICreateRequest, CreateRequest_SelectRangeObject as ICreateRequest_SelectRangeObject, CreateRequest_WorksheetObject as ICreateRequest_WorksheetObject, CreateResponse as ICreateResponse, CreateCollaboratorRequest as ICreateCollaboratorRequest, CreateCollaboratorResponse as ICreateCollaboratorResponse, UpdateCollaboratorRequest as IUpdateCollaboratorRequest, UpdateCollaboratorResponse as IUpdateCollaboratorResponse, DeleteCollaboratorRequest as IDeleteCollaboratorRequest, DeleteCollaboratorResponse as IDeleteCollaboratorResponse, ListCollaboratorRequest as IListCollaboratorRequest, ListCollaboratorResponse as IListCollaboratorResponse, AllowedRequest as IAllowedRequest, ActionInfo as IActionInfo, AllowedResponse as IAllowedResponse, AuthzService as IAuthzService, BatchAllowedResponse as IBatchAllowedResponse, ListRolesResponse as IListRolesResponse, ListPermPointRequest as IListPermPointRequest, ListPermPointResponse as IListPermPointResponse, PermissionPoint as IPermissionPoint, ListRolesRequest as IListRolesRequest, UpdatePermPointRequest as IUpdatePermPointRequest, UpdatePermPointResponse as IUpdatePermPointResponse, PutCollaboratorsRequest as IPutCollaboratorsRequest, PutCollaboratorsResponse as IPutCollaboratorsResponse, } from './ts/v1/authz';
+export type { UnitRoleKV as IUnitRoleKV, UnitPermissionStrategy as IUnitPermissionStrategy, } from './ts/univer/permission';
+export { UnitRole, UnitObject, UnitAction, } from './ts/univer/permission';
+export type { InitialSheet as IInitialSheet, Row as IRow, Row_Cell as IRow_Cell, } from './ts/univer/initial_sheet';
+export type { UrlContext as IUrlContext, UrlRowContext as IUrlRowContext, RangeCompletionRequest as IRangeCompletionRequest, RangeCompletionResponse as IRangeCOmpletionResponse, YuumiService as IYuumiService, } from './ts/yuumi/v1/yuumi';
+export type { SSRService as ISSRService, GetSSRRequest as IGetSSRRequest, GetSSRResponse as IGetSSRResponse, } from './ts/v1/ssr';

package/lib/types/ts/univer/changeset.d.ts

@@ -0,0 +1,26 @@
+import { type UniverType } from "./constants/univer";
+export declare const protobufPackage = "univer";
+/** It should be the same as `ICommandInfo` in the frontend. */
+export interface Mutation {
+    /** ID of the mutation */
+    id: string;
+    /** serialized params */
+    data: string;
+}
+/** It should be the same as `ICommand` in the frontend. */
+export interface Command {
+    /** ID of the command */
+    id: string;
+    /** serizlized params */
+    data: string;
+}
+export interface Changeset {
+    /** unitID of the Univer document */
+    unitID: string;
+    type: UniverType;
+    baseRev: number;
+    revision: number;
+    userID: string;
+    mutations: Mutation[];
+    memberID: string;
+}

package/lib/types/ts/univer/colla_msg.d.ts

@@ -0,0 +1,84 @@
+import { type Changeset } from "./changeset";
+export declare const protobufPackage = "univer";
+export interface CollaMsg {
+    eventID: string;
+    joinEvent?: CollaMsgJoin | undefined;
+    leaveEvent?: CollaMsgLeave | undefined;
+    newCsEvent?: NewChangesets | undefined;
+    csAckEvent?: ChangesetAck | undefined;
+    csRejEvent?: ChangesetRej | undefined;
+    updateCursorEvent?: UpdateCursor | undefined;
+    liveShareRequestHost?: LiveShareRequestHost | undefined;
+    liveShareNewHost?: LiveShareNewHost | undefined;
+    liveShareOperation?: LiveShareOperation | undefined;
+    liveShareTerminate?: LiveShareTerminate | undefined;
+    errorEvent?: CollaMsgErrorEvent | undefined;
+    permissionRejEvent?: PermissionRej | undefined;
+}
+export interface CollaMsgJoin {
+    memberID: string;
+    name: string;
+    avatar: string;
+}
+export interface CollaMsgLeave {
+    memberID: string;
+    name: string;
+}
+export interface NewChangesets {
+    cs: Changeset | undefined;
+}
+export interface ChangesetAck {
+    cs: Changeset | undefined;
+}
+export interface ChangesetRej {
+    cs: Changeset | undefined;
+}
+export interface UpdateCursor {
+    unitID: string;
+    /**
+     * Member ID of the user in the collaboration session.
+     * If a user open a document multi times, there will be different memberIDs.
+     */
+    memberID: string;
+    selection: string;
+}
+export interface LiveShareRequestHost {
+    unitID: string;
+    userID: string;
+}
+export interface LiveShareNewHost {
+    presenter: string;
+    unitID: string;
+    userID: string;
+}
+export interface LiveShareOperation {
+    unitID: string;
+    presenter: string;
+    /** key is Operation.id */
+    operations: {
+        [key: string]: LiveShareOperation_Operation;
+    };
+}
+export interface LiveShareOperation_Operation {
+    id: string;
+    params?: string | undefined;
+}
+export interface LiveShareOperation_OperationsEntry {
+    key: string;
+    value: LiveShareOperation_Operation | undefined;
+}
+export interface LiveShareTerminate {
+    unitID: string;
+}
+/** define msg for errors */
+export interface CollaMsgErrorEvent {
+    code: number;
+    reason: string;
+}
+export interface PermissionRej {
+    cs: Changeset | undefined;
+}
+export interface UpdateUnit {
+    name: string;
+    unitId: string;
+}

package/lib/types/ts/univer/constants/errors.d.ts

@@ -0,0 +1,39 @@
+export declare const protobufPackage = "univer.constants";
+export declare enum ErrorCode {
+    /** UNDEFINED - general codes */
+    UNDEFINED = 0,
+    OK = 1,
+    INTERNAL_ERROR = 2,
+    PERMISSION_DENIED = 3,
+    NOT_FOUND = 4,
+    UNAUTHENTICATED = 5,
+    ALREADY_EXISTS = 6,
+    INVALID_ARGUMENT = 7,
+    TOO_MANY_REQUESTS = 8,
+    /** CHANGESET_REVISION_CONFILICT - changeset codes with 5000 shift */
+    CHANGESET_REVISION_CONFILICT = 5001,
+    /** SNAPSHOT_INVALID_SNAPSHOT - snapshotError codes with 6000 shift */
+    SNAPSHOT_INVALID_SNAPSHOT = 6001,
+    /** APPLY_REJECT - apply service codes with 7000 shift */
+    APPLY_REJECT = 7001,
+    /** APPLY_NON_SEQUENTIAL_REVISION - apply service expects sequential revisions, otherwise return this code */
+    APPLY_NON_SEQUENTIAL_REVISION = 7002,
+    /** APPLY_REVISION_CONFILICT - save changeset failed because of revision exists */
+    APPLY_REVISION_CONFILICT = 7003,
+    /** APPLY_PERMISSION_DENIED - apply failed because of the user permission denied */
+    APPLY_PERMISSION_DENIED = 7004,
+    /** CONNECTOR_DATA_TOO_LARGE - connector codes with 8000 shift */
+    CONNECTOR_DATA_TOO_LARGE = 8001,
+    /** LICENSE_MAX_UNITS_EXCEEDED - license code with 9000 shift */
+    LICENSE_MAX_UNITS_EXCEEDED = 9001,
+    LICENSE_MAX_MEMBERS_PER_UNIT_EXCEEDED = 9002,
+    LICENSE_IMPORT_SIZE_EXCEEDED = 9003,
+    LICENSE_EXPORT_SIZE_EXCEEDED = 9004,
+    /** LICENSE_DISTRO_REJECTED - the feature not allowed for the distro */
+    LICENSE_DISTRO_REJECTED = 9005,
+    UNRECOGNIZED = -1
+}
+export interface Error {
+    code: ErrorCode;
+    message: string;
+}

package/lib/types/ts/univer/constants/univer.d.ts

@@ -0,0 +1,8 @@
+export declare const protobufPackage = "univer.constants";
+export declare enum UniverType {
+    UNIVER_UNKNOWN = 0,
+    UNIVER_DOC = 1,
+    UNIVER_SHEET = 2,
+    UNIVER_SLIDE = 3,
+    UNRECOGNIZED = -1
+}

package/lib/types/ts/univer/doc.d.ts

@@ -0,0 +1,12 @@
+import { type Resource } from "./resource";
+export declare const protobufPackage = "univer";
+export interface DocumentMeta {
+    unitID: string;
+    rev: number;
+    creator: string;
+    name: string;
+    /** The key is sheet id */
+    resources: Resource[];
+    /** The original meta data in JSON format. */
+    originalMeta: Uint8Array;
+}

package/lib/types/ts/univer/drawing.d.ts

@@ -0,0 +1,7 @@
+export declare const protobufPackage = "univer";
+export interface DrawingMeta {
+    unitID: string;
+    name: string;
+    /** The original meta data in JSON format. */
+    originalMeta: Uint8Array;
+}

package/lib/types/ts/univer/initial_sheet.d.ts

@@ -0,0 +1,21 @@
+export declare const protobufPackage = "univer";
+export declare enum CellType {
+    UNDEFINED = 0,
+    TEXT = 1,
+    URL = 2,
+    IMAGE = 3,
+    UNRECOGNIZED = -1
+}
+export interface InitialSheet {
+    sheetName: string;
+    columnName: string[];
+    rows: Row[];
+}
+export interface Row {
+    cells: Row_Cell[];
+}
+export interface Row_Cell {
+    type: CellType;
+    text: string;
+    url: string;
+}

package/lib/types/ts/univer/permission.d.ts

@@ -0,0 +1,98 @@
+export declare const protobufPackage = "univer";
+export declare enum UnitAction {
+    View = 0,
+    Edit = 1,
+    ManageCollaborator = 2,
+    Print = 3,
+    /** Duplicate - create a copy */
+    Duplicate = 4,
+    Comment = 5,
+    Copy = 6,
+    Share = 7,
+    Export = 8,
+    /** @deprecated */
+    MoveWorksheet = 9,
+    /** @deprecated */
+    DeleteWorksheet = 10,
+    /** @deprecated */
+    HideWorksheet = 11,
+    /** @deprecated */
+    RenameWorksheet = 12,
+    /** @deprecated */
+    CreateWorksheet = 13,
+    /** @deprecated */
+    SetWorksheetStyle = 14,
+    /** @deprecated */
+    EditWorksheetCell = 15,
+    InsertHyperlink = 16,
+    Sort = 17,
+    Filter = 18,
+    PivotTable = 19,
+    /** @deprecated */
+    FloatImg = 20,
+    History = 21,
+    /**
+     * RwHgtClWdt - row height, column width
+     *
+     * @deprecated
+     */
+    RwHgtClWdt = 22,
+    /**
+     * ViemRwHgtClWdt - row height, column width in view mode
+     *
+     * @deprecated
+     */
+    ViemRwHgtClWdt = 23,
+    /**
+     * ViewFilter - filter in view mode
+     *
+     * @deprecated
+     */
+    ViewFilter = 24,
+    MoveSheet = 25,
+    DeleteSheet = 26,
+    HideSheet = 27,
+    CopySheet = 28,
+    RenameSheet = 29,
+    CreateSheet = 30,
+    SelectProtectedCells = 31,
+    SelectUnProtectedCells = 32,
+    SetCellStyle = 33,
+    SetCellValue = 34,
+    SetRowStyle = 35,
+    SetColumnStyle = 36,
+    InsertRow = 37,
+    InsertColumn = 38,
+    DeleteRow = 39,
+    DeleteColumn = 40,
+    EditExtraObject = 41,
+    UNRECOGNIZED = -1
+}
+export declare enum UnitRole {
+    Reader = 0,
+    Editor = 1,
+    Owner = 2,
+    UNRECOGNIZED = -1
+}
+export declare enum UnitObject {
+    Unkonwn = 0,
+    Workbook = 1,
+    Worksheet = 2,
+    SelectRange = 3,
+    Document = 4,
+    Slide = 5,
+    UNRECOGNIZED = -1
+}
+export interface UnitRoleKV {
+    role: UnitRole;
+    name: string;
+}
+export interface UnitPermissionStrategy {
+    role: UnitRole;
+    action: UnitAction;
+}
+export interface User {
+    userID: string;
+    name: string;
+    avatar: string;
+}

package/lib/types/ts/univer/resource.d.ts

@@ -0,0 +1,6 @@
+export declare const protobufPackage = "univer";
+export interface Resource {
+    id?: string | undefined;
+    name: string;
+    data: string;
+}

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

@@ -0,0 +1,12 @@
+import { type UniverType } from "./constants/univer";
+import { type DocumentMeta } from "./doc";
+import { type WorkbookMeta } from "./workbook";
+export declare const protobufPackage = "univer";
+export interface Snapshot {
+    /** unitID of the Univer document */
+    unitID: string;
+    type: UniverType;
+    rev: number;
+    workbook: WorkbookMeta | undefined;
+    doc: DocumentMeta | undefined;
+}

package/lib/types/ts/univer/unit_template.d.ts

@@ -0,0 +1,9 @@
+export declare const protobufPackage = "univer";
+/** CustomCellTemplate is the template used for make some drawing on sheet, like draw a cute mario XD. */
+export interface CustomCellTemplate {
+    rowCount: number;
+    colCount: number;
+    rowHeight: number;
+    colWidth: number;
+    showGridlines: number;
+}

package/lib/types/ts/univer/univer_file.d.ts

@@ -0,0 +1,33 @@
+import { type UniverType } from "./constants/univer";
+import { type DocumentMeta } from "./doc";
+import { type DrawingMeta } from "./drawing";
+import { type WorkbookMeta } from "./workbook";
+export declare const protobufPackage = "univer";
+export interface UniverFile {
+    univerID: string;
+    name: string;
+    /** key: unitID, value: unit */
+    units: {
+        [key: string]: Unit;
+    };
+    /** display the unit tree */
+    root: UnitTreeNode | undefined;
+}
+export interface UniverFile_UnitsEntry {
+    key: string;
+    value: Unit | undefined;
+}
+export interface Unit {
+    unitID: string;
+    name: string;
+    type: UniverType;
+    workbook?: WorkbookMeta | undefined;
+    document?: DocumentMeta | undefined;
+    drawing?: DrawingMeta | undefined;
+}
+export interface UnitTreeNode {
+    /** the leaf node */
+    unitIDs: string[];
+    /** the non-leaf node */
+    nodes: UnitTreeNode[];
+}

package/lib/types/ts/univer/workbook.d.ts

@@ -0,0 +1,112 @@
+import { type DocumentMeta } from "./doc";
+import { type Resource } from "./resource";
+export declare const protobufPackage = "univer";
+export declare enum CellValueType {
+    UNKNOWN = 0,
+    STRING = 1,
+    NUMBER = 2,
+    BOOLEAN = 3,
+    FORCE_STRING = 4,
+    UNRECOGNIZED = -1
+}
+export interface WorksheetMeta {
+    type: number;
+    id: string;
+    name: string;
+    rowCount: number;
+    columnCount: number;
+    /** The original meta data in JSON format. Cell data is excluded. */
+    originalMeta: Uint8Array;
+}
+export interface WorkbookMeta {
+    unitID: string;
+    rev: number;
+    creator: string;
+    name: string;
+    sheetOrder: string[];
+    /** The key is sheet id */
+    sheets: {
+        [key: string]: WorksheetMeta;
+    };
+    /**
+     * Questions:  should snapshot server read the celldata?
+     * map<string, univer.Resource> resources = 8; // The key is sheet id
+     */
+    resources: Resource[];
+    /** The key is sheet id */
+    blockMeta: {
+        [key: string]: SheetBlockMeta;
+    };
+    /** The original meta data in JSON format. Cell data is excluded. */
+    originalMeta: Uint8Array;
+}
+export interface WorkbookMeta_SheetsEntry {
+    key: string;
+    value: WorksheetMeta | undefined;
+}
+export interface WorkbookMeta_BlockMetaEntry {
+    key: string;
+    value: SheetBlockMeta | undefined;
+}
+/** import/export would use this message */
+export interface CellDataMatrix {
+    /** The key is the row number */
+    rows: {
+        [key: number]: RowData;
+    };
+}
+export interface CellDataMatrix_RowsEntry {
+    key: number;
+    value: RowData | undefined;
+}
+export interface RowData {
+    rowNumber: number;
+    /** The key is the column number */
+    items: {
+        [key: number]: CellItem;
+    };
+}
+export interface RowData_ItemsEntry {
+    key: number;
+    value: CellItem | undefined;
+}
+export interface CellItem {
+    cell?: CellData | undefined;
+    data?: SomeData | undefined;
+}
+export interface SomeData {
+    id: string;
+    name: string;
+}
+export interface CellValue {
+    strV?: string | undefined;
+    numV?: number | undefined;
+    boolV?: boolean | undefined;
+}
+/** Represents the data for a cell. */
+export interface CellData {
+    /** The value of the cell. */
+    v: CellValue | undefined;
+    /** The type of the cell value. */
+    t: CellValueType;
+    /** univer doc */
+    p: DocumentMeta | undefined;
+    /** style */
+    s: string;
+    /** formula */
+    f: string;
+    /** formula refId */
+    si: string;
+}
+export interface SheetBlock {
+    /** block id, generate by backend server */
+    id: string;
+    startRow: number;
+    endRow: number;
+    data: Uint8Array;
+}
+export interface SheetBlockMeta {
+    sheetID: string;
+    /** sheet block ids */
+    blocks: string[];
+}

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

@@ -0,0 +1,110 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+import { type Changeset, type Command, type Mutation } from "../univer/changeset";
+import { type Error } from "../univer/constants/errors";
+import { type UniverType } from "../univer/constants/univer";
+import { type InitialSheet } from "../univer/initial_sheet";
+import { type Snapshot } from "../univer/snapshot";
+import { type CustomCellTemplate } from "../univer/unit_template";
+export declare const protobufPackage = "univerpro.v1";
+/** The meta required to create a new unit. */
+export interface WorkbookCreateMeta {
+    /**
+     * If you want to create an empty sheet, make this undefined or a empty
+     * string.
+     */
+    templateID?: string | undefined;
+    /** Name of the unit. It should be localized. */
+    name: string;
+    /** Locale of the unit. */
+    locale: string;
+    customCell?: CustomCellTemplate | undefined;
+}
+export interface CreateUnitRequest {
+    unitID: string;
+    type: UniverType;
+    name: string;
+    creator: string;
+    /** If `type` is UniverType.UNIVER_SHEEET, this is requried. */
+    workbookMeta?: WorkbookCreateMeta | undefined;
+    /** Other meta for other types of univer. */
+    initialSheets: InitialSheet[];
+}
+export interface CreateUnitResponse {
+    error: Error | undefined;
+}
+/**
+ * ApplyRequest is almost the same as a Changeset.
+ * See `changeset.proto` for details.
+ */
+export interface ApplyRequest {
+    unitID: string;
+    type: UniverType;
+    /** changeset to apply */
+    changeset: Changeset | undefined;
+    /** changsetset to fast forward to, these cs has been applied to the document */
+    fastForward: Changeset[];
+}
+export interface ApplyResponse {
+    error: Error | undefined;
+    /** The revision of the document right now */
+    revision: number;
+}
+export interface DirectWriteRequest {
+    unitID: string;
+    type: UniverType;
+    body: DirectWriteBody | undefined;
+    userID: string;
+}
+export interface DirectWriteBody {
+    unitID: string;
+    type: UniverType;
+    userID: string;
+    commands: Command[];
+    mutations: Mutation[];
+}
+export interface DirectWriteResponse {
+    error: Error | undefined;
+    revision: number;
+}
+export interface DisposeRequest {
+    unitID: string;
+}
+export interface DisposeResponse {
+    error: Error | undefined;
+}
+export interface EnsureSnapshotRequest {
+    unitID: string;
+    type: UniverType;
+    revision: number;
+}
+export interface EnsureSnapshotResponse {
+    error: Error | undefined;
+    snapshot: Snapshot | undefined;
+}
+/**
+ * This service is used to apply changesets to a document.
+ * It is implements in Node.js. See `univer-pro/apps/univer-collaboration-server`.
+ */
+export interface ApplyService {
+    /**
+     * Create a unit with given meta.
+     * Apply service would save the snapshot to the snapshot service.
+     */
+    CreateUnit(request: CreateUnitRequest, metadata?: Metadata): Observable<CreateUnitResponse>;
+    /** Apply a changeset to he document. */
+    Apply(request: ApplyRequest, metadata?: Metadata): Observable<ApplyResponse>;
+    /** Directly write a changeset with a user's identification to the document. */
+    DirectWrite(request: DirectWriteRequest, metadata?: Metadata): Observable<DirectWriteResponse>;
+    /**
+     * Dispose a document from the server. It would help to free up some memory.
+     * Should be called when the last collaboration member leaves the room.
+     */
+    Dispose(request: DisposeRequest, metadata?: Metadata): Observable<DisposeResponse>;
+    /**
+     * Ensure the snapshot at a given number would be saved to the snapshot service.
+     * Normally used for exporting because the server written in Go
+     * cannot apply changesets.
+     */
+    EnsureSnapshot(request: EnsureSnapshotRequest, metadata?: Metadata): Observable<EnsureSnapshotResponse>;
+}

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

@@ -0,0 +1,170 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+import { type Error } from "../univer/constants/errors";
+import { type UnitAction, type UnitObject, type UnitPermissionStrategy, type UnitRole, type UnitRoleKV, type User } from "../univer/permission";
+export declare const protobufPackage = "universer.v1";
+export interface Collaborator {
+    id: string;
+    role: UnitRole;
+    subject: User | undefined;
+}
+export interface PermissionPoint {
+    objectID: string;
+    unitID: string;
+    objectType: UnitObject;
+    name: string;
+    shareOn: boolean;
+    shareRole: UnitRole;
+    creator: User | undefined;
+    strategies: UnitPermissionStrategy[];
+    actions: ActionInfo[];
+}
+export interface CreateRequest {
+    objectType: UnitObject;
+    selectRangeObject?: CreateRequest_SelectRangeObject | undefined;
+    worksheetObject?: CreateRequest_WorksheetObject | undefined;
+}
+export interface CreateRequest_SelectRangeObject {
+    collaborators: Collaborator[];
+    unitID: string;
+    name: string;
+}
+export interface CreateRequest_WorksheetObject {
+    collaborators: Collaborator[];
+    unitID: string;
+    name: string;
+    strategies: UnitPermissionStrategy[];
+}
+export interface CreateResponse {
+    error: Error | undefined;
+    objectID: string;
+}
+export interface UpdatePermPointRequest {
+    objectType: UnitObject;
+    objectID: string;
+    unitID: string;
+    share: UpdatePermPointRequest_Share | undefined;
+    name: string;
+    strategies: UnitPermissionStrategy[];
+}
+export interface UpdatePermPointRequest_Share {
+    on: boolean;
+    role: UnitRole;
+}
+export interface UpdatePermPointResponse {
+    error: Error | undefined;
+}
+export interface ListPermPointRequest {
+    unitID: string;
+    objectIDs: string[];
+    actions: UnitAction[];
+}
+export interface ListPermPointResponse {
+    error: Error | undefined;
+    objects: PermissionPoint[];
+}
+export interface CreateCollaboratorRequest {
+    objectID: string;
+    unitID: string;
+    collaborators: Collaborator[];
+}
+export interface CreateCollaboratorResponse {
+    error: Error | undefined;
+}
+export interface UpdateCollaboratorRequest {
+    objectID: string;
+    unitID: string;
+    collaborator: Collaborator | undefined;
+}
+export interface UpdateCollaboratorResponse {
+    error: Error | undefined;
+}
+export interface DeleteCollaboratorRequest {
+    objectID: string;
+    unitID: string;
+    collaboratorID: string;
+}
+export interface DeleteCollaboratorResponse {
+    error: Error | undefined;
+}
+export interface ListCollaboratorRequest {
+    objectID: string;
+    unitID: string;
+}
+export interface ListCollaboratorResponse {
+    error: Error | undefined;
+    collaborators: Collaborator[];
+}
+export interface PutCollaboratorsRequest {
+    objectID: string;
+    unitID: string;
+    collaborators: Collaborator[];
+}
+export interface PutCollaboratorsResponse {
+    error: Error | undefined;
+}
+export interface AllowedRequest {
+    objectID: string;
+    objectType: UnitObject;
+    unitID: string;
+    actions: UnitAction[];
+}
+export interface ActionInfo {
+    action: UnitAction;
+    allowed: boolean;
+}
+export interface AllowedResponse {
+    error: Error | undefined;
+    actions: ActionInfo[];
+}
+export interface BatchAllowedRequest {
+    requests: AllowedRequest[];
+}
+export interface ObjectActionInfo {
+    unitID: string;
+    objectID: string;
+    actions: ActionInfo[];
+}
+export interface BatchAllowedResponse {
+    error: Error | undefined;
+    objectActions: ObjectActionInfo[];
+}
+export interface ListRolesRequest {
+    objectType: UnitObject;
+}
+export interface ListRolesResponse {
+    error: Error | undefined;
+    roles: UnitRoleKV[];
+    actions: UnitAction[];
+}
+export interface AuthzService {
+    /** create a permission mount point for specified type of object */
+    Create(request: CreateRequest, metadata?: Metadata): Observable<CreateResponse>;
+    /**
+     * update a permission mount point
+     * selectrange and worksheet may not used if unit record the permission point in mutation by itself.
+     * workbook and document use it to set share mode.
+     */
+    Update(request: UpdatePermPointRequest, metadata?: Metadata): Observable<UpdatePermPointResponse>;
+    /**
+     * list all permission mount points for unit
+     * it may not used if unit record the permission point in mutation by itself
+     */
+    List(request: ListPermPointRequest, metadata?: Metadata): Observable<ListPermPointResponse>;
+    /** request a couple of actions, return the allowed actions */
+    Allowed(request: AllowedRequest, metadata?: Metadata): Observable<AllowedResponse>;
+    /** barch check if the actions are allowed */
+    BatchAllowed(request: BatchAllowedRequest, metadata?: Metadata): Observable<BatchAllowedResponse>;
+    /** list object roles for specified object */
+    ListRoles(request: ListRolesRequest, metadata?: Metadata): Observable<ListRolesResponse>;
+    /** new collaborator for specified object */
+    CreateCollaborator(request: CreateCollaboratorRequest, metadata?: Metadata): Observable<CreateCollaboratorResponse>;
+    /** list all collaborators for specified object */
+    ListCollaborators(request: ListCollaboratorRequest, metadata?: Metadata): Observable<ListCollaboratorResponse>;
+    /** update collaborator for specified object */
+    UpdateCollaborator(request: UpdateCollaboratorRequest, metadata?: Metadata): Observable<UpdateCollaboratorResponse>;
+    /** delete collaborator for specified object */
+    DeleteCollaborator(request: DeleteCollaboratorRequest, metadata?: Metadata): Observable<DeleteCollaboratorResponse>;
+    /** put collaborators for specified object */
+    PutCollaborators(request: PutCollaboratorsRequest, metadata?: Metadata): Observable<PutCollaboratorsResponse>;
+}

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

@@ -0,0 +1,110 @@
+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;
+    avatar?: string | undefined;
+}
+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/file.d.ts

@@ -0,0 +1,28 @@
+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 FileUploadMeta {
+    fileName: string;
+    fileHash: string;
+    fileSize: number;
+}
+export interface FileUploadRequest {
+    data?: Uint8Array | undefined;
+    meta?: FileUploadMeta | undefined;
+}
+export interface UploadResponse {
+    error: Error | undefined;
+    fileID: string;
+}
+export interface FileService {
+    SignUrl(request: SignUrlRequest, metadata?: Metadata): Observable<SignUrlResponse>;
+    Upload(request: Observable<FileUploadRequest>, metadata?: Metadata): Observable<UploadResponse>;
+}

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

@@ -0,0 +1,156 @@
+import { Metadata } from "@grpc/grpc-js";
+import { Observable } from "rxjs";
+import { type Changeset, type Command, type Mutation } from "../univer/changeset";
+import { type Error } from "../univer/constants/errors";
+import { type UniverType } from "../univer/constants/univer";
+import { type InitialSheet } from "../univer/initial_sheet";
+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 DirectWriteRequest {
+    unitID: string;
+    type: UniverType;
+    commands: Command[];
+    mutations: Mutation[];
+}
+export interface DirectWriteResponse {
+    error: Error | undefined;
+    revision: number;
+}
+export interface EnsureSnapshotRequest {
+    unitID: string;
+    type: UniverType;
+    revision: number;
+}
+export interface EnsureSnapshotResponse {
+    error: Error | undefined;
+    snapshot: Snapshot | undefined;
+}
+export interface UpdateUnitRequest {
+    type: UniverType;
+    unitId: string;
+    name: string;
+    memberId: string;
+}
+export interface UpdateUnitResponse {
+    error: Error | undefined;
+}
+export interface CreateUnitRequest {
+    type: UniverType;
+    name: string;
+    creator: string;
+    locale: string;
+    snapshot: Snapshot | undefined;
+    templateID: string;
+    customCell?: CustomCellTemplate | undefined;
+    initialSheets: InitialSheet[];
+}
+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;
+    /** no data */
+    block: SheetBlock | undefined;
+    fileID?: string | 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>;
+    UpdateUnit(request: UpdateUnitRequest, metadata?: Metadata): Observable<UpdateUnitResponse>;
+    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>;
+    /** Directly write a changeset with a user's identification to the document. */
+    DirectWrite(request: DirectWriteRequest, metadata?: Metadata): Observable<DirectWriteResponse>;
+}

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

@@ -0,0 +1,61 @@
+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 User {
+    userID: string;
+    name: string;
+    avatar: string;
+    anonymous: boolean;
+    canBindAnonymous: boolean;
+}
+export interface GetUserRequest {
+}
+export interface GetUserResponse {
+    error: Error | undefined;
+    user: User | undefined;
+}
+export interface AnonymousSignInRequest {
+    deviceID: string;
+}
+export interface AnonymousSignInResponse {
+    error: Error | undefined;
+    user: User | undefined;
+}
+export interface ListUsersRequest {
+    userIDs: string[];
+    query: ListUsersRequest_Query | undefined;
+}
+export interface ListUsersRequest_Query {
+    name: string;
+}
+export interface ListUsersResponse {
+    error: Error | undefined;
+    users: User[];
+}
+export interface LogoutRequest {
+}
+export interface LogoutResponse {
+    error: Error | undefined;
+}
+export interface TransformUserRequest {
+}
+export interface TransformUserResponse {
+    error: Error | undefined;
+}
+export interface VerifyCredentialRequest {
+    credential: string;
+}
+export interface VerifyCredentialResponse {
+    error: Error | undefined;
+    user: User | undefined;
+}
+export interface UserService {
+    GetUser(request: GetUserRequest, metadata?: Metadata): Observable<GetUserResponse>;
+    AnonymousSignIn(request: AnonymousSignInRequest, metadata?: Metadata): Observable<AnonymousSignInResponse>;
+    ListUsers(request: ListUsersRequest, metadata?: Metadata): Observable<ListUsersResponse>;
+    Logout(request: LogoutRequest, metadata?: Metadata): Observable<LogoutResponse>;
+    TransformUser(request: TransformUserRequest, metadata?: Metadata): Observable<TransformUserResponse>;
+    /** grpc only, for internal server */
+    VerifyCredential(request: VerifyCredentialRequest, metadata?: Metadata): Observable<VerifyCredentialResponse>;
+}

package/lib/types/utils.d.ts

@@ -0,0 +1,8 @@
+import type { Error } from './ts/univer/constants/errors';
+/**
+ * To examine if a response is an error.
+ *
+ * @param error error interface
+ * @returns if the response is an error
+ */
+export declare function isError(error?: Error): boolean;

package/lib/umd/index.js

@@ -0,0 +1 @@
+(function(N,I){typeof exports=="object"&&typeof module<"u"?I(exports):typeof define=="function"&&define.amd?define(["exports"],I):(N=typeof globalThis<"u"?globalThis:N||self,I(N.UniverProtocol={}))})(this,function(N){"use strict";var I=(E=>(E[E.UNDEFINED=0]="UNDEFINED",E[E.OK=1]="OK",E[E.INTERNAL_ERROR=2]="INTERNAL_ERROR",E[E.PERMISSION_DENIED=3]="PERMISSION_DENIED",E[E.NOT_FOUND=4]="NOT_FOUND",E[E.UNAUTHENTICATED=5]="UNAUTHENTICATED",E[E.ALREADY_EXISTS=6]="ALREADY_EXISTS",E[E.INVALID_ARGUMENT=7]="INVALID_ARGUMENT",E[E.TOO_MANY_REQUESTS=8]="TOO_MANY_REQUESTS",E[E.CHANGESET_REVISION_CONFILICT=5001]="CHANGESET_REVISION_CONFILICT",E[E.SNAPSHOT_INVALID_SNAPSHOT=6001]="SNAPSHOT_INVALID_SNAPSHOT",E[E.APPLY_REJECT=7001]="APPLY_REJECT",E[E.APPLY_NON_SEQUENTIAL_REVISION=7002]="APPLY_NON_SEQUENTIAL_REVISION",E[E.APPLY_REVISION_CONFILICT=7003]="APPLY_REVISION_CONFILICT",E[E.APPLY_PERMISSION_DENIED=7004]="APPLY_PERMISSION_DENIED",E[E.CONNECTOR_DATA_TOO_LARGE=8001]="CONNECTOR_DATA_TOO_LARGE",E[E.LICENSE_MAX_UNITS_EXCEEDED=9001]="LICENSE_MAX_UNITS_EXCEEDED",E[E.LICENSE_MAX_MEMBERS_PER_UNIT_EXCEEDED=9002]="LICENSE_MAX_MEMBERS_PER_UNIT_EXCEEDED",E[E.LICENSE_IMPORT_SIZE_EXCEEDED=9003]="LICENSE_IMPORT_SIZE_EXCEEDED",E[E.LICENSE_EXPORT_SIZE_EXCEEDED=9004]="LICENSE_EXPORT_SIZE_EXCEEDED",E[E.LICENSE_DISTRO_REJECTED=9005]="LICENSE_DISTRO_REJECTED",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(I||{});function L(E){return!!(E&&E.code&&E.code!==I.OK&&E.code!=="OK")}var e=(E=>(E[E.UNIVER_UNKNOWN=0]="UNIVER_UNKNOWN",E[E.UNIVER_DOC=1]="UNIVER_DOC",E[E.UNIVER_SHEET=2]="UNIVER_SHEET",E[E.UNIVER_SLIDE=3]="UNIVER_SLIDE",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(e||{}),S=(E=>(E[E.UNKNOWN=0]="UNKNOWN",E[E.STRING=1]="STRING",E[E.NUMBER=2]="NUMBER",E[E.BOOLEAN=3]="BOOLEAN",E[E.FORCE_STRING=4]="FORCE_STRING",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(S||{}),_=(E=>(E[E.UNKNOWN_CMD=0]="UNKNOWN_CMD",E[E.HELLO=1]="HELLO",E[E.JOIN=2]="JOIN",E[E.LEAVE=3]="LEAVE",E[E.INGEST=4]="INGEST",E[E.HEARTBEAT=5]="HEARTBEAT",E[E.RECV=6]="RECV",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(_||{}),R=(E=>(E[E.UNKNOWN_CODE=0]="UNKNOWN_CODE",E[E.OK=1]="OK",E[E.FAIL=2]="FAIL",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(R||{}),O=(E=>(E[E.View=0]="View",E[E.Edit=1]="Edit",E[E.ManageCollaborator=2]="ManageCollaborator",E[E.Print=3]="Print",E[E.Duplicate=4]="Duplicate",E[E.Comment=5]="Comment",E[E.Copy=6]="Copy",E[E.Share=7]="Share",E[E.Export=8]="Export",E[E.MoveWorksheet=9]="MoveWorksheet",E[E.DeleteWorksheet=10]="DeleteWorksheet",E[E.HideWorksheet=11]="HideWorksheet",E[E.RenameWorksheet=12]="RenameWorksheet",E[E.CreateWorksheet=13]="CreateWorksheet",E[E.SetWorksheetStyle=14]="SetWorksheetStyle",E[E.EditWorksheetCell=15]="EditWorksheetCell",E[E.InsertHyperlink=16]="InsertHyperlink",E[E.Sort=17]="Sort",E[E.Filter=18]="Filter",E[E.PivotTable=19]="PivotTable",E[E.FloatImg=20]="FloatImg",E[E.History=21]="History",E[E.RwHgtClWdt=22]="RwHgtClWdt",E[E.ViemRwHgtClWdt=23]="ViemRwHgtClWdt",E[E.ViewFilter=24]="ViewFilter",E[E.MoveSheet=25]="MoveSheet",E[E.DeleteSheet=26]="DeleteSheet",E[E.HideSheet=27]="HideSheet",E[E.CopySheet=28]="CopySheet",E[E.RenameSheet=29]="RenameSheet",E[E.CreateSheet=30]="CreateSheet",E[E.SelectProtectedCells=31]="SelectProtectedCells",E[E.SelectUnProtectedCells=32]="SelectUnProtectedCells",E[E.SetCellStyle=33]="SetCellStyle",E[E.SetCellValue=34]="SetCellValue",E[E.SetRowStyle=35]="SetRowStyle",E[E.SetColumnStyle=36]="SetColumnStyle",E[E.InsertRow=37]="InsertRow",E[E.InsertColumn=38]="InsertColumn",E[E.DeleteRow=39]="DeleteRow",E[E.DeleteColumn=40]="DeleteColumn",E[E.EditExtraObject=41]="EditExtraObject",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(O||{}),D=(E=>(E[E.Reader=0]="Reader",E[E.Editor=1]="Editor",E[E.Owner=2]="Owner",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(D||{}),T=(E=>(E[E.Unkonwn=0]="Unkonwn",E[E.Workbook=1]="Workbook",E[E.Worksheet=2]="Worksheet",E[E.SelectRange=3]="SelectRange",E[E.Document=4]="Document",E[E.Slide=5]="Slide",E[E.UNRECOGNIZED=-1]="UNRECOGNIZED",E))(T||{});N.CellValueType=S,N.CmdRspCode=R,N.CombCmd=_,N.ErrorCode=I,N.UnitAction=O,N.UnitObject=T,N.UnitRole=D,N.UniverType=e,N.isError=L,Object.defineProperty(N,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/protocol",
-  "version": "0.1.33-alpha.0",
+  "version": "0.1.34",
   "private": false,
   "description": "A protocol of Univer repos",
   "author": "DreamNum <developer@univer.ai>",