refactor: rename backups to snapshots

Author: joaotonaco

.changeset/smooth-places-hunt.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/api": minor
+---
+
+Rename `backups` to `snapshots`. The old `backups` property will be removed in the next major release.

package.json

@@ -3,18 +3,16 @@
   "version": "3.7.9",
   "description": "A NodeJS wrapper for Square Cloud API",
   "exports": {
-    ".": {
-      "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./lib/index.d.cts",
-        "default": "./lib/index.cjs"
-      },
+    "import": {
       "types": "./lib/index.d.ts",
       "default": "./lib/index.js"
-    }
+    },
+    "require": {
+      "types": "./lib/index.d.cts",
+      "default": "./lib/index.cjs"
+    },
+    "types": "./lib/index.d.ts",
+    "default": "./lib/index.js"
   },
   "packageManager": "pnpm@10.11.1",
   "type": "module",

src/modules/applications.ts

@@ -102,7 +102,7 @@ export class ApplicationsModule {
 }
 
 export * from "../services/cache/application";
-export * from "./backups";
 export * from "./deploys";
 export * from "./files";
 export * from "./network";
+export * from "./snapshots";

src/modules/index.ts

@@ -1,6 +1,6 @@
 export * from "./applications";
-export * from "./backups";
 export * from "./deploys";
 export * from "./files";
 export * from "./network";
+export * from "./snapshots";
 export * from "./user";

src/modules/backups.ts src/modules/snapshots.tssrc/modules/backups.ts renamed to src/modules/snapshots.ts

@@ -2,37 +2,37 @@ import type { RESTPostAPISnapshotResult } from "@squarecloud/api-types/v2";
 
 import { Routes } from "@/lib/routes";
 import { type BaseApplication, SquareCloudAPIError } from "@/structures";
-import { Backup } from "@/structures/backup";
+import { Snapshot } from "@/structures/snapshot";
 
-export class BackupsModule {
+export class SnapshotsModule {
   constructor(public readonly application: BaseApplication) {}
 
   /**
-   * Gets the list of generated backups (snapshots) for this application
+   * Gets the list of generated snapshots for this application
    */
-  async list(): Promise<Backup[]> {
+  async list(): Promise<Snapshot[]> {
     const data = await this.application.client.api.request(
       Routes.apps.snapshots(this.application.id),
     );
 
-    const backups = data.response.map(
-      (backup) => new Backup(this.application, backup),
+    const snapshots = data.response.map(
+      (snapshot) => new Snapshot(this.application, snapshot),
     );
 
     this.application.client.emit(
-      "backupsUpdate",
+      "snapshotsUpdate",
       this.application,
-      this.application.cache.backups,
-      backups,
+      this.application.cache.snapshots,
+      snapshots,
     );
-    this.application.cache.set("backups", backups);
+    this.application.cache.set("snapshots", snapshots);
 
-    return backups;
+    return snapshots;
   }
 
   /**
-   * Generates a new backup
-   * @returns The generated backup URL and key
+   * Generates a new snapshot
+   * @returns The generated snapshot URL and key
    */
   async create(): Promise<RESTPostAPISnapshotResult> {
     const data = await this.application.client.api.request(
@@ -44,18 +44,18 @@ export class BackupsModule {
   }
 
   /**
-   * Generates a new backup and downloads it
-   * @returns The downloaded backup bufer
+   * Generates a new snapshot and downloads it
+   * @returns The downloaded snapshot buffer
    */
   async download(): Promise<Buffer> {
-    const backup = await this.create();
+    const snapshot = await this.create();
 
-    const res = await fetch(backup.url)
+    const res = await fetch(snapshot.url)
       .then((res) => res.arrayBuffer())
       .catch(() => undefined);
 
     if (!res) {
-      throw new SquareCloudAPIError("BACKUP_DOWNLOAD_FAILED");
+      throw new SquareCloudAPIError("SNAPSHOT_DOWNLOAD_FAILED");
     }
 
     return Buffer.from(res);

src/services/cache/application.ts

@@ -1,27 +1,27 @@
 import type { ApplicationStatus } from "@/structures";
-import type { Backup } from "@/structures/backup";
+import type { Snapshot } from "@/structures/snapshot";
 
 import { BaseCacheService } from "./base";
 
 export interface ApplicationCache {
   readonly status?: ApplicationStatus;
-  readonly backups?: Backup[];
+  readonly snapshots?: Snapshot[];
   readonly logs?: string;
 }
 
 export class ApplicationCacheService extends BaseCacheService<ApplicationCache> {
   protected cache: ApplicationCache = {
     status: undefined,
-    backups: undefined,
+    snapshots: undefined,
     logs: undefined,
   };
 
   get status() {
     return this.cache.status;
   }
 
-  get backups() {
-    return this.cache.backups;
+  get snapshots() {
+    return this.cache.snapshots;
   }
 
   get logs() {

src/structures/application/base.ts

@@ -7,7 +7,7 @@ import { readFile } from "fs/promises";
 import type { SquareCloudAPI } from "@/index";
 import { assertPathLike, assertString } from "@/assertions/literal";
 import { Routes } from "@/lib/routes";
-import { BackupsModule, DeploysModule, FilesModule } from "@/modules";
+import { DeploysModule, FilesModule, SnapshotsModule } from "@/modules";
 import { ApplicationCacheService } from "@/services";
 import { ApplicationStatus } from "@/structures";
 
@@ -49,8 +49,8 @@ export class BaseApplication {
   public readonly cache = new ApplicationCacheService();
   /** Files module for this application */
   public readonly files = new FilesModule(this);
-  /** Backup module for this application */
-  public readonly backups = new BackupsModule(this);
+  /** Snapshots module for this application */
+  public readonly snapshots = new SnapshotsModule(this);
   /** Deploys module for this application */
   public readonly deploys = new DeploysModule(this);
 
@@ -76,12 +76,20 @@ export class BaseApplication {
     this.url = `https://squarecloud.app/dashboard/app/${id}`;
   }
 
-  /** @deprecated Use `Application#backups` instead */
+  /** @deprecated Use `Application#snapshots` instead */
   get backup() {
     console.warn(
-      "[SquareCloudAPI] The 'backup' property is deprecated and will be removed in the the next major version. Use Application#backups instead.",
+      "[SquareCloudAPI] The 'backup' property is deprecated and will be removed in the next major version. Use Application#snapshots instead.",
     );
-    return this.backups;
+    return this.snapshots;
+  }
+
+  /** @deprecated Use `Application#snapshots` instead */
+  get backups() {
+    console.warn(
+      "[SquareCloudAPI] The 'backups' property is deprecated and will be removed in the next major version. Use Application#snapshots instead.",
+    );
+    return this.snapshots;
   }
 
   /**

src/structures/index.ts

@@ -1,9 +1,9 @@
 export * from "./application/application";
 export * from "./application/base";
 export * from "./application/website";
-export * from "./backup";
 export * from "./collection";
 export * from "./deploy";
 export * from "./error";
+export * from "./snapshot";
 export * from "./status";
 export * from "./user";

src/structures/backup.ts src/structures/snapshot.tssrc/structures/backup.ts renamed to src/structures/snapshot.ts

@@ -3,30 +3,30 @@ import type { APISnapshot } from "@squarecloud/api-types/v2";
 import type { BaseApplication } from "./application/base";
 
 /**
- * Represents an application backup (snapshot)
+ * Represents an application snapshot
  */
-export class Backup {
-  /** Size of the backup in bytes. */
+export class Snapshot {
+  /** Size of the snapshot in bytes. */
   public size: number;
 
-  /** Date of the last modification of the backup. */
+  /** Date of the last modification of the snapshot. */
   public modifiedAt: Date;
 
-  /** Date of the last modification of the backup in millisseconds. */
+  /** Date of the last modification of the snapshot in millisseconds. */
   public modifiedTimestamp: number;
 
-  /** AWS access key for the backup. */
+  /** AWS access key for the snapshot. */
   public readonly key: string;
 
-  /** The URL for downloading this backup */
+  /** The URL for downloading this snapshot */
   public readonly url: string;
 
   /**
-   * Represents an application backup (snapshot)
+   * Represents an application snapshot
    *
    * @constructor
-   * @param application - The application from which you fetched the backups
-   * @param data - The data from this backup
+   * @param application - The application from which you fetched the snapshots
+   * @param data - The data from this snapshot
    */
   constructor(
     public readonly application: BaseApplication,
@@ -43,18 +43,23 @@ export class Backup {
   }
 
   /**
-   * Downloads this backup
-   * @returns The downloaded backup bufer
+   * Downloads this snapshot
+   * @returns The downloaded snapshot bufer
    */
   async download(): Promise<Buffer> {
     const res = await fetch(this.url)
       .then((res) => res.arrayBuffer())
       .catch(() => undefined);
 
     if (!res) {
-      throw new Error("BACKUP_DOWNLOAD_FAILED");
+      throw new Error("SNAPSHOT_DOWNLOAD_FAILED");
     }
 
     return Buffer.from(res);
   }
 }
+
+/**
+ * @deprecated Use Snapshot instead.
+ */
+export class Backup extends Snapshot {}

src/types/client.ts

@@ -7,7 +7,7 @@ import type {
   User,
   WebsiteApplication,
 } from "@/structures";
-import type { Backup } from "@/structures/backup";
+import type { Snapshot } from "@/structures/snapshot";
 
 export class TypedEventEmitter<TEvents extends Record<string, any>> {
   private emitter = new EventEmitter();
@@ -40,10 +40,10 @@ export interface ClientEvents {
     before: string | undefined,
     after: string,
   ];
-  backupsUpdate: [
+  snapshotsUpdate: [
     application: BaseApplication | Application | WebsiteApplication,
-    before: Backup[] | undefined,
-    after: Backup[],
+    before: Snapshot[] | undefined,
+    after: Snapshot[],
   ];
   statusUpdate: [
     application: BaseApplication | Application | WebsiteApplication,