feat: create structure for deployment

Author: joaotonaco

.changeset/pink-rabbits-guess.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/api": patch
+---
+
+New structure for deployments. It's used at `deploys.list()` method.

src/assertions/deploy.ts

@@ -0,0 +1,21 @@
+import { DeploymentState } from "@squarecloud/api-types/v2";
+import { z } from "zod";
+
+import { assertAPIObject } from "./common";
+
+const DeploymentSchema = z.object({
+	id: z.string(),
+	state: z.nativeEnum(DeploymentState),
+	date: z.coerce.date(),
+});
+
+export function assertDeployment(
+	value: unknown,
+): asserts value is z.infer<typeof DeploymentSchema> {
+	assertAPIObject({
+		schema: DeploymentSchema,
+		value,
+		code: "DEPLOYMENT",
+		route: "/apps/{app_id}/deployments",
+	});
+}

src/modules/deploys.ts

@@ -1,6 +1,7 @@
 import { assertString } from "@/assertions/literal";
 import { Routes } from "@/lib/routes";
 import type { BaseApplication } from "@/structures";
+import { Deployment } from "@/structures/deploy";
 
 export class DeploysModule {
 	constructor(public readonly application: BaseApplication) {}
@@ -29,7 +30,9 @@ export class DeploysModule {
 			Routes.apps.deployments.list(this.application.id),
 		);
 
-		return data.response;
+		return data.response.map(
+			(deployment) => new Deployment(this.application, deployment),
+		);
 	}
 
 	/**

src/structures/deploy.ts

@@ -0,0 +1,31 @@
+import type { APIDeployment, DeploymentState } from "@squarecloud/api-types/v2";
+
+import { assertDeployment } from "@/assertions/deploy";
+import type { BaseApplication } from "./application/base";
+
+export class Deployment {
+	/** The ID of the deploy. */
+	id: `git-${string}`;
+
+	/** The current state of the deploy. */
+	state: DeploymentState;
+
+	/** The date the deploy was created. */
+	createdAt: Date;
+
+	/** The date the deploy was created in millisseconds. */
+	createdTimestamp: number;
+
+	constructor(
+		public readonly application: BaseApplication,
+		data: APIDeployment,
+	) {
+		assertDeployment(data);
+		const { id, state, date } = data;
+
+		this.id = id;
+		this.state = state;
+		this.createdAt = new Date(date);
+		this.createdTimestamp = this.createdAt.getTime();
+	}
+}