refactor: make some managers available at base application

Author: joaotonaco

.changeset/selfish-rockets-wash.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/api": patch
+---
+
+Now `backups`, `deploys`, `files` and `cache` are available in the BaseApplication.

src/managers/application/backup.ts src/managers/application/backups.tssrc/managers/application/backup.ts renamed to src/managers/application/backups.ts

@@ -1,12 +1,16 @@
-import { type Application, SquareCloudAPIError } from "@/index";
+import {
+	Application,
+	type BaseApplication,
+	SquareCloudAPIError,
+} from "@/index";
 import { Routes } from "@/lib/routes";
 import type {
 	APIApplicationBackup,
 	RESTPostAPIApplicationBackupResult,
 } from "@squarecloud/api-types/v2";
 
-export class ApplicationBackupManager {
-	constructor(public readonly application: Application) {}
+export class ApplicationBackupsManager {
+	constructor(public readonly application: BaseApplication) {}
 
 	async list(): Promise<APIApplicationBackup[]> {
 		const data = await this.application.client.api.request(

src/managers/application/deploys.ts

@@ -1,9 +1,9 @@
 import { assertString } from "@/assertions/literal";
-import type { Application } from "@/index";
+import type { BaseApplication } from "@/index";
 import { Routes } from "@/lib/routes";
 
 export class ApplicationDeploysManager {
-	constructor(public readonly application: Application) {}
+	constructor(public readonly application: BaseApplication) {}
 
 	/**
 	 * Integrates Square Cloud with GitHub webhooks

src/managers/application/files.ts

@@ -1,11 +1,11 @@
 import { join } from "path";
 import { assertPathLike, assertString } from "@/assertions/literal";
-import type { Application } from "@/index";
+import type { BaseApplication } from "@/index";
 import { Routes } from "@/lib/routes";
 import { readFile } from "fs/promises";
 
 export class ApplicationFilesManager {
-	constructor(public readonly application: Application) {}
+	constructor(public readonly application: BaseApplication) {}
 
 	/**
 	 * Lists the files inside a directory

src/managers/application/index.ts

@@ -99,7 +99,7 @@ export class ApplicationManager {
 	}
 }
 
-export * from "./backup";
+export * from "./backups";
 export * from "./cache";
 export * from "./deploys";
 export * from "./files";

src/structures/application/application.ts

@@ -1,12 +1,6 @@
 import { assertApplication } from "@/assertions/application";
 import { ApplicationStatus, type SquareCloudAPI } from "@/index";
 import { Routes } from "@/lib/routes";
-import {
-	ApplicationBackupManager,
-	ApplicationCacheManager,
-	ApplicationDeploysManager,
-	ApplicationFilesManager,
-} from "@/managers";
 import type {
 	APIApplication,
 	ApplicationLanguage,
@@ -45,16 +39,10 @@ export class Application extends BaseApplication {
 	 * - `rust`
 	 * - `go`
 	 * - `php`
+	 * - `dotnet`
+	 * - `static`
 	 */
 	language: ApplicationLanguage;
-	/** Files manager for this application */
-	files = new ApplicationFilesManager(this);
-	/** Backup manager for this application */
-	backup = new ApplicationBackupManager(this);
-	/** Deploys manager for this application */
-	deploys = new ApplicationDeploysManager(this);
-	/** Cache manager for this application */
-	cache = new ApplicationCacheManager();
 
 	constructor(
 		public readonly client: SquareCloudAPI,

src/structures/application/base.ts

@@ -1,5 +1,12 @@
 import { assertPathLike, assertString } from "@/assertions/literal";
-import { ApplicationStatus, type SquareCloudAPI } from "@/index";
+import {
+	ApplicationBackupsManager,
+	ApplicationCacheManager,
+	ApplicationDeploysManager,
+	ApplicationFilesManager,
+	ApplicationStatus,
+	type SquareCloudAPI,
+} from "@/index";
 import { Routes } from "@/lib/routes";
 import type {
 	APIUserApplication,
@@ -17,11 +24,18 @@ import type { Application } from "./application";
  * @param data - The data from this application
  */
 export class BaseApplication {
+	/** The application ID */
 	id: string;
+	/** The application display name */
 	name: string;
+	/** The application description */
 	description?: string;
+	/** The url to manage the application via web */
 	url: string;
+	/** The application total ram */
 	ram: number;
+	/** The application current cluster */
+	cluster: string;
 	/**
 	 * The application programming language
 	 *
@@ -33,9 +47,18 @@ export class BaseApplication {
 	 * - `rust`
 	 * - `go`
 	 * - `php`
+	 * - `dotnet`
+	 * - `static`
 	 */
 	language: ApplicationLanguage;
-	cluster: string;
+	/** Cache manager for this application */
+	cache = new ApplicationCacheManager();
+	/** Files manager for this application */
+	files = new ApplicationFilesManager(this);
+	/** Backup manager for this application */
+	backups = new ApplicationBackupsManager(this);
+	/** Deploys manager for this application */
+	deploys = new ApplicationDeploysManager(this);
 
 	constructor(
 		public readonly client: SquareCloudAPI,

src/types/client.ts

@@ -1,6 +1,12 @@
 import EventEmitter from "events";
 import type { APIApplicationBackup } from "@squarecloud/api-types/v2";
-import type { Application, ApplicationStatus, User } from "..";
+import type {
+	Application,
+	ApplicationStatus,
+	BaseApplication,
+	User,
+	WebsiteApplication,
+} from "..";
 
 export class TypedEventEmitter<TEvents extends Record<string, any>> {
 	private emitter = new EventEmitter();
@@ -29,17 +35,17 @@ export class TypedEventEmitter<TEvents extends Record<string, any>> {
 
 export interface ClientEvents {
 	logsUpdate: [
-		application: Application,
+		application: BaseApplication | Application | WebsiteApplication,
 		before: string | undefined,
 		after: string,
 	];
 	backupsUpdate: [
-		application: Application,
+		application: BaseApplication | Application | WebsiteApplication,
 		before: APIApplicationBackup[] | undefined,
 		after: APIApplicationBackup[],
 	];
 	statusUpdate: [
-		application: Application,
+		application: BaseApplication | Application | WebsiteApplication,
 		before: ApplicationStatus | undefined,
 		after: ApplicationStatus,
 	];