@excali-boards/boards-api-client 1.1.1-dev.28 → 1.1.1-dev.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{classes → cjs/classes}/admin.js +1 -1
- package/dist/cjs/classes/auth.d.ts +26 -0
- package/dist/cjs/classes/auth.js +18 -0
- package/dist/{classes → cjs/classes}/invites.d.ts +23 -52
- package/dist/{classes → cjs/classes}/invites.js +1 -13
- package/dist/{classes → cjs/classes}/metrics.d.ts +1 -0
- package/dist/{classes → cjs/classes}/permissions.d.ts +6 -5
- package/dist/{classes → cjs/classes}/users.d.ts +7 -13
- package/dist/{classes → cjs/classes}/users.js +9 -7
- package/dist/{core → cjs/core}/manager.d.ts +2 -2
- package/dist/{core → cjs/core}/manager.js +2 -2
- package/dist/{external → cjs/external}/types.d.ts +1 -14
- package/dist/{external → cjs/external}/vars.d.ts +1 -4
- package/dist/{external → cjs/external}/vars.js +3 -24
- package/dist/{index.d.ts → cjs/index.d.ts} +1 -1
- package/dist/{index.js → cjs/index.js} +1 -1
- package/dist/cjs/tsconfig.tsbuildinfo +1 -0
- package/dist/esm/classes/admin.d.ts +26 -0
- package/dist/esm/classes/admin.js +20 -0
- package/dist/esm/classes/auth.d.ts +26 -0
- package/dist/esm/classes/auth.js +14 -0
- package/dist/esm/classes/boards.d.ts +77 -0
- package/dist/esm/classes/boards.js +50 -0
- package/dist/esm/classes/categories.d.ts +56 -0
- package/dist/esm/classes/categories.js +44 -0
- package/dist/esm/classes/groups.d.ts +74 -0
- package/dist/esm/classes/groups.js +62 -0
- package/dist/esm/classes/invites.d.ts +82 -0
- package/dist/esm/classes/invites.js +32 -0
- package/dist/esm/classes/metrics.d.ts +28 -0
- package/dist/esm/classes/metrics.js +20 -0
- package/dist/esm/classes/permissions.d.ts +50 -0
- package/dist/esm/classes/permissions.js +26 -0
- package/dist/esm/classes/users.d.ts +26 -0
- package/dist/esm/classes/users.js +28 -0
- package/dist/esm/core/manager.d.ts +34 -0
- package/dist/esm/core/manager.js +67 -0
- package/dist/esm/core/utils.d.ts +4 -0
- package/dist/esm/core/utils.js +21 -0
- package/dist/esm/external/types.d.ts +28 -0
- package/dist/esm/external/types.js +4 -0
- package/dist/esm/external/vars.d.ts +92 -0
- package/dist/esm/external/vars.js +42 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +13 -0
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -0
- package/dist/esm/types.d.ts +54 -0
- package/dist/esm/types.js +1 -0
- package/package.json +23 -12
- package/prisma/schema/schema.prisma +0 -8
- package/prisma/schema/user.prisma +0 -20
- package/tsconfig.esm.json +9 -0
- package/dist/classes/sessions.d.ts +0 -46
- package/dist/classes/sessions.js +0 -36
- package/dist/tsconfig.tsbuildinfo +0 -1
- /package/dist/{classes → cjs/classes}/admin.d.ts +0 -0
- /package/dist/{classes → cjs/classes}/boards.d.ts +0 -0
- /package/dist/{classes → cjs/classes}/boards.js +0 -0
- /package/dist/{classes → cjs/classes}/categories.d.ts +0 -0
- /package/dist/{classes → cjs/classes}/categories.js +0 -0
- /package/dist/{classes → cjs/classes}/groups.d.ts +0 -0
- /package/dist/{classes → cjs/classes}/groups.js +0 -0
- /package/dist/{classes → cjs/classes}/metrics.js +0 -0
- /package/dist/{classes → cjs/classes}/permissions.js +0 -0
- /package/dist/{core → cjs/core}/utils.d.ts +0 -0
- /package/dist/{core → cjs/core}/utils.js +0 -0
- /package/dist/{external → cjs/external}/types.js +0 -0
- /package/dist/{types.d.ts → cjs/types.d.ts} +0 -0
- /package/dist/{types.js → cjs/types.js} +0 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { BoardsManager } from '../core/manager';
|
|
2
|
+
import { Platforms } from '@prisma/generated';
|
|
3
|
+
export declare class APIAuth {
|
|
4
|
+
private web;
|
|
5
|
+
constructor(web: BoardsManager);
|
|
6
|
+
authenticate({ auth, body }: AuthFunctionsInput['authenticate']): Promise<import("..").WebResponse<AuthenticateOutput>>;
|
|
7
|
+
}
|
|
8
|
+
export type AuthFunctionsInput = {
|
|
9
|
+
'authenticate': {
|
|
10
|
+
auth: string;
|
|
11
|
+
body: AuthenticateInput;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
export type AuthenticateInput = {
|
|
15
|
+
platform: Platforms;
|
|
16
|
+
email: string;
|
|
17
|
+
displayName: string;
|
|
18
|
+
avatarUrl?: string | null;
|
|
19
|
+
currentUserId?: string;
|
|
20
|
+
};
|
|
21
|
+
export type AuthenticateOutput = {
|
|
22
|
+
email: string;
|
|
23
|
+
displayName: string | null;
|
|
24
|
+
avatarUrl: string | null;
|
|
25
|
+
platform: Platforms;
|
|
26
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.APIAuth = void 0;
|
|
4
|
+
// Data.
|
|
5
|
+
class APIAuth {
|
|
6
|
+
web;
|
|
7
|
+
constructor(web) {
|
|
8
|
+
this.web = web;
|
|
9
|
+
}
|
|
10
|
+
// Methods.
|
|
11
|
+
async authenticate({ auth, body }) {
|
|
12
|
+
return await this.web.request({
|
|
13
|
+
method: 'POST', auth, body,
|
|
14
|
+
endpoint: this.web.qp('/auth'),
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
exports.APIAuth = APIAuth;
|
|
@@ -1,29 +1,18 @@
|
|
|
1
1
|
import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
|
|
2
|
-
import {
|
|
3
|
-
import { Invite } from '../../prisma/generated';
|
|
2
|
+
import { ResourceType } from '../external/types';
|
|
4
3
|
import { BoardsManager } from '../core/manager';
|
|
5
4
|
export declare class APIInvites {
|
|
6
5
|
private web;
|
|
7
6
|
constructor(web: BoardsManager);
|
|
8
|
-
|
|
9
|
-
getResourceInvites({ auth, query }: InvitesFunctionsInput['getResourceInvites']): Promise<import("..").WebResponse<GetResourceInvitesOutput>>;
|
|
10
|
-
getInviteDetails({ auth, code }: InvitesFunctionsInput['getInviteDetails']): Promise<import("..").WebResponse<InviteDetails>>;
|
|
7
|
+
getInvites({ auth }: InvitesFunctionsInput['getInvites']): Promise<import("..").WebResponse<GetInvitesOutput>>;
|
|
11
8
|
createInvite({ auth, body }: InvitesFunctionsInput['createInvite']): Promise<import("..").WebResponse<CreateInviteOutput>>;
|
|
12
9
|
useInvite({ auth, code }: InvitesFunctionsInput['useInvite']): Promise<import("..").WebResponse<UseInviteOutput>>;
|
|
13
10
|
revokeInvite({ auth, code }: InvitesFunctionsInput['revokeInvite']): Promise<import("..").WebResponse<string>>;
|
|
14
11
|
}
|
|
15
12
|
export type InvitesFunctionsInput = {
|
|
16
|
-
'
|
|
13
|
+
'getInvites': {
|
|
17
14
|
auth: string;
|
|
18
15
|
};
|
|
19
|
-
'getResourceInvites': {
|
|
20
|
-
auth: string;
|
|
21
|
-
query: ViewInvitesQuery;
|
|
22
|
-
};
|
|
23
|
-
'getInviteDetails': {
|
|
24
|
-
auth: string;
|
|
25
|
-
code: string;
|
|
26
|
-
};
|
|
27
16
|
'createInvite': {
|
|
28
17
|
auth: string;
|
|
29
18
|
body: CreateInviteInput;
|
|
@@ -37,12 +26,6 @@ export type InvitesFunctionsInput = {
|
|
|
37
26
|
code: string;
|
|
38
27
|
};
|
|
39
28
|
};
|
|
40
|
-
export type ViewInvitesQuery = {
|
|
41
|
-
type: ResourceType;
|
|
42
|
-
groupId?: string;
|
|
43
|
-
categoryId?: string;
|
|
44
|
-
boardId?: string;
|
|
45
|
-
};
|
|
46
29
|
export type CreateInviteInput = {
|
|
47
30
|
groupIds?: string[];
|
|
48
31
|
categoryIds?: string[];
|
|
@@ -58,13 +41,28 @@ export type CreateInviteOutput = {
|
|
|
58
41
|
expiresAt: string;
|
|
59
42
|
maxUses: number;
|
|
60
43
|
};
|
|
61
|
-
export type
|
|
62
|
-
|
|
63
|
-
|
|
44
|
+
export type GetInvitesOutput = {
|
|
45
|
+
dbId: string;
|
|
46
|
+
code: string;
|
|
47
|
+
createdBy: string;
|
|
48
|
+
expiresAt: string | null;
|
|
49
|
+
maxUses: number | null;
|
|
50
|
+
currentUses: number;
|
|
51
|
+
groupIds: string[];
|
|
52
|
+
categoryIds: string[];
|
|
53
|
+
boardIds: string[];
|
|
54
|
+
groupRole: GroupRole | null;
|
|
55
|
+
categoryRole: CategoryRole | null;
|
|
56
|
+
boardRole: BoardRole | null;
|
|
57
|
+
createdAt: string;
|
|
58
|
+
}[];
|
|
59
|
+
export type GrantedRole = {
|
|
60
|
+
type: ResourceType;
|
|
61
|
+
resourceId: string;
|
|
62
|
+
role: BoardRole | CategoryRole | GroupRole;
|
|
64
63
|
};
|
|
65
|
-
export type GetResourceInvitesOutput = InviteData[];
|
|
66
64
|
export type UseInviteOutput = {
|
|
67
|
-
granted:
|
|
65
|
+
granted: GrantedRole[];
|
|
68
66
|
details: {
|
|
69
67
|
groups: {
|
|
70
68
|
groupId: string;
|
|
@@ -82,30 +80,3 @@ export type UseInviteOutput = {
|
|
|
82
80
|
}[];
|
|
83
81
|
};
|
|
84
82
|
};
|
|
85
|
-
export type InviteDetails = {
|
|
86
|
-
code: string;
|
|
87
|
-
expiresAt: string;
|
|
88
|
-
maxUses: number;
|
|
89
|
-
currentUses: number;
|
|
90
|
-
invitedBy: {
|
|
91
|
-
userId: string;
|
|
92
|
-
displayName: string;
|
|
93
|
-
avatarUrl: string | null;
|
|
94
|
-
};
|
|
95
|
-
};
|
|
96
|
-
export type InviteData = Pick<Invite, 'dbId' | 'code' | 'expiresAt' | 'maxUses' | 'currentUses' | 'boardRole' | 'categoryRole' | 'groupRole'> & {
|
|
97
|
-
groups: {
|
|
98
|
-
groupId: string;
|
|
99
|
-
name: string;
|
|
100
|
-
}[];
|
|
101
|
-
categories: {
|
|
102
|
-
categoryId: string;
|
|
103
|
-
name: string;
|
|
104
|
-
groupId: string;
|
|
105
|
-
}[];
|
|
106
|
-
boards: {
|
|
107
|
-
boardId: string;
|
|
108
|
-
name: string;
|
|
109
|
-
categoryId: string;
|
|
110
|
-
}[];
|
|
111
|
-
};
|
|
@@ -8,24 +8,12 @@ class APIInvites {
|
|
|
8
8
|
this.web = web;
|
|
9
9
|
}
|
|
10
10
|
// Methods.
|
|
11
|
-
async
|
|
11
|
+
async getInvites({ auth }) {
|
|
12
12
|
return await this.web.request({
|
|
13
13
|
method: 'GET', auth,
|
|
14
14
|
endpoint: this.web.qp('/invites'),
|
|
15
15
|
});
|
|
16
16
|
}
|
|
17
|
-
async getResourceInvites({ auth, query }) {
|
|
18
|
-
return await this.web.request({
|
|
19
|
-
method: 'GET', auth,
|
|
20
|
-
endpoint: this.web.qp('/resources/invites', query),
|
|
21
|
-
});
|
|
22
|
-
}
|
|
23
|
-
async getInviteDetails({ auth, code }) {
|
|
24
|
-
return await this.web.request({
|
|
25
|
-
method: 'GET', auth,
|
|
26
|
-
endpoint: this.web.qp(`/invites/${code}`),
|
|
27
|
-
});
|
|
28
|
-
}
|
|
29
17
|
async createInvite({ auth, body }) {
|
|
30
18
|
return await this.web.request({
|
|
31
19
|
method: 'POST', auth, body,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
|
|
2
|
-
import {
|
|
2
|
+
import { ResourceType } from '../external/types';
|
|
3
3
|
import { BoardsManager } from '../core/manager';
|
|
4
4
|
export declare class APIPermissions {
|
|
5
5
|
private web;
|
|
@@ -24,22 +24,23 @@ export type PermissionsFunctionsInput = {
|
|
|
24
24
|
};
|
|
25
25
|
export type ViewPermissionsQuery = {
|
|
26
26
|
type: ResourceType;
|
|
27
|
-
|
|
27
|
+
groupId?: string;
|
|
28
|
+
categoryId?: string;
|
|
29
|
+
boardId?: string;
|
|
28
30
|
};
|
|
29
31
|
export type ViewPermissionsOutput = {
|
|
30
32
|
userId: string;
|
|
31
33
|
email: string;
|
|
32
34
|
displayName: string;
|
|
33
35
|
avatarUrl: string | null;
|
|
34
|
-
permissions: GrantedEntry[];
|
|
35
36
|
}[];
|
|
36
37
|
export type GrantPermissionsInput = {
|
|
37
38
|
userId: string;
|
|
38
39
|
groupIds?: string[];
|
|
39
|
-
groupRole?: GroupRole;
|
|
40
40
|
categoryIds?: string[];
|
|
41
|
-
categoryRole?: CategoryRole;
|
|
42
41
|
boardIds?: string[];
|
|
42
|
+
groupRole?: GroupRole;
|
|
43
|
+
categoryRole?: CategoryRole;
|
|
43
44
|
boardRole?: BoardRole;
|
|
44
45
|
};
|
|
45
46
|
export type RevokePermissionsInput = {
|
|
@@ -1,32 +1,26 @@
|
|
|
1
|
-
import { Platforms } from '../../prisma/generated/default';
|
|
2
1
|
import { DBUserPartialType } from '../external/vars';
|
|
3
2
|
import { BoardsManager } from '../core/manager';
|
|
3
|
+
import { Platforms } from '@prisma/generated';
|
|
4
4
|
export declare class APIUsers {
|
|
5
5
|
private web;
|
|
6
6
|
constructor(web: BoardsManager);
|
|
7
7
|
getCurrentUser({ auth }: UsersFunctionsInput['getCurrentUser']): Promise<import("..").WebResponse<GetUsersOutput>>;
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
changeMainPlatform({ auth, newMainPlatform }: UsersFunctionsInput['changeMainPlatform']): Promise<import("..").WebResponse<string>>;
|
|
9
|
+
changeMainGroup({ auth, newMainGroupId }: UsersFunctionsInput['changeMainGroup']): Promise<import("..").WebResponse<string>>;
|
|
10
10
|
}
|
|
11
11
|
export type UsersFunctionsInput = {
|
|
12
12
|
'getCurrentUser': {
|
|
13
13
|
auth: string;
|
|
14
14
|
};
|
|
15
|
-
'
|
|
15
|
+
'changeMainPlatform': {
|
|
16
16
|
auth: string;
|
|
17
|
-
|
|
17
|
+
newMainPlatform: Platforms;
|
|
18
18
|
};
|
|
19
|
-
'
|
|
20
|
-
auth: string;
|
|
21
|
-
};
|
|
22
|
-
'isCurrentUserDev': {
|
|
19
|
+
'changeMainGroup': {
|
|
23
20
|
auth: string;
|
|
21
|
+
newMainGroupId: string | null;
|
|
24
22
|
};
|
|
25
23
|
};
|
|
26
24
|
export type GetUsersOutput = DBUserPartialType & {
|
|
27
25
|
isDev: boolean;
|
|
28
26
|
};
|
|
29
|
-
export type UserInput = {
|
|
30
|
-
mainGroupId?: string | null;
|
|
31
|
-
platform?: Platforms;
|
|
32
|
-
};
|
|
@@ -11,19 +11,21 @@ class APIUsers {
|
|
|
11
11
|
async getCurrentUser({ auth }) {
|
|
12
12
|
return await this.web.request({
|
|
13
13
|
method: 'GET', auth,
|
|
14
|
-
endpoint: this.web.qp('/users'),
|
|
14
|
+
endpoint: this.web.qp('/users/current'),
|
|
15
15
|
});
|
|
16
16
|
}
|
|
17
|
-
async
|
|
17
|
+
async changeMainPlatform({ auth, newMainPlatform }) {
|
|
18
18
|
return await this.web.request({
|
|
19
|
-
method: '
|
|
20
|
-
endpoint: this.web.qp('/users'),
|
|
19
|
+
method: 'POST', auth,
|
|
20
|
+
endpoint: this.web.qp('/users/change-main-platform'),
|
|
21
|
+
body: { name: newMainPlatform },
|
|
21
22
|
});
|
|
22
23
|
}
|
|
23
|
-
async
|
|
24
|
+
async changeMainGroup({ auth, newMainGroupId }) {
|
|
24
25
|
return await this.web.request({
|
|
25
|
-
method: '
|
|
26
|
-
endpoint: this.web.qp('/users'),
|
|
26
|
+
method: 'POST', auth,
|
|
27
|
+
endpoint: this.web.qp('/users/change-main-group'),
|
|
28
|
+
body: { groupId: newMainGroupId },
|
|
27
29
|
});
|
|
28
30
|
}
|
|
29
31
|
}
|
|
@@ -2,24 +2,24 @@ import { PaginatedWebResponse, RequestMethod, WebResponse } from '../types';
|
|
|
2
2
|
import { AxiosResponse, ResponseType } from 'axios';
|
|
3
3
|
import { APIPermissions } from '../classes/permissions';
|
|
4
4
|
import { APICategories } from '../classes/categories';
|
|
5
|
-
import { APISessions } from '../classes/sessions';
|
|
6
5
|
import { APIMetrics } from '../classes/metrics';
|
|
7
6
|
import { APIInvites } from '../classes/invites';
|
|
8
7
|
import { APIGroups } from '../classes/groups';
|
|
9
8
|
import { APIBoards } from '../classes/boards';
|
|
10
9
|
import { APIUsers } from '../classes/users';
|
|
11
10
|
import { APIAdmin } from '../classes/admin';
|
|
11
|
+
import { APIAuth } from '../classes/auth';
|
|
12
12
|
export declare class BoardsManager {
|
|
13
13
|
url: string;
|
|
14
14
|
readonly permissions: APIPermissions;
|
|
15
15
|
readonly categories: APICategories;
|
|
16
|
-
readonly sessions: APISessions;
|
|
17
16
|
readonly invites: APIInvites;
|
|
18
17
|
readonly metrics: APIMetrics;
|
|
19
18
|
readonly groups: APIGroups;
|
|
20
19
|
readonly boards: APIBoards;
|
|
21
20
|
readonly admin: APIAdmin;
|
|
22
21
|
readonly users: APIUsers;
|
|
22
|
+
readonly auth: APIAuth;
|
|
23
23
|
constructor(url: string);
|
|
24
24
|
request<O, T = unknown, R extends boolean = false, P extends boolean = false>(data: {
|
|
25
25
|
endpoint: string;
|
|
@@ -7,25 +7,25 @@ exports.BoardsManager = void 0;
|
|
|
7
7
|
const axios_1 = __importDefault(require("axios"));
|
|
8
8
|
const permissions_1 = require("../classes/permissions");
|
|
9
9
|
const categories_1 = require("../classes/categories");
|
|
10
|
-
const sessions_1 = require("../classes/sessions");
|
|
11
10
|
const metrics_1 = require("../classes/metrics");
|
|
12
11
|
const invites_1 = require("../classes/invites");
|
|
13
12
|
const groups_1 = require("../classes/groups");
|
|
14
13
|
const boards_1 = require("../classes/boards");
|
|
15
14
|
const users_1 = require("../classes/users");
|
|
16
15
|
const admin_1 = require("../classes/admin");
|
|
16
|
+
const auth_1 = require("../classes/auth");
|
|
17
17
|
const utils_1 = require("./utils");
|
|
18
18
|
class BoardsManager {
|
|
19
19
|
url;
|
|
20
20
|
permissions = new permissions_1.APIPermissions(this);
|
|
21
21
|
categories = new categories_1.APICategories(this);
|
|
22
|
-
sessions = new sessions_1.APISessions(this);
|
|
23
22
|
invites = new invites_1.APIInvites(this);
|
|
24
23
|
metrics = new metrics_1.APIMetrics(this);
|
|
25
24
|
groups = new groups_1.APIGroups(this);
|
|
26
25
|
boards = new boards_1.APIBoards(this);
|
|
27
26
|
admin = new admin_1.APIAdmin(this);
|
|
28
27
|
users = new users_1.APIUsers(this);
|
|
28
|
+
auth = new auth_1.APIAuth(this);
|
|
29
29
|
constructor(url) {
|
|
30
30
|
this.url = url;
|
|
31
31
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BoardRole, CategoryRole, GroupRole } from './vars';
|
|
2
|
-
import { TSPrisma } from '
|
|
2
|
+
import { TSPrisma } from '@prisma/generated';
|
|
3
3
|
export type User = TSPrisma.TSPrismaModelsFull['User'];
|
|
4
4
|
export type Group = TSPrisma.TSPrismaModelsFull['Group'];
|
|
5
5
|
export type Category = TSPrisma.TSPrismaModelsFull['Category'];
|
|
@@ -17,12 +17,6 @@ export declare enum GlobalRole {
|
|
|
17
17
|
export type AccessLevel = 'read' | 'write' | 'manage' | 'admin';
|
|
18
18
|
export type ResourceType = 'group' | 'category' | 'board';
|
|
19
19
|
export type GlobalResourceType = ResourceType | 'global';
|
|
20
|
-
export type GrantedRoles = GrantedRole[];
|
|
21
|
-
export type GrantedRole = {
|
|
22
|
-
type: ResourceType;
|
|
23
|
-
resourceId: string;
|
|
24
|
-
role: UserRole;
|
|
25
|
-
};
|
|
26
20
|
export type SingleOutput = {
|
|
27
21
|
id: string;
|
|
28
22
|
name: string;
|
|
@@ -32,10 +26,3 @@ export type SingleOutput = {
|
|
|
32
26
|
export type NameInput = {
|
|
33
27
|
name: string;
|
|
34
28
|
};
|
|
35
|
-
export type GrantedEntry = {
|
|
36
|
-
type: ResourceType;
|
|
37
|
-
role: UserRole;
|
|
38
|
-
resourceId: string;
|
|
39
|
-
basedOnType: ResourceType;
|
|
40
|
-
basedOnResourceId: string;
|
|
41
|
-
};
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import { Prisma } from '
|
|
2
|
-
import { UserRole } from './types';
|
|
1
|
+
import { Prisma } from '@prisma/generated';
|
|
3
2
|
export declare const DBUserSelectArgs: {
|
|
4
3
|
select: {
|
|
5
4
|
userId: true;
|
|
@@ -91,5 +90,3 @@ export declare enum GroupRole {
|
|
|
91
90
|
GroupManager = "GroupManager",
|
|
92
91
|
GroupAdmin = "GroupAdmin"
|
|
93
92
|
}
|
|
94
|
-
export declare const SimplePermissionHierarchy: Record<string, number>;
|
|
95
|
-
export declare const PermissionHierarchy: Record<UserRole, number>;
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
const
|
|
5
|
-
const types_1 = require("./types");
|
|
3
|
+
exports.GroupRole = exports.CategoryRole = exports.BoardRole = exports.Platforms = exports.DBUserPartial = exports.DBUserSelectArgs = void 0;
|
|
4
|
+
const generated_1 = require("@prisma/generated");
|
|
6
5
|
exports.DBUserSelectArgs = {
|
|
7
6
|
select: {
|
|
8
7
|
userId: true,
|
|
@@ -17,7 +16,7 @@ exports.DBUserSelectArgs = {
|
|
|
17
16
|
loginMethods: { select: { platform: true, platformEmail: true } },
|
|
18
17
|
},
|
|
19
18
|
};
|
|
20
|
-
exports.DBUserPartial =
|
|
19
|
+
exports.DBUserPartial = generated_1.Prisma.validator()(exports.DBUserSelectArgs);
|
|
21
20
|
var Platforms;
|
|
22
21
|
(function (Platforms) {
|
|
23
22
|
Platforms["Google"] = "Google";
|
|
@@ -44,23 +43,3 @@ var GroupRole;
|
|
|
44
43
|
GroupRole["GroupManager"] = "GroupManager";
|
|
45
44
|
GroupRole["GroupAdmin"] = "GroupAdmin";
|
|
46
45
|
})(GroupRole || (exports.GroupRole = GroupRole = {}));
|
|
47
|
-
// Variables.
|
|
48
|
-
exports.SimplePermissionHierarchy = {
|
|
49
|
-
Viewer: 1,
|
|
50
|
-
Collaborator: 2,
|
|
51
|
-
Manager: 3,
|
|
52
|
-
Admin: 4,
|
|
53
|
-
};
|
|
54
|
-
exports.PermissionHierarchy = {
|
|
55
|
-
[BoardRole.BoardViewer]: 1,
|
|
56
|
-
[BoardRole.BoardCollaborator]: 2,
|
|
57
|
-
[CategoryRole.CategoryViewer]: 3,
|
|
58
|
-
[CategoryRole.CategoryCollaborator]: 4,
|
|
59
|
-
[CategoryRole.CategoryManager]: 5,
|
|
60
|
-
[CategoryRole.CategoryAdmin]: 6,
|
|
61
|
-
[GroupRole.GroupViewer]: 7,
|
|
62
|
-
[GroupRole.GroupCollaborator]: 8,
|
|
63
|
-
[GroupRole.GroupManager]: 9,
|
|
64
|
-
[GroupRole.GroupAdmin]: 10,
|
|
65
|
-
[types_1.GlobalRole.Developer]: 11,
|
|
66
|
-
};
|
|
@@ -4,10 +4,10 @@ export * from './external/types';
|
|
|
4
4
|
export * from './external/vars';
|
|
5
5
|
export * from './classes/permissions';
|
|
6
6
|
export * from './classes/categories';
|
|
7
|
-
export * from './classes/sessions';
|
|
8
7
|
export * from './classes/invites';
|
|
9
8
|
export * from './classes/metrics';
|
|
10
9
|
export * from './classes/groups';
|
|
11
10
|
export * from './classes/boards';
|
|
12
11
|
export * from './classes/admin';
|
|
13
12
|
export * from './classes/users';
|
|
13
|
+
export * from './classes/auth';
|
|
@@ -20,10 +20,10 @@ __exportStar(require("./external/types"), exports);
|
|
|
20
20
|
__exportStar(require("./external/vars"), exports);
|
|
21
21
|
__exportStar(require("./classes/permissions"), exports);
|
|
22
22
|
__exportStar(require("./classes/categories"), exports);
|
|
23
|
-
__exportStar(require("./classes/sessions"), exports);
|
|
24
23
|
__exportStar(require("./classes/invites"), exports);
|
|
25
24
|
__exportStar(require("./classes/metrics"), exports);
|
|
26
25
|
__exportStar(require("./classes/groups"), exports);
|
|
27
26
|
__exportStar(require("./classes/boards"), exports);
|
|
28
27
|
__exportStar(require("./classes/admin"), exports);
|
|
29
28
|
__exportStar(require("./classes/users"), exports);
|
|
29
|
+
__exportStar(require("./classes/auth"), exports);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"root":["../../src/index.ts","../../src/types.ts","../../src/classes/admin.ts","../../src/classes/auth.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/users.ts","../../src/core/manager.ts","../../src/core/utils.ts","../../src/external/types.ts","../../src/external/vars.ts"],"version":"5.9.2"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { BoardsManager } from '../core/manager';
|
|
2
|
+
import { GetUsersOutput } from './users';
|
|
3
|
+
export declare class APIAdmin {
|
|
4
|
+
private web;
|
|
5
|
+
constructor(web: BoardsManager);
|
|
6
|
+
getUsers({ auth }: AdminFunctionsInput['getUsers']): Promise<import("..").WebResponse<GetUsersOutput[]>>;
|
|
7
|
+
getActiveRooms({ auth }: AdminFunctionsInput['getActiveRooms']): Promise<import("..").WebResponse<GetRoomsOutput<number>[]>>;
|
|
8
|
+
}
|
|
9
|
+
export type AdminFunctionsInput = {
|
|
10
|
+
'getUsers': {
|
|
11
|
+
auth: string;
|
|
12
|
+
};
|
|
13
|
+
'getActiveRooms': {
|
|
14
|
+
auth: string;
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
export type GetRoomsOutput<T> = {
|
|
18
|
+
boardId: string;
|
|
19
|
+
elements: T;
|
|
20
|
+
collaborators: {
|
|
21
|
+
id: string;
|
|
22
|
+
socketId: string;
|
|
23
|
+
username: string;
|
|
24
|
+
avatarUrl: string | null;
|
|
25
|
+
}[];
|
|
26
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
// Data.
|
|
2
|
+
export class APIAdmin {
|
|
3
|
+
web;
|
|
4
|
+
constructor(web) {
|
|
5
|
+
this.web = web;
|
|
6
|
+
}
|
|
7
|
+
// Methods.
|
|
8
|
+
async getUsers({ auth }) {
|
|
9
|
+
return await this.web.request({
|
|
10
|
+
method: 'GET', auth,
|
|
11
|
+
endpoint: this.web.qp('/users'),
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
async getActiveRooms({ auth }) {
|
|
15
|
+
return await this.web.request({
|
|
16
|
+
method: 'GET', auth,
|
|
17
|
+
endpoint: this.web.qp('/admin/rooms'),
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { BoardsManager } from '../core/manager';
|
|
2
|
+
import { Platforms } from '@prisma/generated';
|
|
3
|
+
export declare class APIAuth {
|
|
4
|
+
private web;
|
|
5
|
+
constructor(web: BoardsManager);
|
|
6
|
+
authenticate({ auth, body }: AuthFunctionsInput['authenticate']): Promise<import("..").WebResponse<AuthenticateOutput>>;
|
|
7
|
+
}
|
|
8
|
+
export type AuthFunctionsInput = {
|
|
9
|
+
'authenticate': {
|
|
10
|
+
auth: string;
|
|
11
|
+
body: AuthenticateInput;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
export type AuthenticateInput = {
|
|
15
|
+
platform: Platforms;
|
|
16
|
+
email: string;
|
|
17
|
+
displayName: string;
|
|
18
|
+
avatarUrl?: string | null;
|
|
19
|
+
currentUserId?: string;
|
|
20
|
+
};
|
|
21
|
+
export type AuthenticateOutput = {
|
|
22
|
+
email: string;
|
|
23
|
+
displayName: string | null;
|
|
24
|
+
avatarUrl: string | null;
|
|
25
|
+
platform: Platforms;
|
|
26
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
// Data.
|
|
2
|
+
export class APIAuth {
|
|
3
|
+
web;
|
|
4
|
+
constructor(web) {
|
|
5
|
+
this.web = web;
|
|
6
|
+
}
|
|
7
|
+
// Methods.
|
|
8
|
+
async authenticate({ auth, body }) {
|
|
9
|
+
return await this.web.request({
|
|
10
|
+
method: 'POST', auth, body,
|
|
11
|
+
endpoint: this.web.qp('/auth'),
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { AccessLevel, NameInput, SingleOutput } from '../external/types';
|
|
2
|
+
import { BoardsManager } from '../core/manager';
|
|
3
|
+
import { GetRoomsOutput } from './admin';
|
|
4
|
+
export declare class APIBoards {
|
|
5
|
+
private web;
|
|
6
|
+
constructor(web: BoardsManager);
|
|
7
|
+
getBoards({ auth, categoryId, groupId }: BoardsFunctionsInput['getBoards']): Promise<import("..").WebResponse<GetBoardOutput[]>>;
|
|
8
|
+
getBoard({ auth, categoryId, groupId, boardId }: BoardsFunctionsInput['getBoard']): Promise<import("..").WebResponse<GetBoardOutput>>;
|
|
9
|
+
updateBoard({ auth, categoryId, groupId, boardId, body }: BoardsFunctionsInput['updateBoard']): Promise<import("..").WebResponse<string>>;
|
|
10
|
+
scheduleBoardDeletion({ auth, categoryId, groupId, boardId }: BoardsFunctionsInput['scheduleBoardDeletion']): Promise<import("..").WebResponse<string>>;
|
|
11
|
+
cancelBoardDeletion({ auth, categoryId, groupId, boardId }: BoardsFunctionsInput['cancelBoardDeletion']): Promise<import("..").WebResponse<string>>;
|
|
12
|
+
getBoardRoomData<T>({ auth, categoryId, groupId, boardId }: BoardsFunctionsInput['getRoomData']): Promise<import("..").WebResponse<GetRoomsOutput<T>>>;
|
|
13
|
+
kickUserFromRoom({ auth, categoryId, groupId, boardId, userId }: BoardsFunctionsInput['kickUserFromRoom']): Promise<import("..").WebResponse<string>>;
|
|
14
|
+
}
|
|
15
|
+
export type BoardsFunctionsInput = {
|
|
16
|
+
'getBoards': {
|
|
17
|
+
auth: string;
|
|
18
|
+
categoryId: string;
|
|
19
|
+
groupId: string;
|
|
20
|
+
};
|
|
21
|
+
'getBoard': {
|
|
22
|
+
auth: string;
|
|
23
|
+
categoryId: string;
|
|
24
|
+
groupId: string;
|
|
25
|
+
boardId: string;
|
|
26
|
+
};
|
|
27
|
+
'updateBoard': {
|
|
28
|
+
auth: string;
|
|
29
|
+
categoryId: string;
|
|
30
|
+
groupId: string;
|
|
31
|
+
boardId: string;
|
|
32
|
+
body: NameInput;
|
|
33
|
+
};
|
|
34
|
+
'scheduleBoardDeletion': {
|
|
35
|
+
auth: string;
|
|
36
|
+
categoryId: string;
|
|
37
|
+
groupId: string;
|
|
38
|
+
boardId: string;
|
|
39
|
+
};
|
|
40
|
+
'cancelBoardDeletion': {
|
|
41
|
+
auth: string;
|
|
42
|
+
categoryId: string;
|
|
43
|
+
groupId: string;
|
|
44
|
+
boardId: string;
|
|
45
|
+
};
|
|
46
|
+
'getRoomData': {
|
|
47
|
+
auth: string;
|
|
48
|
+
categoryId: string;
|
|
49
|
+
groupId: string;
|
|
50
|
+
boardId: string;
|
|
51
|
+
};
|
|
52
|
+
'kickUserFromRoom': {
|
|
53
|
+
auth: string;
|
|
54
|
+
categoryId: string;
|
|
55
|
+
groupId: string;
|
|
56
|
+
boardId: string;
|
|
57
|
+
userId: string;
|
|
58
|
+
};
|
|
59
|
+
};
|
|
60
|
+
export type GetBoardOutput = {
|
|
61
|
+
group: SingleOutput;
|
|
62
|
+
category: SingleOutput;
|
|
63
|
+
board: SingleOutput & {
|
|
64
|
+
dataUrl: string;
|
|
65
|
+
totalSizeBytes: number;
|
|
66
|
+
accessLevel: AccessLevel;
|
|
67
|
+
scheduledForDeletion: Date | null;
|
|
68
|
+
files: {
|
|
69
|
+
fileId: string;
|
|
70
|
+
mimeType: string;
|
|
71
|
+
createdAt: Date;
|
|
72
|
+
sizeBytes: number;
|
|
73
|
+
fileUrl: string;
|
|
74
|
+
}[];
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
export type GetFileOutput = ReadableStream | Blob;
|