@univerjs/protocol 0.1.49 → 0.21.0

package/lib/types/ts/univer/colla-msg.d.ts

@@ -0,0 +1,176 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IChangeset } from './changeset';
+import type { IUnitPermissionStrategy, IUser, ObjectScope, UnitRole, UnitShareScope } from './permission';
+export interface ICollaMsg {
+    eventID: string;
+    joinEvent?: ICollaMsgJoin | undefined;
+    leaveEvent?: ICollaMsgLeave | undefined;
+    newCsEvent?: INewChangesets | undefined;
+    csAckEvent?: IChangesetAck | undefined;
+    csRejEvent?: IChangesetRej | undefined;
+    updateCursorEvent?: IUpdateCursor | undefined;
+    liveShareRequestHost?: ILiveShareRequestHost | undefined;
+    liveShareNewHost?: ILiveShareNewHost | undefined;
+    liveShareOperation?: ILiveShareOperation | undefined;
+    liveShareTerminate?: ILiveShareTerminate | undefined;
+    errorEvent?: ICollaMsgErrorEvent | undefined;
+    permissionRejEvent?: IPermissionRej | undefined;
+    /** eventID: "should_close_conn" */
+    shouldCloseConn?: IShouldCloseConn | undefined;
+    commentUpdateEvent?: ICommentUpdate | undefined;
+    /** envntID: "update_collaborator" */
+    updateCollaboratorEvent?: IUpdateCollaborator | undefined;
+    /** eventID: "update_permission_obj" */
+    updatePermissionObjEvent?: IUpdatePermissionObj | undefined;
+    /** eventID: "changeset_should_retry" */
+    csShouldRetryEvent?: IChangesetShouldRetry | undefined;
+    /** eventID: "uniscript.run" */
+    uniscriptRunEvent?: IUniscriptRun | undefined;
+}
+export interface ICollaMsgJoin {
+    memberID: string;
+    name: string;
+    avatar: string;
+}
+export interface ICollaMsgLeave {
+    memberID: string;
+    name: string;
+}
+interface INewChangesets {
+    cs: IChangeset | undefined;
+}
+interface IChangesetAck {
+    cs: IChangeset | undefined;
+}
+interface IChangesetRej {
+    cs: IChangeset | undefined;
+}
+interface IChangesetShouldRetry {
+    cs: IChangeset | undefined;
+}
+export interface IUpdateCursor {
+    unitID: string;
+    /**
+     * IMember 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 ILiveShareRequestHost {
+    unitID: string;
+    userID: string;
+}
+export interface ILiveShareNewHost {
+    presenter: string;
+    unitID: string;
+    userID: string;
+}
+export interface ILiveShareOperation {
+    unitID: string;
+    presenter: string;
+    /** key is Operation.id */
+    operations: {
+        [key: string]: ILiveShareOperationOperation;
+    };
+}
+export interface ILiveShareOperationOperation {
+    id: string;
+    params?: string | undefined;
+}
+export interface ILiveShareTerminate {
+    unitID: string;
+}
+/** define msg for errors */
+export interface ICollaMsgErrorEvent {
+    code: number;
+    reason: string;
+}
+interface IPermissionRej {
+    cs: IChangeset | undefined;
+}
+export interface ICommentUpdate {
+    memberId: string;
+    userId: string;
+    unitId: string;
+    threadId: string;
+    type: CommentUpdateEventType;
+    replyId?: string | undefined;
+    /** Set when solve or reopen  Otherwise, it will be null */
+    solved?: CommentSolvedStatus | undefined;
+    /** Set when edit or new comment reply. Otherwise, it will be null */
+    content?: string | undefined;
+    /** Set true when Create or Edit comment. Otherwise, it will be null */
+    createTimestamp?: string | undefined;
+    user?: IUser | undefined;
+}
+export declare enum CommentSolvedStatus {
+    OpenOrReOpen = 0,
+    Solved = 1,
+    UNRECOGNIZED = -1
+}
+export declare enum CommentUpdateEventType {
+    Unknown = 0,
+    Add = 1,
+    Reply = 2,
+    Edit = 3,
+    Delete = 4,
+    Solve = 5,
+    UNRECOGNIZED = -1
+}
+export interface IShouldCloseConn {
+    /** enum, ["logout", "roleChange"] */
+    reason: string;
+}
+interface IUpdateCollaborator {
+    role: UnitRole;
+    /** enum, ["update", "delete"] */
+    operation: string;
+    userId: string;
+}
+export interface IUpdatePermissionObj {
+    objectId: string;
+    strategies: IUnitPermissionStrategy[];
+    share: IUpdatePermissionObjShare | undefined;
+    scope: IUpdatePermissionObjScope | undefined;
+}
+interface IUpdatePermissionObjShare {
+    scope: UnitShareScope;
+    role: UnitRole;
+}
+interface IUpdatePermissionObjScope {
+    edit: ObjectScope;
+    read: ObjectScope;
+}
+export interface IUniscriptRun {
+    /** name of uniscript */
+    name: string;
+    /** content of uniscirpt */
+    script: string;
+    /** id of uniscript */
+    scriptId: string;
+    function: string;
+    /**
+     * argsOfFunction is a json string, it should be a list of arguments
+     * e.g. '[123, "hello", true, {"a": 1, "b": 2}]'
+     */
+    argsOfFunction?: string | undefined;
+    /** executionId for script logs record. */
+    executionId: string;
+    compiledScript: string;
+}
+export {};

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

@@ -1,4 +1,18 @@
-export declare const protobufPackage = "univer.constants";
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export declare enum ErrorCode {
     /** UNDEFINED - general codes */
     UNDEFINED = 0,
@@ -77,47 +91,47 @@ export declare enum ErrorCode {
     EMAIL_HAS_BEEN_BOUND = 13003,
     /** ENTITLE_CAN_NOT_BUY_LOWER_OTP - entitlement domain errors */
     ENTITLE_CAN_NOT_BUY_LOWER_OTP = 14001,
-    /** ENTITLE_UPDOWN_GRADE_NOT_SUPPORT - 订阅的升/降级暂不支持 */
+    /** ENTITLE_UPDOWN_GRADE_NOT_SUPPORT - subscription upgrade/downgrade is not supported */
     ENTITLE_UPDOWN_GRADE_NOT_SUPPORT = 14002,
-    /** ENTITLE_DUP_SUBSCRIPTION - 重复订阅 */
+    /** ENTITLE_DUP_SUBSCRIPTION - duplicate subscription */
     ENTITLE_DUP_SUBSCRIPTION = 14003,
-    /** PAYMENT_CHANNEL_NOT_SUPPORT - 支付渠道不支持 */
+    /** PAYMENT_CHANNEL_NOT_SUPPORT - payment channel is not supported */
     PAYMENT_CHANNEL_NOT_SUPPORT = 14004,
-    /** ENTITLE_INVALID_COUPON_CODE - 不合法的coupon code */
+    /** ENTITLE_INVALID_COUPON_CODE - invalid coupon code */
     ENTITLE_INVALID_COUPON_CODE = 14005,
-    /** ENTITLE_COUPON_EXPIRED - coupon 过期 */
+    /** ENTITLE_COUPON_EXPIRED - coupon expired */
     ENTITLE_COUPON_EXPIRED = 14006,
-    /** ENTITLE_COUPON_USED_UP - coupon 用完了 */
+    /** ENTITLE_COUPON_USED_UP - coupon used up */
     ENTITLE_COUPON_USED_UP = 14007,
-    /** ENTITLE_USE_COUPON_NOT_1ST_TRADE - 不是第一次购买，不能使用coupon */
+    /** ENTITLE_USE_COUPON_NOT_1ST_TRADE - not the first purchase, cannot use coupon */
     ENTITLE_USE_COUPON_NOT_1ST_TRADE = 14008,
-    /** ENTITLE_CHAT_LIMIT_EXCEED - 会话被限频 */
+    /** ENTITLE_CHAT_LIMIT_EXCEED - chat rate limit exceeded */
     ENTITLE_CHAT_LIMIT_EXCEED = 14101,
-    /** ENTITLE_REPORT_LIMIT_EXCEED - 报告被限频 */
+    /** ENTITLE_REPORT_LIMIT_EXCEED - report rate limit exceeded */
     ENTITLE_REPORT_LIMIT_EXCEED = 14102,
-    /** ENTITLE_INSUFFICIENT_QUOTA - 配额不足 */
+    /** ENTITLE_INSUFFICIENT_QUOTA - insufficient quota */
     ENTITLE_INSUFFICIENT_QUOTA = 14103,
-    /** ENTITLE_NEED_BILLING_ADDRESS - 需要补充账单地址 */
+    /** ENTITLE_NEED_BILLING_ADDRESS - billing address required */
     ENTITLE_NEED_BILLING_ADDRESS = 14301,
     /** REDEMPTION_INVALID_CODE - redemption code domain errors */
     REDEMPTION_INVALID_CODE = 15001,
-    /** REDEMPTION_CODE_INACTIVE - code已失效 */
+    /** REDEMPTION_CODE_INACTIVE - code inactive */
     REDEMPTION_CODE_INACTIVE = 15002,
-    /** REDEMPTION_CODE_FULLY_REDEEMED - 已全部兑换完 */
+    /** REDEMPTION_CODE_FULLY_REDEEMED - fully redeemed */
     REDEMPTION_CODE_FULLY_REDEEMED = 15003,
-    /** REDEMPTION_CODE_NOT_STARTED - 还未开始 */
+    /** REDEMPTION_CODE_NOT_STARTED - not started yet */
     REDEMPTION_CODE_NOT_STARTED = 15004,
-    /** REDEMPTION_USER_NOT_ELIGIBLE - 用户无兑换资格 */
+    /** REDEMPTION_USER_NOT_ELIGIBLE - user not eligible */
     REDEMPTION_USER_NOT_ELIGIBLE = 15005,
-    /** REDEMPTION_USER_REDEEM_TIMES_EXCEED - 用户已达最大兑换次数 */
+    /** REDEMPTION_USER_REDEEM_TIMES_EXCEED - user redemption limit exceeded */
     REDEMPTION_USER_REDEEM_TIMES_EXCEED = 15006,
-    /** REDEMPTION_CODE_HAS_BEEN_CREATED - 兑换码已存在 */
+    /** REDEMPTION_CODE_HAS_BEEN_CREATED - redemption code already exists */
     REDEMPTION_CODE_HAS_BEEN_CREATED = 15007,
     /** DATA_SOURCE_TOO_LARGE - data source errors */
     DATA_SOURCE_TOO_LARGE = 16001,
     UNRECOGNIZED = -1
 }
-export interface Error {
+export interface IError {
     code: ErrorCode;
     message: string;
 }

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

@@ -1,4 +1,18 @@
-export declare const protobufPackage = "univer.constants";
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export declare enum UniverType {
     UNIVER_UNKNOWN = 0,
     UNIVER_DOC = 1,

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

@@ -1,12 +1,26 @@
-import { Resource } from './resource';
-export declare const protobufPackage = "univer";
-export interface DocumentMeta {
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IResource } from './resource';
+export interface IDocumentMeta {
     unitID: string;
     rev: number;
     creator: string;
     name: string;
     /** The key is sheet id */
-    resources: Resource[];
+    resources: IResource[];
     /** The original meta data in JSON format. */
     originalMeta: Uint8Array;
 }

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

@@ -1,5 +1,19 @@
-export declare const protobufPackage = "univer";
-export interface DrawingMeta {
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface IDrawingMeta {
     unitID: string;
     name: string;
     /** The original meta data in JSON format. */

package/lib/types/ts/univer/initial-sheet.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare enum CellType {
+    UNDEFINED = 0,
+    TEXT = 1,
+    URL = 2,
+    IMAGE = 3,
+    UNRECOGNIZED = -1
+}
+export interface IInitialSheet {
+    sheetName: string;
+    columnName: string[];
+    rows: IRow[];
+    /** If true, do not apply filter plugin */
+    disableFilter?: boolean | undefined;
+}
+export interface IRowCell {
+    type: CellType;
+    text: string;
+    url: string;
+    /** Optional style information */
+    style?: IStyle | undefined;
+}
+interface IStyle {
+    /** Background color */
+    bg: string;
+    /** Text color */
+    cl: string;
+}
+export interface IRow {
+    cells: IRowCell[];
+}
+export {};

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

@@ -1,4 +1,18 @@
-export declare const protobufPackage = "univer";
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export declare enum UnitAction {
     View = 0,
     Edit = 1,
@@ -31,7 +45,7 @@ export declare enum UnitAction {
     /** @deprecated */
     FloatImg = 20,
     /** @deprecated */
-    History = 21,
+    IHistory = 21,
     /**
      * RwHgtClWdt - row height, column width
      *
@@ -102,15 +116,15 @@ export declare enum ObjectScope {
     OneSelf = 2,
     UNRECOGNIZED = -1
 }
-export interface UnitRoleKV {
+export interface IUnitRoleKV {
     role: UnitRole;
     name: string;
 }
-export interface UnitPermissionStrategy {
+export interface IUnitPermissionStrategy {
     role: UnitRole;
     action: UnitAction;
 }
-export interface User {
+export interface IUser {
     userID: string;
     name: string;
     avatar: string;

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

@@ -1,5 +1,19 @@
-export declare const protobufPackage = "univer";
-export interface Range {
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface IRange {
     startRow: number;
     endRow: number;
     startColumn: number;

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

@@ -1,5 +1,19 @@
-export declare const protobufPackage = "univer";
-export interface Resource {
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface IResource {
     id?: string | undefined;
     name: string;
     data: string;

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

@@ -1,19 +1,33 @@
-import { UniverType } from './constants/univer';
-import { DocumentMeta } from './doc';
-import { WorkbookMeta } from './workbook';
-export declare const protobufPackage = "univer";
-export interface Snapshot {
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { UniverType } from './constants/univer';
+import type { IDocumentMeta } from './doc';
+import type { IWorkbookMeta } from './workbook';
+export interface ISnapshot {
     /** unitID of the Univer document */
     unitID: string;
     type: UniverType;
     rev: number;
-    workbook: WorkbookMeta | undefined;
-    doc: DocumentMeta | undefined;
+    workbook: IWorkbookMeta | undefined;
+    doc: IDocumentMeta | undefined;
 }
-export interface TableInfo {
+export interface ITableInfo {
     /** json:ITableInfo */
     meta: Uint8Array;
     dataPath: string;
-    /** A matrix of values in JSON format. use in GetPreprocessRangesResponse */
+    /** A matrix of values in JSON format. use in IGetPreprocessRangesResponse */
     data?: string | undefined;
 }

package/lib/types/ts/univer/unit-template.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/** ICustomCellTemplate is the template used for make some drawing on sheet, like draw a cute mario XD. */
+export interface ICustomCellTemplate {
+    rowCount: number;
+    colCount: number;
+    rowHeight: number;
+    colWidth: number;
+    showGridlines: number;
+}

package/lib/types/ts/univer/univer-file.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { UniverType } from './constants/univer';
+import type { IDocumentMeta } from './doc';
+import type { IDrawingMeta } from './drawing';
+import type { IWorkbookMeta } from './workbook';
+export interface IUnit {
+    unitID: string;
+    name: string;
+    type: UniverType;
+    workbook?: IWorkbookMeta | undefined;
+    document?: IDocumentMeta | undefined;
+    drawing?: IDrawingMeta | undefined;
+}