Error cleanup

#11 #13 #14

src/errors/AddressErrors.ts

@@ -1,6 +1,9 @@
 import { IsString } from 'class-validator';
 import { NotAcceptableError, NotFoundError } from 'routing-controllers';
 
+/**
+ * Error to throw, when to provided address doesn't belong to the accepted types.
+ */
 export class AddressWrongTypeError extends NotAcceptableError {
 	@IsString()
 	name = "AddressWrongTypeError"
@@ -9,6 +12,9 @@ export class AddressWrongTypeError extends NotAcceptableError {
 	message = "The address must be an existing adress's id. \n You provided a object of another type."
 }
 
+/**
+ * Error to throw, when a non-existant address get's loaded.
+ */
 export class AddressNotFoundError extends NotFoundError {
 	@IsString()
 	name = "AddressNotFoundError"

src/errors/AuthError.ts

@@ -2,7 +2,7 @@ import { IsString } from 'class-validator';
 import { ForbiddenError, NotAcceptableError, NotFoundError, UnauthorizedError } from 'routing-controllers';
 
 /**
- * Error to throw when a jwt is expired
+ * Error to throw when a jwt is expired.
  */
 export class ExpiredJWTError extends UnauthorizedError {
 	@IsString()
@@ -13,7 +13,7 @@ export class ExpiredJWTError extends UnauthorizedError {
 }
 
 /**
- * Error to throw when a jwt could not be parsed
+ * Error to throw when a jwt could not be parsed.
  */
 export class IllegalJWTError extends UnauthorizedError {
 	@IsString()
@@ -24,7 +24,7 @@ export class IllegalJWTError extends UnauthorizedError {
 }
 
 /**
- * Error to throw when user is nonexistant or refreshtoken is invalid
+ * Error to throw when user is nonexistant or refreshtoken is invalid.
  */
 export class UserNonexistantOrRefreshtokenInvalidError extends UnauthorizedError {
 	@IsString()
@@ -35,7 +35,7 @@ export class UserNonexistantOrRefreshtokenInvalidError extends UnauthorizedError
 }
 
 /**
- * Error to throw when provided credentials are invalid
+ * Error to throw when provided credentials are invalid.
  */
 export class InvalidCredentialsError extends UnauthorizedError {
 	@IsString()
@@ -46,7 +46,7 @@ export class InvalidCredentialsError extends UnauthorizedError {
 }
 
 /**
- * Error to throw when a jwt does not have permission for this route/ action
+ * Error to throw when a jwt does not have permission for this route/action.
  */
 export class NoPermissionError extends ForbiddenError {
 	@IsString()
@@ -57,7 +57,7 @@ export class NoPermissionError extends ForbiddenError {
 }
 
 /**
- * Error to thow when no username and no email is set
+ * Error to throw when no username and no email is set.
  */
 export class UsernameOrEmailNeededError extends NotAcceptableError {
 	@IsString()
@@ -68,7 +68,7 @@ export class UsernameOrEmailNeededError extends NotAcceptableError {
 }
 
 /**
- * Error to thow when no password is provided
+ * Error to throw when no password is provided.
  */
 export class PasswordNeededError extends NotAcceptableError {
 	@IsString()
@@ -79,7 +79,7 @@ export class PasswordNeededError extends NotAcceptableError {
 }
 
 /**
- * Error to thow when no user could be found for provided credential
+ * Error to throw when no user could be found mating the provided credential.
  */
 export class UserNotFoundError extends NotFoundError {
 	@IsString()
@@ -90,7 +90,7 @@ export class UserNotFoundError extends NotFoundError {
 }
 
 /**
- * Error to thow when no jwt token was provided
+ * Error to throw when no jwt token was provided (but one had to be).
  */
 export class JwtNotProvidedError extends NotAcceptableError {
 	@IsString()
@@ -101,7 +101,7 @@ export class JwtNotProvidedError extends NotAcceptableError {
 }
 
 /**
- * Error to thow when user was not found or refresh token count was invalid
+ * Error to throw when user was not found or refresh token count was invalid.
  */
 export class UserNotFoundOrRefreshTokenCountInvalidError extends NotAcceptableError {
 	@IsString()
@@ -112,7 +112,7 @@ export class UserNotFoundOrRefreshTokenCountInvalidError extends NotAcceptableEr
 }
 
 /**
- * Error to thow when refresh token count was invalid
+ * Error to throw when refresh token count was invalid
  */
 export class RefreshTokenCountInvalidError extends NotAcceptableError {
 	@IsString()

src/errors/GroupContactErrors.ts

@@ -1,6 +1,9 @@
 import { IsString } from 'class-validator';
 import { NotAcceptableError, NotFoundError } from 'routing-controllers';
 
+/**
+ * Error to throw, when a provided groupContact doesn't belong to the accepted types.
+ */
 export class GroupContactWrongTypeError extends NotAcceptableError {
 	@IsString()
 	name = "GroupContactWrongTypeError"
@@ -9,6 +12,9 @@ export class GroupContactWrongTypeError extends NotAcceptableError {
 	message = "The groupContact must be an existing groupContact's id. \n You provided a object of another type."
 }
 
+/**
+ * Error to throw, when a non-existant groupContact get's loaded.
+ */
 export class GroupContactNotFoundError extends NotFoundError {
 	@IsString()
 	name = "GroupContactNotFoundError"

src/errors/RunnerErrors.ts

@@ -26,27 +26,13 @@ export class RunnerIdsNotMatchingError extends NotAcceptableError {
 	message = "The id's don't match!! \n And if you wanted to change a runner's id: This isn't allowed"
 }
 
-export class RunnerOnlyOneGroupAllowedError extends NotAcceptableError {
-	@IsString()
-	name = "RunnerOnlyOneGroupAllowedError"
-
-	@IsString()
-	message = "Runner's can only be part of one group (team or organisiation)! \n You provided an id for both."
-}
-
+/**
+ * Error to throw when a runner is missing his group association.
+ */
 export class RunnerGroupNeededError extends NotAcceptableError {
 	@IsString()
 	name = "RunnerGroupNeededError"
 
 	@IsString()
 	message = "Runner's need to be part of one group (team or organisiation)! \n You provided neither."
-}
-
-
-export class RunnerGroupNotFoundError extends NotFoundError {
-	@IsString()
-	name = "RunnerGroupNotFoundError"
-
-	@IsString()
-	message = "The group you provided couldn't be located in the system. \n Please check your request."
 }

src/errors/RunnerGroupErrors.ts

@@ -0,0 +1,14 @@
+import { IsString } from 'class-validator';
+import { NotFoundError } from 'routing-controllers';
+
+/**
+ * Error to throw when a runner group couldn't be found.
+ * Implemented this ways to work with the json-schema conversion for openapi.
+ */
+export class RunnerGroupNotFoundError extends NotFoundError {
+	@IsString()
+	name = "RunnerGroupNotFoundError"
+
+	@IsString()
+	message = "RunnerGroup not found!"
+}

src/errors/RunnerOrganisationErrors.ts

@@ -50,6 +50,9 @@ export class RunnerOrganisationHasTeamsError extends NotAcceptableError {
 	message = "This organisation still has teams associated with it. \n If you want to delete this organisation with all it's runners and teams ass `?force` to your query."
 }
 
+/**
+ * Error to throw, when a provided runnerOrganisation doesn't belong to the accepted types.
+ */
 export class RunnerOrganisationWrongTypeError extends NotAcceptableError {
 	@IsString()
 	name = "RunnerOrganisationWrongTypeError"

src/errors/UserErrors.ts

@@ -1,16 +1,6 @@
 import { IsString } from 'class-validator';
 import { NotAcceptableError, NotFoundError } from 'routing-controllers';
 
-/**
- * Error to throw when a usergroup couldn't be found.
- */
-export class UserGroupNotFoundError extends NotFoundError {
-	@IsString()
-	name = "UserGroupNotFoundError"
-
-	@IsString()
-	message = "User Group not found!"
-}
 
 /**
  * Error to throw when no username or email is set