@univerjs/protocol 0.1.49 → 0.21.0-insiders.20260422-d7fcb4d

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

@@ -1,18 +1,32 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Error } from '../../univer/constants/errors';
-import { ObjectScope, UnitAction, UnitObject, UnitPermissionStrategy, UnitRole, UnitRoleKV, UnitShareScope, User } from '../../univer/permission';
-export declare const protobufPackage = "universer.v1";
-export interface Collaborator {
+/**
+ * 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 { Metadata } from '@grpc/grpc-js';
+import type { Observable } from 'rxjs';
+import type { IError } from '../../univer/constants/errors';
+import type { IUnitPermissionStrategy, IUnitRoleKV, IUser, ObjectScope, UnitAction, UnitObject, UnitRole, UnitShareScope } from '../../univer/permission';
+export interface ICollaborator {
     id: string;
     role: UnitRole;
-    subject: User | undefined;
+    subject: IUser | undefined;
 }
-export interface ObjScope {
+interface IObjScope {
     edit: ObjectScope;
     read: ObjectScope;
 }
-export interface PermissionPoint {
+export interface IPermissionPoint {
     objectID: string;
     unitID: string;
     objectType: UnitObject;
@@ -20,169 +34,170 @@ export interface PermissionPoint {
     /** @deprecated */
     shareOn: boolean;
     shareRole: UnitRole;
-    creator: User | undefined;
-    strategies: UnitPermissionStrategy[];
-    actions: ActionInfo[];
+    creator: IUser | undefined;
+    strategies: IUnitPermissionStrategy[];
+    actions: IActionInfo[];
     shareScope: UnitShareScope;
-    scope: ObjScope | undefined;
+    scope: IObjScope | undefined;
 }
-export interface CreateRequest {
+export interface ICreateRequest {
     objectType: UnitObject;
-    selectRangeObject?: CreateRequest_SelectRangeObject | undefined;
-    worksheetObject?: CreateRequest_WorksheetObject | undefined;
+    selectRangeObject?: ICreateRequestSelectRangeObject | undefined;
+    worksheetObject?: ICreateRequestWorksheetObject | undefined;
 }
-export interface CreateRequest_SelectRangeObject {
-    collaborators: Collaborator[];
+export interface ICreateRequestSelectRangeObject {
+    collaborators: ICollaborator[];
     unitID: string;
     name: string;
-    scope: ObjScope | undefined;
+    scope: IObjScope | undefined;
 }
-export interface CreateRequest_WorksheetObject {
-    collaborators: Collaborator[];
+interface ICreateRequestWorksheetObject {
+    collaborators: ICollaborator[];
     unitID: string;
     name: string;
-    strategies: UnitPermissionStrategy[];
-    scope: ObjScope | undefined;
+    strategies: IUnitPermissionStrategy[];
+    scope: IObjScope | undefined;
 }
-export interface CreateResponse {
-    error: Error | undefined;
+export interface ICreateResponse {
+    error: IError | undefined;
     objectID: string;
 }
-export interface UpdatePermPointRequest {
+export interface IUpdatePermPointRequest {
     objectType: UnitObject;
     objectID: string;
     unitID: string;
-    share: UpdatePermPointRequest_Share | undefined;
+    share: IUpdatePermPointRequestShare | undefined;
     name: string;
-    strategies: UnitPermissionStrategy[];
-    scope: ObjScope | undefined;
-    collaborators: UpdatePermPointRequest_Collaborators | undefined;
+    strategies: IUnitPermissionStrategy[];
+    scope: IObjScope | undefined;
+    collaborators: IUpdatePermPointRequestCollaborators | undefined;
 }
-export interface UpdatePermPointRequest_Share {
+interface IUpdatePermPointRequestShare {
     /** @deprecated */
     on: boolean;
     role: UnitRole;
     scope: UnitShareScope;
 }
-export interface UpdatePermPointRequest_Collaborators {
-    collaborators: Collaborator[];
+interface IUpdatePermPointRequestCollaborators {
+    collaborators: ICollaborator[];
 }
-export interface UpdatePermPointResponse {
-    error: Error | undefined;
+interface IUpdatePermPointResponse {
+    error: IError | undefined;
 }
-export interface ListPermPointRequest {
+export interface IListPermPointRequest {
     unitID: string;
     objectIDs: string[];
     actions: UnitAction[];
 }
-export interface ListPermPointResponse {
-    error: Error | undefined;
-    objects: PermissionPoint[];
+export interface IListPermPointResponse {
+    error: IError | undefined;
+    objects: IPermissionPoint[];
 }
-export interface CreateCollaboratorRequest {
+export interface ICreateCollaboratorRequest {
     objectID: string;
     unitID: string;
-    collaborators: Collaborator[];
+    collaborators: ICollaborator[];
 }
-export interface CreateCollaboratorResponse {
-    error: Error | undefined;
+interface ICreateCollaboratorResponse {
+    error: IError | undefined;
 }
-export interface UpdateCollaboratorRequest {
+export interface IUpdateCollaboratorRequest {
     objectID: string;
     unitID: string;
-    collaborator: Collaborator | undefined;
+    collaborator: ICollaborator | undefined;
 }
-export interface UpdateCollaboratorResponse {
-    error: Error | undefined;
+export interface IUpdateCollaboratorResponse {
+    error: IError | undefined;
 }
-export interface DeleteCollaboratorRequest {
+export interface IDeleteCollaboratorRequest {
     objectID: string;
     unitID: string;
     collaboratorID: string;
 }
-export interface DeleteCollaboratorResponse {
-    error: Error | undefined;
+export interface IDeleteCollaboratorResponse {
+    error: IError | undefined;
 }
-export interface ListCollaboratorRequest {
+export interface IListCollaboratorRequest {
     objectID: string;
     unitID: string;
 }
-export interface ListCollaboratorResponse {
-    error: Error | undefined;
-    collaborators: Collaborator[];
+export interface IListCollaboratorResponse {
+    error: IError | undefined;
+    collaborators: ICollaborator[];
     cfgEnableObjInherit: boolean;
 }
-export interface PutCollaboratorsRequest {
+export interface IPutCollaboratorsRequest {
     objectID: string;
     unitID: string;
-    collaborators: Collaborator[];
+    collaborators: ICollaborator[];
 }
-export interface PutCollaboratorsResponse {
-    error: Error | undefined;
+export interface IPutCollaboratorsResponse {
+    error: IError | undefined;
 }
-export interface AllowedRequest {
+export interface IAllowedRequest {
     objectID: string;
     objectType: UnitObject;
     unitID: string;
     actions: UnitAction[];
 }
-export interface ActionInfo {
+export interface IActionInfo {
     action?: UnitAction | undefined;
     allowed?: boolean | undefined;
 }
-export interface AllowedResponse {
-    error: Error | undefined;
-    actions: ActionInfo[];
+export interface IAllowedResponse {
+    error: IError | undefined;
+    actions: IActionInfo[];
 }
-export interface BatchAllowedRequest {
-    requests: AllowedRequest[];
+interface IBatchAllowedRequest {
+    requests: IAllowedRequest[];
 }
-export interface ObjectActionInfo {
+interface IObjectActionInfo {
     unitID: string;
     objectID: string;
-    actions: ActionInfo[];
+    actions: IActionInfo[];
 }
-export interface BatchAllowedResponse {
-    error: Error | undefined;
-    objectActions: ObjectActionInfo[];
+export interface IBatchAllowedResponse {
+    error: IError | undefined;
+    objectActions: IObjectActionInfo[];
 }
-export interface ListRolesRequest {
+export interface IListRolesRequest {
     objectType: UnitObject;
 }
-export interface ListRolesResponse {
-    error: Error | undefined;
-    roles: UnitRoleKV[];
+export interface IListRolesResponse {
+    error: IError | undefined;
+    roles: IUnitRoleKV[];
     actions: UnitAction[];
-    defaultStrategies: UnitPermissionStrategy[];
+    defaultStrategies: IUnitPermissionStrategy[];
 }
-export interface AuthzService {
+export interface IAuthzService {
     /** create a permission mount point for specified type of object */
-    Create(request: CreateRequest, metadata?: Metadata): Observable<CreateResponse>;
+    Create(request: ICreateRequest, metadata?: Metadata): Observable<ICreateResponse>;
     /**
      * 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>;
+    Update(request: IUpdatePermPointRequest, metadata?: Metadata): Observable<IUpdatePermPointResponse>;
     /**
      * 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>;
+    List(request: IListPermPointRequest, metadata?: Metadata): Observable<IListPermPointResponse>;
     /** request a couple of actions, return the allowed actions */
-    Allowed(request: AllowedRequest, metadata?: Metadata): Observable<AllowedResponse>;
+    Allowed(request: IAllowedRequest, metadata?: Metadata): Observable<IAllowedResponse>;
     /** barch check if the actions are allowed */
-    BatchAllowed(request: BatchAllowedRequest, metadata?: Metadata): Observable<BatchAllowedResponse>;
+    BatchAllowed(request: IBatchAllowedRequest, metadata?: Metadata): Observable<IBatchAllowedResponse>;
     /** list object roles for specified object */
-    ListRoles(request: ListRolesRequest, metadata?: Metadata): Observable<ListRolesResponse>;
+    ListRoles(request: IListRolesRequest, metadata?: Metadata): Observable<IListRolesResponse>;
     /** new collaborator for specified object */
-    CreateCollaborator(request: CreateCollaboratorRequest, metadata?: Metadata): Observable<CreateCollaboratorResponse>;
+    CreateCollaborator(request: ICreateCollaboratorRequest, metadata?: Metadata): Observable<ICreateCollaboratorResponse>;
     /** list all collaborators for specified object */
-    ListCollaborators(request: ListCollaboratorRequest, metadata?: Metadata): Observable<ListCollaboratorResponse>;
+    ListCollaborators(request: IListCollaboratorRequest, metadata?: Metadata): Observable<IListCollaboratorResponse>;
     /** update collaborator for specified object */
-    UpdateCollaborator(request: UpdateCollaboratorRequest, metadata?: Metadata): Observable<UpdateCollaboratorResponse>;
+    UpdateCollaborator(request: IUpdateCollaboratorRequest, metadata?: Metadata): Observable<IUpdateCollaboratorResponse>;
     /** delete collaborator for specified object */
-    DeleteCollaborator(request: DeleteCollaboratorRequest, metadata?: Metadata): Observable<DeleteCollaboratorResponse>;
+    DeleteCollaborator(request: IDeleteCollaboratorRequest, metadata?: Metadata): Observable<IDeleteCollaboratorResponse>;
     /** put collaborators for specified object */
-    PutCollaborators(request: PutCollaboratorsRequest, metadata?: Metadata): Observable<PutCollaboratorsResponse>;
+    PutCollaborators(request: IPutCollaboratorsRequest, metadata?: Metadata): Observable<IPutCollaboratorsResponse>;
 }
+export {};

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

@@ -1,11 +1,25 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Empty } from '../../google/protobuf/empty';
-import { Changeset } from '../../univer/changeset';
-import { CollaMsg } from '../../univer/colla_msg';
-import { Error } from '../../univer/constants/errors';
-import { UniverType } from '../../univer/constants/univer';
-export declare const protobufPackage = "universer.v1";
+/**
+ * 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 { Metadata } from '@grpc/grpc-js';
+import type { Observable } from 'rxjs';
+import type { IChangeset } from '../../univer/changeset';
+import type { IError } from '../../univer/constants/errors';
+import type { UniverType } from '../../univer/constants/univer';
+interface IEmpty {
+}
 /** more details: https://c3fgartrp2.feishu.cn/docx/OS47dk8BCo1ZeKxXiNvcDLuZn2g#PymGdupuyoYfvTxv1EBciV7in9b */
 export declare enum CombCmd {
     /** UNKNOWN_CMD - unknown cmd */
@@ -44,83 +58,48 @@ export declare enum CmdRspCode {
     GLOBAL_ROOMS_CNT_EXCEEDS = 1004,
     UNRECOGNIZED = -1
 }
-export interface ConnectResponse {
-    error: Error | undefined;
-    memberID: string;
-}
-export interface BroadcastRequest {
+interface IBroadcastRequest {
     roomID: string;
     message: string;
 }
-export interface NewChangesRequest {
+export interface INewChangesRequest {
     unitID: string;
     memberID: string;
     type: UniverType;
-    changeset: Changeset | undefined;
+    changeset: IChangeset | undefined;
 }
-export interface NewChangesResponse {
-    error: Error | undefined;
+export interface INewChangesResponse {
+    error: IError | 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 {
+interface ICombJoinInfo {
     roomID: string;
     /** extra args for joining the room */
     args: string;
 }
-export interface CombJoinRequest {
-    rooms: CombJoinInfo[];
+export interface ICombJoinRequest {
+    rooms: ICombJoinInfo[];
 }
-export interface CombJoinResponse {
+export interface ICombJoinResponse {
     roomInfos: {
-        [key: string]: CombJoinResponse_RoomInfo;
+        [key: string]: ICombJoinResponseRoomInfo;
     };
 }
-export interface CombJoinResponse_RoomInfo {
+interface ICombJoinResponseRoomInfo {
     roomID: string;
-    members: Member[];
-}
-export interface CombJoinResponse_RoomInfosEntry {
-    key: string;
-    value: CombJoinResponse_RoomInfo | undefined;
+    members: IMember[];
 }
-export interface CombInfoResponse {
-    memberID: string;
-}
-export interface CombLeaveRequest {
+export interface ICombLeaveRequest {
     roomID: string;
     /** extra args for leaving the room */
     args: string;
 }
-export interface Member {
+export interface IMember {
     memberID: string;
     name: string;
     avatar?: string | undefined;
 }
-export interface Rule {
-    /** exclude member */
-    excludeMember: string[];
-    /** only member */
-    onlyMember: string[];
-    tunnel: Rule_Tunnel | undefined;
-}
-export interface Rule_Tunnel {
-    name: string;
-    value: string;
-}
-export interface CombService {
-    NewChanges(request: NewChangesRequest, metadata?: Metadata): Observable<NewChangesResponse>;
-    Broadcast(request: BroadcastRequest, metadata?: Metadata): Observable<Empty>;
+export interface ICombService {
+    NewChanges(request: INewChangesRequest, metadata?: Metadata): Observable<INewChangesResponse>;
+    Broadcast(request: IBroadcastRequest, metadata?: Metadata): Observable<IEmpty>;
 }
+export {};

package/lib/types/ts/universer/v1/comment.d.ts

@@ -1,73 +1,77 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { CommentUpdate_Status } from '../../univer/colla_msg';
-import { Error } from '../../univer/constants/errors';
-import { User } from '../../univer/permission';
-export declare const protobufPackage = "universer.v1";
-export interface Reply {
+/**
+ * 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 { CommentSolvedStatus } from '../../univer/colla-msg';
+import type { IError } from '../../univer/constants/errors';
+import type { IUser } from '../../univer/permission';
+export interface IReply {
     threadId: string;
     replyId: string;
     content: string;
     userId: string;
     createTimestamp: number;
 }
-export interface Thread {
+export interface IThread {
     threadId: string;
-    solved: CommentUpdate_Status;
-    replies: Reply[];
+    solved: CommentSolvedStatus;
+    replies: IReply[];
 }
-export interface AddCommentRequest {
+export interface IAddCommentRequest {
     memberId: string;
     unitId: string;
     content: string;
     mention: string[];
 }
-export interface AddCommentResponse {
-    error: Error | undefined;
-    comment: Thread | undefined;
+export interface IAddCommentResponse {
+    error: IError | undefined;
+    comment: IThread | undefined;
 }
-export interface ListCommentsRequest {
+export interface IListCommentsRequest {
     unitId: string;
     threadId: string[];
 }
-export interface ListCommentsResponse {
-    error: Error | undefined;
+export interface IListCommentsResponse {
+    error: IError | undefined;
     comments: {
-        [key: string]: Thread;
+        [key: string]: IThread;
     };
     users: {
-        [key: string]: User;
+        [key: string]: IUser;
     };
 }
-export interface ListCommentsResponse_CommentsEntry {
-    key: string;
-    value: Thread | undefined;
-}
-export interface ListCommentsResponse_UsersEntry {
-    key: string;
-    value: User | undefined;
-}
-export interface ReplyCommentRequest {
+export interface IReplyCommentRequest {
     memberId: string;
     unitId: string;
     threadId: string;
     content: string;
     mention: string[];
 }
-export interface ReplyCommentResponse {
-    error: Error | undefined;
-    reply: Reply | undefined;
+export interface IReplyCommentResponse {
+    error: IError | undefined;
+    reply: IReply | undefined;
 }
-export interface SolvedCommentRequest {
+export interface ISolvedCommentRequest {
     memberId: string;
     unitId: string;
     threadId: string;
-    solved: CommentUpdate_Status;
+    solved: CommentSolvedStatus;
 }
-export interface SolvedCommentResponse {
-    error: Error | undefined;
+export interface ISolvedCommentResponse {
+    error: IError | undefined;
 }
-export interface EditCommentRequest {
+export interface IEditCommentRequest {
     memberId: string;
     unitId: string;
     threadId: string;
@@ -75,23 +79,15 @@ export interface EditCommentRequest {
     content: string;
     mention: string[];
 }
-export interface EditCommentResponse {
-    error: Error | undefined;
+export interface IEditCommentResponse {
+    error: IError | undefined;
 }
-export interface DeleteCommentRequest {
+export interface IDeleteCommentRequest {
     memberId: string;
     unitId: string;
     threadId: string;
     replyId?: string | undefined;
 }
-export interface DeleteCommentResponse {
-    error: Error | undefined;
-}
-export interface CommentService {
-    AddComment(request: AddCommentRequest, metadata?: Metadata): Observable<AddCommentResponse>;
-    ListComments(request: ListCommentsRequest, metadata?: Metadata): Observable<ListCommentsResponse>;
-    ReplyComment(request: ReplyCommentRequest, metadata?: Metadata): Observable<ReplyCommentResponse>;
-    SolvedComment(request: SolvedCommentRequest, metadata?: Metadata): Observable<SolvedCommentResponse>;
-    EditComment(request: EditCommentRequest, metadata?: Metadata): Observable<EditCommentResponse>;
-    DeleteComment(request: DeleteCommentRequest, metadata?: Metadata): Observable<DeleteCommentResponse>;
+export interface IDeleteCommentResponse {
+    error: IError | undefined;
 }