@excali-boards/boards-api-client 1.1.51 → 1.1.52

package/dist/core/manager.js

@@ -1,47 +1,43 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BoardsManager = void 0;
-const permissions_1 = require("../classes/permissions");
-const flashcards_1 = require("../classes/flashcards");
-const categories_1 = require("../classes/categories");
-const analytics_1 = require("../classes/analytics");
-const sessions_1 = require("../classes/sessions");
-const calendar_1 = require("../classes/calendar");
-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 utils_1 = require("../classes/utils");
-const users_1 = require("../classes/users");
-const files_1 = require("../classes/files");
-const admin_1 = require("../classes/admin");
-const axios_1 = __importDefault(require("axios"));
-const utils_2 = require("./utils");
-class BoardsManager {
+import { APIPermissions } from '../classes/permissions';
+import { APIFlashcards } from '../classes/flashcards';
+import { APICategories } from '../classes/categories';
+import { APIAnalytics } from '../classes/analytics';
+import { APISessions } from '../classes/sessions';
+import { APICalendar } from '../classes/calendar';
+import { APIMetrics } from '../classes/metrics';
+import { APIInvites } from '../classes/invites';
+import { APIGroups } from '../classes/groups';
+import { APIBoards } from '../classes/boards';
+import { APIUtils } from '../classes/utils';
+import { APIUsers } from '../classes/users';
+import { APIFiles } from '../classes/files';
+import { APIAdmin } from '../classes/admin';
+import { APIAuth } from '../classes/auth';
+import axios from 'axios';
+import { transformDates } from './utils';
+export class BoardsManager {
     url;
-    permissions = new permissions_1.APIPermissions(this);
-    categories = new categories_1.APICategories(this);
-    flashcards = new flashcards_1.APIFlashcards(this);
-    analytics = new analytics_1.APIAnalytics(this);
-    calendar = new calendar_1.APICalendar(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);
-    utils = new utils_1.APIUtils(this);
-    files = new files_1.APIFiles(this);
+    permissions = new APIPermissions(this);
+    categories = new APICategories(this);
+    flashcards = new APIFlashcards(this);
+    analytics = new APIAnalytics(this);
+    calendar = new APICalendar(this);
+    sessions = new APISessions(this);
+    invites = new APIInvites(this);
+    metrics = new APIMetrics(this);
+    groups = new APIGroups(this);
+    boards = new APIBoards(this);
+    admin = new APIAdmin(this);
+    users = new APIUsers(this);
+    utils = new APIUtils(this);
+    files = new APIFiles(this);
+    auth = new APIAuth(this);
     constructor(url) {
         this.url = url;
     }
     async request(data) {
         try {
-            axios_1.default.interceptors.response.use(utils_2.transformDates);
+            axios.interceptors.response.use(transformDates);
             let requestData;
             let contentType;
             if (data.body instanceof FormData) {
@@ -56,7 +52,7 @@ class BoardsManager {
                 requestData = undefined;
                 contentType = undefined;
             }
-            const res = await (0, axios_1.default)(this.url + data.endpoint, {
+            const res = await axios(this.url + data.endpoint, {
                 method: data.method,
                 data: requestData,
                 headers: {
@@ -94,4 +90,3 @@ class BoardsManager {
         return (obj && typeof obj === 'object' && 'status' in obj);
     }
 }
-exports.BoardsManager = BoardsManager;

package/dist/core/utils.js

@@ -1,14 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDateStringRegex = isDateStringRegex;
-exports.recursiveDateConversion = recursiveDateConversion;
-exports.transformDates = transformDates;
-exports.getAll = getAll;
-function isDateStringRegex(value) {
+export function isDateStringRegex(value) {
     const isoPattern = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,3})?Z$/;
     return typeof value === 'string' && isoPattern.test(value);
 }
-function recursiveDateConversion(data) {
+export function recursiveDateConversion(data) {
     if (data instanceof Date)
         return new Date(data);
     if (Array.isArray(data))
@@ -20,12 +14,12 @@ function recursiveDateConversion(data) {
     }
     return isDateStringRegex(data) ? new Date(data) : data;
 }
-function transformDates(response) {
+export function transformDates(response) {
     if (response.data)
         response.data = recursiveDateConversion(response.data);
     return response;
 }
-async function getAll(fetcher, options) {
+export async function getAll(fetcher, options) {
     const limit = options?.limit ?? 50;
     const maxItems = options?.maxItems ?? Infinity;
     const allItems = [];

package/dist/external/types.d.ts

@@ -68,6 +68,17 @@ export type AllRooms = {
     type: BoardType;
     collaborators: CollabUser[];
 }[];
+export type RecentlyActiveRoom = {
+    boardId: string;
+    elements: number;
+    type: BoardType;
+    lastCollaborators: CollabUser[];
+    lastActiveAt: number;
+};
+export type GetActiveRoomsResponse = {
+    rooms: AllRooms;
+    recentlyActiveRooms: RecentlyActiveRoom[];
+};
 export type CollabUser = {
     id: string;
     socketId: string;

package/dist/external/types.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GlobalRole = void 0;
-var GlobalRole;
+export var GlobalRole;
 (function (GlobalRole) {
     GlobalRole["Developer"] = "Developer";
-})(GlobalRole || (exports.GlobalRole = GlobalRole = {}));
+})(GlobalRole || (GlobalRole = {}));

package/dist/external/vars.js

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PermissionHierarchy = exports.SimplePermissionHierarchy = exports.GroupRole = exports.CategoryRole = exports.BoardRole = exports.Platforms = exports.DBUserPartial = exports.DBUserSelectArgs = void 0;
-const default_1 = require("../../prisma/generated/default");
-const types_1 = require("./types");
-exports.DBUserSelectArgs = {
+import { Prisma } from '../../prisma/generated/default';
+import { GlobalRole } from './types';
+export const DBUserSelectArgs = {
     select: {
         email: true,
         userId: true,
@@ -19,41 +16,41 @@ exports.DBUserSelectArgs = {
         loginMethods: { select: { platform: true, platformEmail: true } },
     },
 };
-exports.DBUserPartial = default_1.Prisma.validator()(exports.DBUserSelectArgs);
-var Platforms;
+export const DBUserPartial = Prisma.validator()(DBUserSelectArgs);
+export var Platforms;
 (function (Platforms) {
     Platforms["Google"] = "Google";
     Platforms["GitHub"] = "GitHub";
     Platforms["Discord"] = "Discord";
     Platforms["Microsoft"] = "Microsoft";
-})(Platforms || (exports.Platforms = Platforms = {}));
-var BoardRole;
+})(Platforms || (Platforms = {}));
+export var BoardRole;
 (function (BoardRole) {
     BoardRole["BoardViewer"] = "BoardViewer";
     BoardRole["BoardCollaborator"] = "BoardCollaborator";
-})(BoardRole || (exports.BoardRole = BoardRole = {}));
-var CategoryRole;
+})(BoardRole || (BoardRole = {}));
+export var CategoryRole;
 (function (CategoryRole) {
     CategoryRole["CategoryViewer"] = "CategoryViewer";
     CategoryRole["CategoryCollaborator"] = "CategoryCollaborator";
     CategoryRole["CategoryManager"] = "CategoryManager";
     CategoryRole["CategoryAdmin"] = "CategoryAdmin";
-})(CategoryRole || (exports.CategoryRole = CategoryRole = {}));
-var GroupRole;
+})(CategoryRole || (CategoryRole = {}));
+export var GroupRole;
 (function (GroupRole) {
     GroupRole["GroupViewer"] = "GroupViewer";
     GroupRole["GroupCollaborator"] = "GroupCollaborator";
     GroupRole["GroupManager"] = "GroupManager";
     GroupRole["GroupAdmin"] = "GroupAdmin";
-})(GroupRole || (exports.GroupRole = GroupRole = {}));
+})(GroupRole || (GroupRole = {}));
 // Variables.
-exports.SimplePermissionHierarchy = {
+export const SimplePermissionHierarchy = {
     Viewer: 1,
     Collaborator: 2,
     Manager: 3,
     Admin: 4,
 };
-exports.PermissionHierarchy = {
+export const PermissionHierarchy = {
     [BoardRole.BoardViewer]: 1,
     [BoardRole.BoardCollaborator]: 2,
     [CategoryRole.CategoryViewer]: 3,
@@ -64,5 +61,5 @@ exports.PermissionHierarchy = {
     [GroupRole.GroupCollaborator]: 8,
     [GroupRole.GroupManager]: 9,
     [GroupRole.GroupAdmin]: 10,
-    [types_1.GlobalRole.Developer]: 11,
+    [GlobalRole.Developer]: 11,
 };

package/dist/index.d.ts

@@ -17,3 +17,4 @@ export * from './classes/utils';
 export * from './classes/admin';
 export * from './classes/users';
 export * from './classes/files';
+export * from './classes/auth';

package/dist/index.js

@@ -1,35 +1,20 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./core/manager"), exports);
-__exportStar(require("./core/utils"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./external/types"), exports);
-__exportStar(require("./external/vars"), exports);
-__exportStar(require("./classes/permissions"), exports);
-__exportStar(require("./classes/categories"), exports);
-__exportStar(require("./classes/flashcards"), exports);
-__exportStar(require("./classes/analytics"), exports);
-__exportStar(require("./classes/calendar"), 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/utils"), exports);
-__exportStar(require("./classes/admin"), exports);
-__exportStar(require("./classes/users"), exports);
-__exportStar(require("./classes/files"), exports);
+export * from './core/manager';
+export * from './core/utils';
+export * from './types';
+export * from './external/types';
+export * from './external/vars';
+export * from './classes/permissions';
+export * from './classes/categories';
+export * from './classes/flashcards';
+export * from './classes/analytics';
+export * from './classes/calendar';
+export * from './classes/sessions';
+export * from './classes/invites';
+export * from './classes/metrics';
+export * from './classes/groups';
+export * from './classes/boards';
+export * from './classes/utils';
+export * from './classes/admin';
+export * from './classes/users';
+export * from './classes/files';
+export * from './classes/auth';

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

@@ -0,0 +1,23 @@
+import { Paginated, WithHeaders } from '../types';
+import { BoardsManager } from '../core/manager';
+import { AllRooms, RecentlyActiveRoom } from '../external/types';
+import { GetUsersOutput } from './users';
+export declare class APIAdmin {
+    private web;
+    constructor(web: BoardsManager);
+    getUsers({ auth, page, limit, ...rest }: AdminFunctionsInput['getUsers']): Promise<import("..").WebResponse<Paginated<GetUsersOutput>>>;
+    getActiveRooms({ auth, ...rest }: AdminFunctionsInput['getActiveRooms']): Promise<import("..").WebResponse<{
+        rooms: AllRooms;
+        recentlyActiveRooms: RecentlyActiveRoom[];
+    }>>;
+}
+export type AdminFunctionsInput = WithHeaders<{
+    'getUsers': {
+        auth: string;
+        page?: number;
+        limit?: number;
+    };
+    'getActiveRooms': {
+        auth: string;
+    };
+}>;

package/dist/src/classes/admin.js

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

package/dist/src/classes/analytics.d.ts

@@ -0,0 +1,62 @@
+import { BoardsManager } from '../core/manager';
+import { WithHeaders } from '../types';
+export declare class APIAnalytics {
+    private web;
+    constructor(web: BoardsManager);
+    getGlobalAnalytics({ auth, ...rest }: AnalyticsFunctionsInput['getGlobalAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithUser[]>>;
+    getUserAnalytics({ auth, ...rest }: AnalyticsFunctionsInput['getUserAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithBoard[]>>;
+    getBoardAnalytics({ auth, boardId, categoryId, groupId, ...rest }: AnalyticsFunctionsInput['getBoardAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithUser[]>>;
+    getCategoryAnalytics({ auth, categoryId, groupId, ...rest }: AnalyticsFunctionsInput['getCategoryAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithUser[]>>;
+    getGroupAnalytics({ auth, groupId, ...rest }: AnalyticsFunctionsInput['getGroupAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithUser[]>>;
+}
+export type AnalyticsFunctionsInput = WithHeaders<{
+    'getGlobalAnalytics': {
+        auth: string;
+    };
+    'getUserAnalytics': {
+        auth: string;
+    };
+    'getBoardAnalytics': {
+        auth: string;
+        boardId: string;
+        categoryId: string;
+        groupId: string;
+    };
+    'getCategoryAnalytics': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+    };
+    'getGroupAnalytics': {
+        auth: string;
+        groupId: string;
+    };
+}>;
+export type ActivityAnalytics = {
+    totalSessions: number;
+    totalActiveSeconds: number;
+    lastActivityAt: Date;
+};
+export type BoardData = {
+    name: string;
+    boardId: string;
+    category: {
+        categoryId: string;
+        name: string;
+        group: {
+            groupId: string;
+            name: string;
+        };
+    };
+};
+export type UserBoardActivityWithBoard = ActivityAnalytics & {
+    board: BoardData;
+};
+export type UserBoardActivityWithUser = ActivityAnalytics & {
+    board: BoardData;
+    user: {
+        userId: string;
+        displayName: string;
+        avatarUrl: string | null;
+    };
+};

package/dist/src/classes/analytics.js

@@ -0,0 +1,38 @@
+// Data.
+export class APIAnalytics {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    // Methods.
+    async getGlobalAnalytics({ auth, ...rest }) {
+        return await this.web.request({
+            method: 'GET', auth, ...rest,
+            endpoint: this.web.qp('/analytics'),
+        });
+    }
+    async getUserAnalytics({ auth, ...rest }) {
+        return await this.web.request({
+            method: 'GET', auth, ...rest,
+            endpoint: this.web.qp('/analytics/user'),
+        });
+    }
+    async getBoardAnalytics({ auth, boardId, categoryId, groupId, ...rest }) {
+        return await this.web.request({
+            method: 'GET', auth, ...rest,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/analytics`),
+        });
+    }
+    async getCategoryAnalytics({ auth, categoryId, groupId, ...rest }) {
+        return await this.web.request({
+            method: 'GET', auth, ...rest,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/analytics`),
+        });
+    }
+    async getGroupAnalytics({ auth, groupId, ...rest }) {
+        return await this.web.request({
+            method: 'GET', auth, ...rest,
+            endpoint: this.web.qp(`/groups/${groupId}/analytics`),
+        });
+    }
+}

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

@@ -0,0 +1,48 @@
+import { BoardsManager } from '../core/manager';
+import { CreateSessionInput } from './sessions';
+import { DBUserPartialType } from '../external/vars';
+import { WithHeaders } from '../types';
+export declare class APIAuth {
+    private web;
+    constructor(web: BoardsManager);
+    authenticate({ auth, body, ...rest }: AuthFunctionsInput['authenticate']): Promise<import("..").WebResponse<{
+        avatarUrl: string | null;
+        boardPermissions: {
+            boardId: string;
+            role: import("../../prisma/generated").$Enums.BoardRole;
+        }[];
+        categoryPermissions: {
+            categoryId: string;
+            role: import("../../prisma/generated").$Enums.CategoryRole;
+        }[];
+        displayName: string;
+        email: string;
+        groupPermissions: {
+            groupId: string;
+            role: import("../../prisma/generated").$Enums.GroupRole;
+        }[];
+        invitedBy: string | null;
+        loginMethods: {
+            platform: import("../../prisma/generated").$Enums.Platforms;
+            platformEmail: string;
+        }[];
+        mainGroupId: string | null;
+        mainLoginType: import("../../prisma/generated").$Enums.Platforms;
+        registrationMethod: import("../../prisma/generated").$Enums.RegistrationMethod;
+        userId: string;
+    }>>;
+}
+export type AuthFunctionsInput = WithHeaders<{
+    'authenticate': {
+        auth: string;
+        body: CreateSessionInput & {
+            refreshProfile?: boolean;
+        };
+    };
+}>;
+export type AuthOutput = DBUserPartialType & {
+    sessions: {
+        dbId: string;
+        lastUsed: Date;
+    }[];
+};

package/dist/src/classes/auth.js

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

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

@@ -0,0 +1,99 @@
+import { AccessLevel, AllRooms, NameInput, SingleOutput } from '../external/types';
+import { BoardType } from '../../prisma/generated/default';
+import { BoardsManager } from '../core/manager';
+import { WithHeaders } from '../types';
+export declare class APIBoards {
+    private web;
+    constructor(web: BoardsManager);
+    getBoards({ auth, categoryId, groupId, ...rest }: BoardsFunctionsInput['getBoards']): Promise<import("..").WebResponse<GetBoardOutput[]>>;
+    getBoard({ auth, categoryId, groupId, boardId, ...rest }: BoardsFunctionsInput['getBoard']): Promise<import("..").WebResponse<GetBoardOutput>>;
+    updateBoard({ auth, categoryId, groupId, boardId, body, ...rest }: BoardsFunctionsInput['updateBoard']): Promise<import("..").WebResponse<string>>;
+    moveBoard({ auth, categoryId, groupId, boardId, body, ...rest }: BoardsFunctionsInput['moveBoard']): Promise<import("..").WebResponse<MoveBoardOutput>>;
+    scheduleBoardDeletion({ auth, categoryId, groupId, boardId, ...rest }: BoardsFunctionsInput['scheduleBoardDeletion']): Promise<import("..").WebResponse<string>>;
+    forceDeleteBoard({ auth, categoryId, groupId, boardId, ...rest }: BoardsFunctionsInput['scheduleBoardDeletion']): Promise<import("..").WebResponse<string>>;
+    cancelBoardDeletion({ auth, categoryId, groupId, boardId, ...rest }: BoardsFunctionsInput['cancelBoardDeletion']): Promise<import("..").WebResponse<string>>;
+    getBoardRoomData({ auth, categoryId, groupId, boardId, ...rest }: BoardsFunctionsInput['getRoomData']): Promise<import("..").WebResponse<AllRooms>>;
+    kickUserFromRoom({ auth, categoryId, groupId, boardId, userId, ...rest }: BoardsFunctionsInput['kickUserFromRoom']): Promise<import("..").WebResponse<string>>;
+}
+export type BoardsFunctionsInput = WithHeaders<{
+    '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;
+    };
+    'moveBoard': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+        boardId: string;
+        body: MoveBoardInput;
+    };
+    '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 & {
+        type: BoardType;
+        dataUrl: string;
+        hasFlashcards: boolean;
+        totalSizeBytes: number;
+        accessLevel: AccessLevel;
+        scheduledForDeletion: Date | null;
+        files: {
+            fileId: string;
+            mimeType: string;
+            createdAt: Date;
+            sizeBytes: number;
+            fileUrl: string;
+        }[];
+    };
+};
+export type GetFileOutput = ReadableStream | Blob;
+export type MoveBoardInput = {
+    targetCategoryId: string;
+    targetIndex?: number;
+};
+export type MoveBoardOutput = {
+    boardId: string;
+    categoryId: string;
+    groupId: string;
+    index: number;
+};