refactor(list-objects): remove response validation

Author: joaotonaco

src/managers/objects.ts

@@ -5,11 +5,9 @@ import type {
 	CreateObjectOptions,
 	CreateObjectResponse,
 } from "../types/create";
-import type { ListObjectsResponse, ListObjectsType } from "../types/list";
+import type { ListObjectsOptions, ListObjectsResponse } from "../types/list";
 import { parsePathLike } from "../utils/path-like";
 import { makeCreateObjectPayload } from "../utils/payloads";
-import { assertListObjectsResponse } from "../validation/assertions/list";
-import { listObjectsPayloadSchema } from "../validation/schemas/list";
 
 export class ObjectsManager {
 	constructor(private readonly client: SquareCloudBlob) {}
@@ -22,14 +20,11 @@ export class ObjectsManager {
 	 * blob.objects.list();
 	 * ```
 	 */
-	async list(options?: ListObjectsType) {
-		const payload = listObjectsPayloadSchema.parse(options);
-
-		const response = await this.client.api.request<ListObjectsResponse>(
+	async list(options?: ListObjectsOptions) {
+		const { objects } = await this.client.api.request<ListObjectsResponse>(
 			"objects",
-			{ params: payload.params },
+			{ params: options },
 		);
-		const { objects } = assertListObjectsResponse(response);
 
 		return objects.map((objectData) => {
 			const createdAt = new Date(objectData.created_at);
@@ -49,7 +44,7 @@ export class ObjectsManager {
 	/**
 	 * Uploads an object to the storage.
 	 *
-	 * @param data - An object to upload
+	 * @param options - An object to upload
 	 *
 	 * @example
 	 * ```js
@@ -67,17 +62,17 @@ export class ObjectsManager {
 	 * })
 	 * ```
 	 */
-	async create(data: CreateObjectOptions) {
-		if (data.file instanceof Buffer && !data.mimeType) {
+	async create(options: CreateObjectOptions) {
+		if (options.file instanceof Buffer && !options.mimeType) {
 			throw new SquareCloudBlobError(
 				"MIME_TYPE_REQUIRED",
 				"Mime type is required when using a Buffer",
 			);
 		}
 
-		const payload = makeCreateObjectPayload(data);
+		const payload = makeCreateObjectPayload(options);
 		const file = await parsePathLike(payload.file);
-		const type = payload.mimeType || data.mimeType;
+		const type = payload.mimeType || options.mimeType;
 
 		const formData = new FormData();
 		formData.append("file", new Blob([new Uint8Array(file)], { type }));

src/types/create.ts

@@ -1,6 +1,6 @@
 import type { MimeTypes } from "../utils/mimetype";
 
-export interface CreateObjectOptions {
+export type CreateObjectOptions = {
 	/**
 	 * A string representing the name of the file.
 	 * Must adhere to the a to z, A to Z, 0 to 9, and _ pattern. (3 to 32 characters)
@@ -21,9 +21,9 @@ export interface CreateObjectOptions {
 	securityHash?: boolean;
 	/** Set to true if the file should be set for automatic download. */
 	autoDownload?: boolean;
-}
+};
 
-export interface CreateObjectResponse {
+export type CreateObjectResponse = {
 	/** The id of the uploaded file. */
 	id: string;
 	/** The name of the uploaded file. */
@@ -34,4 +34,4 @@ export interface CreateObjectResponse {
 	url: string;
 	/** The prefix of the uploaded file. */
 	prefix?: string;
-}
+};

src/types/list.ts

@@ -1,8 +1,15 @@
-import type { z } from "zod";
-import type {
-	listObjectsResponseSchema,
-	listObjectsSchema,
-} from "../validation/schemas/list";
+export type ListObjectsOptions = {
+	prefix?: string;
+	continuationToken?: string;
+};
 
-export type ListObjectsType = z.infer<typeof listObjectsSchema>;
-export type ListObjectsResponse = z.infer<typeof listObjectsResponseSchema>;
+export type ListedObject = {
+	id: string;
+	size: number;
+	created_at: Date;
+	expires_at?: Date;
+};
+
+export type ListObjectsResponse = {
+	objects: ListedObject[];
+};

src/types/object.ts

@@ -1,6 +1,6 @@
-export interface BlobObjectData {
+export type BlobObjectData = {
 	idOrUrl: string;
 	size: number;
 	expiresAt?: Date;
 	createdAt?: Date;
-}
+};

src/types/stats.ts

@@ -1,4 +1,4 @@
-export interface StatsResponse {
+export type StatsResponse = {
 	usage: {
 		/** The total number of objects in your account. */
 		objects: number;
@@ -19,4 +19,4 @@ export interface StatsResponse {
 		/** The total estimate of all objects, storage and extra storage in your account, in BRL. */
 		totalEstimate: number;
 	};
-}
+};

src/validation/assertions/list.ts

@@ -1,7 +1,7 @@
-import type { ListObjectsType } from "../src";
+import type { ListObjectsOptions } from "../src";
 import { blob } from "./index.test";
 
-const listOptions: ListObjectsType = {
+const listOptions: ListObjectsOptions = {
 	prefix: "test",
 };