add options to objects.list

Author: joaotonaco

.changeset/dirty-pillows-rescue.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": minor
+---
+
+Add `options` parameter for `objects.list`

src/managers/objects.ts

@@ -1,11 +1,12 @@
 import type { SquareCloudBlob } from "..";
 import { BlobObject } from "../structures/object";
 import type { CreateObjectResponse, CreateObjectType } from "../types/create";
-import type { ListObjectsResponse } from "../types/list";
+import type { ListObjectsResponse, ListObjectsType } from "../types/list";
 import { parsePathLike } from "../utils/path-like";
 import { assertCreateObjectResponse } from "../validation/assertions/create";
 import { assertListObjectsResponse } from "../validation/assertions/list";
 import { createObjectPayloadSchema } from "../validation/schemas/create";
+import { listObjectsPayloadSchema } from "../validation/schemas/list";
 
 export class ObjectsManager {
 	constructor(private readonly client: SquareCloudBlob) {}
@@ -18,16 +19,16 @@ export class ObjectsManager {
 	 * blob.objects.list();
 	 * ```
 	 */
-	async list() {
-		const { response } =
-			await this.client.api.request<ListObjectsResponse>("objects");
-		const list = assertListObjectsResponse(response);
+	async list(options?: ListObjectsType) {
+		const payload = listObjectsPayloadSchema.parse(options);
 
-		if (!list.objects) {
-			return [];
-		}
+		const { response } = await this.client.api.request<ListObjectsResponse>(
+			"objects",
+			{ params: payload.params },
+		);
+		const { objects } = assertListObjectsResponse(response);
 
-		return list.objects.map((objectData) => {
+		return objects.map((objectData) => {
 			const createdAt = new Date(objectData.created_at);
 			const expiresAt = objectData.expires_at
 				? new Date(objectData.expires_at)

src/types/list.ts

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

src/validation/schemas/list.ts

@@ -1,12 +1,21 @@
 import { z } from "zod";
 
-export const listObjectSchema = z.object({
+export const listObjectsSchema = z.object({
+	prefix: z.string().optional(),
+	continuationToken: z.string().optional(),
+});
+
+export const listObjectsPayloadSchema = listObjectsSchema
+	.optional()
+	.transform((params) => ({ params }));
+
+export const listObjectResponseSchema = z.object({
 	id: z.string(),
 	size: z.number(),
 	created_at: z.coerce.date(),
 	expires_at: z.coerce.date().optional(),
 });
 
 export const listObjectsResponseSchema = z.object({
-	objects: z.array(listObjectSchema),
+	objects: z.array(listObjectResponseSchema).default([]),
 });