create objects manager list method

Author: joaotonaco

.changeset/thin-foxes-laugh.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": minor
+---
+
+Add `BlobObjectsManager#list` method for listing blobs

src/assertions/list.ts

@@ -0,0 +1,12 @@
+import { listObjectsResponseSchema } from "../schemas/list";
+import type { ListObjectsResponse } from "../types/list";
+import { handleAPIObjectAssertion } from "./handlers";
+
+export function assertListObjectsResponse(value: unknown): ListObjectsResponse {
+	return handleAPIObjectAssertion({
+		schema: listObjectsResponseSchema,
+		code: "LIST_OBJECTS",
+		route: "/list",
+		value,
+	});
+}

src/managers/objects.ts

@@ -1,5 +1,6 @@
 import { readFile } from "fs/promises";
 import type { SquareCloudBlob } from "..";
+import { assertListObjectsResponse } from "../assertions/list";
 import { assertPutObjectResponse } from "../assertions/put";
 import { putObjectPayloadSchema } from "../schemas/put";
 import { SquareCloudBlobError } from "../structures/error";
@@ -8,6 +9,21 @@ import type { PutObjectResponse, PutObjectType } from "../types/put";
 export class BlobObjectsManager {
 	constructor(private readonly client: SquareCloudBlob) {}
 
+	/**
+	 * Lists all objects in the storage.
+	 *
+	 * @example
+	 * ```js
+	 * const objects = await blob.objects.list();
+	 * ```
+	 */
+	async list() {
+		const { response } =
+			await this.client.api.request<PutObjectResponse>("list");
+
+		return assertListObjectsResponse(response);
+	}
+
 	/**
 	 * Uploads an object to the storage.
 	 *

src/schemas/list.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+
+export const listObjectSchema = z.object({
+	name: z.string(),
+	size: z.number(),
+	created_at: z.coerce.date(),
+	expire_at: z.coerce.date().optional(),
+});
+
+export const listObjectsResponseSchema = z.array(listObjectSchema);

src/types/list.ts

@@ -0,0 +1,4 @@
+import type { z } from "zod";
+import type { listObjectsResponseSchema } from "../schemas/list";
+
+export type ListObjectsResponse = z.infer<typeof listObjectsResponseSchema>;