@excali-boards/boards-api-client 1.1.41 → 1.1.43

package/dist/classes/analytics.d.ts

@@ -0,0 +1,60 @@
+import { BoardsManager } from '../core/manager';
+export declare class APIAnalytics {
+    private web;
+    constructor(web: BoardsManager);
+    getUserAnalytics({ auth }: AnalyticsFunctionsInput['getUserAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithBoard[]>>;
+    getBoardAnalytics({ auth, boardId, categoryId, groupId }: AnalyticsFunctionsInput['getBoardAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithUser[]>>;
+    getCategoryAnalytics({ auth, categoryId, groupId }: AnalyticsFunctionsInput['getCategoryAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithUserAndBoard[]>>;
+    getGroupAnalytics({ auth, groupId }: AnalyticsFunctionsInput['getGroupAnalytics']): Promise<import("..").WebResponse<UserBoardActivityWithUserAndBoard[]>>;
+}
+export type AnalyticsFunctionsInput = {
+    'getUserAnalytics': {
+        auth: string;
+    };
+    'getBoardAnalytics': {
+        auth: string;
+        boardId: string;
+        categoryId: string;
+        groupId: string;
+    };
+    'getCategoryAnalytics': {
+        auth: string;
+        categoryId: string;
+        groupId: string;
+    };
+    'getGroupAnalytics': {
+        auth: string;
+        groupId: string;
+    };
+};
+export type ActivityAnalytics = {
+    totalSessions: number;
+    totalActiveSeconds: number;
+    totalActions: number;
+    lastActivityAt: Date;
+};
+export type UserBoardActivityWithBoard = ActivityAnalytics & {
+    board: {
+        name: string;
+        boardId: string;
+    };
+};
+export type UserBoardActivityWithUser = ActivityAnalytics & {
+    user: {
+        userId: string;
+        displayName: string;
+        avatarUrl: string | null;
+    };
+};
+export type UserBoardActivityWithUserAndBoard = ActivityAnalytics & {
+    user: {
+        userId: string;
+        displayName: string;
+        avatarUrl: string | null;
+    };
+    board: {
+        name: string;
+        boardId: string;
+        categoryId: string;
+    };
+};

package/dist/classes/analytics.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIAnalytics = void 0;
+// Data.
+class APIAnalytics {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    // Methods.
+    async getUserAnalytics({ auth }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp('/analytics/user'),
+        });
+    }
+    async getBoardAnalytics({ auth, boardId, categoryId, groupId }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/boards/${boardId}/analytics`),
+        });
+    }
+    async getCategoryAnalytics({ auth, categoryId, groupId }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/groups/${groupId}/categories/${categoryId}/analytics`),
+        });
+    }
+    async getGroupAnalytics({ auth, groupId }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/groups/${groupId}/analytics`),
+        });
+    }
+}
+exports.APIAnalytics = APIAnalytics;

package/dist/core/manager.d.ts

@@ -2,6 +2,7 @@ import { APIPermissions } from '../classes/permissions';
 import { RequestMethod, WebResponse } from '../types';
 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';
@@ -17,6 +18,7 @@ export declare class BoardsManager {
     readonly permissions: APIPermissions;
     readonly categories: APICategories;
     readonly flashcards: APIFlashcards;
+    readonly analytics: APIAnalytics;
     readonly calendar: APICalendar;
     readonly sessions: APISessions;
     readonly invites: APIInvites;

package/dist/core/manager.js

@@ -7,6 +7,7 @@ exports.BoardsManager = void 0;
 const permissions_1 = require("../classes/permissions");
 const flashcards_1 = require("../classes/flashcards");
 const categories_1 = require("../classes/categories");
+const analytics_1 = require("../classes/analytics");
 const sessions_1 = require("../classes/sessions");
 const calendar_1 = require("../classes/calendar");
 const metrics_1 = require("../classes/metrics");
@@ -24,6 +25,7 @@ class BoardsManager {
     permissions = new permissions_1.APIPermissions(this);
     categories = new categories_1.APICategories(this);
     flashcards = new flashcards_1.APIFlashcards(this);
+    analytics = new analytics_1.APIAnalytics(this);
     calendar = new calendar_1.APICalendar(this);
     sessions = new sessions_1.APISessions(this);
     invites = new invites_1.APIInvites(this);

package/dist/external/types.d.ts

@@ -1,15 +1,5 @@
-import { TSPrisma, BoardType } from '../../prisma/generated/default';
 import { BoardRole, CategoryRole, GroupRole } from './vars';
-export type User = TSPrisma.TSPrismaModelsFull['User'];
-export type Group = TSPrisma.TSPrismaModelsFull['Group'];
-export type Category = TSPrisma.TSPrismaModelsFull['Category'];
-export type Board = TSPrisma.TSPrismaModelsFull['Board'];
-export type File = TSPrisma.TSPrismaModelsFull['File'];
-export type LoginMethod = TSPrisma.TSPrismaModelsFull['LoginMethod'];
-export type GroupPermission = TSPrisma.TSPrismaModelsFull['GroupPermission'];
-export type CategoryPermission = TSPrisma.TSPrismaModelsFull['CategoryPermission'];
-export type BoardPermission = TSPrisma.TSPrismaModelsFull['BoardPermission'];
-export type Invite = TSPrisma.TSPrismaModelsFull['Invite'];
+import { BoardType } from '../../prisma/generated/default';
 export type UserRole = BoardRole | CategoryRole | GroupRole | GlobalRole;
 export declare enum GlobalRole {
     Developer = "Developer"

package/dist/index.d.ts

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

package/dist/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./external/vars"), exports);
 __exportStar(require("./classes/permissions"), exports);
 __exportStar(require("./classes/categories"), exports);
 __exportStar(require("./classes/flashcards"), exports);
+__exportStar(require("./classes/analytics"), 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/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"}
+{"root":["../src/index.ts","../src/types.ts","../src/classes/admin.ts","../src/classes/analytics.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/dist/types.d.ts

@@ -4,7 +4,7 @@ export type WebResponse<T, S extends StatusWebCode = StatusWebCode> = S extends
     data: T;
 } : {
     status: S;
-    error: string;
+    error: string | string[];
 };
 export type Paginated<T> = {
     data: T extends (infer U)[] ? U[] : T[];

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.1.41",
+	"version": "1.1.43",
 	"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

@@ -47,6 +47,33 @@ model Board {
 
     files           File[]
     boardPermission BoardPermission[]
+    userActivities  UserBoardActivity[]
+
+    @@index([categoryId])
+    @@index([index])
+}
+
+model UserBoardActivity {
+    dbId String @id @default(uuid())
+
+    userId String
+    user   User   @relation(fields: [userId], references: [userId], onDelete: Cascade)
+
+    boardId String
+    board   Board  @relation(fields: [boardId], references: [boardId], onDelete: Cascade)
+
+    totalSessions      Int @default(0)
+    totalActiveSeconds Int @default(0)
+
+    totalActions   Int      @default(0)
+    lastActivityAt DateTime @default(now())
+
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+
+    @@unique([userId, boardId])
+    @@index([boardId])
+    @@index([lastActivityAt])
 }
 
 model File {
@@ -59,4 +86,6 @@ model File {
 
     boardId String
     board   Board  @relation(fields: [boardId], references: [boardId], onDelete: Cascade)
+
+    @@index([boardId])
 }

package/prisma/schema/user.prisma

@@ -10,7 +10,7 @@ model User {
 
     mainLoginType Platforms
     loginMethods  LoginMethod[]
-    
+
     invitedBy          String?
     registrationMethod RegistrationMethod @default(direct)
 
@@ -20,9 +20,10 @@ model User {
 
     flashcardProgress DeckProgress[]
 
-    sessions       Session[]
-    createdEvents  Event[]
-    createdInvites Invite[]
+    sessions        Session[]
+    createdEvents   Event[]
+    createdInvites  Invite[]
+    boardActivities UserBoardActivity[]
 }
 
 model Session {