[DEV] add missing tools for TS

typescript_model/rest-tools.ts

@@ -0,0 +1,217 @@
+/** @file
+ * @author Edouard DUPIN
+ * @copyright 2024, Edouard DUPIN, all right reserved
+ * @license MPL-2 (Generate file)
+ */
+
+import { RestErrorResponse } from "./model"
+
+export enum HTTPRequestModel {
+    DELETE = 'DELETE',
+    GET = 'GET',
+    PATCH = 'PATCH',
+    POST = 'POST',
+    PUT = 'PUT',
+}
+export enum HTTPMimeType {
+    ALL = '*/*',
+    IMAGE = 'image/*',
+    IMAGE_JPEG = 'image/jpeg',
+    IMAGE_PNG = 'image/png',
+    JSON = 'application/json',
+    OCTET_STREAM = 'application/octet-stream',
+}
+
+export interface RESTConfig {
+    // base of the server: http(s)://my.server.org/plop/api/
+    server: string;
+    // Token to access of the data.
+    token?: string;
+}
+
+export interface RESTModel {
+    // base of the local API request: "sheep/{id}".
+    endPoint: string;
+    // Type of the request.
+    requestType?: HTTPRequestModel;
+    // Input type requested.
+    accept?: HTTPMimeType;
+    // Content of the local data.
+    contentType?: HTTPMimeType;
+    // Mode of the TOKEN in urk or Header
+    tokenInUrl?: boolean;
+}
+
+export interface RESTRequest {
+    params?: object;
+    body?: any;
+}
+
+export interface ModelResponseHttp {
+    status: number;
+    data: any;
+}
+
+export function isArrayOf<TYPE>(
+    data: any,
+    typeChecker: (subData: any) => subData is TYPE,
+    length?: number
+): data is TYPE[] {
+    if (!Array.isArray(data)) {
+        return false;
+    }
+    if (!data.every(typeChecker)) {
+        return false;
+    }
+    if (length !== undefined && data.length != length) {
+        return false;
+    }
+    return true;
+}
+
+export type RESTRequestType = {
+    restModel: RESTModel,
+    restConfig: RESTConfig,
+    data?: any,
+    params?: object,
+    queries?: object,
+};
+
+/**
+ * This service permit to add some data like token and authorization..
+ */
+export function RESTRequest({ restModel, restConfig, data, params, queries }: RESTRequestType): Promise<ModelResponseHttp> {
+    // Create the URL PATH:
+    let generateUrl = `${restConfig.server}/${restModel.endPoint}`;
+    if (params !== undefined) {
+        for (let key of Object.keys(params)) {
+            generateUrl = generateUrl.replaceAll(`{${key}}`, `${params[key]}`);
+        }
+    }
+    if (queries !== undefined) {
+        const searchParams = new URLSearchParams();
+        for (let key of Object.keys(queries)) {
+            const value = queries[key];
+            if (Array.isArray(value)) {
+                for (let iii = 0; iii < value.length; iii++) {
+                    searchParams.append(`${key}`, `${value[iii]}`);
+                }
+            } else {
+                searchParams.append(`${key}`, `${value}`);
+            }
+        }
+        if (restConfig.token !== undefined && restModel.tokenInUrl === true) {
+            searchParams.append('Authorization', `Bearer ${restConfig.token}`);
+        }
+        generateUrl += "?" + searchParams.toString();
+    }
+    let headers: any = {};
+    if (restConfig.token !== undefined && restModel.tokenInUrl !== true) {
+        headers['Authorization'] = `Bearer ${restConfig.token}`;
+    }
+    if (restModel.accept !== undefined) {
+        headers['Accept'] = restModel.accept;
+    }
+    if (restModel.requestType !== HTTPRequestModel.GET) {
+        // if Get we have not a content type, the body is empty
+        headers['Content-Type'] = restModel.contentType;
+    }
+    let body = data;
+    if (restModel.contentType === HTTPMimeType.JSON) {
+        body = JSON.stringify(data);
+    }
+    console.log(`Call ${generateUrl}`)
+    return new Promise((resolve, reject) => {
+        fetch(generateUrl, {
+            method: restModel.requestType,
+            headers,
+            body,
+        }).then((response: Response) => {
+            if (response.status >= 200 && response.status <= 299) {
+                const contentType = response.headers.get('Content-Type');
+                if (restModel.accept !== contentType) {
+                    reject({
+                        time: Date().toString(),
+                        status: 901,
+                        error: `REST check wrong type: ${restModel.accept} != ${contentType}`,
+                        statusMessage: "Fetch error",
+                        message: "rest-tools.ts Wrong type in the message return type"
+                    } as RestErrorResponse);
+                } else if (contentType === HTTPMimeType.JSON) {
+                    response
+                        .json()
+                        .then((value: any) => {
+                            //console.log(`RECEIVE ==> ${response.status}=${ JSON.stringify(value, null, 2)}`);
+                            resolve({ status: response.status, data: value });
+                        })
+                        .catch((reason: any) => {
+                            reject({
+                                time: Date().toString(),
+                                status: 902,
+                                error: `REST parse json fail: ${reason}`,
+                                statusMessage: "Fetch parse error",
+                                message: "rest-tools.ts Wrong message model to parse"
+                            } as RestErrorResponse);
+                        });
+                } else {
+                    resolve({ status: response.status, data: response.body });
+                }
+            } else {
+                reject({
+                    time: Date().toString(),
+                    status: response.status,
+                    error: `${response.body}`,
+                    statusMessage: "Fetch code error",
+                    message: "rest-tools.ts Wrong return code"
+                } as RestErrorResponse);
+            }
+        }).catch((error: any) => {
+            reject({
+                time: Date(),
+                status: 999,
+                error: error,
+                statusMessage: "Fetch catch error",
+                message: "http-wrapper.ts detect an error in the fetch request"
+            });
+        });
+    });
+}
+
+export function RESTRequestJson<TYPE>(request: RESTRequestType, checker: (data: any) => data is TYPE): Promise<TYPE> {
+    return new Promise((resolve, reject) => {
+        RESTRequest(request).then((value: ModelResponseHttp) => {
+            if (checker(value.data)) {
+                resolve(value.data);
+            } else {
+                reject({
+                    time: Date().toString(),
+                    status: 950,
+                    error: "REST Fail to verify the data",
+                    statusMessage: "API cast ERROR",
+                    message: "api.ts Check type as fail"
+                } as RestErrorResponse);
+            }
+        }).catch((reason: RestErrorResponse) => {
+            reject(reason);
+        });
+    });
+}
+export function RESTRequestJsonArray<TYPE>(request: RESTRequestType, checker: (data: any) => data is TYPE): Promise<TYPE[]> {
+    return new Promise((resolve, reject) => {
+        RESTRequest(request).then((value: ModelResponseHttp) => {
+            if (isArrayOf(value.data, checker)) {
+                resolve(value.data);
+            } else {
+                reject({
+                    time: Date().toString(),
+                    status: 950,
+                    error: "REST Fail to verify the data",
+                    statusMessage: "API cast ERROR",
+                    message: "api.ts Check type as fail"
+                } as RestErrorResponse);
+            }
+        }).catch((reason: RestErrorResponse) => {
+            reject(reason);
+        });
+    });
+}