fix: work through how i want to return the api response with the data property being of the right type.

This commit is contained in:
StevanFreeborn
2023-02-01 21:21:39 -06:00
parent 5a6c5094e9
commit 4952bf30ec
9 changed files with 164 additions and 39 deletions
+7 -6
View File
@@ -1,12 +1,12 @@
import { AxiosInstance } from 'axios';
import { AxiosInstance, AxiosResponse } from 'axios';
import axios from 'axios';
import { ArgumentValidator } from './models/ArgumentValidator';
import { EndpointFactory } from './models/EndpointFactory';
import { ApiResponseFactory } from './models/ApiResponseFactory';
import { ApiResponse } from './models/ApiResponse';
import { App } from './models/App';
import { PagingRequest } from './models/PagingRequest';
import { GetPagedAppsResponse } from './models/GetPagedAppsResponse';
import { App } from './models/App';
/**
* @class OnspringClient - A client that can communicate with the Onspring API.
@@ -55,14 +55,14 @@ export class OnspringClient {
this._client.defaults.baseURL
);
const response = await this.get<ApiResponse<boolean>>(endpoint);
const response = await this.get<any>(endpoint);
return response.isSuccessful;
}
/**
*
*
* @param pagingRequest - The paging request that will be used to get the apps.
* @returns
* @returns
*/
public async getApps(
pagingRequest: PagingRequest = new PagingRequest(1, 50)
@@ -72,7 +72,8 @@ export class OnspringClient {
pagingRequest
);
return await this.get<GetPagedAppsResponse>(endpoint);
var apiResponse = await this.get<any>(endpoint);
return apiResponse.AsGetPagedAppsResponseType();
}
/**
+28 -4
View File
@@ -1,3 +1,6 @@
import { App } from "./App";
import { GetPagedAppsResponse } from "./GetPagedAppsResponse";
/**
* @class ApiResponse - A generic response object for API requests.
*/
@@ -5,22 +8,22 @@ export class ApiResponse<T> {
/**
* @property {number} statusCode - The status code of the response.
*/
readonly statusCode: number;
public statusCode: number;
/**
* @property {boolean} isSuccessful - True if the status code is less than 400; otherwise, false.
*/
readonly isSuccessful: boolean;
public isSuccessful: boolean;
/**
* @property {string} message - The message of the response.
*/
readonly message: string;
public message: string;
/**
* @property {T} data - The data of the response.
*/
readonly data: T;
public data: T;
/**
* @constructor - Creates a new instance of the ApiResponse class.
@@ -35,4 +38,25 @@ export class ApiResponse<T> {
this.message = message;
this.data = data;
}
public AsGetPagedAppsResponseType(): ApiResponse<GetPagedAppsResponse> {
var apiResponse = this as ApiResponse<any>;
var apps = apiResponse.data.items.map((item: any) => {
return new App(item.href, item.id, item.name);
});
var getAppsPagedResponse = new GetPagedAppsResponse(
apps,
apiResponse.data.pageNumber,
apiResponse.data.pageSize,
apiResponse.data.totalPages,
apiResponse.data.totalRecords
);
return new ApiResponse<GetPagedAppsResponse>(
apiResponse.statusCode,
apiResponse.message,
getAppsPagedResponse
);
}
}
+1 -2
View File
@@ -15,8 +15,7 @@ export class ApiResponseFactory {
const message = this.TryToGetMessage(response);
if (this.isSuccessStatusCode(response.status) === true) {
const data = response.data as T;
return new ApiResponse<T>(response.status, message, data);
return new ApiResponse<T>(response.status, message, response.data);
}
return new ApiResponse<T>(response.status, message, null);
+2 -2
View File
@@ -2,7 +2,7 @@ import { PagedResponse } from "./PagedResponse";
import { App } from "./App";
export class GetPagedAppsResponse extends PagedResponse<App> {
constructor(items: App[], pageNumber: number, pageSize: number, totalCount: number) {
super(items, pageNumber, pageSize, totalCount);
constructor(items: App[], pageNumber: number, pageSize: number, totalPages: number, totalRecords: number) {
super(items, pageNumber, pageSize, totalPages, totalRecords);
}
}
+5 -3
View File
@@ -2,12 +2,14 @@ export class PagedResponse<T> {
public items: T[];
public pageNumber: number;
public pageSize: number;
public totalCount: number;
public totalPages: number;
public totalRecords: number;
constructor(items: T[], pageNumber: number, pageSize: number, totalCount: number) {
constructor(items: T[], pageNumber: number, pageSize: number, totalPages: number, totalRecords: number) {
this.items = items;
this.pageNumber = pageNumber;
this.pageSize = pageSize;
this.totalCount = totalCount;
this.totalPages = totalPages;
this.totalRecords = totalRecords;
}
}