@excali-boards/boards-api-client 1.1.65 → 1.1.67

package/dist/classes/boards.d.ts

@@ -2,13 +2,17 @@ import { AccessLevel, AllRooms, NameInput, SingleOutput } from '../external/type
 import { BoardsManager } from '../core/manager.js';
 import { BoardType } from '../external/types.js';
 import { WithHeaders } from '../types.js';
+import type { PersonalFunctionsInput } from './personal.js';
 export declare class APIBoards {
     private web;
     constructor(web: BoardsManager);
     getBoards({ auth, categoryId, groupId, ...rest }: BoardsFunctionsInput['getBoards']): Promise<import("../types.js").WebResponse<GetBoardOutput[]>>;
-    getPersonalBoards({ auth, ...rest }: BoardsFunctionsInput['getPersonalBoards']): Promise<import("../types.js").WebResponse<PersonalBoardsAdminOutput | PersonalBoardsOutput | null>>;
-    createPersonalBoard({ auth, body, ...rest }: BoardsFunctionsInput['createPersonalBoard']): Promise<import("../types.js").WebResponse<CreatePersonalBoardOutput>>;
-    createPersonalCategory({ auth, body, ...rest }: BoardsFunctionsInput['createPersonalCategory']): Promise<import("../types.js").WebResponse<CreatePersonalCategoryOutput>>;
+    /** @deprecated Use manager.personal for personal-board endpoints. */
+    getPersonalBoards(input: PersonalFunctionsInput['getPersonalBoards']): Promise<import("../types.js").WebResponse<import("./personal.js").PersonalBoardsAdminOutput | import("./personal.js").PersonalBoardsOutput | null>>;
+    /** @deprecated Use manager.personal for personal-board endpoints. */
+    createPersonalBoard(input: PersonalFunctionsInput['createPersonalBoard']): Promise<import("../types.js").WebResponse<import("./personal.js").CreatePersonalBoardOutput>>;
+    /** @deprecated Use manager.personal for personal-board endpoints. */
+    createPersonalCategory(input: PersonalFunctionsInput['createPersonalCategory']): Promise<import("../types.js").WebResponse<import("./personal.js").CreatePersonalCategoryOutput>>;
     getBoard({ auth, categoryId, groupId, boardId, ...rest }: BoardsFunctionsInput['getBoard']): Promise<import("../types.js").WebResponse<GetBoardOutput>>;
     updateBoard({ auth, categoryId, groupId, boardId, body, ...rest }: BoardsFunctionsInput['updateBoard']): Promise<import("../types.js").WebResponse<string>>;
     moveBoard({ auth, categoryId, groupId, boardId, body, ...rest }: BoardsFunctionsInput['moveBoard']): Promise<import("../types.js").WebResponse<MoveBoardOutput>>;
@@ -24,20 +28,6 @@ export type BoardsFunctionsInput = WithHeaders<{
         categoryId: string;
         groupId: string;
     };
-    'getPersonalBoards': {
-        auth: string;
-    };
-    'createPersonalBoard': {
-        auth: string;
-        body: NameInput & {
-            type: BoardType;
-            categoryId?: string;
-        };
-    };
-    'createPersonalCategory': {
-        auth: string;
-        body: NameInput;
-    };
     'getBoard': {
         auth: string;
         categoryId: string;
@@ -104,45 +94,6 @@ export type GetBoardOutput = {
     };
 };
 export type GetFileOutput = ReadableStream | Blob;
-export type CreatePersonalBoardOutput = {
-    groupId: string;
-    categoryId: string;
-    boardId: string;
-};
-export type CreatePersonalCategoryOutput = {
-    categoryId: string;
-    name: string;
-    backingCategoryId: string;
-};
-export type PersonalBoardsOutput = {
-    id: string;
-    owner: PersonalBoardOwnerOutput;
-    boards: PersonalBoardOutput[];
-    categories: PersonalCategoryOutput[];
-};
-export type PersonalBoardsAdminOutput = {
-    owners: PersonalBoardsOutput[];
-};
-export type PersonalBoardOwnerOutput = {
-    userId: string;
-    displayName: string;
-    email: string;
-    avatarUrl: string | null;
-};
-export type PersonalCategoryOutput = {
-    id: string;
-    name: string;
-    boards: PersonalBoardOutput[];
-};
-export type PersonalBoardOutput = {
-    id: string;
-    categoryId: string;
-    name: string;
-    type: BoardType;
-    index: number;
-    totalSizeBytes: number;
-    scheduledForDeletion: Date | null;
-};
 export type MoveBoardInput = {
     targetCategoryId: string;
     targetIndex?: number;

package/dist/classes/boards.js

@@ -9,24 +9,12 @@ export class APIBoards {
             endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}`),
         });
     }
-    async getPersonalBoards({ auth, ...rest }) {
-        return await this.web.request({
-            method: 'GET', auth, ...rest,
-            endpoint: this.web.qp('/personal'),
-        });
-    }
-    async createPersonalBoard({ auth, body, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, body, ...rest,
-            endpoint: this.web.qp('/personal'),
-        });
-    }
-    async createPersonalCategory({ auth, body, ...rest }) {
-        return await this.web.request({
-            method: 'POST', auth, body, ...rest,
-            endpoint: this.web.qp('/personal/categories'),
-        });
-    }
+    /** @deprecated Use manager.personal for personal-board endpoints. */
+    getPersonalBoards(input) { return this.web.personal.getPersonalBoards(input); }
+    /** @deprecated Use manager.personal for personal-board endpoints. */
+    createPersonalBoard(input) { return this.web.personal.createPersonalBoard(input); }
+    /** @deprecated Use manager.personal for personal-board endpoints. */
+    createPersonalCategory(input) { return this.web.personal.createPersonalCategory(input); }
     async getBoard({ auth, categoryId, groupId, boardId, ...rest }) {
         return await this.web.request({
             method: 'GET', auth, ...rest,

package/dist/classes/personal.d.ts

@@ -0,0 +1,102 @@
+import { BoardType, NameInput } from '../external/types.js';
+import type { GetBoardOutput } from './boards.js';
+import { BoardsManager } from '../core/manager.js';
+import { WithHeaders } from '../types.js';
+export declare class APIPersonal {
+    private web;
+    constructor(web: BoardsManager);
+    getPersonalBoards({ auth, ...rest }: PersonalFunctionsInput['getPersonalBoards']): Promise<import("../types.js").WebResponse<PersonalBoardsAdminOutput | PersonalBoardsOutput | null>>;
+    getAllPersonalBoards({ auth, ...rest }: PersonalFunctionsInput['getAllPersonalBoards']): Promise<import("../types.js").WebResponse<PersonalWorkspaceOutput[]>>;
+    getPersonalWorkspace({ auth, userId, ...rest }: PersonalFunctionsInput['getPersonalWorkspace']): Promise<import("../types.js").WebResponse<PersonalWorkspaceOutput>>;
+    getPersonalCategoryBoards({ auth, userId, categoryId, ...rest }: PersonalFunctionsInput['getPersonalCategoryBoards']): Promise<import("../types.js").WebResponse<PersonalBoardOutput[]>>;
+    createPersonalBoard({ auth, body, ...rest }: PersonalFunctionsInput['createPersonalBoard']): Promise<import("../types.js").WebResponse<CreatePersonalBoardOutput>>;
+    createPersonalBoardInCategory({ auth, userId, categoryId, body, ...rest }: PersonalFunctionsInput['createPersonalBoardInCategory']): Promise<import("../types.js").WebResponse<CreatePersonalBoardOutput>>;
+    createPersonalCategory({ auth, body, ...rest }: PersonalFunctionsInput['createPersonalCategory']): Promise<import("../types.js").WebResponse<CreatePersonalCategoryOutput>>;
+    getPersonalBoard({ auth, userId, categoryId, boardId, ...rest }: PersonalFunctionsInput['getPersonalBoard']): Promise<import("../types.js").WebResponse<GetBoardOutput>>;
+}
+export type PersonalFunctionsInput = WithHeaders<{
+    getPersonalBoards: {
+        auth: string;
+    };
+    getAllPersonalBoards: {
+        auth: string;
+    };
+    getPersonalWorkspace: {
+        auth: string;
+        userId: string;
+    };
+    getPersonalCategoryBoards: {
+        auth: string;
+        userId: string;
+        categoryId: string;
+    };
+    createPersonalBoard: {
+        auth: string;
+        body: NameInput & {
+            type: BoardType;
+            categoryId?: string;
+        };
+    };
+    createPersonalBoardInCategory: {
+        auth: string;
+        userId: string;
+        categoryId: string;
+        body: NameInput & {
+            type: BoardType;
+        };
+    };
+    createPersonalCategory: {
+        auth: string;
+        body: NameInput;
+    };
+    getPersonalBoard: {
+        auth: string;
+        userId: string;
+        categoryId: string;
+        boardId: string;
+    };
+}>;
+export type CreatePersonalBoardOutput = {
+    groupId: string;
+    categoryId: string;
+    boardId: string;
+};
+export type CreatePersonalCategoryOutput = {
+    categoryId: string;
+    name: string;
+    backingCategoryId: string;
+};
+export type PersonalBoardsOutput = {
+    id: string;
+    owner: PersonalBoardOwnerOutput;
+    boards: PersonalBoardOutput[];
+    categories: PersonalCategoryOutput[];
+};
+export type PersonalWorkspaceOutput = {
+    id: string;
+    owner: PersonalBoardOwnerOutput;
+    categories: PersonalCategoryOutput[];
+};
+export type PersonalBoardsAdminOutput = {
+    owners: PersonalBoardsOutput[];
+};
+export type PersonalBoardOwnerOutput = {
+    userId: string;
+    displayName: string;
+    email: string;
+    avatarUrl: string | null;
+};
+export type PersonalCategoryOutput = {
+    id: string;
+    name: string;
+    boards: PersonalBoardOutput[];
+};
+export type PersonalBoardOutput = {
+    id: string;
+    categoryId: string;
+    name: string;
+    type: BoardType;
+    index: number;
+    totalSizeBytes: number;
+    scheduledForDeletion: Date | null;
+};

package/dist/classes/personal.js

@@ -0,0 +1,30 @@
+export class APIPersonal {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    async getPersonalBoards({ auth, ...rest }) {
+        return await this.web.request({ method: 'GET', auth, ...rest, endpoint: this.web.qp('/personal') });
+    }
+    async getAllPersonalBoards({ auth, ...rest }) {
+        return await this.web.request({ method: 'GET', auth, ...rest, endpoint: this.web.qp('/all/personal') });
+    }
+    async getPersonalWorkspace({ auth, userId, ...rest }) {
+        return await this.web.request({ method: 'GET', auth, ...rest, endpoint: this.web.qp(`/personal/${userId}`) });
+    }
+    async getPersonalCategoryBoards({ auth, userId, categoryId, ...rest }) {
+        return await this.web.request({ method: 'GET', auth, ...rest, endpoint: this.web.qp(`/personal/${userId}/categories/${categoryId}/boards`) });
+    }
+    async createPersonalBoard({ auth, body, ...rest }) {
+        return await this.web.request({ method: 'POST', auth, body, ...rest, endpoint: this.web.qp('/personal') });
+    }
+    async createPersonalBoardInCategory({ auth, userId, categoryId, body, ...rest }) {
+        return await this.web.request({ method: 'POST', auth, body, ...rest, endpoint: this.web.qp(`/personal/${userId}/categories/${categoryId}/boards`) });
+    }
+    async createPersonalCategory({ auth, body, ...rest }) {
+        return await this.web.request({ method: 'POST', auth, body, ...rest, endpoint: this.web.qp('/personal/categories') });
+    }
+    async getPersonalBoard({ auth, userId, categoryId, boardId, ...rest }) {
+        return await this.web.request({ method: 'GET', auth, ...rest, endpoint: this.web.qp(`/personal/${userId}/categories/${categoryId}/boards/${boardId}`) });
+    }
+}

package/dist/classes/users.d.ts

@@ -29,6 +29,7 @@ export type UsersFunctionsInput = WithHeaders<{
 }>;
 export type GetUsersOutput = DBUserPartialType & {
     isDev: boolean;
+    personalBoardsEnabled: boolean;
 };
 export type UserInput = {
     mainGroupId?: string | null;

package/dist/core/manager.d.ts

@@ -8,6 +8,7 @@ import { APIMetrics } from '../classes/metrics.js';
 import { APIInvites } from '../classes/invites.js';
 import { APIGroups } from '../classes/groups.js';
 import { APIBoards } from '../classes/boards.js';
+import { APIPersonal } from '../classes/personal.js';
 import { APIUtils } from '../classes/utils.js';
 import { APIUsers } from '../classes/users.js';
 import { APIFiles } from '../classes/files.js';
@@ -26,6 +27,7 @@ export declare class BoardsManager {
     readonly metrics: APIMetrics;
     readonly groups: APIGroups;
     readonly boards: APIBoards;
+    readonly personal: APIPersonal;
     readonly admin: APIAdmin;
     readonly users: APIUsers;
     readonly utils: APIUtils;

package/dist/core/manager.js

@@ -8,6 +8,7 @@ import { APIMetrics } from '../classes/metrics.js';
 import { APIInvites } from '../classes/invites.js';
 import { APIGroups } from '../classes/groups.js';
 import { APIBoards } from '../classes/boards.js';
+import { APIPersonal } from '../classes/personal.js';
 import { APIUtils } from '../classes/utils.js';
 import { APIUsers } from '../classes/users.js';
 import { APIFiles } from '../classes/files.js';
@@ -27,6 +28,7 @@ export class BoardsManager {
     metrics = new APIMetrics(this);
     groups = new APIGroups(this);
     boards = new APIBoards(this);
+    personal = new APIPersonal(this);
     admin = new APIAdmin(this);
     users = new APIUsers(this);
     utils = new APIUtils(this);

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export * from './classes/invites.js';
 export * from './classes/metrics.js';
 export * from './classes/groups.js';
 export * from './classes/boards.js';
+export * from './classes/personal.js';
 export * from './classes/utils.js';
 export * from './classes/admin.js';
 export * from './classes/users.js';

package/dist/index.js

@@ -13,6 +13,7 @@ export * from './classes/invites.js';
 export * from './classes/metrics.js';
 export * from './classes/groups.js';
 export * from './classes/boards.js';
+export * from './classes/personal.js';
 export * from './classes/utils.js';
 export * from './classes/admin.js';
 export * from './classes/users.js';

package/package.json

@@ -1,42 +1,43 @@
 {
-  "version": "1.1.65",
-  "name": "@excali-boards/boards-api-client",
-  "description": "A simple API client for the Boards API.",
-  "repository": "https://github.com/Excali-Boards/boards-api-client",
-  "author": "Digital39999",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "license": "GPL-3.0",
-  "files": [
-    "dist",
-    "prisma/schema",
-    "prisma/generated",
-    "prisma.config.ts",
-    "README.md",
-    "LICENSE"
-  ],
-  "devDependencies": {
-    "@types/node": "20.14.13",
-    "@typescript-eslint/eslint-plugin": "6.18.0",
-    "@typescript-eslint/parser": "6.18.0",
-    "eslint": "8.56.0",
-    "typescript": "7.0.2"
-  },
-  "engines": {
-    "node": ">=20.2.0"
-  },
-  "dependencies": {
-    "@prisma/client": "6.16.2",
-    "axios": "1.12.2",
-    "prisma": "6.16.2",
-    "zod": "4.1.9"
-  },
-  "scripts": {
-    "ts": "pnpm install typescript --save-dev -g",
-    "init": "pnpm install && pnpm run build",
-    "build": "tsc --build",
-    "watch": "tsc --watch",
-    "lint": "eslint . --ext .ts",
-    "updates": "pnpm npm-check-updates -i --format group"
-  }
-}
+	"version": "1.1.67",
+	"name": "@excali-boards/boards-api-client",
+	"description": "A simple API client for the Boards API.",
+	"repository": "https://github.com/Excali-Boards/boards-api-client",
+	"author": "Digital39999",
+	"scripts": {
+		"ts": "pnpm install typescript --save-dev -g",
+		"init": "pnpm install && pnpm run build",
+		"build": "tsc --build",
+		"postinstall": "prisma generate",
+		"watch": "tsc --watch",
+		"lint": "eslint . --ext .ts",
+		"updates": "pnpm npm-check-updates -i --format group"
+	},
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"license": "GPL-3.0",
+	"files": [
+		"dist",
+		"prisma/schema",
+		"prisma/generated",
+		"prisma.config.ts",
+		"README.md",
+		"LICENSE"
+	],
+	"devDependencies": {
+		"@types/node": "20.14.13",
+		"@typescript-eslint/eslint-plugin": "6.18.0",
+		"@typescript-eslint/parser": "6.18.0",
+		"eslint": "8.56.0",
+		"typescript": "7.0.2"
+	},
+	"engines": {
+		"node": ">=20.2.0"
+	},
+	"dependencies": {
+		"@prisma/client": "6.16.2",
+		"axios": "1.12.2",
+		"prisma": "6.16.2",
+		"zod": "4.1.9"
+	}
+}

package/prisma/schema/personal.prisma

@@ -31,11 +31,11 @@ model PersonalBoard {
     dbId        String  @id @default(uuid())
     boardId     String  @unique
     workspaceId String
-    categoryId  String?
+    categoryId  String
 
     board     Board             @relation(fields: [boardId], references: [boardId], onDelete: Cascade)
     workspace PersonalWorkspace @relation(fields: [workspaceId], references: [dbId], onDelete: Cascade)
-    category  PersonalCategory? @relation(fields: [categoryId], references: [dbId], onDelete: SetNull)
+    category  PersonalCategory @relation(fields: [categoryId], references: [dbId], onDelete: Cascade)
 
     @@index([workspaceId])
     @@index([categoryId])