@univerjs/protocol 0.1.28 → 0.1.29

package/lib/types/index.d.ts

@@ -12,6 +12,6 @@ export { type FetchMissingChangesetsRequest as IFetchMissingChangesetsRequest, t
 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 { 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';

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

@@ -54,3 +54,8 @@ export interface UnitPermissionStrategy {
     role: UnitRole;
     action: UnitAction;
 }
+export interface User {
+    userID: string;
+    name: string;
+    avatar: string;
+}

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, UnitObject, UnitPermissionStrategy, UnitRole, UnitRoleKV, 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/user.d.ts

@@ -13,6 +13,14 @@ export interface GetUserResponse {
     error: Error | undefined;
     user: User | undefined;
 }
+export interface ListUsersRequest {
+    userIDs: string[];
+}
+export interface ListUsersResponse {
+    error: Error | undefined;
+    users: User[];
+}
 export interface UserService {
     GetUser(request: GetUserRequest, metadata?: Metadata): Observable<GetUserResponse>;
+    ListUsers(request: ListUsersRequest, metadata?: Metadata): Observable<ListUsersResponse>;
 }

package/package.json

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