@excali-boards/boards-api-client 1.1.34 → 1.1.36

package/README.md

@@ -6,7 +6,7 @@ A comprehensive TypeScript client library for the [Boards Room API](https://gith
 
 ## Features
 
-- Fully typed REST client (boards, users, permissions, files, sessions, categories, flashcards, metrics, invites)
+- Fully typed REST client (boards, users, permissions, files, sessions, categories, flashcards, codesnippets, metrics, invites)
 - WebSocket client with auto-reconnect, heartbeat, and message queueing
 - React hooks: generic `useWebSocket` and `useExecutor` for code execution streams
 - Zero-config defaults; override `baseUrl` when needed

package/dist/classes/boards.d.ts

@@ -65,6 +65,7 @@ export type GetBoardOutput = {
         type: BoardType;
         dataUrl: string;
         hasFlashcards: boolean;
+        hasCodeSnippets: boolean;
         totalSizeBytes: number;
         accessLevel: AccessLevel;
         scheduledForDeletion: Date | null;

package/dist/classes/codesnippets.d.ts

@@ -0,0 +1,93 @@
+import { AccessLevel } from '../external/types';
+import { BoardsManager } from '../core/manager';
+export declare class APICodeSnippets {
+    private web;
+    constructor(web: BoardsManager);
+    getCollection({ auth, groupId, categoryId, boardId }: CodeSnippetsFunctionsInput['getCollection']): Promise<import("..").WebResponse<CodeSnippetCollectionResponse>>;
+    initializeCollection({ auth, groupId, categoryId, boardId }: CodeSnippetsFunctionsInput['initializeCollection']): Promise<import("..").WebResponse<string>>;
+    destroyCollection({ auth, groupId, categoryId, boardId }: CodeSnippetsFunctionsInput['destroyCollection']): Promise<import("..").WebResponse<string>>;
+    createSnippets({ auth, groupId, categoryId, boardId, body }: CodeSnippetsFunctionsInput['createSnippets']): Promise<import("..").WebResponse<string>>;
+    updateSnippets({ auth, groupId, categoryId, boardId, body }: CodeSnippetsFunctionsInput['updateSnippets']): Promise<import("..").WebResponse<string>>;
+    deleteSnippets({ auth, groupId, categoryId, boardId, body }: CodeSnippetsFunctionsInput['deleteSnippets']): Promise<import("..").WebResponse<string>>;
+    reorderSnippets({ auth, groupId, categoryId, boardId, body }: CodeSnippetsFunctionsInput['reorderSnippets']): Promise<import("..").WebResponse<string>>;
+}
+export type CodeSnippetsFunctionsInput = {
+    getCollection: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+    };
+    initializeCollection: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+    };
+    destroyCollection: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+    };
+    createSnippets: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: CodeSnippetInput[];
+    };
+    updateSnippets: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: CodeSnippetUpdateInput[];
+    };
+    deleteSnippets: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: string[];
+    };
+    reorderSnippets: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: string[];
+    };
+};
+export type CodeSnippetInput = {
+    title: string;
+    description?: string;
+    code: string;
+    language?: string;
+};
+export type CodeSnippetUpdateInput = CodeSnippetInput & {
+    id: string;
+};
+export type CodeSnippetCollectionResponse = {
+    board: {
+        id: string;
+        name: string;
+        accessLevel: AccessLevel;
+    };
+    collection: {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+    };
+    snippets: CodeSnippet[];
+};
+export type CodeSnippet = {
+    id: string;
+    title: string;
+    description: string;
+    code: string;
+    language: string;
+    index: number;
+    createdAt: Date;
+    updatedAt: Date;
+};

package/dist/classes/codesnippets.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APICodeSnippets = void 0;
+// Data.
+class APICodeSnippets {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    // Methods.
+    async getCollection({ auth, groupId, categoryId, boardId }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/codesnippets`),
+        });
+    }
+    async initializeCollection({ auth, groupId, categoryId, boardId }) {
+        return await this.web.request({
+            method: 'POST', auth,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/codesnippets/initialize`),
+        });
+    }
+    async destroyCollection({ auth, groupId, categoryId, boardId }) {
+        return await this.web.request({
+            method: 'POST', auth,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/codesnippets/destroy`),
+        });
+    }
+    async createSnippets({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'POST', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/codesnippets`),
+        });
+    }
+    async updateSnippets({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'PATCH', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/codesnippets`),
+        });
+    }
+    async deleteSnippets({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'DELETE', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/codesnippets`),
+        });
+    }
+    async reorderSnippets({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'POST', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/codesnippets/reorder`),
+        });
+    }
+}
+exports.APICodeSnippets = APICodeSnippets;

package/dist/classes/groups.d.ts

@@ -68,6 +68,7 @@ export type GetAllSortedOutput = (SingleOutput & {
     categories: (SingleOutput & {
         boards: (SingleOutput & {
             hasFlashcards: boolean;
+            hasCodeSnippets: boolean;
             totalSizeBytes: number;
             scheduledForDeletion: Date | null;
         })[];

package/dist/core/manager.d.ts

@@ -1,4 +1,5 @@
 import { PaginatedWebResponse, RequestMethod, WebResponse } from '../types';
+import { APICodeSnippets } from '../classes/codesnippets';
 import { AxiosResponse } from 'axios';
 import { APIPermissions } from '../classes/permissions';
 import { APIFlashcards } from '../classes/flashcards';
@@ -15,6 +16,7 @@ import { APIFiles } from '../classes/files';
 import { APIAdmin } from '../classes/admin';
 export declare class BoardsManager {
     url: string;
+    readonly codeSnippets: APICodeSnippets;
     readonly permissions: APIPermissions;
     readonly categories: APICategories;
     readonly flashcards: APIFlashcards;

package/dist/core/manager.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BoardsManager = void 0;
+const codesnippets_1 = require("../classes/codesnippets");
 const axios_1 = __importDefault(require("axios"));
 const permissions_1 = require("../classes/permissions");
 const flashcards_1 = require("../classes/flashcards");
@@ -21,6 +22,7 @@ const admin_1 = require("../classes/admin");
 const utils_2 = require("./utils");
 class BoardsManager {
     url;
+    codeSnippets = new codesnippets_1.APICodeSnippets(this);
     permissions = new permissions_1.APIPermissions(this);
     categories = new categories_1.APICategories(this);
     flashcards = new flashcards_1.APIFlashcards(this);

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * from './external/vars';
 export * from './websocket/manager';
 export * from './websocket/client';
 export * from './websocket/types';
+export * from './classes/codesnippets';
 export * from './classes/permissions';
 export * from './classes/categories';
 export * from './classes/flashcards';

package/dist/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./external/vars"), exports);
 __exportStar(require("./websocket/manager"), exports);
 __exportStar(require("./websocket/client"), exports);
 __exportStar(require("./websocket/types"), exports);
+__exportStar(require("./classes/codesnippets"), exports);
 __exportStar(require("./classes/permissions"), exports);
 __exportStar(require("./classes/categories"), exports);
 __exportStar(require("./classes/flashcards"), exports);

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/index.ts","../src/types.ts","../src/classes/admin.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","../src/websocket/client.ts","../src/websocket/manager.ts","../src/websocket/types.ts","../src/websocket/hooks/useExecutor.ts","../src/websocket/hooks/useWebSocket.ts"],"version":"5.9.2"}
+{"root":["../src/index.ts","../src/types.ts","../src/classes/admin.ts","../src/classes/boards.ts","../src/classes/calendar.ts","../src/classes/categories.ts","../src/classes/codesnippets.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","../src/websocket/client.ts","../src/websocket/manager.ts","../src/websocket/types.ts","../src/websocket/hooks/useExecutor.ts","../src/websocket/hooks/useWebSocket.ts"],"version":"5.9.2"}

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.1.34",
+	"version": "1.1.36",
 	"name": "@excali-boards/boards-api-client",
 	"description": "A simple API client for the Boards API.",
 	"repository": "https://github.com/Excali-Boards/boards-api-client",