1
0
Fork 1
mirror of https://github.com/hay-kot/homebox.git synced 2024-12-23 23:36:30 +00:00
homebox/frontend/lib/api/base/base-api.ts

75 lines
2.2 KiB
TypeScript
Raw Normal View History

import { Requests } from "../../requests";
2022-08-31 00:06:57 +00:00
const ZERO_DATE = "0001-01-01T00:00:00Z";
type BaseApiType = {
createdAt: string;
updatedAt: string;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
[key: string]: any;
};
export function hasKey(obj: object, key: string): obj is Required<BaseApiType> {
return typeof obj[key] === "string";
}
export function parseDate<T>(obj: T, keys: Array<keyof T> = []): T {
const result = { ...obj };
[...keys, "createdAt", "updatedAt"].forEach(key => {
// @ts-ignore - TS doesn't know that we're checking for the key above
if (hasKey(result, key)) {
if (result[key] === ZERO_DATE) {
const dt = new Date();
dt.setFullYear(1);
result[key] = dt;
return;
}
// Ensure date like format YYYY/MM/DD - otherwise results will be 1 day off
const dateStr: string = result[key].split("T")[0].replace(/-/g, "/");
result[key] = new Date(dateStr);
}
});
return result;
}
2022-08-31 00:06:57 +00:00
export class BaseAPI {
2022-08-31 05:22:10 +00:00
http: Requests;
attachmentToken: string;
2022-08-31 00:06:57 +00:00
constructor(requests: Requests, attachmentToken = "") {
2022-08-31 05:22:10 +00:00
this.http = requests;
this.attachmentToken = attachmentToken;
}
// if a attachmentToken is present it will be added to URL as a query param
// this is done with a simple appending of the query param to the URL. If your
// URL already has a query param, this will not work.
authURL(url: string): string {
if (this.attachmentToken) {
return `/api/v1${url}?access_token=${this.attachmentToken}`;
}
return url;
2022-08-31 05:22:10 +00:00
}
/**
* dropFields will remove any fields that are specified in the fields array
* additionally, it will remove the `createdAt` and `updatedAt` fields if they
* are present. This is useful for when you want to send a subset of fields to
* the server like when performing an update.
*/
protected dropFields<T>(obj: T, keys: Array<keyof T> = []): T {
const result = { ...obj };
[...keys, "createdAt", "updatedAt"].forEach(key => {
// @ts-ignore - we are checking for the key above
if (hasKey(result, key)) {
// @ts-ignore - we are guarding against this above
delete result[key];
}
});
return result;
}
2022-08-31 00:06:57 +00:00
}