Merge pull request #1196 from DEVTomatoCake/feat/list-create-developer-teams

Listing & creation of Developer Portal teams

assets/openapi.json

@@ -118,10 +118,7 @@
                         "type": "string"
                     },
                     "team_id": {
-                        "type": [
+                        "type": "string"
-                            "string",
-                            "integer"
-                        ]
                     }
                 },
                 "required": [
@@ -3169,6 +3166,9 @@
                             "type": "string"
                         }
                     },
+                    "role": {
+                        "$ref": "#/components/schemas/TeamMemberRole"
+                    },
                     "team_id": {
                         "type": "string"
                     },
@@ -3189,6 +3189,7 @@
                     "id",
                     "membership_state",
                     "permissions",
+                    "role",
                     "team",
                     "team_id",
                     "user",
@@ -3202,6 +3203,14 @@
                 ],
                 "type": "number"
             },
+            "TeamMemberRole": {
+                "enum": [
+                    "admin",
+                    "developer",
+                    "read_only"
+                ],
+                "type": "string"
+            },
             "Sticker": {
                 "type": "object",
                 "properties": {
@@ -6307,6 +6316,17 @@
                     "protocol"
                 ]
             },
+            "TeamCreateSchema": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string"
+                    }
+                },
+                "required": [
+                    "name"
+                ]
+            },
             "TemplateCreateSchema": {
                 "type": "object",
                 "properties": {
@@ -7661,6 +7681,14 @@
                     "location"
                 ]
             },
+            "TeamListResponse": {
+                "type": "object",
+                "patternProperties": {
+                    "^[0-9]+$": {
+                        "$ref": "#/components/schemas/Team"
+                    }
+                }
+            },
             "TenorTrendingResponse": {
                 "type": "object",
                 "properties": {
@@ -10622,8 +10650,57 @@
                     }
                 ],
                 "responses": {
-                    "default": {
+                    "200": {
-                        "description": "No description available"
+                        "description": "",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/TeamListResponse"
+                                }
+                            }
+                        }
+                    }
+                },
+                "parameters": [
+                    {
+                        "name": "include_payout_account_status",
+                        "in": "query",
+                        "schema": {
+                            "type": "boolean"
+                        },
+                        "description": "Whether to include team payout account status in the response (default false)"
+                    }
+                ],
+                "tags": [
+                    "teams"
+                ]
+            },
+            "post": {
+                "security": [
+                    {
+                        "bearer": []
+                    }
+                ],
+                "requestBody": {
+                    "required": true,
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/TeamCreateSchema"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/Team"
+                                }
+                            }
+                        }
                     }
                 },
                 "tags": [

src/api/routes/teams.ts

@@ -1,29 +1,99 @@
 /*
 	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
 	Copyright (C) 2023 Spacebar and Spacebar Contributors
-	
+
 	This program is free software: you can redistribute it and/or modify
 	it under the terms of the GNU Affero General Public License as published
 	by the Free Software Foundation, either version 3 of the License, or
 	(at your option) any later version.
-	
+
 	This program is distributed in the hope that it will be useful,
 	but WITHOUT ANY WARRANTY; without even the implied warranty of
 	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 	GNU Affero General Public License for more details.
-	
+
 	You should have received a copy of the GNU Affero General Public License
 	along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
 import { Request, Response, Router } from "express";
 import { route } from "@spacebar/api";
+import {
+	Team,
+	TeamCreateSchema,
+	TeamMember,
+	TeamMemberRole,
+	TeamMemberState,
+	User,
+} from "@spacebar/util";
+import { HTTPError } from "lambert-server";
 
 const router: Router = Router();
 
-router.get("/", route({}), async (req: Request, res: Response) => {
+router.get(
-	//TODO
+	"/",
-	res.send([]);
+	route({
-});
+		query: {
+			include_payout_account_status: {
+				type: "boolean",
+				description:
+					"Whether to include team payout account status in the response (default false)",
+			},
+		},
+		responses: {
+			200: {
+				body: "TeamListResponse",
+			},
+		},
+	}),
+	async (req: Request, res: Response) => {
+		const teams = await Team.find({
+			where: {
+				owner_user_id: req.user_id,
+			},
+			relations: ["members"],
+		});
+
+		res.send(teams);
+	},
+);
+
+router.post(
+	"/",
+	route({
+		requestBody: "TeamCreateSchema",
+		responses: {
+			200: {
+				body: "Team",
+			},
+		},
+	}),
+	async (req: Request, res: Response) => {
+		const user = await User.findOneOrFail({
+			where: [{ id: req.user_id }],
+			select: ["mfa_enabled"],
+		});
+		if (!user.mfa_enabled)
+			throw new HTTPError("You must enable MFA to create a team");
+
+		const body = req.body as TeamCreateSchema;
+
+		const team = Team.create({
+			name: body.name,
+			owner_user_id: req.user_id,
+		});
+		await team.save();
+
+		await TeamMember.create({
+			user_id: req.user_id,
+			team_id: team.id,
+			membership_state: TeamMemberState.ACCEPTED,
+			permissions: ["*"],
+			role: TeamMemberRole.ADMIN,
+		}).save();
+
+		res.json(team);
+	},
+);
 
 export default router;

src/util/entities/TeamMember.ts

@@ -25,6 +25,11 @@ export enum TeamMemberState {
 	INVITED = 1,
 	ACCEPTED = 2,
 }
+export enum TeamMemberRole {
+	ADMIN = "admin",
+	DEVELOPER = "developer",
+	READ_ONLY = "read_only",
+}
 
 @Entity({
 	name: "team_members",
@@ -37,6 +42,9 @@ export class TeamMember extends BaseClass {
 	@Column({ type: "simple-array" })
 	permissions: string[];
 
+	@Column()
+	role: TeamMemberRole;
+
 	@Column({ nullable: true })
 	@RelationId((member: TeamMember) => member.team)
 	team_id: string;

src/util/migration/mariadb/1724477620293-teamMemberRole.ts

@@ -0,0 +1,17 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class TeamMemberRole1724477620293 implements MigrationInterface {
+	name = "TeamMemberRole1724477620293";
+
+	public async up(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.query(
+			"ALTER TABLE `team_members` ADD COLUMN `role` VARCHAR(255) NOT NULL AFTER `permissions`",
+		);
+	}
+
+	public async down(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.query(
+			"ALTER TABLE `team_members` DROP COLUMN `role`",
+		);
+	}
+}

src/util/migration/mysql/1724477620293-teamMemberRole.ts

@@ -0,0 +1,17 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class TeamMemberRole1724477620293 implements MigrationInterface {
+	name = "TeamMemberRole1724477620293";
+
+	public async up(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.query(
+			"ALTER TABLE `team_members` ADD COLUMN `role` VARCHAR(255) NOT NULL AFTER `permissions`",
+		);
+	}
+
+	public async down(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.query(
+			"ALTER TABLE `team_members` DROP COLUMN `role`",
+		);
+	}
+}

src/util/migration/postgres/1724477620293-teamMemberRole.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class TeamMemberRole1724477620293 implements MigrationInterface {
+	name = "TeamMemberRole1724477620293";
+
+	public async up(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.query(
+			"ALTER TABLE team_members ADD COLUMN role text NOT NULL",
+		);
+	}
+
+	public async down(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.query("ALTER TABLE team_members DROP COLUMN role");
+	}
+}

src/util/schemas/ApplicationCreateSchema.ts

@@ -1,22 +1,22 @@
 /*
 	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
 	Copyright (C) 2023 Spacebar and Spacebar Contributors
-	
+
 	This program is free software: you can redistribute it and/or modify
 	it under the terms of the GNU Affero General Public License as published
 	by the Free Software Foundation, either version 3 of the License, or
 	(at your option) any later version.
-	
+
 	This program is distributed in the hope that it will be useful,
 	but WITHOUT ANY WARRANTY; without even the implied warranty of
 	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 	GNU Affero General Public License for more details.
-	
+
 	You should have received a copy of the GNU Affero General Public License
 	along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
 export interface ApplicationCreateSchema {
 	name: string;
-	team_id?: string | number;
+	team_id?: string;
 }

src/util/schemas/TeamCreateSchema.ts

@@ -0,0 +1,21 @@
+/*
+	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
+	Copyright (C) 2023 Spacebar and Spacebar Contributors
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Affero General Public License as published
+	by the Free Software Foundation, either version 3 of the License, or
+	(at your option) any later version.
+
+	This program is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+	GNU Affero General Public License for more details.
+
+	You should have received a copy of the GNU Affero General Public License
+	along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+export interface TeamCreateSchema {
+	name: string;
+}

src/util/schemas/index.ts

@@ -62,6 +62,7 @@ export * from "./RequestGuildMembersSchema";
 export * from "./RoleModifySchema";
 export * from "./RolePositionUpdateSchema";
 export * from "./SelectProtocolSchema";
+export * from "./TeamCreateSchema";
 export * from "./TemplateCreateSchema";
 export * from "./TemplateModifySchema";
 export * from "./TotpDisableSchema";

src/util/schemas/responses/TeamListResponse.ts

@@ -0,0 +1,21 @@
+/*
+	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
+	Copyright (C) 2023 Spacebar and Spacebar Contributors
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Affero General Public License as published
+	by the Free Software Foundation, either version 3 of the License, or
+	(at your option) any later version.
+
+	This program is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+	GNU Affero General Public License for more details.
+
+	You should have received a copy of the GNU Affero General Public License
+	along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+import { Team } from "@spacebar/util";
+
+export interface TeamListResponse extends Array<Team> {}

src/util/schemas/responses/index.ts

@@ -1,17 +1,17 @@
 /*
 	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
 	Copyright (C) 2023 Spacebar and Spacebar Contributors
-	
+
 	This program is free software: you can redistribute it and/or modify
 	it under the terms of the GNU Affero General Public License as published
 	by the Free Software Foundation, either version 3 of the License, or
 	(at your option) any later version.
-	
+
 	This program is distributed in the hope that it will be useful,
 	but WITHOUT ANY WARRANTY; without even the implied warranty of
 	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 	GNU Affero General Public License for more details.
-	
+
 	You should have received a copy of the GNU Affero General Public License
 	along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
@@ -40,6 +40,7 @@ export * from "./InstanceStatsResponse";
 export * from "./LocationMetadataResponse";
 export * from "./MemberJoinGuildResponse";
 export * from "./OAuthAuthorizeResponse";
+export * from "./TeamListResponse";
 export * from "./Tenor";
 export * from "./TokenResponse";
 export * from "./TypedResponses";