@excali-boards/boards-api-client 1.1.1-dev.3 → 1.1.1-dev.31

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

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

package/dist/{esm/classes → classes}/invites.d.ts

@@ -1,18 +1,29 @@
 import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
-import { ResourceType } from '../external/types';
+import { GrantedRoles, ResourceType } from '../external/types';
+import { Invite } from '../../prisma/generated';
 import { BoardsManager } from '../core/manager';
 export declare class APIInvites {
     private web;
     constructor(web: BoardsManager);
-    getInvites({ auth }: InvitesFunctionsInput['getInvites']): Promise<import("..").WebResponse<GetInvitesOutput>>;
+    getUserInvites({ auth }: InvitesFunctionsInput['getUserInvites']): Promise<import("..").WebResponse<GetUserInvitesOutput>>;
+    getResourceInvites({ auth, query }: InvitesFunctionsInput['getResourceInvites']): Promise<import("..").WebResponse<GetResourceInvitesOutput>>;
+    getInviteDetails({ auth, code }: InvitesFunctionsInput['getInviteDetails']): Promise<import("..").WebResponse<InviteDetails>>;
     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': {
+    'getUserInvites': {
         auth: string;
     };
+    'getResourceInvites': {
+        auth: string;
+        query: ViewInvitesQuery;
+    };
+    'getInviteDetails': {
+        auth: string;
+        code: string;
+    };
     'createInvite': {
         auth: string;
         body: CreateInviteInput;
@@ -26,6 +37,12 @@ export type InvitesFunctionsInput = {
         code: string;
     };
 };
+export type ViewInvitesQuery = {
+    type: ResourceType;
+    groupId?: string;
+    categoryId?: string;
+    boardId?: string;
+};
 export type CreateInviteInput = {
     groupIds?: string[];
     categoryIds?: string[];
@@ -41,28 +58,13 @@ export type CreateInviteOutput = {
     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 GetUserInvitesOutput = {
+    invites: InviteData[];
+    canInvite: boolean;
 };
+export type GetResourceInvitesOutput = InviteData[];
 export type UseInviteOutput = {
-    granted: GrantedRole[];
+    granted: GrantedRoles;
     details: {
         groups: {
             groupId: string;
@@ -80,3 +82,30 @@ export type UseInviteOutput = {
         }[];
     };
 };
+export type InviteDetails = {
+    code: string;
+    expiresAt: string;
+    maxUses: number;
+    currentUses: number;
+    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/{cjs/classes → classes}/invites.js

@@ -8,12 +8,24 @@ class APIInvites {
         this.web = web;
     }
     // Methods.
-    async getInvites({ auth }) {
+    async getUserInvites({ 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 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/{cjs/classes → classes}/metrics.d.ts

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

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

@@ -1,5 +1,5 @@
 import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
-import { ResourceType } from '../external/types';
+import { GrantedEntry, ResourceType } from '../external/types';
 import { BoardsManager } from '../core/manager';
 export declare class APIPermissions {
     private web;
@@ -24,23 +24,22 @@ export type PermissionsFunctionsInput = {
 };
 export type ViewPermissionsQuery = {
     type: ResourceType;
-    groupId?: string;
-    categoryId?: string;
-    boardId?: string;
+    id: string;
 };
 export type ViewPermissionsOutput = {
     userId: string;
     email: string;
     displayName: string;
     avatarUrl: string | null;
+    permissions: GrantedEntry[];
 }[];
 export type GrantPermissionsInput = {
     userId: string;
     groupIds?: string[];
-    categoryIds?: string[];
-    boardIds?: string[];
     groupRole?: GroupRole;
+    categoryIds?: string[];
     categoryRole?: CategoryRole;
+    boardIds?: string[];
     boardRole?: BoardRole;
 };
 export type RevokePermissionsInput = {

package/dist/classes/sessions.d.ts

@@ -0,0 +1,50 @@
+import { Device, Platforms } from '../../prisma/generated/default';
+import { BoardsManager } from '../core/manager';
+export declare class APISessions {
+    private web;
+    constructor(web: BoardsManager);
+    createSession({ auth, body }: SessionsFunctionsInput['createSession']): Promise<import("..").WebResponse<CreateSessionOutput>>;
+    getAllSessions({ auth }: SessionsFunctionsInput['getAllSessions']): Promise<import("..").WebResponse<SessionsOutput>>;
+    deleteSession({ auth, dbId }: SessionsFunctionsInput['deleteSession']): Promise<import("..").WebResponse<string>>;
+    deleteAllSessions({ auth }: SessionsFunctionsInput['deleteAllSessions']): Promise<import("..").WebResponse<string>>;
+}
+export type SessionsFunctionsInput = {
+    'createSession': {
+        auth: string;
+        body: CreateSessionInput;
+    };
+    'getAllSessions': {
+        auth: string;
+    };
+    'deleteSession': {
+        auth: string;
+        dbId: string;
+    };
+    'deleteAllSessions': {
+        auth: string;
+    };
+};
+export type CreateSessionInput = {
+    ip?: string;
+    email: string;
+    platform: Platforms;
+    displayName: string;
+    avatarUrl?: string | null;
+    currentUserId?: string;
+};
+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;
+    }[];
+};

package/dist/classes/sessions.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APISessions = void 0;
+// Data.
+class APISessions {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    // Methods.
+    async createSession({ auth, body }) {
+        return await this.web.request({
+            method: 'POST', auth, body,
+            endpoint: this.web.qp('/sessions'),
+        });
+    }
+    async getAllSessions({ auth }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp('/sessions'),
+        });
+    }
+    async deleteSession({ auth, dbId }) {
+        return await this.web.request({
+            method: 'DELETE', auth, body: { dbId },
+            endpoint: this.web.qp('/sessions'),
+        });
+    }
+    async deleteAllSessions({ auth }) {
+        return await this.web.request({
+            method: 'DELETE', auth,
+            endpoint: this.web.qp('/sessions/all'),
+        });
+    }
+}
+exports.APISessions = APISessions;

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

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

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

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

package/dist/{cjs/core → 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/{cjs/core → 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/{cjs/external → external}/types.d.ts

@@ -1,5 +1,5 @@
 import { BoardRole, CategoryRole, GroupRole } from './vars';
-import { TSPrisma } from '@prisma/generated';
+import { TSPrisma } from '../../prisma/generated/default';
 export type User = TSPrisma.TSPrismaModelsFull['User'];
 export type Group = TSPrisma.TSPrismaModelsFull['Group'];
 export type Category = TSPrisma.TSPrismaModelsFull['Category'];
@@ -17,6 +17,12 @@ export declare enum GlobalRole {
 export type AccessLevel = 'read' | 'write' | 'manage' | 'admin';
 export type ResourceType = 'group' | 'category' | 'board';
 export type GlobalResourceType = ResourceType | 'global';
+export type GrantedRoles = GrantedRole[];
+export type GrantedRole = {
+    type: ResourceType;
+    resourceId: string;
+    role: UserRole;
+};
 export type SingleOutput = {
     id: string;
     name: string;
@@ -26,3 +32,10 @@ export type SingleOutput = {
 export type NameInput = {
     name: string;
 };
+export type GrantedEntry = {
+    type: ResourceType;
+    role: UserRole;
+    resourceId: string;
+    basedOnType: ResourceType;
+    basedOnResourceId: string;
+};

package/dist/{esm/external → external}/vars.d.ts

@@ -1,4 +1,5 @@
-import { Prisma } from '@prisma/generated';
+import { Prisma } from '../../prisma/generated/default';
+import { UserRole } from './types';
 export declare const DBUserSelectArgs: {
     select: {
         userId: true;
@@ -90,3 +91,5 @@ export declare enum GroupRole {
     GroupManager = "GroupManager",
     GroupAdmin = "GroupAdmin"
 }
+export declare const SimplePermissionHierarchy: Record<string, number>;
+export declare const PermissionHierarchy: Record<UserRole, number>;

package/dist/{cjs/external → external}/vars.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GroupRole = exports.CategoryRole = exports.BoardRole = exports.Platforms = exports.DBUserPartial = exports.DBUserSelectArgs = void 0;
-const generated_1 = require("@prisma/generated");
+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 = {
     select: {
         userId: true,
@@ -16,7 +17,7 @@ exports.DBUserSelectArgs = {
         loginMethods: { select: { platform: true, platformEmail: true } },
     },
 };
-exports.DBUserPartial = generated_1.Prisma.validator()(exports.DBUserSelectArgs);
+exports.DBUserPartial = default_1.Prisma.validator()(exports.DBUserSelectArgs);
 var Platforms;
 (function (Platforms) {
     Platforms["Google"] = "Google";
@@ -43,3 +44,23 @@ var GroupRole;
     GroupRole["GroupManager"] = "GroupManager";
     GroupRole["GroupAdmin"] = "GroupAdmin";
 })(GroupRole || (exports.GroupRole = GroupRole = {}));
+// Variables.
+exports.SimplePermissionHierarchy = {
+    Viewer: 1,
+    Collaborator: 2,
+    Manager: 3,
+    Admin: 4,
+};
+exports.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,
+    [types_1.GlobalRole.Developer]: 11,
+};

package/dist/{cjs/index.d.ts → 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/{cjs/index.js → 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/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/types.ts","../src/classes/admin.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/sessions.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/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.1.1-dev.3",
+	"version": "1.1.1-dev.31",
 	"name": "@excali-boards/boards-api-client",
 	"description": "A simple API client for the Boards API.",
 	"repository": "https://github.com/Excali-Boards/boards-api-client",
@@ -7,33 +7,22 @@
 	"scripts": {
 		"ts": "pnpm install typescript --save-dev -g",
 		"init": "pnpm install && pnpm run build",
-		"build": "tsc --build && tsc --build tsconfig.esm.json",
+		"build": "tsc --build",
 		"watch": "tsc --watch",
 		"lint": "eslint . --ext .ts",
 		"postinstall": "prisma generate",
 		"updates": "pnpm npm-check-updates -i --format group"
 	},
-	"main": "dist/cjs/index.js",
-	"module": "dist/esm/index.js",
-	"types": "dist/cjs/index.d.ts",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
 	"license": "GPL-3.0",
-	"exports": {
-		".": {
-			"import": "./dist/esm/index.js",
-			"require": "./dist/cjs/index.js",
-			"types": "./dist/cjs/index.d.ts"
-		},
-		"./external": {
-			"import": "./dist/esm/external/vars.js",
-			"require": "./dist/cjs/external/vars.js",
-			"types": "./dist/cjs/external/vars.d.ts"
-		},
-		"./prisma/generated/default": {
-			"import": "./prisma/generated/default.js",
-			"require": "./prisma/generated/default.js",
-			"types": "./prisma/generated/default.d.ts"
-		}
-	},
+	"files": [
+		"dist",
+		"prisma/schema",
+		"prisma.config.ts",
+		"README.md",
+		"LICENSE"
+	],
 	"pnpm": {
 		"onlyBuiltDependencies": [
 			"@prisma/client",
@@ -58,4 +47,4 @@
 		"ts-prisma": "1.3.3",
 		"zod": "4.1.9"
 	}
-}
+}

package/prisma/schema/schema.prisma

@@ -19,6 +19,13 @@ enum Platforms {
     GitHub
 }
 
+enum Device {
+    Desktop
+    Mobile
+    Tablet
+    Other
+}
+
 // Separate role enums for each resource type
 enum BoardRole {
     BoardViewer // read-only to specific board
@@ -43,6 +50,7 @@ model AllEnumsModel {
     dbId String @id @default(uuid())
 
     platformEnum Platforms
+    deviceEnum   Device
 
     boardRoleEnum    BoardRole
     categoryRoleEnum CategoryRole

package/prisma/schema/user.prisma

@@ -16,6 +16,26 @@ model User {
     boardPermissions    BoardPermission[]
 
     createdInvites Invite[]
+    sessions       Session[]
+}
+
+model Session {
+    dbId String @id @default(uuid())
+
+    token String @unique
+
+    device            Device?
+    locationEncrypted String?
+
+    userId String
+    user   User   @relation(fields: [userId], references: [userId], onDelete: Cascade)
+
+    createdAt DateTime @default(now())
+    expiresAt DateTime
+    lastUsed  DateTime @default(now())
+
+    @@index([userId])
+    @@index([expiresAt])
 }
 
 model LoginMethod {

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

@@ -1,26 +0,0 @@
-import { BoardsManager } from '../core/manager';
-import { Platforms } from '@prisma/generated';
-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;
-};