|
| 1 | +// SPDX-FileCopyrightText: 2025 Sidings Media <contact@sidingsmedia.com> |
| 2 | +// SPDX-License-Identifier: MIT |
| 3 | + |
| 4 | +import { ApiError } from "./ApiError"; |
| 5 | +import type { Error } from "./responses/common"; |
| 6 | + |
| 7 | +export type DecodeAs = "json" | "text" | "blob"; |
| 8 | + |
| 9 | +export class Api { |
| 10 | + private baseUrl: string = |
| 11 | + (import.meta.env.VITE_API_URL as string | undefined) ?? |
| 12 | + "http://localhost:8080/v1/"; |
| 13 | + |
| 14 | + /** |
| 15 | + * Make a GET request to the API |
| 16 | + * @param path Endpoint path to call |
| 17 | + * @param options Standard fetch() options |
| 18 | + * @returns API response |
| 19 | + */ |
| 20 | + public async get<T>(path: string, options?: RequestInit): Promise<T> { |
| 21 | + const completeOptions = options ?? {}; |
| 22 | + return this.request(path, "get", completeOptions); |
| 23 | + } |
| 24 | + |
| 25 | + /** |
| 26 | + * Make a POST request to the API |
| 27 | + * @param path Endpoint path to call |
| 28 | + * @param options Standard fetch() options |
| 29 | + * @returns API response |
| 30 | + */ |
| 31 | + public async post<T>(path: string, options: RequestInit): Promise<T> { |
| 32 | + return this.request(path, "post", options); |
| 33 | + } |
| 34 | + |
| 35 | + /** |
| 36 | + * Make a PUT request to the API |
| 37 | + * @param path Endpoint path to call |
| 38 | + * @param options Standard fetch() options |
| 39 | + * @returns API response |
| 40 | + */ |
| 41 | + public async put<T>(path: string, options: RequestInit): Promise<T> { |
| 42 | + return this.request(path, "put", options); |
| 43 | + } |
| 44 | + |
| 45 | + /** |
| 46 | + * Make a PATCH request to the API |
| 47 | + * @param path Endpoint path to call |
| 48 | + * @param options Standard fetch() options |
| 49 | + * @returns API response |
| 50 | + */ |
| 51 | + public async patch<T>(path: string, options: RequestInit): Promise<T> { |
| 52 | + return this.request(path, "patch", options); |
| 53 | + } |
| 54 | + |
| 55 | + /** |
| 56 | + * Make a DELETE request to the API |
| 57 | + * @param path Endpoint path to call |
| 58 | + * @param options Standard fetch() options |
| 59 | + * @returns API response |
| 60 | + */ |
| 61 | + public async delete<T>(path: string, options?: RequestInit): Promise<T> { |
| 62 | + const completeOptions = options ?? {}; |
| 63 | + return this.request(path, "delete", completeOptions); |
| 64 | + } |
| 65 | + |
| 66 | + /** |
| 67 | + * Make request to API. Generally one of the other methods (e.g. |
| 68 | + * get(), post() and so on) should be used rather than this one. Only |
| 69 | + * use this one if you need more flexibility (e.g. return a blob). |
| 70 | + * |
| 71 | + * @param path Endpoint path |
| 72 | + * @param method HTTP method |
| 73 | + * @param options Standard fetch() options |
| 74 | + * @param baseUrl Optional alternate base url to use |
| 75 | + * @param [decodeAs="json"] How should the response be decoded? Defaults |
| 76 | + * to `json`. |
| 77 | + * @param [contentType="application/json"] Content type to use. |
| 78 | + * `Defaults to application/json` |
| 79 | + * @returns API response |
| 80 | + */ |
| 81 | + public async request<T>( |
| 82 | + path: string, |
| 83 | + method: "get" | "post" | "put" | "patch" | "delete", |
| 84 | + options: RequestInit, |
| 85 | + baseUrl?: string, |
| 86 | + decodeAs: DecodeAs = "json", |
| 87 | + contentType = "application/json", |
| 88 | + ): Promise<T> { |
| 89 | + const opts = { |
| 90 | + ...options, |
| 91 | + method, |
| 92 | + }; |
| 93 | + |
| 94 | + opts.headers = { |
| 95 | + // eslint-disable-next-line @typescript-eslint/no-misused-spread |
| 96 | + ...opts.headers, |
| 97 | + "Content-type": contentType, |
| 98 | + ...this.headers(), |
| 99 | + }; |
| 100 | + |
| 101 | + let url: URL; |
| 102 | + if (baseUrl === undefined) { |
| 103 | + // Handle when base URL is set to relative path |
| 104 | + if (!this.baseUrl.startsWith("http")) { |
| 105 | + this.baseUrl = new URL(this.baseUrl, window.location.origin).toString(); |
| 106 | + } |
| 107 | + url = new URL(path, this.baseUrl); |
| 108 | + } else { |
| 109 | + url = new URL(path, baseUrl); |
| 110 | + } |
| 111 | + |
| 112 | + console.log(`Sending request: ${method.toUpperCase()} ${url.toString()}`); |
| 113 | + const response = await fetch(url.toString(), opts); |
| 114 | + if (!response.ok) { |
| 115 | + const data: Error = (await response.json()) as Error; |
| 116 | + throw new ApiError(data.message, data); |
| 117 | + } |
| 118 | + |
| 119 | + switch (decodeAs) { |
| 120 | + case "json": |
| 121 | + return response.json() as Promise<T>; |
| 122 | + case "text": |
| 123 | + return response.text() as Promise<T>; |
| 124 | + case "blob": |
| 125 | + return response.blob() as T; |
| 126 | + } |
| 127 | + } |
| 128 | + |
| 129 | + /** |
| 130 | + * Get the required headers for requests |
| 131 | + * @returns No headers needed |
| 132 | + */ |
| 133 | + private headers(): Record<string, string> { |
| 134 | + return {}; |
| 135 | + } |
| 136 | + |
| 137 | + /** |
| 138 | + * Create a URL using the configured base URL. |
| 139 | + * |
| 140 | + * @param path Path to append to base URL |
| 141 | + * @returns Correctly formatted URL |
| 142 | + */ |
| 143 | + public constructUrl(path: string): URL { |
| 144 | + // Handle when base URL is set to relative path |
| 145 | + if (!this.baseUrl.startsWith("http")) { |
| 146 | + this.baseUrl = new URL(this.baseUrl, window.location.origin).toString(); |
| 147 | + } |
| 148 | + return new URL(path, this.baseUrl); |
| 149 | + } |
| 150 | +} |
0 commit comments