ISSUE #5299 - Ticket Filters in Tabular View

backend/package.json

@@ -4,6 +4,11 @@
   "engines": {
     "node": "22.x.x"
   },
+  "apidoc": {
+    "title": "3D Repo V4 Backend documentation",
+    "name": "3D Repo V4 backend documentation",
+    "description": "Backend documentation for v4 APIs. To view v5 API endpoints, please visition https://www.3drepo.io/docs"
+  },
   "private": true,
   "scripts": {
     "gen-docs": "yarn apidoc -i src/v4/routes/ -o docs/ ",
@@ -29,7 +34,7 @@
     "@elastic/elasticsearch": "7.17.14",
     "@frontegg/client": "5.3.2",
     "amqplib": "0.10.5",
-    "apidoc": "0.29.0",
+    "apidoc": "1.2.0",
     "app-config": "1.0.1",
     "archiver": "6.0.2",
     "archiver-zip-encrypted": "2.0.0",
@@ -59,13 +64,13 @@
     "moment": "2.30.1",
     "moment-timezone": "0.5.45",
     "mongodb": "3.7.4",
-    "multer": "2.0.0",
+    "multer": "2.0.1",
     "node-device-detector": "2.2.0",
     "nodemailer": "6.9.14",
     "openapi-schema-validator": "12.1.3",
     "paypal-rest-sdk": "1.8.1",
     "pug": "3.0.3",
-    "serialize-javascript": "4.0.0",
+    "serialize-javascript": "6.0.2",
     "serve-favicon": "2.5.0",
     "sharp": "0.33.5",
     "slash": "3.0.0",
@@ -118,7 +123,8 @@
     "wrap-ansi": "6.2.0",
     "cross-spawn": "7.0.6",
     "micromatch": "4.0.8",
-    "nanoid": "3.3.8"
+    "nanoid": "3.3.8",
+    "brace-expansion": "2.0.2"
   },
   "description": "The backend for 3drepo.io",
   "main": "3drepo.js",

backend/src/scripts/utility/teamspaces/createTeamspace.js

@@ -16,17 +16,28 @@
  */
 
 const Path = require('path');
-const { v5Path } = require('../../../interop');
+const { v5Path, v4Path } = require('../../../interop');
 
 const { logger } = require(`${v5Path}/utils/logger`);
 
 const { initTeamspace } = require(`${v5Path}/processors/teamspaces`);
-const { getUserByUsername } = require(`${v5Path}/models/users`);
+const { getUserByUsernameOrEmail } = require(`${v5Path}/models/users`);
 const { getTeamspaceSetting } = require(`${v5Path}/models/teamspaceSettings`);
+const { templates } = require(`${v5Path}/utils/responseCodes`);
+const { create: createInvite } = require(`${v4Path}/models/invitations`);
 
-const run = async (teamspace, user) => {
-	logger.logInfo(`Checking ${user} exists...`);
-	await getUserByUsername(user);
+const { DEFAULT_OWNER_JOB } = require(`${v5Path}/models/jobs.constants`);
+
+const run = async (teamspace, user, accountId) => {
+	logger.logInfo(`Checking ${user} information...`);
+	let username;
+	try {
+		const { user: foundUser } = await getUserByUsernameOrEmail(user);
+		username = foundUser;
+	} catch (error) {
+		/* istanbul ignore next */
+		if (error.message !== templates.userNotFound.message) throw error;
+	}
 
 	logger.logInfo(`Checking if teamspace ${teamspace} already exists...`);
 	const teamspaceExists = await getTeamspaceSetting(teamspace, { _id: 1 }).catch(() => false);
@@ -35,10 +46,13 @@ const run = async (teamspace, user) => {
 		throw new Error('Teamspace already exists');
 	}
 
-	await initTeamspace(teamspace, user);
+	await initTeamspace(teamspace, username, accountId);
+	if (!username) {
+		await createInvite(user, teamspace, DEFAULT_OWNER_JOB, undefined, { teamspace_admin: true }, false);
+	}
+
 	logger.logInfo(`Teamspace ${teamspace} created.`);
 };
-
 const genYargs = /* istanbul ignore next */(yargs) => {
 	const commandName = Path.basename(__filename, Path.extname(__filename));
 	const argsSpec = (subYargs) => subYargs.option('teamspace',
@@ -51,11 +65,15 @@ const genYargs = /* istanbul ignore next */(yargs) => {
 			describe: 'a user to be assigned to be an admin of this teamspace',
 			type: 'string',
 			demandOption: true,
-		});
+		}).option('accountId', {
+		describe: 'an already existing frontEgg account Id (tennant Id) for the teamspace',
+		type: 'string',
+		demandOption: false,
+	});
 	return yargs.command(commandName,
 		'Create a teamspace of the name provided and gives the user specified admin privileges',
 		argsSpec,
-		({ teamspace, user }) => run(teamspace, user));
+		({ teamspace, user, accountId }) => run(teamspace, user, accountId));
 };
 
 module.exports = {

backend/src/v4/models/invitations.js

@@ -83,13 +83,17 @@ const cleanPermissions = (permissions) => {
 
 const sendInvitationEmail = async (email, username, teamspace) => {
 	const refId = await getTeamspaceRefId(teamspace);
-	const { customData: { firstName, lastName }} = await User.findByUserName(username, { "customData.firstName": 1, "customData.lastName": 1});
-	const sender = [firstName, lastName].join(" ");
+
+	let sender;
+	if(username) {
+		const { customData: { firstName, lastName }} = await User.findByUserName(username, { "customData.firstName": 1, "customData.lastName": 1});
+		sender = [firstName, lastName].join(" ");
+	}
 
 	await addUserToAccount(refId, email, undefined, {teamspace, sender  });
 };
 
-invitations.create = async (email, teamspace, job, username, permissions = {}) => {
+invitations.create = async (email, teamspace, job, username, permissions = {}, checkLicenceLimit = true) => {
 	// 1 - find if there is already and invitation with that email
 	// 2 - if there is update the invitation with the new teamspace data
 	// 2.5 - if there is not, create an entry with that email and job/permission
@@ -138,6 +142,9 @@ invitations.create = async (email, teamspace, job, username, permissions = {}) =
 
 		// if its a new teamspace that the user has been invited send an invitation email
 		if (result.teamSpaces.every(t=> t.teamspace !== teamspace)) {
+			if(checkLicenceLimit) {
+				await User.hasReachedLicenceLimitCheck(teamspace);
+			}
 			await sendInvitationEmail(email, username, teamspace);
 			publish(events.INVITATION_ADDED, { teamspace, executor: username, email, job, permissions});
 		}
@@ -148,7 +155,9 @@ invitations.create = async (email, teamspace, job, username, permissions = {}) =
 		await coll.updateOne({_id:email}, { $set: invitation });
 
 	} else {
-		await User.hasReachedLicenceLimitCheck(teamspace);
+		if(checkLicenceLimit) {
+			await User.hasReachedLicenceLimitCheck(teamspace);
+		}
 		const invitation = {_id:email ,teamSpaces: [teamspaceEntry] };
 		await sendInvitationEmail(email, username, teamspace);
 		await coll.insertOne(invitation);
@@ -237,13 +246,13 @@ const applyTeamspacePermissions = (invitedUser) => async ({ teamspace, job, perm
 	const teamPerms = permissions.teamspace_admin ? ["teamspace_admin"] : [];
 
 	try {
-		await User.addTeamMember(teamspace, invitedUser, job, teamPerms);
+		await User.addTeamMember(teamspace, invitedUser, job, teamPerms, undefined, true);
 
 		if (!permissions.teamspace_admin) {
 			await Promise.all(permissions.projects.map(applyProjectPermissions(teamspace, invitedUser)));
 		}
 	} catch(err) {
-		systemLogger.logError("Something failed when unpacking invitation: " + err.stack);
+		systemLogger.logError("Something failed when unpacking invitation: ", err.message);
 	}
 };
 

backend/src/v4/models/user.js

@@ -526,9 +526,10 @@ User.removeTeamMember = async function (teamspace, userToRemove, cascadeRemove,
 
 };
 
-User.addTeamMember = async function(teamspace, userToAdd, job, permissions, executor) {
-	await hasReachedLicenceLimit(teamspace);
-
+User.addTeamMember = async function(teamspace, userToAdd, job, permissions, executor, bypassQuotaCheck = false) {
+	if(!bypassQuotaCheck) {
+		await hasReachedLicenceLimit(teamspace);
+	}
 	let userEntry = null;
 	if (strings.email.isValidSync(userToAdd)) { // if the submited username is the email
 		userEntry = await User.findByEmail(userToAdd);

backend/src/v4/routes/accountPermission.js

@@ -66,8 +66,8 @@
 	 * @apiDescription Assign account level permission to a user
 	 *
 	 * @apiParam {String} teamspace Name of teamspace
-	 * @apiParam (Request body) {String} user User to assign permissions to
-	 * @apiParam (Request body) {String[]} permissions List of account level permissions
+	 * @apiBody {String} user User to assign permissions to
+	 * @apiBody {String[]} permissions List of account level permissions
 	 * @apiSuccess (200) {String} user User
 	 * @apiSuccess (200) {String[]} permissions Account Level Permission types
 	 *
@@ -101,8 +101,8 @@
 	 *
 	 * @apiParam {String} teamspace Name of teamspace
 	 * @apiParam {String} user User to update
-	 * @apiParam (Request body) {String[]} permissions List of account level permissions
-	 * @apiSuccess {String[]} permissions List of account level permissions
+	 * @apiBody {String[]} permissions List of account level permissions
+	 * @apiSuccess (200) {String[]} permissions List of account level permissions
 	 *
 	 * @apiExample {put} Example usage:
 	 * PUT /acme/permissions/alice HTTP/1.1
@@ -112,7 +112,7 @@
 	 * 	]
 	 * }
 	 *
-	 * @apiSuccessExample {json} Success-Response
+	 * @apiSuccessExample {json} Success-Response:
 	 * HTTP/1.1 200 OK
 	 * {
 	 *	"permissions": [
@@ -134,7 +134,7 @@
 	 * @apiExample {delete} Example usage:
 	 * DELETE /acme/permissions/alice HTTP/1.1
 	 *
-	 * @apiSuccessExample {json} Success-Response
+	 * @apiSuccessExample {json} Success-Response:
 	 * HTTP/1.1 200 OK
 	 * {}
 	 */

backend/src/v4/routes/auth.js

@@ -42,11 +42,11 @@ const { fileExists } = require("../models/fileRef");
  * @apiDescription Show current application version.
  *
  * @apiSuccess (200) {String} VERSION API service version
- * @apiSuccess (200) {String} unity Unity viewer version
- * @apiSuccess (200) {String} navis Autodesk Navisworks version
- * @apiSuccess (200) {String} unitydll Unity viewer version
+ * @apiSuccess (200) {Object} unity Unity viewer version
+ * @apiSuccess (200) {Object} navis Autodesk Navisworks version
+ * @apiSuccess (200) {Object} unitydll Unity viewer version
  *
- * @apiSuccessExample {json} Success-Response
+ * @apiSuccessExample {json} Success-Response:
  * HTTP/1.1 200 OK
  * {
  * 	"VERSION": "2.20.1",
@@ -69,24 +69,24 @@ const { fileExists } = require("../models/fileRef");
 router.get("/version", printVersion);
 
 /**
- * @api {get} /:user.json List account information
+ * @api {get} /:account.json List account information
  * @apiName listInfo
  * @apiGroup Account
  * @apiDescription Account information and list of projects grouped by teamspace
  * that the user has access to.
  *
- * @apiParam {String} user User
+ * @apiParam {String} account.json Account name with .json extension
  * @apiSuccess (200) {Object[]} accounts User account
  * @apiSuccess (200) {Object} billingInfo Billing information
  * @apiSuccess (200) {String} email User e-mail address
  * @apiSuccess (200) {String} firstName First name
  * @apiSuccess (200) {String} lastName Surname
  * @apiSuccess (200) {Boolean} hasAvatar True if user account has an avatar
  *
- * @apiExample {delete} Example usage:
+ * @apiExample {get} Example usage:
  * GET /alice.json HTTP/1.1
  *
- * @apiSuccessExample {json} Success-Response
+ * @apiSuccessExample {json} Success-Response:
  * HTTP/1.1 200 OK
  * {
  * 	"accounts": [
@@ -220,7 +220,7 @@ router.get("/version", printVersion);
  * 			"_id": "Actor"
  * 		},
  * 		{
- * 			"_id": "Producer
+ * 			"_id": "Producer"
  * 		}
  * 	]
  * }
@@ -229,23 +229,25 @@ router.get("/:account.json", middlewares.loggedIn, listInfo);
 // TODO: divide into different endpoints that makes sense.
 
 /**
- * @api {get} /:user/avatar Get avatar
+ * @api {get} /:account/avatar Get avatar
  * @apiName getAvatar
  * @apiGroup Account
  * @apiDescription Get user avatar.
  *
- * @apiParam {String} user User
- * @apiSuccess (200) {Object} avatar User Avatar Image
+ * @apiParam {String} account Account name
+ * @apiSuccess (200) {File} avatar User Avatar Image
  * @apiError (404) USER_DOES_NOT_HAVE_AVATAR User does not have an avatar
  *
- * @apiExample {put} Example usage:
+ * @apiExample {get} Example usage:
  * GET /alice/avatar HTTP/1.1
  *
- * @apiSuccessExample {json} Success-Response
+ * @apiSuccessExample {binary} Success-Response:
  * HTTP/1.1 200 OK
- * <binary image>
+ * Content-Type: image/png
+ *
+ * <binary image data>
  *
- * @apiErrorExample {json} Error-Response
+ * @apiErrorExample {json} Error-Response:
  * HTTP/1.1 404 Not Found
  * {
  * 	"message": "User does not have an avatar",
@@ -257,16 +259,16 @@ router.get("/:account.json", middlewares.loggedIn, listInfo);
 router.get("/:account/avatar", middlewares.loggedIn, getAvatar);
 
 /**
- * @api {post} /:user/avatar Upload avatar
+ * @api {post} /:account/avatar Upload avatar
  * @apiName uploadAvatar
  * @apiGroup Account
  * @apiDescription Upload a new avatar image.
  * Only multipart form data content type will be accepted.
  *
- * @apiParam {String} user User
- * @apiParam (Request body) {File} file Image to upload
+ * @apiParam {String} account Account name
+ * @apiBody {File} file Image to upload
  *
- * @apiExample {put} Example usage:
+ * @apiExample {post} Example usage:
  * POST /alice/avatar HTTP/1.1
  * Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryN8dwXAkcO1frCHLf
  *
@@ -278,7 +280,7 @@ router.get("/:account/avatar", middlewares.loggedIn, getAvatar);
  * ------WebKitFormBoundaryN8dwXAkcO1frCHLf--
  *
  * @apiSuccess (200) {Object} status Status of Avatar upload.
- * @apiSuccessExample {json} Success-Response
+ * @apiSuccessExample {json} Success-Response:
  * HTTP/1.1 200 OK
  * {
  *	"status":"success"