@univerjs/protocol 0.1.21 → 0.1.23

package/lib/types/index.d.ts

@@ -0,0 +1,16 @@
+export { isError } from './utils';
+export type { Changeset as IChangeset, Mutation as IMutation } 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, } 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 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, } from './ts/v1/authz';
+export type { UnitRoleKV as IUnitRoleKV, UnitRole as IUnitRole, UnitObject as IUnitObject, UnitPermissionStrategy as IUnitPermissionStrategy, UnitAction as IUnitAction, } from './ts/univer/permission';

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

@@ -0,0 +1,34 @@
+export declare const protobufPackage = "univer";
+export declare enum UnitAction {
+    View = 0,
+    Edit = 1,
+    ManageCollaborator = 2,
+    Print = 3,
+    Duplicate = 4,
+    Comment = 5,
+    Copy = 6,
+    Share = 7,
+    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,
+    UNRECOGNIZED = -1
+}
+export interface UnitRoleKV {
+    role: UnitRole;
+    name: string;
+}
+export interface UnitPermissionStrategy {
+    role: UnitRole;
+    action: UnitAction;
+}

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

@@ -0,0 +1,88 @@
+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 { 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;
+}
+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 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>;
+    /**
+     * 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/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/user.d.ts

@@ -0,0 +1,18 @@
+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;
+}
+export interface GetUserRequest {
+}
+export interface GetUserResponse {
+    error: Error | undefined;
+    user: User | undefined;
+}
+export interface UserService {
+    GetUser(request: GetUserRequest, metadata?: Metadata): Observable<GetUserResponse>;
+}

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/package.json

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