refactor: divide managers into services and modules

joaotonaco · joaotonaco · commit e0405b3617f6 · 2024-07-25T22:21:39.000-03:00
diff --git a/src/index.ts b/src/index.ts
@@ -1,10 +1,6 @@
 import { assertString } from "./assertions/literal";
-import {
-	APIManager,
-	ApplicationManager,
-	CacheManager,
-	UserManager,
-} from "./managers";
+import { ApplicationModule, UserModule } from "./modules";
+import { APIService, GlobalCacheService } from "./services";
 import { type ClientEvents, TypedEventEmitter } from "./types";
 
 export class SquareCloudAPI extends TypedEventEmitter<ClientEvents> {
@@ -13,14 +9,15 @@ export class SquareCloudAPI extends TypedEventEmitter<ClientEvents> {
 		baseUrl: "https://api.squarecloud.app/",
 	};
 
-	public readonly api: APIManager;
+	/** The API service */
+	public readonly api: APIService;
 
-	/** The applications manager */
-	public applications = new ApplicationManager(this);
-	/** The users manager */
-	public users = new UserManager(this);
-	/** The global cache manager */
-	public cache = new CacheManager();
+	/** The applications module */
+	public applications = new ApplicationModule(this);
+	/** The users module */
+	public users = new UserModule(this);
+	/** The global cache service */
+	public cache = new GlobalCacheService();
 
 	/**
 	 * Creates an API instance
@@ -31,10 +28,10 @@ export class SquareCloudAPI extends TypedEventEmitter<ClientEvents> {
 		super();
 
 		assertString(apiKey, "API_KEY");
-		this.api = new APIManager(apiKey);
+		this.api = new APIService(apiKey);
 	}
 }
 
-export * from "./managers";
+export * from "./services";
 export * from "./structures";
 export * from "./types";
diff --git a/src/managers/application/cache.ts b/src/managers/application/cache.ts
diff --git a/src/managers/cache.ts b/src/managers/cache.ts
diff --git a/src/managers/index.ts b/src/managers/index.ts
diff --git a/src/modules/application.ts b/src/modules/application.ts
@@ -1,19 +1,19 @@
 import { assertPathLike, assertString } from "@/assertions/literal";
+import { Routes } from "@/lib/routes";
 import {
 	Application,
 	type BaseApplication,
 	type Collection,
 	SimpleApplicationStatus,
-	type SquareCloudAPI,
 	SquareCloudAPIError,
 	User,
-} from "@/index";
-import { Routes } from "@/lib/routes";
+} from "@/structures";
 import type { RESTPostAPIApplicationUploadResult } from "@squarecloud/api-types/v2";
 import FormData from "form-data";
 import { readFile } from "fs/promises";
+import type { SquareCloudAPI } from "..";
 
-export class ApplicationManager {
+export class ApplicationModule {
 	constructor(public readonly client: SquareCloudAPI) {}
 
 	/**
@@ -100,7 +100,7 @@ export class ApplicationManager {
 }
 
 export * from "./backups";
-export * from "./cache";
+export * from "../services/cache/application";
 export * from "./deploys";
 export * from "./files";
 export * from "./network";
diff --git a/src/modules/backups.ts b/src/modules/backups.ts
@@ -1,11 +1,11 @@
-import { type BaseApplication, SquareCloudAPIError } from "@/index";
 import { Routes } from "@/lib/routes";
+import { type BaseApplication, SquareCloudAPIError } from "@/structures";
 import type {
 	APIApplicationBackup,
 	RESTPostAPIApplicationBackupResult,
 } from "@squarecloud/api-types/v2";
 
-export class ApplicationBackupsManager {
+export class BackupsModule {
 	constructor(public readonly application: BaseApplication) {}
 
 	async list(): Promise<APIApplicationBackup[]> {
diff --git a/src/modules/deploys.ts b/src/modules/deploys.ts
@@ -1,8 +1,8 @@
 import { assertString } from "@/assertions/literal";
-import type { BaseApplication } from "@/index";
 import { Routes } from "@/lib/routes";
+import type { BaseApplication } from "@/structures";
 
-export class ApplicationDeploysManager {
+export class DeploysModule {
 	constructor(public readonly application: BaseApplication) {}
 
 	/**
diff --git a/src/modules/files.ts b/src/modules/files.ts
@@ -1,10 +1,10 @@
 import { join } from "path";
 import { assertPathLike, assertString } from "@/assertions/literal";
-import type { BaseApplication } from "@/index";
 import { Routes } from "@/lib/routes";
+import type { BaseApplication } from "@/structures";
 import { readFile } from "fs/promises";
 
-export class ApplicationFilesManager {
+export class FilesModule {
 	constructor(public readonly application: BaseApplication) {}
 
 	/**
diff --git a/src/modules/index.ts b/src/modules/index.ts
@@ -0,0 +1,6 @@
+export * from "./application";
+export * from "./backups";
+export * from "./deploys";
+export * from "./files";
+export * from "./network";
+export * from "./user";
diff --git a/src/modules/network.ts b/src/modules/network.ts
@@ -1,8 +1,8 @@
 import { assertString } from "@/assertions/literal";
-import type { WebsiteApplication } from "@/index";
 import { Routes } from "@/lib/routes";
+import type { WebsiteApplication } from "@/structures";
 
-export class ApplicationNetworkManager {
+export class NetworkModule {
 	constructor(public readonly application: WebsiteApplication) {}
 
 	/**
diff --git a/src/modules/user.ts b/src/modules/user.ts
@@ -1,7 +1,8 @@
 import { Routes } from "@/lib/routes";
-import { type SquareCloudAPI, User } from "..";
+import { User } from "@/structures";
+import type { SquareCloudAPI } from "..";
 
-export class UserManager {
+export class UserModule {
 	constructor(public readonly client: SquareCloudAPI) {}
 
 	/**
diff --git a/src/services/api.ts b/src/services/api.ts
@@ -1,13 +1,13 @@
+import { SquareCloudAPIError } from "@/structures";
+import type {
+	APIEndpoint,
+	APIRequestArgs,
+	APIRequestOptions,
+	APIResponse,
+} from "@/types";
 import type { APIVersion } from "@squarecloud/api-types/v2";
-import {
-	type APIEndpoint,
-	type APIRequestArgs,
-	type APIRequestOptions,
-	type APIResponse,
-	SquareCloudAPIError,
-} from "..";
 
-export class APIManager {
+export class APIService {
 	public readonly baseUrl = "https://api.squarecloud.app";
 	public readonly version: APIVersion<1 | 2> = "v2";
 
diff --git a/src/services/cache/application.ts b/src/services/cache/application.ts
@@ -0,0 +1,29 @@
+import type { ApplicationStatus } from "@/structures";
+import type { APIApplicationBackup } from "@squarecloud/api-types/v2";
+import { BaseCacheService } from "./base";
+
+export interface ApplicationCache {
+	readonly status?: ApplicationStatus;
+	readonly backups?: APIApplicationBackup[];
+	readonly logs?: string;
+}
+
+export class ApplicationCacheService extends BaseCacheService<ApplicationCache> {
+	protected defaults: ApplicationCache = {
+		status: undefined,
+		backups: undefined,
+		logs: undefined,
+	};
+
+	get status() {
+		return this.cache.status;
+	}
+
+	get backups() {
+		return this.cache.backups;
+	}
+
+	get logs() {
+		return this.cache.logs;
+	}
+}
diff --git a/src/services/cache/base.ts b/src/services/cache/base.ts
@@ -0,0 +1,19 @@
+export class BaseCacheService<
+	Struct extends object,
+	Keys extends keyof Struct = keyof Struct,
+> {
+	protected cache: Struct;
+	protected defaults: Struct;
+
+	set<T extends Keys>(key: T, value: Struct[T]) {
+		Reflect.set(this, key, value);
+	}
+
+	get<T extends Keys>(key: T): Struct[T] {
+		return this.cache[key];
+	}
+
+	clear() {
+		Reflect.set(this, "cache", this.defaults);
+	}
+}
diff --git a/src/services/cache/global.ts b/src/services/cache/global.ts
@@ -0,0 +1,16 @@
+import type { User } from "@/structures";
+import { BaseCacheService } from "./base";
+
+export interface GlobalCache {
+	readonly user?: User;
+}
+
+export class GlobalCacheService extends BaseCacheService<GlobalCache> {
+	protected defaults: GlobalCache = {
+		user: undefined,
+	};
+
+	get user() {
+		return this.cache.user;
+	}
+}
diff --git a/src/services/index.ts b/src/services/index.ts
@@ -0,0 +1,3 @@
+export * from "./api";
+export * from "./cache/global";
+export * from "./cache/application";
diff --git a/src/structures/application/application.ts b/src/structures/application/application.ts
@@ -1,7 +1,8 @@
 import { assertApplication } from "@/assertions/application";
-import type { SquareCloudAPI, WebsiteApplication } from "@/index";
+import type { SquareCloudAPI } from "@/index";
 import type { APIApplication } from "@squarecloud/api-types/v2";
 import { BaseApplication } from "./base";
+import type { WebsiteApplication } from "./website";
 
 /**
  * Represents a Square Cloud application
diff --git a/src/structures/application/base.ts b/src/structures/application/base.ts
@@ -1,13 +1,10 @@
 import { assertPathLike, assertString } from "@/assertions/literal";
-import {
-	ApplicationBackupsManager,
-	ApplicationCacheManager,
-	ApplicationDeploysManager,
-	ApplicationFilesManager,
-	ApplicationStatus,
-	type SquareCloudAPI,
-} from "@/index";
+
+import type { SquareCloudAPI } from "@/index";
 import { Routes } from "@/lib/routes";
+import { BackupsModule, DeploysModule, FilesModule } from "@/modules";
+import { ApplicationCacheService } from "@/services";
+import { ApplicationStatus } from "@/structures";
 import type {
 	APIUserApplication,
 	ApplicationLanguage,
@@ -51,14 +48,14 @@ export class BaseApplication {
 	 * - `static`
 	 */
 	language: ApplicationLanguage;
-	/** 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);
+	/** Cache service for this application */
+	cache = new ApplicationCacheService();
+	/** Files module for this application */
+	files = new FilesModule(this);
+	/** Backup module for this application */
+	backups = new BackupsModule(this);
+	/** Deploys module for this application */
+	deploys = new DeploysModule(this);
 
 	constructor(
 		public readonly client: SquareCloudAPI,
diff --git a/src/structures/application/website.ts b/src/structures/application/website.ts
@@ -1,6 +1,6 @@
 import { assertWebsiteApplication } from "@/assertions/application";
 import type { SquareCloudAPI } from "@/index";
-import { ApplicationNetworkManager } from "@/managers";
+import { NetworkModule } from "@/modules";
 import type { APIWebsiteApplication } from "@squarecloud/api-types/v2";
 import { Application } from "./application";
 
@@ -16,8 +16,8 @@ export class WebsiteApplication extends Application {
 	domain: string;
 	/** The custom configured domain (e.g. yoursite.com) */
 	custom?: string;
-	/** Network manager for this application */
-	network = new ApplicationNetworkManager(this);
+	/** Network module for this application */
+	network = new NetworkModule(this);
 
 	constructor(
 		public readonly client: SquareCloudAPI,
diff --git a/src/structures/user.ts b/src/structures/user.ts
@@ -1,8 +1,9 @@
 import { assertUserInfo } from "@/assertions/user";
 import type { UserPlan } from "@/types/user";
 import type { APIUserInfo } from "@squarecloud/api-types/v2";
-import { Collection, type SquareCloudAPI } from "..";
+import type { SquareCloudAPI } from "..";
 import { BaseApplication } from "./application/base";
+import { Collection } from "./collection";
 
 /**
  * Represents a Square Cloud user
diff --git a/src/types/client.ts b/src/types/client.ts
@@ -1,12 +1,12 @@
 import EventEmitter from "events";
-import type { APIApplicationBackup } from "@squarecloud/api-types/v2";
 import type {
 	Application,
 	ApplicationStatus,
 	BaseApplication,
 	User,
 	WebsiteApplication,
-} from "..";
+} from "@/structures";
+import type { APIApplicationBackup } from "@squarecloud/api-types/v2";
 
 export class TypedEventEmitter<TEvents extends Record<string, any>> {
 	private emitter = new EventEmitter();
