refactor: improve api internal typings and helpers

Author: joaotonaco

src/lib/routes.ts

@@ -1,100 +1,103 @@
 import type { APIEndpoint } from "@/types";
 
 export type Route<T extends APIEndpoint> = string & { __route: T };
-export const Route = <T extends APIEndpoint>(route: string) => {
-	return route as Route<T>;
-};
+export const Route = <T extends APIEndpoint>(route: string) =>
+	route as Route<T>;
+
+interface IRoutes {
+	[k: string]: ((...args: string[]) => Route<APIEndpoint>) | IRoutes;
+}
 
 export const Routes = {
-	user() {
+	user: () => {
 		return Route<"user">("/v2/users/me");
 	},
 	service: {
-		status() {
+		status: () => {
 			return Route<"service/status">("/v2/service/status");
 		},
 	},
 	apps: {
-		upload() {
+		upload: () => {
 			return Route<"apps/upload">("/v2/apps");
 		},
-		statusAll() {
+		statusAll: () => {
 			return Route<"apps/status-all">("/v2/apps/status");
 		},
-		info(appId: string) {
+		info: (appId: string) => {
 			return Route<"apps/info">(`/v2/apps/${appId}`);
 		},
-		status(appId: string) {
+		status: (appId: string) => {
 			return Route<"apps/status">(`/v2/apps/${appId}/status`);
 		},
-		logs(appId: string) {
+		logs: (appId: string) => {
 			return Route<"apps/logs">(`/v2/apps/${appId}/logs`);
 		},
-		backups(appId: string) {
+		delete: (appId: string) => {
+			return Route<"apps/delete">(`/v2/apps/${appId}`);
+		},
+		commit: (appId: string) => {
+			return Route<"apps/commit">(`/v2/apps/${appId}/commit`);
+		},
+		backups: (appId: string) => {
 			return Route<"apps/backups">(`/v2/apps/${appId}/backups`);
 		},
-		generateBackup(appId: string) {
+		generateBackup: (appId: string) => {
 			return Route<"apps/generate-backup">(`/v2/apps/${appId}/backups`);
 		},
-		start(appId: string) {
+		start: (appId: string) => {
 			return Route<"apps/start">(`/v2/apps/${appId}/start`);
 		},
-		restart(appId: string) {
+		restart: (appId: string) => {
 			return Route<"apps/restart">(`/v2/apps/${appId}/restart`);
 		},
-		stop(appId: string) {
+		stop: (appId: string) => {
 			return Route<"apps/stop">(`/v2/apps/${appId}/stop`);
 		},
-		delete(appId: string) {
-			return Route<"apps/delete">(`/v2/apps/${appId}`);
-		},
-		commit(appId: string) {
-			return Route<"apps/commit">(`/v2/apps/${appId}/commit`);
-		},
 		files: {
-			read(appId: string) {
+			read: (appId: string) => {
 				return Route<"apps/files/read">(`/v2/apps/${appId}/files/content`);
 			},
-			list(appId: string) {
+			list: (appId: string) => {
 				return Route<"apps/files/list">(`/v2/apps/${appId}/files`);
 			},
-			upsert(appId: string) {
+			upsert: (appId: string) => {
 				return Route<"apps/files/upsert">(`/v2/apps/${appId}/files`);
 			},
-			move(appId: string) {
+			move: (appId: string) => {
 				return Route<"apps/files/move">(`/v2/apps/${appId}/files`);
 			},
-			delete(appId: string) {
+			delete: (appId: string) => {
 				return Route<"apps/files/delete">(`/v2/apps/${appId}/files`);
 			},
 		},
 		deployments: {
-			list(appId: string) {
+			list: (appId: string) => {
 				return Route<"apps/deployments/list">(`/v2/apps/${appId}/deployments`);
 			},
-			current(appId: string) {
+			current: (appId: string) => {
 				return Route<"apps/deployments/current">(
 					`/v2/apps/${appId}/deployments/current`,
 				);
 			},
-			webhook(appId: string) {
+			webhook: (appId: string) => {
 				return Route<"apps/deployments/webhook">(
 					`/v2/apps/${appId}/deploy/webhook`,
 				);
 			},
 		},
 		network: {
-			dns(appId: string) {
+			dns: (appId: string) => {
 				return Route<"apps/network/dns">(`/v2/apps/${appId}/network/dns`);
 			},
-			analytics(appId: string) {
+			custom: (appId: string) => {
+				return Route<"apps/network/custom">(`/v2/apps/${appId}/network/custom`);
+			},
+			analytics: (appId: string) => {
 				return Route<"apps/network/analytics">(
 					`/v2/apps/${appId}/network/analytics`,
 				);
 			},
-			custom(appId: string) {
-				return Route<"apps/network/custom">(`/v2/apps/${appId}/network/custom`);
-			},
 		},
 	},
-};
+} satisfies IRoutes;

src/managers/api.ts

@@ -1,5 +1,5 @@
 import type { Route } from "@/lib/routes";
-import type { APIPayload, APIVersion } from "@squarecloud/api-types/v2";
+import type { APIVersion } from "@squarecloud/api-types/v2";
 import {
 	type APIEndpoint,
 	type APIRequestOptions,
@@ -11,11 +11,11 @@ export class APIManager {
 	public readonly baseUrl = "https://api.squarecloud.app";
 	public readonly version: APIVersion<1 | 2> = "v2";
 
-	constructor(readonly apiKey: string) {}
+	constructor(protected readonly apiKey: string) {}
 
-	async request<T extends APIEndpoint>(
+	async request<T extends APIEndpoint, U extends APIRequestOptions<T>>(
 		path: Route<T>,
-		options?: APIRequestOptions<T>,
+		options?: U,
 	): Promise<APIResponse<T>> {
 		const { url, init } = this.parseRequestOptions(path, options);
 
@@ -35,7 +35,7 @@ export class APIManager {
 		path: string,
 		options?: APIRequestOptions<APIEndpoint>,
 	) {
-		const init = options || ({} as RequestInit);
+		const init: RequestInit = options || {};
 
 		init.method = init.method || "GET";
 		init.headers = {

src/types/api.ts

@@ -49,6 +49,7 @@ export interface APIEndpoints {
 		response: APIServiceStatus;
 	};
 	"apps/upload": {
+		method: "POST";
 		body: Buffer;
 		response: RESTPostAPIApplicationUploadResult;
 	};
@@ -68,21 +69,27 @@ export interface APIEndpoints {
 		response: APIApplicationBackup[];
 	};
 	"apps/generate-backup": {
+		method: "POST";
 		response: RESTPostAPIApplicationBackupResult;
 	};
 	"apps/start": {
+		method: "POST";
 		response: undefined;
 	};
 	"apps/restart": {
+		method: "POST";
 		response: undefined;
 	};
 	"apps/stop": {
+		method: "POST";
 		response: undefined;
 	};
 	"apps/delete": {
+		method: "DELETE";
 		response: undefined;
 	};
 	"apps/commit": {
+		method: "POST";
 		query: RESTPostAPIApplicationCommitQuery;
 		body: Buffer;
 		response: undefined;
@@ -96,14 +103,17 @@ export interface APIEndpoints {
 		response: APIListedFile[];
 	};
 	"apps/files/upsert": {
+		method: "PUT";
 		body: RESTPutAPIFileUpsertJSONBody;
 		response: undefined;
 	};
 	"apps/files/move": {
+		method: "PATCH";
 		body: RESTPatchAPIFileMoveJSONBody;
 		response: undefined;
 	};
 	"apps/files/delete": {
+		method: "DELETE";
 		query: RESTDeleteAPIFileDeleteQuery;
 		response: undefined;
 	};
@@ -114,6 +124,7 @@ export interface APIEndpoints {
 		response: APIDeploymentCurrent;
 	};
 	"apps/deployments/webhook": {
+		method: "POST";
 		body: RESTPostAPIGithubWebhookJSONBody;
 		response: RESTPostAPIGithubWebhookResult;
 	};
@@ -124,20 +135,19 @@ export interface APIEndpoints {
 		response: APINetworkAnalytics;
 	};
 	"apps/network/custom": {
+		method: "POST";
 		body: RESTPostAPINetworkCustomDomainJSONBody;
 		response: undefined;
 	};
 }
 
 export type APIEndpoint = keyof APIEndpoints;
 
-export type APIRequestOptions<
-	T extends APIEndpoint,
-	U extends APIEndpoints[T] = APIEndpoints[T],
-> = Omit<U, "response"> & {
-	method?: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+export type APIMethod = "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+
+export type APIRequestOptions<T extends APIEndpoint> = {
 	headers?: HeadersInit;
-};
+} & Omit<APIEndpoints[T], "response">;
 
 export type APIResponse<T extends APIEndpoint> = APIPayload<
 	APIEndpoints[T]["response"]