@excali-boards/boards-api-client 1.1.23 → 1.1.24

package/dist/classes/boards.d.ts

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

package/dist/classes/flashcards.d.ts

@@ -0,0 +1,105 @@
+import { SingleOutput } from 'src/external/types';
+import { BoardsManager } from '../core/manager';
+export declare class APIFlashcards {
+    private web;
+    constructor(web: BoardsManager);
+    getDeck({ auth, groupId, categoryId, boardId }: FlashcardsFunctionsInput['getDeck']): Promise<import("..").WebResponse<FlashcardDeckResponse>>;
+    createCards({ auth, groupId, categoryId, boardId, body }: FlashcardsFunctionsInput['createCards']): Promise<import("..").WebResponse<string>>;
+    updateCards({ auth, groupId, categoryId, boardId, body }: FlashcardsFunctionsInput['updateCards']): Promise<import("..").WebResponse<string>>;
+    deleteCards({ auth, groupId, categoryId, boardId, body }: FlashcardsFunctionsInput['deleteCards']): Promise<import("..").WebResponse<string>>;
+    overrideCards({ auth, groupId, categoryId, boardId, body }: FlashcardsFunctionsInput['overrideCards']): Promise<import("..").WebResponse<string>>;
+    updateProgress({ auth, groupId, categoryId, boardId, body }: FlashcardsFunctionsInput['updateProgress']): Promise<import("..").WebResponse<string>>;
+    resetProgress({ auth, groupId, categoryId, boardId }: FlashcardsFunctionsInput['resetProgress']): Promise<import("..").WebResponse<string>>;
+    reorderCards({ auth, groupId, categoryId, boardId, body }: FlashcardsFunctionsInput['reorderCards']): Promise<import("..").WebResponse<string>>;
+}
+export type FlashcardsFunctionsInput = {
+    getDeck: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+    };
+    createCards: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: CardInput[];
+    };
+    updateCards: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: CardUpdateInput[];
+    };
+    deleteCards: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: string[];
+    };
+    overrideCards: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: CardInput[];
+    };
+    updateProgress: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: ProgressInput;
+    };
+    resetProgress: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+    };
+    reorderCards: {
+        auth: string;
+        groupId: string;
+        categoryId: string;
+        boardId: string;
+        body: string[];
+    };
+};
+export type CardInput = {
+    front: string;
+    back: string;
+};
+export type CardUpdateInput = {
+    id: string;
+    front?: string;
+    back?: string;
+};
+export type ProgressInput = {
+    currentIndex: number;
+    completed?: boolean;
+};
+export type FlashcardDeckResponse = {
+    board: SingleOutput;
+    deck: {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+    };
+    cards: FlashcardCard[];
+    progress: {
+        completed: boolean;
+        lastStudied: Date;
+        currentIndex: number;
+    } | null;
+};
+export type FlashcardCard = {
+    id: string;
+    front: string;
+    back: string;
+    index: number;
+    createdAt: Date;
+    updatedAt: Date;
+};

package/dist/classes/flashcards.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIFlashcards = void 0;
+// Data.
+class APIFlashcards {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    // Methods.
+    async getDeck({ auth, groupId, categoryId, boardId }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/flashcards`),
+        });
+    }
+    async createCards({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'POST', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/flashcards`),
+        });
+    }
+    async updateCards({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'PATCH', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/flashcards`),
+        });
+    }
+    async deleteCards({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'DELETE', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/flashcards`),
+        });
+    }
+    async overrideCards({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'PUT', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/flashcards/override`),
+        });
+    }
+    async updateProgress({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'PATCH', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/flashcards/progress`),
+        });
+    }
+    async resetProgress({ auth, groupId, categoryId, boardId }) {
+        return await this.web.request({
+            method: 'DELETE', auth,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/flashcards/progress`),
+        });
+    }
+    async reorderCards({ auth, groupId, categoryId, boardId, body }) {
+        return await this.web.request({
+            method: 'PUT', auth, body,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/flashcards/reorder`),
+        });
+    }
+}
+exports.APIFlashcards = APIFlashcards;

package/dist/classes/groups.d.ts

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

package/dist/core/manager.d.ts

@@ -1,6 +1,7 @@
 import { PaginatedWebResponse, RequestMethod, WebResponse } from '../types';
 import { AxiosResponse } from 'axios';
 import { APIPermissions } from '../classes/permissions';
+import { APIFlashcards } from '../classes/flashcards';
 import { APICategories } from '../classes/categories';
 import { APISessions } from '../classes/sessions';
 import { APICalendar } from '../classes/calendar';
@@ -16,6 +17,7 @@ export declare class BoardsManager {
     url: string;
     readonly permissions: APIPermissions;
     readonly categories: APICategories;
+    readonly flashcards: APIFlashcards;
     readonly calendar: APICalendar;
     readonly sessions: APISessions;
     readonly invites: APIInvites;

package/dist/core/manager.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BoardsManager = void 0;
 const axios_1 = __importDefault(require("axios"));
 const permissions_1 = require("../classes/permissions");
+const flashcards_1 = require("../classes/flashcards");
 const categories_1 = require("../classes/categories");
 const sessions_1 = require("../classes/sessions");
 const calendar_1 = require("../classes/calendar");
@@ -22,6 +23,7 @@ class BoardsManager {
     url;
     permissions = new permissions_1.APIPermissions(this);
     categories = new categories_1.APICategories(this);
+    flashcards = new flashcards_1.APIFlashcards(this);
     calendar = new calendar_1.APICalendar(this);
     sessions = new sessions_1.APISessions(this);
     invites = new invites_1.APIInvites(this);

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from './external/types';
 export * from './external/vars';
 export * from './classes/permissions';
 export * from './classes/categories';
+export * from './classes/flashcards';
 export * from './classes/calendar';
 export * from './classes/sessions';
 export * from './classes/invites';

package/dist/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./external/types"), exports);
 __exportStar(require("./external/vars"), exports);
 __exportStar(require("./classes/permissions"), exports);
 __exportStar(require("./classes/categories"), exports);
+__exportStar(require("./classes/flashcards"), exports);
 __exportStar(require("./classes/calendar"), exports);
 __exportStar(require("./classes/sessions"), exports);
 __exportStar(require("./classes/invites"), 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/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"}
+{"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"],"version":"5.9.2"}

package/package.json

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

package/prisma/schema/boards.prisma

@@ -5,7 +5,7 @@ model Group {
     name  String
     index Int
 
-    calCode String
+    calCode String?
     events  Event[]
 
     categories  Category[]
@@ -43,6 +43,8 @@ model Board {
     categoryId String
     category   Category @relation(fields: [categoryId], references: [categoryId], onDelete: Cascade)
 
+    flashcardDeck FlashcardDeck?
+
     files           File[]
     boardPermission BoardPermission[]
 }

package/prisma/schema/flashcards.prisma

@@ -0,0 +1,49 @@
+model FlashcardDeck {
+    dbId   String @id @default(uuid())
+    deckId String @unique
+
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+
+    boardId String @unique
+    board   Board  @relation(fields: [boardId], references: [boardId], onDelete: Cascade)
+
+    cards    FlashcardCard[]
+    progress DeckProgress[]
+
+    @@index([boardId])
+}
+
+model FlashcardCard {
+    dbId   String @id @default(uuid())
+    cardId String @unique
+
+    front String
+    back  String
+    index Int
+
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+
+    deckId String
+    deck   FlashcardDeck @relation(fields: [deckId], references: [deckId], onDelete: Cascade)
+
+    @@index([deckId])
+}
+
+model DeckProgress {
+    dbId String @id @default(uuid())
+
+    deckId String
+    userId String
+
+    currentIndex Int      @default(0)
+    completed    Boolean  @default(false)
+    lastStudied  DateTime @default(now())
+
+    deck FlashcardDeck @relation(fields: [deckId], references: [deckId], onDelete: Cascade)
+    user User          @relation(fields: [userId], references: [userId], onDelete: Cascade)
+
+    @@unique([deckId, userId])
+    @@index([userId])
+}

package/prisma/schema/permissions.prisma

@@ -51,8 +51,8 @@ model Invite {
 
     code String @unique
 
-    // Allow invites to multiple groups, categories, or boards
-    // If multiple are specified, the invite grants access to all of them
+    // Allow invites to multiple groups, categories, or boards.
+    // If multiple are specified, the invite grants access to all of them.
     groupIds  String[]
     groupRole GroupRole?
 

package/prisma/schema/user.prisma

@@ -15,6 +15,8 @@ model User {
     categoryPermissions CategoryPermission[]
     boardPermissions    BoardPermission[]
 
+    flashcardProgress DeckProgress[]
+
     sessions       Session[]
     createdEvents  Event[]
     createdInvites Invite[]