@excali-boards/boards-api-client 1.1.1-dev.19 → 1.1.1-dev.2

package/dist/{classes → cjs/classes}/admin.js

@@ -11,7 +11,7 @@ class APIAdmin {
     async getUsers({ auth }) {
         return await this.web.request({
             method: 'GET', auth,
-            endpoint: this.web.qp('/admin/users'),
+            endpoint: this.web.qp('/users'),
         });
     }
     async getActiveRooms({ auth }) {

package/dist/cjs/classes/auth.d.ts

@@ -0,0 +1,26 @@
+import { Platforms } from '../../prisma/generated/default';
+import { BoardsManager } from '../core/manager';
+export declare class APIAuth {
+    private web;
+    constructor(web: BoardsManager);
+    authenticate({ auth, body }: AuthFunctionsInput['authenticate']): Promise<import("..").WebResponse<AuthenticateOutput>>;
+}
+export type AuthFunctionsInput = {
+    'authenticate': {
+        auth: string;
+        body: AuthenticateInput;
+    };
+};
+export type AuthenticateInput = {
+    platform: Platforms;
+    email: string;
+    displayName: string;
+    avatarUrl?: string | null;
+    currentUserId?: string;
+};
+export type AuthenticateOutput = {
+    email: string;
+    displayName: string | null;
+    avatarUrl: string | null;
+    platform: Platforms;
+};

package/dist/cjs/classes/auth.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIAuth = void 0;
+// Data.
+class APIAuth {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    // Methods.
+    async authenticate({ auth, body }) {
+        return await this.web.request({
+            method: 'POST', auth, body,
+            endpoint: this.web.qp('/auth'),
+        });
+    }
+}
+exports.APIAuth = APIAuth;

package/dist/cjs/classes/invites.d.ts

@@ -0,0 +1,82 @@
+import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
+import { ResourceType } from '../external/types';
+import { BoardsManager } from '../core/manager';
+export declare class APIInvites {
+    private web;
+    constructor(web: BoardsManager);
+    getInvites({ auth }: InvitesFunctionsInput['getInvites']): Promise<import("..").WebResponse<GetInvitesOutput>>;
+    createInvite({ auth, body }: InvitesFunctionsInput['createInvite']): Promise<import("..").WebResponse<CreateInviteOutput>>;
+    useInvite({ auth, code }: InvitesFunctionsInput['useInvite']): Promise<import("..").WebResponse<UseInviteOutput>>;
+    revokeInvite({ auth, code }: InvitesFunctionsInput['revokeInvite']): Promise<import("..").WebResponse<string>>;
+}
+export type InvitesFunctionsInput = {
+    'getInvites': {
+        auth: string;
+    };
+    'createInvite': {
+        auth: string;
+        body: CreateInviteInput;
+    };
+    'useInvite': {
+        auth: string;
+        code: string;
+    };
+    'revokeInvite': {
+        auth: string;
+        code: string;
+    };
+};
+export type CreateInviteInput = {
+    groupIds?: string[];
+    categoryIds?: string[];
+    boardIds?: string[];
+    groupRole?: GroupRole;
+    categoryRole?: CategoryRole;
+    boardRole?: BoardRole;
+    expiresIn?: number;
+    maxUses?: number;
+};
+export type CreateInviteOutput = {
+    code: string;
+    expiresAt: string;
+    maxUses: number;
+};
+export type GetInvitesOutput = {
+    dbId: string;
+    code: string;
+    createdBy: string;
+    expiresAt: string | null;
+    maxUses: number | null;
+    currentUses: number;
+    groupIds: string[];
+    categoryIds: string[];
+    boardIds: string[];
+    groupRole: GroupRole | null;
+    categoryRole: CategoryRole | null;
+    boardRole: BoardRole | null;
+    createdAt: string;
+}[];
+export type GrantedRole = {
+    type: ResourceType;
+    resourceId: string;
+    role: BoardRole | CategoryRole | GroupRole;
+};
+export type UseInviteOutput = {
+    granted: GrantedRole[];
+    details: {
+        groups: {
+            groupId: string;
+            name: string;
+        }[];
+        categories: {
+            categoryId: string;
+            name: string;
+            groupId: string;
+        }[];
+        boards: {
+            boardId: string;
+            name: string;
+            categoryId: string;
+        }[];
+    };
+};

package/dist/{classes → cjs/classes}/invites.js

@@ -8,30 +8,12 @@ class APIInvites {
         this.web = web;
     }
     // Methods.
-    async getUserInvites({ auth }) {
+    async getInvites({ auth }) {
         return await this.web.request({
             method: 'GET', auth,
             endpoint: this.web.qp('/invites'),
         });
     }
-    async getResourceInvites({ auth, query }) {
-        return await this.web.request({
-            method: 'GET', auth,
-            endpoint: this.web.qp('/resources/invites', query),
-        });
-    }
-    async bulkGetResourceInvites({ auth, query }) {
-        return await this.web.request({
-            method: 'GET', auth,
-            endpoint: this.web.qp('/resources/invites/bulk', query),
-        });
-    }
-    async getInviteDetails({ auth, code }) {
-        return await this.web.request({
-            method: 'GET', auth,
-            endpoint: this.web.qp(`/invites/${code}`),
-        });
-    }
     async createInvite({ auth, body }) {
         return await this.web.request({
             method: 'POST', auth, body,

package/dist/{classes → cjs/classes}/metrics.d.ts

@@ -19,6 +19,7 @@ export type SystemStatus = {
     activeRooms: number;
     socketConnections: number;
     queuedFiles: number;
+    cacheSize: number;
     totalUsers: number;
     totalInvites: number;
     totalBoards: number;

package/dist/{classes → cjs/classes}/permissions.d.ts

@@ -1,11 +1,10 @@
-import { BulkPermissions, GrantedRoles, ResourceType } from '../external/types';
 import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
+import { 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>>;
-    bulkViewPermissions({ auth, query }: PermissionsFunctionsInput['bulkViewPermissions']): Promise<import("..").WebResponse<ViewPermissionsOutput>>;
     grantPermissions({ auth, body }: PermissionsFunctionsInput['grantPermissions']): Promise<import("..").WebResponse<string>>;
     revokePermissions({ auth, body }: PermissionsFunctionsInput['revokePermissions']): Promise<import("..").WebResponse<string>>;
 }
@@ -14,10 +13,6 @@ export type PermissionsFunctionsInput = {
         auth: string;
         query: ViewPermissionsQuery;
     };
-    'bulkViewPermissions': {
-        auth: string;
-        query: BulkViewPermissionsQuery;
-    };
     'grantPermissions': {
         auth: string;
         body: GrantPermissionsInput;
@@ -33,25 +28,19 @@ export type ViewPermissionsQuery = {
     categoryId?: string;
     boardId?: string;
 };
-export type BulkViewPermissionsQuery = {
-    mode: BulkPermissions;
-    groupId?: string;
-    categoryId?: string;
-};
 export type ViewPermissionsOutput = {
     userId: string;
     email: string;
     displayName: string;
     avatarUrl: string | null;
-    permissions: GrantedRoles;
 }[];
 export type GrantPermissionsInput = {
     userId: string;
     groupIds?: string[];
-    groupRole?: GroupRole;
     categoryIds?: string[];
-    categoryRole?: CategoryRole;
     boardIds?: string[];
+    groupRole?: GroupRole;
+    categoryRole?: CategoryRole;
     boardRole?: BoardRole;
 };
 export type RevokePermissionsInput = {

package/dist/{classes → cjs/classes}/permissions.js

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

package/dist/{classes → cjs/classes}/users.d.ts

@@ -5,28 +5,22 @@ export declare class APIUsers {
     private web;
     constructor(web: BoardsManager);
     getCurrentUser({ auth }: UsersFunctionsInput['getCurrentUser']): Promise<import("..").WebResponse<GetUsersOutput>>;
-    updateUser({ auth, body }: UsersFunctionsInput['updateUser']): Promise<import("..").WebResponse<string>>;
-    deleteAccount({ auth }: UsersFunctionsInput['deleteAccount']): Promise<import("..").WebResponse<void>>;
+    changeMainPlatform({ auth, newMainPlatform }: UsersFunctionsInput['changeMainPlatform']): Promise<import("..").WebResponse<string>>;
+    changeMainGroup({ auth, newMainGroupId }: UsersFunctionsInput['changeMainGroup']): Promise<import("..").WebResponse<string>>;
 }
 export type UsersFunctionsInput = {
     'getCurrentUser': {
         auth: string;
     };
-    'updateUser': {
+    'changeMainPlatform': {
         auth: string;
-        body: UserInput;
+        newMainPlatform: Platforms;
     };
-    'deleteAccount': {
-        auth: string;
-    };
-    'isCurrentUserDev': {
+    'changeMainGroup': {
         auth: string;
+        newMainGroupId: string | null;
     };
 };
 export type GetUsersOutput = DBUserPartialType & {
     isDev: boolean;
 };
-export type UserInput = {
-    mainGroupId?: string | null;
-    platform?: Platforms;
-};

package/dist/{classes → cjs/classes}/users.js

@@ -11,19 +11,21 @@ class APIUsers {
     async getCurrentUser({ auth }) {
         return await this.web.request({
             method: 'GET', auth,
-            endpoint: this.web.qp('/users'),
+            endpoint: this.web.qp('/users/current'),
         });
     }
-    async updateUser({ auth, body }) {
+    async changeMainPlatform({ auth, newMainPlatform }) {
         return await this.web.request({
-            method: 'PATCH', auth, body,
-            endpoint: this.web.qp('/users'),
+            method: 'POST', auth,
+            endpoint: this.web.qp('/users/change-main-platform'),
+            body: { name: newMainPlatform },
         });
     }
-    async deleteAccount({ auth }) {
+    async changeMainGroup({ auth, newMainGroupId }) {
         return await this.web.request({
-            method: 'DELETE', auth,
-            endpoint: this.web.qp('/users'),
+            method: 'POST', auth,
+            endpoint: this.web.qp('/users/change-main-group'),
+            body: { groupId: newMainGroupId },
         });
     }
 }

package/dist/{core → cjs/core}/manager.d.ts

@@ -2,24 +2,24 @@ import { PaginatedWebResponse, RequestMethod, WebResponse } from '../types';
 import { AxiosResponse, ResponseType } from 'axios';
 import { APIPermissions } from '../classes/permissions';
 import { APICategories } from '../classes/categories';
-import { APISessions } from '../classes/sessions';
 import { APIMetrics } from '../classes/metrics';
 import { APIInvites } from '../classes/invites';
 import { APIGroups } from '../classes/groups';
 import { APIBoards } from '../classes/boards';
 import { APIUsers } from '../classes/users';
 import { APIAdmin } from '../classes/admin';
+import { APIAuth } from '../classes/auth';
 export declare class BoardsManager {
     url: string;
     readonly permissions: APIPermissions;
     readonly categories: APICategories;
-    readonly sessions: APISessions;
     readonly invites: APIInvites;
     readonly metrics: APIMetrics;
     readonly groups: APIGroups;
     readonly boards: APIBoards;
     readonly admin: APIAdmin;
     readonly users: APIUsers;
+    readonly auth: APIAuth;
     constructor(url: string);
     request<O, T = unknown, R extends boolean = false, P extends boolean = false>(data: {
         endpoint: string;

package/dist/{core → cjs/core}/manager.js

@@ -7,25 +7,25 @@ exports.BoardsManager = void 0;
 const axios_1 = __importDefault(require("axios"));
 const permissions_1 = require("../classes/permissions");
 const categories_1 = require("../classes/categories");
-const sessions_1 = require("../classes/sessions");
 const metrics_1 = require("../classes/metrics");
 const invites_1 = require("../classes/invites");
 const groups_1 = require("../classes/groups");
 const boards_1 = require("../classes/boards");
 const users_1 = require("../classes/users");
 const admin_1 = require("../classes/admin");
+const auth_1 = require("../classes/auth");
 const utils_1 = require("./utils");
 class BoardsManager {
     url;
     permissions = new permissions_1.APIPermissions(this);
     categories = new categories_1.APICategories(this);
-    sessions = new sessions_1.APISessions(this);
     invites = new invites_1.APIInvites(this);
     metrics = new metrics_1.APIMetrics(this);
     groups = new groups_1.APIGroups(this);
     boards = new boards_1.APIBoards(this);
     admin = new admin_1.APIAdmin(this);
     users = new users_1.APIUsers(this);
+    auth = new auth_1.APIAuth(this);
     constructor(url) {
         this.url = url;
     }

package/dist/{external → cjs/external}/types.d.ts

@@ -17,13 +17,6 @@ export declare enum GlobalRole {
 export type AccessLevel = 'read' | 'write' | 'manage' | 'admin';
 export type ResourceType = 'group' | 'category' | 'board';
 export type GlobalResourceType = ResourceType | 'global';
-export type BulkPermissions = 'all-groups' | 'group-categories' | 'category-boards';
-export type GrantedRoles = GrantedRole[];
-export type GrantedRole = {
-    type: ResourceType;
-    resourceId: string;
-    role: UserRole;
-};
 export type SingleOutput = {
     id: string;
     name: string;

package/dist/{index.d.ts → cjs/index.d.ts}

@@ -4,10 +4,10 @@ export * from './external/types';
 export * from './external/vars';
 export * from './classes/permissions';
 export * from './classes/categories';
-export * from './classes/sessions';
 export * from './classes/invites';
 export * from './classes/metrics';
 export * from './classes/groups';
 export * from './classes/boards';
 export * from './classes/admin';
 export * from './classes/users';
+export * from './classes/auth';

package/dist/{index.js → cjs/index.js}

@@ -20,10 +20,10 @@ __exportStar(require("./external/types"), exports);
 __exportStar(require("./external/vars"), exports);
 __exportStar(require("./classes/permissions"), exports);
 __exportStar(require("./classes/categories"), exports);
-__exportStar(require("./classes/sessions"), exports);
 __exportStar(require("./classes/invites"), exports);
 __exportStar(require("./classes/metrics"), exports);
 __exportStar(require("./classes/groups"), exports);
 __exportStar(require("./classes/boards"), exports);
 __exportStar(require("./classes/admin"), exports);
 __exportStar(require("./classes/users"), exports);
+__exportStar(require("./classes/auth"), exports);

package/dist/cjs/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../../src/index.ts","../../src/types.ts","../../src/classes/admin.ts","../../src/classes/auth.ts","../../src/classes/boards.ts","../../src/classes/categories.ts","../../src/classes/groups.ts","../../src/classes/invites.ts","../../src/classes/metrics.ts","../../src/classes/permissions.ts","../../src/classes/users.ts","../../src/core/manager.ts","../../src/core/utils.ts","../../src/external/types.ts","../../src/external/vars.ts"],"version":"5.9.2"}

package/dist/esm/classes/admin.d.ts

@@ -0,0 +1,26 @@
+import { BoardsManager } from '../core/manager';
+import { GetUsersOutput } from './users';
+export declare class APIAdmin {
+    private web;
+    constructor(web: BoardsManager);
+    getUsers({ auth }: AdminFunctionsInput['getUsers']): Promise<import("..").WebResponse<GetUsersOutput[]>>;
+    getActiveRooms({ auth }: AdminFunctionsInput['getActiveRooms']): Promise<import("..").WebResponse<GetRoomsOutput<number>[]>>;
+}
+export type AdminFunctionsInput = {
+    'getUsers': {
+        auth: string;
+    };
+    'getActiveRooms': {
+        auth: string;
+    };
+};
+export type GetRoomsOutput<T> = {
+    boardId: string;
+    elements: T;
+    collaborators: {
+        id: string;
+        socketId: string;
+        username: string;
+        avatarUrl: string | null;
+    }[];
+};

package/dist/esm/classes/admin.js

@@ -0,0 +1,20 @@
+// Data.
+export class APIAdmin {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    // Methods.
+    async getUsers({ auth }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp('/users'),
+        });
+    }
+    async getActiveRooms({ auth }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp('/admin/rooms'),
+        });
+    }
+}

package/dist/esm/classes/auth.d.ts

@@ -0,0 +1,26 @@
+import { Platforms } from '../../prisma/generated/default';
+import { BoardsManager } from '../core/manager';
+export declare class APIAuth {
+    private web;
+    constructor(web: BoardsManager);
+    authenticate({ auth, body }: AuthFunctionsInput['authenticate']): Promise<import("..").WebResponse<AuthenticateOutput>>;
+}
+export type AuthFunctionsInput = {
+    'authenticate': {
+        auth: string;
+        body: AuthenticateInput;
+    };
+};
+export type AuthenticateInput = {
+    platform: Platforms;
+    email: string;
+    displayName: string;
+    avatarUrl?: string | null;
+    currentUserId?: string;
+};
+export type AuthenticateOutput = {
+    email: string;
+    displayName: string | null;
+    avatarUrl: string | null;
+    platform: Platforms;
+};

package/dist/esm/classes/auth.js

@@ -0,0 +1,14 @@
+// Data.
+export class APIAuth {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    // Methods.
+    async authenticate({ auth, body }) {
+        return await this.web.request({
+            method: 'POST', auth, body,
+            endpoint: this.web.qp('/auth'),
+        });
+    }
+}

package/dist/esm/classes/boards.d.ts

@@ -0,0 +1,77 @@
+import { AccessLevel, NameInput, SingleOutput } from '../external/types';
+import { BoardsManager } from '../core/manager';
+import { GetRoomsOutput } from './admin';
+export declare class APIBoards {
+    private web;
+    constructor(web: BoardsManager);
+    getBoards({ auth, categoryId, groupId }: BoardsFunctionsInput['getBoards']): Promise<import("..").WebResponse<GetBoardOutput[]>>;
+    getBoard({ auth, categoryId, groupId, boardId }: BoardsFunctionsInput['getBoard']): Promise<import("..").WebResponse<GetBoardOutput>>;
+    updateBoard({ auth, categoryId, groupId, boardId, body }: BoardsFunctionsInput['updateBoard']): Promise<import("..").WebResponse<string>>;
+    scheduleBoardDeletion({ auth, categoryId, groupId, boardId }: BoardsFunctionsInput['scheduleBoardDeletion']): Promise<import("..").WebResponse<string>>;
+    cancelBoardDeletion({ auth, categoryId, groupId, boardId }: BoardsFunctionsInput['cancelBoardDeletion']): Promise<import("..").WebResponse<string>>;
+    getBoardRoomData<T>({ auth, categoryId, groupId, boardId }: BoardsFunctionsInput['getRoomData']): Promise<import("..").WebResponse<GetRoomsOutput<T>>>;
+    kickUserFromRoom({ auth, categoryId, groupId, boardId, userId }: BoardsFunctionsInput['kickUserFromRoom']): Promise<import("..").WebResponse<string>>;
+}
+export type BoardsFunctionsInput = {
+    'getBoards': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+    };
+    'getBoard': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+        boardId: string;
+    };
+    'updateBoard': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+        boardId: string;
+        body: NameInput;
+    };
+    'scheduleBoardDeletion': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+        boardId: string;
+    };
+    'cancelBoardDeletion': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+        boardId: string;
+    };
+    'getRoomData': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+        boardId: string;
+    };
+    'kickUserFromRoom': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+        boardId: string;
+        userId: string;
+    };
+};
+export type GetBoardOutput = {
+    group: SingleOutput;
+    category: SingleOutput;
+    board: SingleOutput & {
+        dataUrl: string;
+        totalSizeBytes: number;
+        accessLevel: AccessLevel;
+        scheduledForDeletion: Date | null;
+        files: {
+            fileId: string;
+            mimeType: string;
+            createdAt: Date;
+            sizeBytes: number;
+            fileUrl: string;
+        }[];
+    };
+};
+export type GetFileOutput = ReadableStream | Blob;

package/dist/esm/classes/boards.js

@@ -0,0 +1,50 @@
+export class APIBoards {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    async getBoards({ auth, categoryId, groupId }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/data/groups/${groupId}/categories/${categoryId}`),
+        });
+    }
+    async getBoard({ auth, categoryId, groupId, boardId }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/data/groups/${groupId}/categories/${categoryId}/boards/${boardId}`),
+        });
+    }
+    async updateBoard({ auth, categoryId, groupId, boardId, body }) {
+        return await this.web.request({
+            method: 'PATCH', auth, body,
+            endpoint: this.web.qp(`/data/groups/${groupId}/categories/${categoryId}/boards/${boardId}`),
+        });
+    }
+    async scheduleBoardDeletion({ auth, categoryId, groupId, boardId }) {
+        return await this.web.request({
+            method: 'DELETE', auth,
+            endpoint: this.web.qp(`/data/groups/${groupId}/categories/${categoryId}/boards/${boardId}`),
+        });
+    }
+    async cancelBoardDeletion({ auth, categoryId, groupId, boardId }) {
+        return await this.web.request({
+            method: 'POST', auth,
+            endpoint: this.web.qp(`/data/groups/${groupId}/categories/${categoryId}/boards/${boardId}/cancel-deletion`),
+        });
+    }
+    async getBoardRoomData({ auth, categoryId, groupId, boardId }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/data/groups/${groupId}/categories/${categoryId}/boards/${boardId}/room`),
+        });
+    }
+    async kickUserFromRoom({ auth, categoryId, groupId, boardId, userId }) {
+        return await this.web.request({
+            method: 'POST', auth,
+            endpoint: this.web.qp(`/data/groups/${groupId}/categories/${categoryId}/boards/${boardId}/room`, {
+                userId,
+            }),
+        });
+    }
+}