feat: implement new routes convention

Author: joaotonaco

.changeset/shaggy-starfishes-stare.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/api": minor
+---
+
+Implement new API routes convention

src/lib/routes.ts

@@ -0,0 +1,100 @@
+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 Routes = {
+	user() {
+		return Route<"user">("/v2/users/me");
+	},
+	service: {
+		status() {
+			return Route<"service/status">("/v2/service/status");
+		},
+	},
+	apps: {
+		upload() {
+			return Route<"apps/upload">("/v2/apps");
+		},
+		statusAll() {
+			return Route<"apps/status-all">("/v2/apps/status");
+		},
+		info(appId: string) {
+			return Route<"apps/info">(`/v2/apps/${appId}`);
+		},
+		status(appId: string) {
+			return Route<"apps/status">(`/v2/apps/${appId}/status`);
+		},
+		logs(appId: string) {
+			return Route<"apps/logs">(`/v2/apps/${appId}/logs`);
+		},
+		backups(appId: string) {
+			return Route<"apps/backups">(`/v2/apps/${appId}/backups`);
+		},
+		generateBackup(appId: string) {
+			return Route<"apps/generate-backup">(`/v2/apps/${appId}/backups`);
+		},
+		start(appId: string) {
+			return Route<"apps/start">(`/v2/apps/${appId}/start`);
+		},
+		restart(appId: string) {
+			return Route<"apps/restart">(`/v2/apps/${appId}/restart`);
+		},
+		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) {
+				return Route<"apps/files/read">(`/v2/apps/${appId}/files/content`);
+			},
+			list(appId: string) {
+				return Route<"apps/files/list">(`/v2/apps/${appId}/files`);
+			},
+			upsert(appId: string) {
+				return Route<"apps/files/upsert">(`/v2/apps/${appId}/files`);
+			},
+			move(appId: string) {
+				return Route<"apps/files/move">(`/v2/apps/${appId}/files`);
+			},
+			delete(appId: string) {
+				return Route<"apps/files/delete">(`/v2/apps/${appId}/files`);
+			},
+		},
+		deployments: {
+			list(appId: string) {
+				return Route<"apps/deployments/list">(`/v2/apps/${appId}/deployments`);
+			},
+			current(appId: string) {
+				return Route<"apps/deployments/current">(
+					`/v2/apps/${appId}/deployments/current`,
+				);
+			},
+			webhook(appId: string) {
+				return Route<"apps/deployments/webhook">(
+					`/v2/apps/${appId}/deploy/webhook`,
+				);
+			},
+		},
+		network: {
+			dns(appId: string) {
+				return Route<"apps/network/dns">(`/v2/apps/${appId}/network/dns`);
+			},
+			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`);
+			},
+		},
+	},
+};

src/managers/api.ts

@@ -1,43 +1,52 @@
-import type {
-	APIPayload,
-	APIUserInfo,
-	APIVersion,
-} from "@squarecloud/api-types/v2";
-import { type APIApplicationEndpoints, SquareCloudAPIError } from "..";
+import type { Route } from "@/lib/routes";
+import type { APIPayload, APIVersion } from "@squarecloud/api-types/v2";
+import {
+	type APIEndpoint,
+	type APIRequestOptions,
+	type APIResponse,
+	SquareCloudAPIError,
+} from "..";
 
 export class APIManager {
 	public readonly baseUrl = "https://api.squarecloud.app";
 	public readonly version: APIVersion<1 | 2> = "v2";
 
 	constructor(readonly apiKey: string) {}
 
-	user(userId?: string): Promise<APIPayload<APIUserInfo>> {
-		return this.fetch(`user${userId ? `/${userId}` : ""}`);
-	}
+	async request<T extends APIEndpoint>(
+		path: Route<T>,
+		options?: APIRequestOptions<T>,
+	): Promise<APIResponse<T>> {
+		const init = options || ({} as RequestInit);
+
+		init.method = init.method || "GET";
+		init.headers = {
+			...(init.headers || {}),
+			Authorization: this.apiKey,
+		};
 
-	application<T extends keyof APIApplicationEndpoints | (string & {})>(
-		path: T,
-		appId?: string,
-		params?: Record<string, string>,
-		options?: RequestInit | "GET" | "POST" | "DELETE",
-	): Promise<
-		APIPayload<
-			T extends keyof APIApplicationEndpoints
-				? APIApplicationEndpoints[T]
-				: never
-		>
-	> {
-		if (typeof options === "string") {
-			options = {
-				method: options,
-			};
+		const url = new URL(path, `${this.baseUrl}/${this.version}`);
+
+		if ("query" in init && init.query) {
+			const query = new URLSearchParams(init.query as Record<string, string>);
+			url.search = query.toString();
+			init.query = undefined;
 		}
 
-		const url = `apps${appId ? `/${appId}` : ""}${path ? `/${path}` : ""}${
-			params ? `?${new URLSearchParams(params)}` : ""
-		}`;
+		if ("body" in init && init.body && !(init.body instanceof Buffer)) {
+			init.body = JSON.stringify(init.body);
+		}
 
-		return this.fetch(url, options);
+		const response = await fetch(url, init).catch((err) => {
+			throw new SquareCloudAPIError(err.code, err.message);
+		});
+		const data = await response.json();
+
+		if (!data || data.status === "error" || !response.ok) {
+			throw new SquareCloudAPIError(data?.code || "COMMON_ERROR");
+		}
+
+		return data;
 	}
 
 	async fetch<T>(

src/managers/application/backup.ts

@@ -1,16 +1,18 @@
 import { type Application, SquareCloudAPIError } from "@/index";
+import { Routes } from "@/lib/routes";
+import type { RESTPostAPIApplicationBackupResult } from "@squarecloud/api-types/v2";
 
 export class ApplicationBackupManager {
 	constructor(public readonly application: Application) {}
 
 	/** @returns The generated backup URL */
-	async url(): Promise<string> {
-		const data = await this.application.client.api.application(
-			"backup",
-			this.application.id,
+	async create(): Promise<RESTPostAPIApplicationBackupResult> {
+		const data = await this.application.client.api.request(
+			Routes.apps.generateBackup(this.application.id),
+			{ method: "POST" },
 		);
 
-		const backup = data.response.downloadURL;
+		const backup = data.response;
 
 		this.application.client.emit(
 			"backupUpdate",
@@ -25,14 +27,9 @@ export class ApplicationBackupManager {
 
 	/** @returns The generated backup buffer */
 	async download(): Promise<Buffer> {
-		const url = await this.url();
+		const backup = await this.create();
 
-		const registryUrl = url.replace(
-			"https://squarecloud.app/dashboard/backup/",
-			"https://registry.squarecloud.app/v1/backup/download/",
-		);
-
-		const res = await fetch(registryUrl)
+		const res = await fetch(backup.url)
 			.then((res) => res.arrayBuffer())
 			.catch(() => undefined);
 

src/managers/application/cache.ts

@@ -1,10 +1,11 @@
 import type { ApplicationStatus } from "@/structures";
+import type { RESTPostAPIApplicationBackupResult } from "@squarecloud/api-types/v2";
 
 export type ApplicationCacheKey = "status" | "backup" | "logs";
 
 export class ApplicationCacheManager {
 	readonly status?: ApplicationStatus;
-	readonly backup?: string;
+	readonly backup?: RESTPostAPIApplicationBackupResult;
 	readonly logs?: string;
 
 	set<T extends ApplicationCacheKey>(

src/managers/application/deploys.ts

@@ -1,5 +1,6 @@
 import { assertString } from "@/assertions/literal";
 import type { Application } from "@/index";
+import { Routes } from "@/lib/routes";
 
 export class ApplicationDeploysManager {
 	constructor(public readonly application: Application) {}
@@ -12,14 +13,9 @@ export class ApplicationDeploysManager {
 	async getGithubWebhook(accessToken: string) {
 		assertString(accessToken);
 
-		const data = await this.application.client.api.application(
-			"deploy/git-webhook",
-			this.application.id,
-			undefined,
-			{
-				method: "POST",
-				body: JSON.stringify({ access_token: accessToken }),
-			},
+		const data = await this.application.client.api.request(
+			Routes.apps.deployments.webhook(this.application.id),
+			{ method: "POST", body: { access_token: accessToken } },
 		);
 
 		return data.response.webhook;
@@ -29,9 +25,8 @@ export class ApplicationDeploysManager {
 	 * Gets the last 10 deployments of an application from the last 24 hours
 	 */
 	async list() {
-		const data = await this.application.client.api.application(
-			"deploys/list",
-			this.application.id,
+		const data = await this.application.client.api.request(
+			Routes.apps.deployments.list(this.application.id),
 		);
 
 		return data?.response;

src/managers/application/files.ts

@@ -1,6 +1,7 @@
 import { join } from "path";
 import { assertPathLike, assertString } from "@/assertions/literal";
 import type { Application } from "@/index";
+import { Routes } from "@/lib/routes";
 import { readFile } from "fs/promises";
 
 export class ApplicationFilesManager {
@@ -14,10 +15,9 @@ export class ApplicationFilesManager {
 	async list(path = "/") {
 		assertString(path, "LIST_FILES_PATH");
 
-		const { response } = await this.application.client.api.application(
-			"files/list",
-			this.application.id,
-			{ path },
+		const { response } = await this.application.client.api.request(
+			Routes.apps.files.list(this.application.id),
+			{ query: { path } },
 		);
 
 		return response;
@@ -31,10 +31,9 @@ export class ApplicationFilesManager {
 	async read(path: string) {
 		assertString(path, "READ_FILE_PATH");
 
-		const { response } = await this.application.client.api.application(
-			"files/read",
-			this.application.id,
-			{ path },
+		const { response } = await this.application.client.api.request(
+			Routes.apps.files.read(this.application.id),
+			{ query: { path } },
 		);
 
 		if (!response) {
@@ -59,16 +58,11 @@ export class ApplicationFilesManager {
 		}
 		path = join(path, fileName).replaceAll("\\", "/");
 
-		const { status } = await this.application.client.api.application(
-			"files/create",
-			this.application.id,
-			undefined,
+		const { status } = await this.application.client.api.request(
+			Routes.apps.files.upsert(this.application.id),
 			{
-				method: "POST",
-				body: JSON.stringify({
-					buffer: file.toJSON(),
-					path,
-				}),
+				method: "PUT",
+				body: { content: file.toString("utf8"), path },
 			},
 		);
 
@@ -83,11 +77,9 @@ export class ApplicationFilesManager {
 	async delete(path: string) {
 		assertString(path, "DELETE_FILE_PATH");
 
-		const { status } = await this.application.client.api.application(
-			"files/delete",
-			this.application.id,
-			{ path },
-			"DELETE",
+		const { status } = await this.application.client.api.request(
+			Routes.apps.files.delete(this.application.id),
+			{ method: "DELETE", query: { path } },
 		);
 
 		return status === "success";