@excali-boards/boards-api-client 1.1.73 → 1.1.74

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

@@ -1,116 +0,0 @@
-import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
-import { GrantedRoles, ResourceType } from '../external/types';
-import { Invite } from '../../prisma/generated';
-import { BoardsManager } from '../core/manager';
-import { WithHeaders } from '../types';
-export declare class APIInvites {
-    private web;
-    constructor(web: BoardsManager);
-    getUserInvites({ auth, ...rest }: InvitesFunctionsInput['getUserInvites']): Promise<import("..").WebResponse<GetUserInvitesOutput>>;
-    getResourceInvites({ auth, query, ...rest }: InvitesFunctionsInput['getResourceInvites']): Promise<import("..").WebResponse<GetResourceInvitesOutput>>;
-    getInviteDetails({ auth, code, ...rest }: InvitesFunctionsInput['getInviteDetails']): Promise<import("..").WebResponse<InviteDetails>>;
-    createInvite({ auth, body, ...rest }: InvitesFunctionsInput['createInvite']): Promise<import("..").WebResponse<CreateInviteOutput>>;
-    useInvite({ auth, code, ...rest }: InvitesFunctionsInput['useInvite']): Promise<import("..").WebResponse<UseInviteOutput>>;
-    renewInvite({ auth, code, ...rest }: InvitesFunctionsInput['renewInvite']): Promise<import("..").WebResponse<RenewInviteOutput>>;
-    revokeInvite({ auth, code, ...rest }: InvitesFunctionsInput['revokeInvite']): Promise<import("..").WebResponse<string>>;
-}
-export type InvitesFunctionsInput = WithHeaders<{
-    'getUserInvites': {
-        auth: string;
-    };
-    'getResourceInvites': {
-        auth: string;
-        query: ViewInvitesQuery;
-    };
-    'getInviteDetails': {
-        auth: string;
-        code: string;
-    };
-    'createInvite': {
-        auth: string;
-        body: CreateInviteInput;
-    };
-    'useInvite': {
-        auth: string;
-        code: string;
-    };
-    'revokeInvite': {
-        auth: string;
-        code: string;
-    };
-    'renewInvite': {
-        auth: string;
-        code: string;
-    };
-}>;
-export type ViewInvitesQuery = {
-    type: ResourceType;
-    groupId?: string;
-    categoryId?: string;
-    boardId?: 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 RenewInviteOutput = CreateInviteOutput & {
-    currentUses: number;
-};
-export type GetUserInvitesOutput = {
-    invites: InviteData[];
-    canInvite: boolean;
-};
-export type GetResourceInvitesOutput = InviteData[];
-export type UseInviteOutput = {
-    granted: GrantedRoles;
-    details: {
-        groups: {
-            groupId: string;
-            name: string;
-        }[];
-        categories: {
-            categoryId: string;
-            name: string;
-            groupId: string;
-        }[];
-        boards: {
-            boardId: string;
-            name: string;
-            categoryId: string;
-        }[];
-    };
-};
-export type InviteDetails = RenewInviteOutput & {
-    invitedBy: {
-        userId: string;
-        displayName: string;
-        avatarUrl: string | null;
-    };
-};
-export type InviteData = Pick<Invite, 'code' | 'expiresAt' | 'maxUses' | 'currentUses' | 'boardRole' | 'categoryRole' | 'groupRole'> & {
-    groups: {
-        groupId: string;
-        name: string;
-    }[];
-    categories: {
-        categoryId: string;
-        name: string;
-        groupId: string;
-    }[];
-    boards: {
-        boardId: string;
-        name: string;
-        categoryId: string;
-    }[];
-};

package/dist/src/classes/invites.js

@@ -1,50 +0,0 @@
-// Data.
-export class APIInvites {
-    web;
-    constructor(web) {
-        this.web = web;
-    }
-    // Methods.
-    async getUserInvites({ auth, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/invites'),
-        });
-    }
-    async getResourceInvites({ auth, query, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/resources/invites', query),
-        });
-    }
-    async getInviteDetails({ auth, code, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp(`/invites/${code}`),
-        });
-    }
-    async createInvite({ auth, body, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, body, ...rest,
-            endpoint: this.web.qp('/invites'),
-        });
-    }
-    async useInvite({ auth, code, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, ...rest,
-            endpoint: this.web.qp(`/invites/${code}`),
-        });
-    }
-    async renewInvite({ auth, code, ...rest }) {
-        return await this.web.request({
-            method: 'PATCH', auth, ...rest,
-            endpoint: this.web.qp(`/invites/${code}`),
-        });
-    }
-    async revokeInvite({ auth, code, ...rest }) {
-        return await this.web.request({
-            method: 'DELETE', auth, ...rest,
-            endpoint: this.web.qp(`/invites/${code}`),
-        });
-    }
-}

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

@@ -1,31 +0,0 @@
-import { BoardsManager } from '../core/manager';
-import { WithHeaders } from '../types';
-export declare class APIMetrics {
-    private web;
-    constructor(web: BoardsManager);
-    getMetrics({ auth, ...rest }: MetricsFunctionsInput['getMetrics']): Promise<import("..").WebResponse<string>>;
-    getStatus({ auth, ...rest }: MetricsFunctionsInput['getStatus']): Promise<import("..").WebResponse<SystemStatus>>;
-}
-export type MetricsFunctionsInput = WithHeaders<{
-    'getMetrics': {
-        auth: string;
-    };
-    'getStatus': {
-        auth: string;
-    };
-}>;
-export type SystemStatus = {
-    cpuUsage: number;
-    memoryUsageMb: number;
-    uptimeSeconds: number;
-    activeRooms: number;
-    socketConnections: number;
-    queuedFiles: number;
-    totalUsers: number;
-    totalInvites: number;
-    totalBoards: number;
-    totalCategories: number;
-    totalGroups: number;
-    totalFiles: number;
-    storageSizeMb: number;
-};

package/dist/src/classes/metrics.js

@@ -1,20 +0,0 @@
-// Data.
-export class APIMetrics {
-    web;
-    constructor(web) {
-        this.web = web;
-    }
-    // Methods.
-    async getMetrics({ auth, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/metrics'),
-        });
-    }
-    async getStatus({ auth, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/status'),
-        });
-    }
-}

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

@@ -1,48 +0,0 @@
-import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
-import { PermUser, ResourceType } from '../external/types';
-import { BoardsManager } from '../core/manager';
-import { WithHeaders } from '../types';
-export declare class APIPermissions {
-    private web;
-    constructor(web: BoardsManager);
-    viewPermissions({ auth, query, ...rest }: PermissionsFunctionsInput['viewPermissions']): Promise<import("..").WebResponse<PermUser[]>>;
-    viewAllPermissions({ auth, userIds, ...rest }: PermissionsFunctionsInput['viewAllPermissions']): Promise<import("..").WebResponse<Record<string, PermUser>>>;
-    grantPermissions({ auth, body, ...rest }: PermissionsFunctionsInput['grantPermissions']): Promise<import("..").WebResponse<string>>;
-    revokePermissions({ auth, body, ...rest }: PermissionsFunctionsInput['revokePermissions']): Promise<import("..").WebResponse<string>>;
-}
-export type PermissionsFunctionsInput = WithHeaders<{
-    'viewPermissions': {
-        auth: string;
-        query: ViewPermissionsQuery;
-    };
-    'viewAllPermissions': {
-        auth: string;
-        userIds: string[];
-    };
-    'grantPermissions': {
-        auth: string;
-        body: GrantPermissionsInput;
-    };
-    'revokePermissions': {
-        auth: string;
-        body: RevokePermissionsInput;
-    };
-}>;
-export type ViewPermissionsQuery = {
-    type: ResourceType;
-    id: string;
-};
-export type GrantPermissionsInput = {
-    userId: string;
-    groupIds?: string[];
-    groupRole?: GroupRole;
-    categoryIds?: string[];
-    categoryRole?: CategoryRole;
-    boardIds?: string[];
-    boardRole?: BoardRole;
-};
-export type RevokePermissionsInput = {
-    userId: string;
-    resourceType: ResourceType;
-    resourceId: string;
-};

package/dist/src/classes/permissions.js

@@ -1,32 +0,0 @@
-// Data.
-export class APIPermissions {
-    web;
-    constructor(web) {
-        this.web = web;
-    }
-    // Methods.
-    async viewPermissions({ auth, query, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/permissions/view', query),
-        });
-    }
-    async viewAllPermissions({ auth, userIds, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, body: { userIds }, ...rest,
-            endpoint: this.web.qp('/permissions/view-all'),
-        });
-    }
-    async grantPermissions({ auth, body, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, body, ...rest,
-            endpoint: this.web.qp('/permissions/grant'),
-        });
-    }
-    async revokePermissions({ auth, body, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, body, ...rest,
-            endpoint: this.web.qp('/permissions/revoke'),
-        });
-    }
-}

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

@@ -1,61 +0,0 @@
-import { Device, Platforms } from '../../prisma/generated/default';
-import { BoardsManager } from '../core/manager';
-import { WithHeaders } from '../types';
-export declare class APISessions {
-    private web;
-    constructor(web: BoardsManager);
-    createSession({ auth, body, ...rest }: SessionsFunctionsInput['createSession']): Promise<import("..").WebResponse<CreateSessionOutput>>;
-    getAllSessions({ auth, ...rest }: SessionsFunctionsInput['getAllSessions']): Promise<import("..").WebResponse<SessionsOutput>>;
-    deleteSession({ auth, dbId, ...rest }: SessionsFunctionsInput['deleteSession']): Promise<import("..").WebResponse<string>>;
-    deleteAllSessions({ auth, ...rest }: SessionsFunctionsInput['deleteAllSessions']): Promise<import("..").WebResponse<string>>;
-    rotateLinkedSession({ auth, body, ...rest }: SessionsFunctionsInput['rotateLinkedSession']): Promise<import("..").WebResponse<string>>;
-}
-export type SessionsFunctionsInput = WithHeaders<{
-    'createSession': {
-        auth: string;
-        body: CreateSessionInput;
-    };
-    'getAllSessions': {
-        auth: string;
-    };
-    'deleteSession': {
-        auth: string;
-        dbId: string;
-    };
-    'deleteAllSessions': {
-        auth: string;
-    };
-    'rotateLinkedSession': {
-        auth: string;
-        body: UnlinkLoginMethodInput;
-    };
-}>;
-export type CreateSessionInput = {
-    ip?: string;
-    email: string;
-    device?: Device;
-    platform: Platforms;
-    displayName: string;
-    avatarUrl?: string | null;
-    currentUserId?: string;
-    refreshProfile?: boolean;
-};
-export type CreateSessionOutput = {
-    token: string;
-    expiresAt: Date;
-};
-export type SessionsOutput = {
-    activeDbId: string;
-    sessions: {
-        location: string | null;
-        device: Device | null;
-        tokenPreview: string;
-        dbId: string;
-        expiresAt: Date;
-        createdAt: Date;
-        lastUsed: Date;
-    }[];
-};
-export type UnlinkLoginMethodInput = {
-    platform: Platforms;
-};

package/dist/src/classes/sessions.js

@@ -1,38 +0,0 @@
-// Data.
-export class APISessions {
-    web;
-    constructor(web) {
-        this.web = web;
-    }
-    // Methods.
-    async createSession({ auth, body, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, body, ...rest,
-            endpoint: this.web.qp('/sessions'),
-        });
-    }
-    async getAllSessions({ auth, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/sessions'),
-        });
-    }
-    async deleteSession({ auth, dbId, ...rest }) {
-        return await this.web.request({
-            method: 'DELETE', auth, body: { dbId }, ...rest,
-            endpoint: this.web.qp('/sessions'),
-        });
-    }
-    async deleteAllSessions({ auth, ...rest }) {
-        return await this.web.request({
-            method: 'DELETE', auth, ...rest,
-            endpoint: this.web.qp('/sessions/all'),
-        });
-    }
-    async rotateLinkedSession({ auth, body, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, body, ...rest,
-            endpoint: this.web.qp('/sessions/rotate'),
-        });
-    }
-}

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

@@ -1,37 +0,0 @@
-import { Platforms } from '../../prisma/generated/default';
-import { DBUserPartialType } from '../external/vars';
-import { BoardsManager } from '../core/manager';
-import { WithHeaders } from '../types';
-export declare class APIUsers {
-    private web;
-    constructor(web: BoardsManager);
-    getUser({ auth, userId, ...rest }: UsersFunctionsInput['getCurrentUser']): Promise<import("..").WebResponse<GetUsersOutput>>;
-    updateUser({ auth, userId, body, ...rest }: UsersFunctionsInput['updateUser']): Promise<import("..").WebResponse<string>>;
-    deleteAccount({ auth, userId, ...rest }: UsersFunctionsInput['deleteAccount']): Promise<import("..").WebResponse<void>>;
-}
-export type UsersFunctionsInput = WithHeaders<{
-    'getCurrentUser': {
-        auth: string;
-        userId?: string;
-    };
-    'updateUser': {
-        auth: string;
-        userId?: string;
-        body: UserInput;
-    };
-    'deleteAccount': {
-        auth: string;
-        userId?: string;
-    };
-    'isCurrentUserDev': {
-        auth: string;
-    };
-}>;
-export type GetUsersOutput = DBUserPartialType & {
-    isDev: boolean;
-};
-export type UserInput = {
-    mainGroupId?: string | null;
-    displayName?: string;
-    platform?: Platforms;
-};

package/dist/src/classes/users.js

@@ -1,26 +0,0 @@
-// Data.
-export class APIUsers {
-    web;
-    constructor(web) {
-        this.web = web;
-    }
-    // Methods.
-    async getUser({ auth, userId, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/users' + (userId ? `/${userId}` : '')),
-        });
-    }
-    async updateUser({ auth, userId, body, ...rest }) {
-        return await this.web.request({
-            method: 'PATCH', auth, body, ...rest,
-            endpoint: this.web.qp('/users' + (userId ? `/${userId}` : '')),
-        });
-    }
-    async deleteAccount({ auth, userId, ...rest }) {
-        return await this.web.request({
-            method: 'DELETE', auth, ...rest,
-            endpoint: this.web.qp('/users' + (userId ? `/${userId}` : '')),
-        });
-    }
-}

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

@@ -1,19 +0,0 @@
-import { BoardsManager } from '../core/manager';
-import { WithHeaders } from '../types';
-export declare class APIUtils {
-    private web;
-    constructor(web: BoardsManager);
-    unfurlUrl({ auth, url, ...rest }: UtilsFunctionsInput['unfurlUrl']): Promise<import("..").WebResponse<Partial<UnfurlOutput>>>;
-}
-export type UtilsFunctionsInput = WithHeaders<{
-    'unfurlUrl': {
-        auth: string;
-        url: string;
-    };
-}>;
-export type UnfurlOutput = {
-    title: string;
-    description: string;
-    image: string;
-    favicon: string;
-};

package/dist/src/classes/utils.js

@@ -1,16 +0,0 @@
-// Data.
-export class APIUtils {
-    web;
-    constructor(web) {
-        this.web = web;
-    }
-    // Methods.
-    async unfurlUrl({ auth, url, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/utils/unfurl', {
-                url,
-            }),
-        });
-    }
-}

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

@@ -1,44 +0,0 @@
-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

@@ -1,92 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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>>;