micosil
/
DevSpace
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

🩹 The API was missing some ease of use parameters 

Signed-off-by: Pau Costa <mico@micodev.es>
pull/2/head
Pau Costa Ferrer 2024-02-09 13:45:20 +01:00
parent 591dae9567
commit e27423a2e5
7 changed files with 363 additions and 168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
DevSpaceOApi.json
View File

@ -76,6 +76,27 @@
} }
} }
}, },
"Notification": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Notification ID"
},
"message": {
"type": "string",
"description": "Notification message"
},
"timeStamp": {
"type": "string",
"description": "Notification creation date"
},
"seen": {
"type": "boolean",
"description": "Notification seen status"
}
}
},
"User": { "User": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -128,6 +149,24 @@
} }
} }
] ]
},
"UserWithRelationsAndNotifications": {
"allOf": [
{
"$ref": "#/components/schemas/UserWithRelations"
},
{
"type": "object",
"properties": {
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
}
}
]
} }
} }
}, },
@ -745,7 +784,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/UserWithRelations" "$ref": "#/components/schemas/UserWithRelationsAndNotifications"
} }
} }
} }
@ -837,4 +876,4 @@
} }
}, },
"tags": [] "tags": []
} }

7
client/openapitools.json Normal file
View File

@ -0,0 +1,7 @@
{
"$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
"spaces": 2,
"generator-cli": {
"version": "7.3.0"
}
}

2
client/src/api/.openapi-generator/VERSION
View File

@ -1 +1 @@
7.2.0 7.3.0

192
client/src/api/api.ts
View File

@ -186,6 +186,37 @@ export interface CreatePostRequest {
*/ */
'content'?: string; 'content'?: string;
} }
/**
*
* @export
* @interface Notification
*/
export interface Notification {
/**
* Notification ID
* @type {number}
* @memberof Notification
*/
'id'?: number;
/**
* Notification message
* @type {string}
* @memberof Notification
*/
'message'?: string;
/**
* Notification creation date
* @type {string}
* @memberof Notification
*/
'timeStamp'?: string;
/**
* Notification seen status
* @type {boolean}
* @memberof Notification
*/
'seen'?: boolean;
}
/** /**
* *
* @export * @export
@ -309,6 +340,61 @@ export interface UserWithRelations {
*/ */
'followers'?: Array<User>; 'followers'?: Array<User>;
} }
/**
*
* @export
* @interface UserWithRelationsAndNotifications
*/
export interface UserWithRelationsAndNotifications {
/**
* User ID
* @type {number}
* @memberof UserWithRelationsAndNotifications
*/
'id'?: number;
/**
* User first name
* @type {string}
* @memberof UserWithRelationsAndNotifications
*/
'firstName'?: string;
/**
* User last name
* @type {string}
* @memberof UserWithRelationsAndNotifications
*/
'lastName'?: string;
/**
*
* @type {Array<Post>}
* @memberof UserWithRelationsAndNotifications
*/
'posts'?: Array<Post>;
/**
*
* @type {Array<Comment>}
* @memberof UserWithRelationsAndNotifications
*/
'comments'?: Array<Comment>;
/**
*
* @type {Array<User>}
* @memberof UserWithRelationsAndNotifications
*/
'followed'?: Array<User>;
/**
*
* @type {Array<User>}
* @memberof UserWithRelationsAndNotifications
*/
'followers'?: Array<User>;
/**
*
* @type {Array<Notification>}
* @memberof UserWithRelationsAndNotifications
*/
'notifications'?: Array<Notification>;
}
/** /**
* AuthenticationApi - axios parameter creator * AuthenticationApi - axios parameter creator
@ -441,9 +527,9 @@ export const AuthenticationApiFp = function(configuration?: Configuration) {
*/ */
async authLoginPost(authLoginPostRequest: AuthLoginPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthLoginPost200Response>> { async authLoginPost(authLoginPostRequest: AuthLoginPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthLoginPost200Response>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.authLoginPost(authLoginPostRequest, options); const localVarAxiosArgs = await localVarAxiosParamCreator.authLoginPost(authLoginPostRequest, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['AuthenticationApi.authLoginPost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authLoginPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -453,9 +539,9 @@ export const AuthenticationApiFp = function(configuration?: Configuration) {
*/ */
async authLogoutGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthLogoutGet200Response>> { async authLogoutGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthLogoutGet200Response>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.authLogoutGet(options); const localVarAxiosArgs = await localVarAxiosParamCreator.authLogoutGet(options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['AuthenticationApi.authLogoutGet']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authLogoutGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -466,9 +552,9 @@ export const AuthenticationApiFp = function(configuration?: Configuration) {
*/ */
async authSignupPost(authSignupPostRequest: AuthSignupPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>> { async authSignupPost(authSignupPostRequest: AuthSignupPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.authSignupPost(authSignupPostRequest, options); const localVarAxiosArgs = await localVarAxiosParamCreator.authSignupPost(authSignupPostRequest, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['AuthenticationApi.authSignupPost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authSignupPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
} }
}; };
@ -931,9 +1017,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async commentPost(id: number, commentPostRequest: CommentPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>> { async commentPost(id: number, commentPostRequest: CommentPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Comment>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.commentPost(id, commentPostRequest, options); const localVarAxiosArgs = await localVarAxiosParamCreator.commentPost(id, commentPostRequest, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.commentPost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.commentPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -944,9 +1030,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async createPost(createPostRequest: CreatePostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> { async createPost(createPostRequest: CreatePostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.createPost(createPostRequest, options); const localVarAxiosArgs = await localVarAxiosParamCreator.createPost(createPostRequest, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.createPost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.createPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -957,9 +1043,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async deletePost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { async deletePost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePost(id, options); const localVarAxiosArgs = await localVarAxiosParamCreator.deletePost(id, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.deletePost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.deletePost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -969,9 +1055,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async getAllPosts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Post>>> { async getAllPosts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Post>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllPosts(options); const localVarAxiosArgs = await localVarAxiosParamCreator.getAllPosts(options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.getAllPosts']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.getAllPosts']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -981,9 +1067,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async getFollowedPosts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Post>>> { async getFollowedPosts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Post>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getFollowedPosts(options); const localVarAxiosArgs = await localVarAxiosParamCreator.getFollowedPosts(options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.getFollowedPosts']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.getFollowedPosts']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -994,9 +1080,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async getPost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> { async getPost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getPost(id, options); const localVarAxiosArgs = await localVarAxiosParamCreator.getPost(id, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.getPost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.getPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -1007,9 +1093,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async likePost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> { async likePost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.likePost(id, options); const localVarAxiosArgs = await localVarAxiosParamCreator.likePost(id, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.likePost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.likePost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -1020,9 +1106,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async unlikePost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> { async unlikePost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.unlikePost(id, options); const localVarAxiosArgs = await localVarAxiosParamCreator.unlikePost(id, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.unlikePost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.unlikePost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -1034,9 +1120,9 @@ export const PostsApiFp = function(configuration?: Configuration) {
*/ */
async updatePost(id: number, createPostRequest: CreatePostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> { async updatePost(id: number, createPostRequest: CreatePostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Post>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePost(id, createPostRequest, options); const localVarAxiosArgs = await localVarAxiosParamCreator.updatePost(id, createPostRequest, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['PostsApi.updatePost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['PostsApi.updatePost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
} }
}; };
@ -1465,9 +1551,9 @@ export const UsersApiFp = function(configuration?: Configuration) {
*/ */
async usersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<User>>> { async usersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<User>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.usersGet(options); const localVarAxiosArgs = await localVarAxiosParamCreator.usersGet(options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['UsersApi.usersGet']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['UsersApi.usersGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -1478,9 +1564,9 @@ export const UsersApiFp = function(configuration?: Configuration) {
*/ */
async usersIdFollowDelete(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWithRelations>> { async usersIdFollowDelete(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWithRelations>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.usersIdFollowDelete(id, options); const localVarAxiosArgs = await localVarAxiosParamCreator.usersIdFollowDelete(id, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['UsersApi.usersIdFollowDelete']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['UsersApi.usersIdFollowDelete']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -1491,9 +1577,9 @@ export const UsersApiFp = function(configuration?: Configuration) {
*/ */
async usersIdFollowPost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWithRelations>> { async usersIdFollowPost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWithRelations>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.usersIdFollowPost(id, options); const localVarAxiosArgs = await localVarAxiosParamCreator.usersIdFollowPost(id, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['UsersApi.usersIdFollowPost']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['UsersApi.usersIdFollowPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -1504,9 +1590,9 @@ export const UsersApiFp = function(configuration?: Configuration) {
*/ */
async usersIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWithRelations>> { async usersIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWithRelations>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.usersIdGet(id, options); const localVarAxiosArgs = await localVarAxiosParamCreator.usersIdGet(id, options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['UsersApi.usersIdGet']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['UsersApi.usersIdGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
/** /**
* *
@ -1514,11 +1600,11 @@ export const UsersApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option. * @param {*} [options] Override http request option.
* @throws {RequiredError} * @throws {RequiredError}
*/ */
async usersMeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWithRelations>> { async usersMeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWithRelationsAndNotifications>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.usersMeGet(options); const localVarAxiosArgs = await localVarAxiosParamCreator.usersMeGet(options);
const index = configuration?.serverIndex ?? 0; const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const operationBasePath = operationServerMap['UsersApi.usersMeGet']?.[index]?.url; const localVarOperationServerBasePath = operationServerMap['UsersApi.usersMeGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}, },
} }
}; };
@ -1575,7 +1661,7 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
* @param {*} [options] Override http request option. * @param {*} [options] Override http request option.
* @throws {RequiredError} * @throws {RequiredError}
*/ */
usersMeGet(options?: any): AxiosPromise<UserWithRelations> { usersMeGet(options?: any): AxiosPromise<UserWithRelationsAndNotifications> {
return localVarFp.usersMeGet(options).then((request) => request(axios, basePath)); return localVarFp.usersMeGet(options).then((request) => request(axios, basePath));
}, },
}; };

241
server/src/controller/UserController.ts
View File

@ -7,10 +7,9 @@ import {Notification} from "../entity/Notification";
import {catchAsync} from "../util/catchAsync"; import {catchAsync} from "../util/catchAsync";
export class UserController { export class UserController {
private userRepository = AppDataSource.getRepository(User);
private userRepository = AppDataSource.getRepository(User) private notificationRepository = AppDataSource.getRepository(Notification);
private notificationRepository = AppDataSource.getRepository(Notification)
/** /**
* @swagger * @swagger
* /users: * /users:
@ -34,13 +33,14 @@ export class UserController {
async (req: Request, res: Response, next: NextFunction) => { async (req: Request, res: Response, next: NextFunction) => {
const users = await this.userRepository.find(); const users = await this.userRepository.find();
// remove sensitive fields // remove sensitive fields
users.forEach(user => { users.forEach((user) => {
user.deleteSensitiveFields() user.deleteSensitiveFields();
}) });
res.status(200).send(users) res.status(200).send(users);
}) }
);
/** /**
* @swagger * @swagger
@ -73,23 +73,28 @@ export class UserController {
// Check if ID is a number // Check if ID is a number
if (isNaN(parsedId)) return next(new AppError("Invalid ID", 400)); if (isNaN(parsedId)) return next(new AppError("Invalid ID", 400));
const user = await this.userRepository.findOne({where: {id: parsedId}, relations:{ const user = await this.userRepository.findOne({
followed: true, where: { id: parsedId },
followers: true, relations: {
posts: true, followed: true,
comments: true, followers: true,
}}) posts: true,
comments: true,
},
});
if (!user) return next(new AppError("No user found with that ID", 404));
if(!user) return next(new AppError('No user found with that ID', 404)) // remove sensitive fields
user.deleteSensitiveFields();
user.followed.forEach((followedUser) =>
followedUser.deleteSensitiveFields()
);
user.followers.forEach((follower) => follower.deleteSensitiveFields());
// remove sensitive fields return res.send(user);
user.deleteSensitiveFields() }
user.followed.forEach(followedUser => followedUser.deleteSensitiveFields()) );
user.followers.forEach(follower => follower.deleteSensitiveFields())
return res.send(user)
})
/** /**
* @swagger * @swagger
@ -106,7 +111,7 @@ export class UserController {
* content: * content:
* application/json: * application/json:
* schema: * schema:
* $ref: '#/components/schemas/UserWithRelations' * $ref: '#/components/schemas/UserWithRelationsAndNotifications'
*/ */
public getMe = catchAsync( public getMe = catchAsync(
async (req: AppRequest, res: Response, next: NextFunction) => { async (req: AppRequest, res: Response, next: NextFunction) => {
@ -117,14 +122,18 @@ export class UserController {
followers: true, followers: true,
posts: true, posts: true,
comments: true, comments: true,
notifications: true,
}, },
}); });
user.followed.forEach(followedUser => followedUser.deleteSensitiveFields()) user.followed.forEach((followedUser) =>
user.followers.forEach(follower => follower.deleteSensitiveFields()) followedUser.deleteSensitiveFields()
);
user.followers.forEach((follower) => follower.deleteSensitiveFields());
return res.status(200).send(user) return res.status(200).send(user);
}) }
);
/** /**
* @swagger * @swagger
@ -161,69 +170,74 @@ export class UserController {
// Check if ID is a number // Check if ID is a number
if (isNaN(parsedId)) return next(new AppError("Invalid ID", 400)); if (isNaN(parsedId)) return next(new AppError("Invalid ID", 400));
const user = req.user const user = req.user;
const userToFollow = await this.userRepository.findOne({ const userToFollow = await this.userRepository.findOne({
where: {id: parsedId}, where: { id: parsedId },
relations:{followed: true, followers: true, notifications: true}} relations: { followed: true, followers: true, notifications: true },
});
if (!userToFollow)
return next(new AppError("No user found with that ID", 404));
// Check if user is already following
if (
user.followed.some(
(followedUser) => followedUser.id === userToFollow.id
) )
) {
return next(new AppError("You are already following this user", 400));
}
// Follow the user
user.followed.push(userToFollow);
await this.userRepository.save(user);
// Add the requesting user to the followers of the user being followed
userToFollow.followers.push(user);
// Create a notification for the user being followed
const followNotification = Object.assign(new Notification(), {
seen: false,
message: `${user.firstName} is now following you`,
timeStamp: new Date(),
});
userToFollow.notifications.push(
await this.notificationRepository.save(followNotification)
);
await this.userRepository.save(userToFollow);
if(!userToFollow) return next(new AppError('No user found with that ID', 404)) return res.status(200).send({
status: "success",
message: `You are now following ${userToFollow.firstName}`,
});
}
);
// Check if user is already following /**
if(user.followed.some(followedUser => followedUser.id === userToFollow.id)){ * @swagger
return next(new AppError('You are already following this user', 400)) * /users/{id}/follow:
} * delete:
// Follow the user * security:
user.followed.push(userToFollow) * - bearerAuth: []
await this.userRepository.save(user) * tags:
// Add the requesting user to the followers of the user being followed * - Users
userToFollow.followers.push(user) * summary: Unfollow a user
// Create a notification for the user being followed * parameters:
const followNotification = Object.assign(new Notification(),{ * - in: path
seen: false, * name: id
message: `${user.firstName} is now following you`, * required: true
timeStamp: new Date() * schema:
}) * type: integer
userToFollow.notifications.push( * description: The ID of the user to unfollow
await this.notificationRepository.save(followNotification) * responses:
) * 200:
await this.userRepository.save(userToFollow) * description: Successfully unfollowed the user
* content:
* application/json:
return res.status(200).send({ * schema:
status: 'success', * $ref: '#/components/schemas/UserWithRelations'
message: `You are now following ${userToFollow.firstName}` * 400:
}) * description: Invalid ID
}) * 404:
* description: No user found with that ID
/** */
* @swagger
* /users/{id}/follow:
* delete:
* security:
* - bearerAuth: []
* tags:
* - Users
* summary: Unfollow a user
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* description: The ID of the user to unfollow
* responses:
* 200:
* description: Successfully unfollowed the user
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/UserWithRelations'
* 400:
* description: Invalid ID
* 404:
* description: No user found with that ID
*/
public unfollowUser = catchAsync( public unfollowUser = catchAsync(
async (req: AppRequest, res: Response, next: NextFunction) => { async (req: AppRequest, res: Response, next: NextFunction) => {
const userToUnfollowId = req.params.id; const userToUnfollowId = req.params.id;
@ -231,28 +245,37 @@ export class UserController {
// Check if ID is a number // Check if ID is a number
if (isNaN(parsedId)) return next(new AppError("Invalid ID", 400)); if (isNaN(parsedId)) return next(new AppError("Invalid ID", 400));
const user = req.user const user = req.user;
const userToUnfollow = await this.userRepository.findOne({ const userToUnfollow = await this.userRepository.findOne({
where: {id: parsedId}, where: { id: parsedId },
relations: {followed: true, followers: true} relations: { followed: true, followers: true },
}) });
if(!userToUnfollow) return next(new AppError('No user found with that ID', 404)) if (!userToUnfollow)
// Check if user is following return next(new AppError("No user found with that ID", 404));
if(!user.followed.some(followedUser => followedUser.id === userToUnfollow.id)){ // Check if user is following
return next(new AppError('You are not following this user', 400)) if (
} !user.followed.some(
// Unfollow the user (followedUser) => followedUser.id === userToUnfollow.id
user.followed = user.followed.filter(followedUser => followedUser.id !== userToUnfollow.id) )
await this.userRepository.save(user) ) {
return next(new AppError("You are not following this user", 400));
}
// Unfollow the user
user.followed = user.followed.filter(
(followedUser) => followedUser.id !== userToUnfollow.id
);
await this.userRepository.save(user);
userToUnfollow.followers = userToUnfollow.followers.filter(follower => follower.id !== user.id) userToUnfollow.followers = userToUnfollow.followers.filter(
await this.userRepository.save(userToUnfollow) (follower) => follower.id !== user.id
);
return res.status(200).send({ await this.userRepository.save(userToUnfollow);
status: 'success',
message: `You are no longer following ${userToUnfollow.firstName}`
})
})
return res.status(200).send({
status: "success",
message: `You are no longer following ${userToUnfollow.firstName}`,
});
}
);
} }

8
server/src/controller/postController.ts
View File

@ -117,8 +117,12 @@ export class PostController {
public getFollowedPosts = catchAsync(async (req : AppRequest, res, _next) => { public getFollowedPosts = catchAsync(async (req : AppRequest, res, _next) => {
const user = await this.userRepository.findOne({ const user = await this.userRepository.findOne({
where: {id: req.user.id}, where: { id: req.user.id },
relations: {followed: true, posts: true}}) relations: {
followed: true,
posts: { likedBy: true, comments: true },
},
});
const followedPosts = user.followed.map(followedUser => followedUser.posts).flat() const followedPosts = user.followed.map(followedUser => followedUser.posts).flat()

38
server/src/routes/swaggerRoutes.ts
View File

@ -83,6 +83,27 @@ const swaggerOptions = {
}, },
}, },
}, },
Notification: {
type: "object",
properties: {
id: {
type: "integer",
description: "Notification ID",
},
message: {
type: "string",
description: "Notification message",
},
timeStamp: {
type: "string",
description: "Notification creation date",
},
seen: {
type: "boolean",
description: "Notification seen status",
},
},
},
User: { User: {
type: "object", type: "object",
properties: { properties: {
@ -136,10 +157,25 @@ const swaggerOptions = {
}, },
], ],
}, },
UserWithRelationsAndNotifications: {
allOf: [
{ $ref: "#/components/schemas/UserWithRelations" },
{
type: "object",
properties: {
notifications: {
type: "array",
items: {
$ref: "#/components/schemas/Notification",
},
},
},
},
],
},
}, },
}, },
}, },
apis: ["**/controller/*.ts"], apis: ["**/controller/*.ts"],
}; };