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

package/dist/src/core/manager.d.ts

@@ -0,0 +1,44 @@
+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 { RequestMethod, WebResponse } from '../types';
+export declare class BoardsManager {
+    url: string;
+    readonly permissions: APIPermissions;
+    readonly categories: APICategories;
+    readonly flashcards: APIFlashcards;
+    readonly analytics: APIAnalytics;
+    readonly calendar: APICalendar;
+    readonly sessions: APISessions;
+    readonly invites: APIInvites;
+    readonly metrics: APIMetrics;
+    readonly groups: APIGroups;
+    readonly boards: APIBoards;
+    readonly admin: APIAdmin;
+    readonly users: APIUsers;
+    readonly utils: APIUtils;
+    readonly files: APIFiles;
+    readonly auth: APIAuth;
+    constructor(url: string);
+    request<O, T = unknown>(data: {
+        endpoint: string;
+        method: RequestMethod;
+        body?: T;
+        auth?: string;
+        headers?: Record<string, string> | null;
+    }): Promise<WebResponse<O>>;
+    qp<T extends Record<string, unknown>>(url: string, params?: T): string;
+    private isResponse;
+}

package/dist/src/core/manager.js

@@ -0,0 +1,92 @@
+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 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.interceptors.response.use(transformDates);
+            let requestData;
+            let contentType;
+            if (data.body instanceof FormData) {
+                requestData = data.body;
+                contentType = 'multipart/form-data';
+            }
+            else if (data.body !== undefined) {
+                requestData = JSON.stringify(data.body);
+                contentType = 'application/json';
+            }
+            else {
+                requestData = undefined;
+                contentType = undefined;
+            }
+            const res = await axios(this.url + data.endpoint, {
+                method: data.method,
+                data: requestData,
+                headers: {
+                    ...(data.headers === null ? {} : contentType ? { 'Content-Type': contentType } : {}),
+                    ...(data.auth ? { 'Authorization': data.auth } : {}),
+                    ...(data.headers || {}),
+                },
+            })
+                .then((res) => res.data)
+                .catch((err) => err.response?.data);
+            if (!this.isResponse(res)) {
+                throw new Error('Invalid response received.');
+            }
+            return res;
+        }
+        catch {
+            return {
+                status: 500,
+                error: 'An error occurred while processing the request.',
+            };
+        }
+    }
+    qp(url, params) {
+        if (!params)
+            return url;
+        const query = new URLSearchParams();
+        for (const [key, value] of Object.entries(params)) {
+            if (value === undefined)
+                continue;
+            query.append(key, String(value));
+        }
+        return url + '?' + query.toString();
+    }
+    isResponse(obj) {
+        return (obj && typeof obj === 'object' && 'status' in obj);
+    }
+}

package/dist/src/core/utils.d.ts

@@ -0,0 +1,9 @@
+import { Paginated, PaginatedWebResponse, WebResponse } from '../types';
+import { AxiosResponse } from 'axios';
+export declare function isDateStringRegex(value: unknown): value is string;
+export declare function recursiveDateConversion<T>(data: T): T;
+export declare function transformDates<T>(response: AxiosResponse<T>): AxiosResponse<T>;
+export declare function getAll<T>(fetcher: (page: number, limit: number) => Promise<WebResponse<Paginated<T>>>, options?: {
+    limit?: number;
+    maxItems?: number;
+}): Promise<PaginatedWebResponse<T>>;

package/dist/src/core/utils.js

@@ -0,0 +1,52 @@
+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);
+}
+export function recursiveDateConversion(data) {
+    if (data instanceof Date)
+        return new Date(data);
+    if (Array.isArray(data))
+        return data.map(recursiveDateConversion);
+    if (typeof data === 'object' && data !== null) {
+        for (const key in data) {
+            data[key] = recursiveDateConversion(data[key]);
+        }
+    }
+    return isDateStringRegex(data) ? new Date(data) : data;
+}
+export function transformDates(response) {
+    if (response.data)
+        response.data = recursiveDateConversion(response.data);
+    return response;
+}
+export async function getAll(fetcher, options) {
+    const limit = options?.limit ?? 50;
+    const maxItems = options?.maxItems ?? Infinity;
+    const allItems = [];
+    let hasMore = true;
+    let page = 1;
+    while (hasMore && allItems.length < maxItems) {
+        const response = await fetcher(page, limit);
+        if (response.status !== 200)
+            return {
+                status: response.status,
+                error: response.error || 'An error occurred while fetching items.',
+            };
+        const items = Array.isArray(response.data.data) ? response.data.data : [response.data.data];
+        allItems.push(...items.slice(0, maxItems - allItems.length));
+        hasMore = response.data.pagination.hasMore && allItems.length < maxItems;
+        page++;
+    }
+    return {
+        status: 200,
+        data: {
+            data: allItems,
+            pagination: {
+                page: Math.ceil(allItems.length / limit),
+                limit,
+                total: allItems.length,
+                hasMore: allItems.length >= maxItems ? false : hasMore,
+            },
+        },
+    };
+}

package/dist/src/external/types.d.ts

@@ -0,0 +1,87 @@
+import { BoardRole, CategoryRole, GroupRole } from './vars';
+import { BoardType } from '../../prisma/generated/default';
+export type UserRole = BoardRole | CategoryRole | GroupRole | GlobalRole;
+export declare enum GlobalRole {
+    Developer = "Developer"
+}
+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;
+    resourceId: string;
+    role: UserRole;
+};
+export type SingleOutput = {
+    id: string;
+    name: string;
+    index: number;
+    accessLevel: AccessLevel;
+};
+export type NameInput = {
+    name: string;
+};
+export type BoardInput = NameInput & {
+    type: BoardType;
+};
+export type GrantedEntry = {
+    role: UserRole;
+    grantType: 'explicit' | 'implicit';
+    type: ResourceType;
+    resourceId: string;
+    basedOnType: ResourceType;
+    basedOnResourceId: string;
+    basedOnResourceName: string;
+};
+export type AllRooms = {
+    boardId: string;
+    elements: number;
+    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;
+    username: string;
+    avatarUrl: string | null;
+};

package/dist/src/external/types.js

@@ -0,0 +1,4 @@
+export var GlobalRole;
+(function (GlobalRole) {
+    GlobalRole["Developer"] = "Developer";
+})(GlobalRole || (GlobalRole = {}));

package/dist/src/external/vars.d.ts

@@ -0,0 +1,99 @@
+import { Prisma } from '../../prisma/generated/default';
+import { UserRole } from './types';
+export declare const DBUserSelectArgs: {
+    select: {
+        email: true;
+        userId: true;
+        invitedBy: true;
+        avatarUrl: true;
+        mainGroupId: true;
+        displayName: true;
+        mainLoginType: true;
+        registrationMethod: true;
+        groupPermissions: {
+            select: {
+                groupId: true;
+                role: true;
+            };
+        };
+        categoryPermissions: {
+            select: {
+                categoryId: true;
+                role: true;
+            };
+        };
+        boardPermissions: {
+            select: {
+                boardId: true;
+                role: true;
+            };
+        };
+        loginMethods: {
+            select: {
+                platform: true;
+                platformEmail: true;
+            };
+        };
+    };
+};
+export declare const DBUserPartial: {
+    select: {
+        email: true;
+        userId: true;
+        invitedBy: true;
+        avatarUrl: true;
+        mainGroupId: true;
+        displayName: true;
+        mainLoginType: true;
+        registrationMethod: true;
+        groupPermissions: {
+            select: {
+                groupId: true;
+                role: true;
+            };
+        };
+        categoryPermissions: {
+            select: {
+                categoryId: true;
+                role: true;
+            };
+        };
+        boardPermissions: {
+            select: {
+                boardId: true;
+                role: true;
+            };
+        };
+        loginMethods: {
+            select: {
+                platform: true;
+                platformEmail: true;
+            };
+        };
+    };
+};
+export type DBUserPartialType = Prisma.UserGetPayload<typeof DBUserPartial>;
+export declare enum Platforms {
+    Google = "Google",
+    GitHub = "GitHub",
+    Discord = "Discord",
+    Microsoft = "Microsoft"
+}
+export declare enum BoardRole {
+    BoardViewer = "BoardViewer",
+    BoardCollaborator = "BoardCollaborator"
+}
+export declare enum CategoryRole {
+    CategoryViewer = "CategoryViewer",
+    CategoryCollaborator = "CategoryCollaborator",
+    CategoryManager = "CategoryManager",
+    CategoryAdmin = "CategoryAdmin"
+}
+export declare enum GroupRole {
+    GroupViewer = "GroupViewer",
+    GroupCollaborator = "GroupCollaborator",
+    GroupManager = "GroupManager",
+    GroupAdmin = "GroupAdmin"
+}
+export declare const SimplePermissionHierarchy: Record<string, number>;
+export declare const PermissionHierarchy: Record<UserRole, number>;

package/dist/src/external/vars.js

@@ -0,0 +1,65 @@
+import { Prisma } from '../../prisma/generated/default';
+import { GlobalRole } from './types';
+export const DBUserSelectArgs = {
+    select: {
+        email: true,
+        userId: true,
+        invitedBy: true,
+        avatarUrl: true,
+        mainGroupId: true,
+        displayName: true,
+        mainLoginType: true,
+        registrationMethod: true,
+        groupPermissions: { select: { groupId: true, role: true } },
+        categoryPermissions: { select: { categoryId: true, role: true } },
+        boardPermissions: { select: { boardId: true, role: true } },
+        loginMethods: { select: { platform: true, platformEmail: true } },
+    },
+};
+export const DBUserPartial = Prisma.validator()(DBUserSelectArgs);
+export var Platforms;
+(function (Platforms) {
+    Platforms["Google"] = "Google";
+    Platforms["GitHub"] = "GitHub";
+    Platforms["Discord"] = "Discord";
+    Platforms["Microsoft"] = "Microsoft";
+})(Platforms || (Platforms = {}));
+export var BoardRole;
+(function (BoardRole) {
+    BoardRole["BoardViewer"] = "BoardViewer";
+    BoardRole["BoardCollaborator"] = "BoardCollaborator";
+})(BoardRole || (BoardRole = {}));
+export var CategoryRole;
+(function (CategoryRole) {
+    CategoryRole["CategoryViewer"] = "CategoryViewer";
+    CategoryRole["CategoryCollaborator"] = "CategoryCollaborator";
+    CategoryRole["CategoryManager"] = "CategoryManager";
+    CategoryRole["CategoryAdmin"] = "CategoryAdmin";
+})(CategoryRole || (CategoryRole = {}));
+export var GroupRole;
+(function (GroupRole) {
+    GroupRole["GroupViewer"] = "GroupViewer";
+    GroupRole["GroupCollaborator"] = "GroupCollaborator";
+    GroupRole["GroupManager"] = "GroupManager";
+    GroupRole["GroupAdmin"] = "GroupAdmin";
+})(GroupRole || (GroupRole = {}));
+// Variables.
+export const SimplePermissionHierarchy = {
+    Viewer: 1,
+    Collaborator: 2,
+    Manager: 3,
+    Admin: 4,
+};
+export const PermissionHierarchy = {
+    [BoardRole.BoardViewer]: 1,
+    [BoardRole.BoardCollaborator]: 2,
+    [CategoryRole.CategoryViewer]: 3,
+    [CategoryRole.CategoryCollaborator]: 4,
+    [CategoryRole.CategoryManager]: 5,
+    [CategoryRole.CategoryAdmin]: 6,
+    [GroupRole.GroupViewer]: 7,
+    [GroupRole.GroupCollaborator]: 8,
+    [GroupRole.GroupManager]: 9,
+    [GroupRole.GroupAdmin]: 10,
+    [GlobalRole.Developer]: 11,
+};

package/dist/src/index.d.ts

@@ -0,0 +1,20 @@
+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/index.js

@@ -0,0 +1,20 @@
+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/types.d.ts

@@ -0,0 +1,61 @@
+export type StatusWebCode = 200 | 400 | 401 | 403 | 404 | 413 | 429 | 500 | 503;
+export type WebResponse<T, S extends StatusWebCode = StatusWebCode> = S extends 200 ? {
+    status: S;
+    data: T;
+} : {
+    status: S;
+    error: string | string[];
+};
+export type Paginated<T> = {
+    data: T extends (infer U)[] ? U[] : T[];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+        hasMore: boolean;
+    };
+};
+export type WithHeaders<T> = {
+    [P in keyof T]: T[P] & {
+        headers?: Record<string, string>;
+    };
+};
+export type PaginatedWebResponse<T, S extends StatusWebCode = StatusWebCode> = WebResponse<Paginated<T>, S>;
+export type SuccessWithId<T extends string> = {
+    [x in T]: string;
+} & {
+    message: string;
+};
+export type RequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+export type CancelOutWebResponses<T extends WebResponse<unknown>> = T extends {
+    status: 200;
+    data: infer U;
+} ? U : never;
+export type InferPartial<T> = T extends DeepPartial<infer U> ? U : T;
+export type Simplify<T> = {
+    [P in keyof T]: T[P];
+};
+export type Primitive = string | number | boolean | bigint | symbol | null | undefined | Date;
+export type DeepPartial<T, N extends boolean = false> = T extends Primitive ? T | (N extends true ? undefined : never) : T extends Array<infer U> ? Array<DeepPartial<U, N>> : {
+    [P in keyof T]?: DeepPartial<T[P], N>;
+};
+export type DeepRequired<T> = T extends Primitive ? NonNullable<T> : T extends Array<infer U> ? Array<DeepRequired<U>> : {
+    [P in keyof T]-?: DeepRequired<T[P]>;
+};
+export type DeepNullable<T> = T extends Primitive ? T | null : T extends Array<infer U> ? Array<DeepNullable<U>> : {
+    [P in keyof T]: DeepNullable<T[P]>;
+};
+export type AtLeast<T, K extends keyof T> = T & Pick<T, K>;
+export type AtLeastPartial<T, K extends keyof T> = DeepPartial<T> & Pick<T, K>;
+export type MakeRequired<T, P extends keyof T> = T extends Array<infer U> ? U extends object ? Array<MakeRequired<U, P & keyof U>> : T : Omit<T, P> & Required<Pick<T, P>>;
+export type WithoutUndefined<T> = T extends undefined ? never : T;
+export type DeepNonNullable<T> = {
+    [P in keyof T]-?: DeepNonNullable<NonNullable<T[P]>>;
+};
+export type DeepNonReadonly<T> = {
+    -readonly [P in keyof T]: DeepNonReadonly<T[P]>;
+};
+export type KeysOf<T> = '*' | KeysOfInner<DeepRequired<T>>;
+export type KeysOfInner<T> = T extends Record<string, unknown> ? {
+    [K in keyof T]-?: K extends string ? T[K] extends (infer U)[] ? `${K}[]` | `${K}[].${KeysOfInner<U>}` : `${K}` | (T[K] extends null | undefined ? never : `${K}.${KeysOfInner<NonNullable<T[K]>>}`) : never;
+}[keyof T] : never;

package/dist/src/types.js

@@ -0,0 +1 @@
+export {};

package/dist/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.1.50",
+	"version": "1.1.52",
 	"name": "@excali-boards/boards-api-client",
 	"description": "A simple API client for the Boards API.",
 	"repository": "https://github.com/Excali-Boards/boards-api-client",
@@ -35,7 +35,7 @@
 		"@typescript-eslint/eslint-plugin": "6.18.0",
 		"@typescript-eslint/parser": "6.18.0",
 		"eslint": "8.56.0",
-		"typescript": "5.9.2"
+		"typescript": "7.0.2"
 	},
 	"engines": {
 		"node": ">=20.2.0"

package/dist/tsconfig.tsbuildinfo

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