@excali-boards/boards-api-client 1.1.21 → 1.1.22

package/dist/classes/permissions.d.ts

@@ -1,10 +1,11 @@
 import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
-import { GrantedEntry, ResourceType } from '../external/types';
+import { PermUser, ResourceType } from '../external/types';
 import { BoardsManager } from '../core/manager';
 export declare class APIPermissions {
     private web;
     constructor(web: BoardsManager);
-    viewPermissions({ auth, query }: PermissionsFunctionsInput['viewPermissions']): Promise<import("..").WebResponse<ViewPermissionsOutput>>;
+    viewPermissions({ auth, query }: PermissionsFunctionsInput['viewPermissions']): Promise<import("..").WebResponse<PermUser[]>>;
+    viewAllPermissions({ auth, userIds }: PermissionsFunctionsInput['viewAllPermissions']): Promise<import("..").WebResponse<Record<string, PermUser[]>>>;
     grantPermissions({ auth, body }: PermissionsFunctionsInput['grantPermissions']): Promise<import("..").WebResponse<string>>;
     revokePermissions({ auth, body }: PermissionsFunctionsInput['revokePermissions']): Promise<import("..").WebResponse<string>>;
 }
@@ -13,6 +14,10 @@ export type PermissionsFunctionsInput = {
         auth: string;
         query: ViewPermissionsQuery;
     };
+    'viewAllPermissions': {
+        auth: string;
+        userIds: string[];
+    };
     'grantPermissions': {
         auth: string;
         body: GrantPermissionsInput;
@@ -26,13 +31,6 @@ export type ViewPermissionsQuery = {
     type: ResourceType;
     id: string;
 };
-export type ViewPermissionsOutput = {
-    userId: string;
-    email: string;
-    displayName: string;
-    avatarUrl: string | null;
-    permissions: GrantedEntry[];
-}[];
 export type GrantPermissionsInput = {
     userId: string;
     groupIds?: string[];

package/dist/classes/permissions.js

@@ -14,6 +14,12 @@ class APIPermissions {
             endpoint: this.web.qp('/permissions/view', query),
         });
     }
+    async viewAllPermissions({ auth, userIds }) {
+        return await this.web.request({
+            method: 'POST', auth, body: { userIds },
+            endpoint: this.web.qp('/permissions/view-all'),
+        });
+    }
     async grantPermissions({ auth, body }) {
         return await this.web.request({
             method: 'POST', auth, body,

package/dist/external/types.d.ts

@@ -17,6 +17,34 @@ export declare enum GlobalRole {
 export type AccessLevel = 'read' | 'write' | 'manage' | 'admin';
 export type ResourceType = 'group' | 'category' | 'board';
 export type GlobalResourceType = ResourceType | 'global';
+export type ResourceId<A extends GlobalResourceType> = A extends 'board' ? {
+    boardId: string;
+    categoryId: string;
+    groupId: string;
+} : A extends 'category' ? {
+    categoryId: string;
+    groupId: string;
+} : A extends 'group' ? {
+    groupId: string;
+} : A extends 'global' ? null : never;
+export type ResourceReturnEnum<A extends GlobalResourceType> = A extends 'board' ? BoardRole : A extends 'category' ? CategoryRole : A extends 'group' ? GroupRole : A extends 'global' ? GlobalRole : never;
+export type PermissionGrantResult = {
+    newPermissions: GrantedRoles;
+    updatedPermissions: (GrantedRole & {
+        dbId: string;
+    })[];
+};
+export type PermissionCheckData<T extends ResourceType> = {
+    type: T;
+    data: ResourceId<T>;
+};
+export type PermUser = {
+    email: string;
+    userId: string;
+    displayName: string;
+    avatarUrl: string | null;
+    permissions: GrantedEntry[];
+};
 export type GrantedRoles = GrantedRole[];
 export type GrantedRole = {
     type: ResourceType;

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.1.21",
+	"version": "1.1.22",
 	"name": "@excali-boards/boards-api-client",
 	"description": "A simple API client for the Boards API.",
 	"repository": "https://github.com/Excali-Boards/boards-api-client",