chore: jsdocs

Author: joaotonaco

src/modules/applications.ts

@@ -52,6 +52,7 @@ export class ApplicationsModule {
 	 * Uploads an application
 	 *
 	 * @param file - The zip file path or Buffer
+	 *
 	 * @returns The uploaded application data
 	 */
 	async create(
@@ -76,7 +77,7 @@ export class ApplicationsModule {
 	}
 
 	/**
-	 * Returns the status for all your applications
+	 * Gets the summary status for all your applications
 	 */
 	async statusAll(): Promise<SimpleApplicationStatus[]> {
 		const data = await this.client.api.request(Routes.apps.statusAll());

src/modules/backups.ts

@@ -7,7 +7,9 @@ import { Backup } from "@/structures/backup";
 export class BackupsModule {
 	constructor(public readonly application: BaseApplication) {}
 
-	/** @returns The list of backups (snapshots) */
+	/**
+	 * Gets the list of generated backups (snapshots) for this application
+	 */
 	async list(): Promise<Backup[]> {
 		const data = await this.application.client.api.request(
 			Routes.apps.backups(this.application.id),
@@ -26,7 +28,10 @@ export class BackupsModule {
 		return backups.map((backup) => new Backup(this.application, backup));
 	}
 
-	/** @returns The generated backup URL and key */
+	/**
+	 * Generates a new backup
+	 * @returns The generated backup URL and key
+	 */
 	async create(): Promise<RESTPostAPIApplicationBackupResult> {
 		const data = await this.application.client.api.request(
 			Routes.apps.generateBackup(this.application.id),
@@ -36,7 +41,10 @@ export class BackupsModule {
 		return data.response;
 	}
 
-	/** @returns The generated backup buffer */
+	/**
+	 * Generates a new backup and downloads it
+	 * @returns The downloaded backup bufer
+	 */
 	async download(): Promise<Buffer> {
 		const backup = await this.create();
 

src/modules/network.ts

@@ -9,7 +9,7 @@ export class NetworkModule {
 	 * Integrates your website with a custom domain
 	 * - Requires [Senior plan](https://squarecloud.app/plans) or higher
 	 *
-	 * @param domain - The custom domain you want to use (e.g. yoursite.com)
+	 * @param custom - The custom domain you want to use (e.g. yoursite.com)
 	 */
 	async setCustomDomain(custom: string) {
 		assertString(custom, "CUSTOM_DOMAIN");

src/modules/user.ts

@@ -6,9 +6,7 @@ export class UserModule {
 	constructor(public readonly client: SquareCloudAPI) {}
 
 	/**
-	 * Gets a user's informations
-	 *
-	 * @param userId - The user ID, if not provided it will get your own information
+	 * Gets the authenticated user information
 	 */
 	async get(): Promise<User> {
 		const { response } = await this.client.api.request(Routes.user());

src/structures/application/application.ts

@@ -7,12 +7,15 @@ import type { WebsiteApplication } from "./website";
 
 /**
  * Represents a Square Cloud application
- *
- * @constructor
- * @param client - The client for this application
- * @param data - The data from this application
  */
 export class Application extends BaseApplication {
+	/**
+	 * Represents a Square Cloud application
+	 *
+	 * @constructor
+	 * @param client - The client for this application
+	 * @param data - The data from this application
+	 */
 	constructor(
 		public readonly client: SquareCloudAPI,
 		data: APIApplication,

src/structures/application/base.ts

@@ -15,10 +15,6 @@ import type { Application } from "./application";
 
 /**
  * Represents the base application from the user endpoint
- *
- * @constructor
- * @param client - The client for this application
- * @param data - The data from this application
  */
 export class BaseApplication {
 	/** The application ID */
@@ -57,6 +53,13 @@ export class BaseApplication {
 	/** Deploys module for this application */
 	deploys = new DeploysModule(this);
 
+	/**
+	 * Represents the base application from the user endpoint
+	 *
+	 * @constructor
+	 * @param client - The client for this application
+	 * @param data - The data from this application
+	 */
 	constructor(
 		public readonly client: SquareCloudAPI,
 		data: APIUserApplication,
@@ -80,11 +83,16 @@ export class BaseApplication {
 		return this.backups;
 	}
 
+	/**
+	 * Fetches this application for full information
+	 */
 	async fetch(): Promise<Application> {
 		return this.client.applications.fetch(this.id);
 	}
 
-	/** @returns The application current status information */
+	/**
+	 * Gets the application current status information
+	 */
 	async getStatus(): Promise<ApplicationStatus> {
 		const data = await this.client.api.request(Routes.apps.status(this.id));
 		const status = new ApplicationStatus(this.client, data.response, this.id);
@@ -95,7 +103,9 @@ export class BaseApplication {
 		return status;
 	}
 
-	/** @returns The application logs */
+	/**
+	 * Gets the application current logs
+	 */
 	async getLogs(): Promise<string> {
 		const data = await this.client.api.request(Routes.apps.logs(this.id));
 		const { logs } = data.response;
@@ -108,7 +118,7 @@ export class BaseApplication {
 
 	/**
 	 * Starts up the application
-	 * @returns `true` for success or `false` for fail
+	 * @returns `boolean` for success or fail
 	 */
 	async start(): Promise<boolean> {
 		const data = await this.client.api.request(Routes.apps.start(this.id), {
@@ -120,7 +130,7 @@ export class BaseApplication {
 
 	/**
 	 * Stops the application
-	 * @returns `true` for success or `false` for fail
+	 * @returns `boolean` for success or fail
 	 */
 	async stop(): Promise<boolean> {
 		const data = await this.client.api.request(Routes.apps.stop(this.id), {
@@ -132,7 +142,7 @@ export class BaseApplication {
 
 	/**
 	 * Restarts the application
-	 * @returns `true` for success or `false` for fail
+	 * @returns `boolean` for success or fail
 	 */
 	async restart(): Promise<boolean> {
 		const data = await this.client.api.request(Routes.apps.restart(this.id), {
@@ -144,9 +154,9 @@ export class BaseApplication {
 
 	/**
 	 * Deletes your whole application
-	 *
 	 * - This action is irreversible.
-	 * @returns `true` for success or `false` for fail
+	 *
+	 * @returns `boolean` for success or fail
 	 */
 	async delete(): Promise<boolean> {
 		const data = await this.client.api.request(Routes.apps.delete(this.id), {
@@ -165,7 +175,7 @@ export class BaseApplication {
 	 * ```ts
 	 * require('path').join(__dirname, 'fileName')
 	 * ```
-	 * - Tip2: use a zip file to commit more than one archive
+	 * - Tip 2: use a zip file to commit more than one archive
 	 *
 	 * @param file - Buffer or absolute path to the file
 	 * @param fileName - The file name (e.g.: "index.js")

src/structures/application/website.ts

@@ -7,10 +7,6 @@ import { Application } from "./application";
 
 /**
  * Represents a Square Cloud application
- *
- * @constructor
- * @param client - The client for this application
- * @param data - The data from this application
  */
 export class WebsiteApplication extends Application {
 	/** The application default domain (e.g. example.squareweb.app) */
@@ -20,6 +16,13 @@ export class WebsiteApplication extends Application {
 	/** Network module for this application */
 	network = new NetworkModule(this);
 
+	/**
+	 * Represents a Square Cloud application
+	 *
+	 * @constructor
+	 * @param client - The client for this application
+	 * @param data - The data from this application
+	 */
 	constructor(
 		public readonly client: SquareCloudAPI,
 		data: APIWebsiteApplication,

src/structures/backup.ts

@@ -3,10 +3,10 @@ import type { APIApplicationBackup } from "@squarecloud/api-types/v2";
 import { assertBackup } from "@/assertions/backup";
 import type { BaseApplication } from "./application/base";
 
+/**
+ * Represents an application backup (snapshot)
+ */
 export class Backup {
-	/** The ID of the application from which you fetched the backups. */
-	applicationId: string;
-
 	/** Size of the backup in bytes. */
 	size: number;
 
@@ -22,6 +22,13 @@ export class Backup {
 	/** The URL for downloading this backup */
 	url: string;
 
+	/**
+	 * Represents an application backup (snapshot)
+	 *
+	 * @constructor
+	 * @param application - The application from which you fetched the backups
+	 * @param data - The data from this backup
+	 */
 	constructor(
 		public readonly application: BaseApplication,
 		data: APIApplicationBackup,
@@ -30,15 +37,17 @@ export class Backup {
 		const { name, size, modified, key } = data;
 		const { userId } = application.client.api;
 
-		this.applicationId = name;
 		this.size = size;
 		this.modifiedAt = new Date(modified);
 		this.modifiedTimestamp = this.modifiedAt.getTime();
 		this.key = key;
 		this.url = `https://backups.squarecloud.app/${userId}_${name}.zip?${key}`;
 	}
 
-	/** @returns The downloaded backup buffer */
+	/**
+	 * Downloads this backup
+	 * @returns The downloaded backup bufer
+	 */
 	async download(): Promise<Buffer> {
 		const res = await fetch(this.url)
 			.then((res) => res.arrayBuffer())

src/structures/deploy.ts

@@ -3,6 +3,9 @@ import type { APIDeployment, DeploymentState } from "@squarecloud/api-types/v2";
 import { assertDeployment } from "@/assertions/deploy";
 import type { BaseApplication } from "./application/base";
 
+/**
+ * Represents an application deployment
+ */
 export class Deployment {
 	/** The ID of the deploy. */
 	id: `git-${string}`;
@@ -16,6 +19,13 @@ export class Deployment {
 	/** The date the deploy was created in millisseconds. */
 	createdTimestamp: number;
 
+	/**
+	 * Represents an application deployment
+	 *
+	 * @constructor
+	 * @param application - The application from which you fetched the deployment
+	 * @param data - The data from this deployment
+	 */
 	constructor(
 		public readonly application: BaseApplication,
 		data: APIDeployment,

src/structures/status.ts

@@ -9,6 +9,9 @@ import { Routes } from "@/lib/routes";
 import type { ApplicationStatusUsage } from "@/types/application";
 import type { SquareCloudAPI } from "..";
 
+/**
+ * Represents an application status fetched from status all endpoint
+ */
 export class SimpleApplicationStatus<R extends boolean = boolean> {
 	/** The application's ID this status came from */
 	applicationId: string;
@@ -19,6 +22,13 @@ export class SimpleApplicationStatus<R extends boolean = boolean> {
 	/** Whether the application is running or not */
 	running: R;
 
+	/**
+	 * Represents an application status fetched from status all endpoint
+	 *
+	 * @constructor
+	 * @param client - The client for this status
+	 * @param data - The data from this status
+	 */
 	constructor(
 		public readonly client: SquareCloudAPI,
 		data: APIApplicationStatusAll,
@@ -39,6 +49,9 @@ export class SimpleApplicationStatus<R extends boolean = boolean> {
 		}
 	}
 
+	/**
+	 * Fetches the full application status
+	 */
 	async fetch() {
 		const data = await this.client.api.request(
 			Routes.apps.status(this.applicationId),
@@ -52,6 +65,9 @@ export class SimpleApplicationStatus<R extends boolean = boolean> {
 	}
 }
 
+/**
+ * Represents an application status
+ */
 export class ApplicationStatus {
 	/** The application's ID this status came from */
 	applicationId: string;
@@ -77,6 +93,14 @@ export class ApplicationStatus {
 	/** For how long the app is running */
 	uptime?: Date;
 
+	/**
+	 * Represents an application status
+	 *
+	 * @constructor
+	 * @param client - The client for this status
+	 * @param data - The data from this status
+	 * @param applicationId - The application ID this status came from
+	 */
 	constructor(
 		public readonly client: SquareCloudAPI,
 		data: APIApplicationStatus,