refactor(validation): replace zod schemas with type interfaces and utility functions

Author: joaotonaco

src/managers/objects.ts

@@ -1,11 +1,14 @@
 import type { SquareCloudBlob } from "..";
+import { SquareCloudBlobError } from "../structures/error";
 import { BlobObject } from "../structures/object";
-import type { CreateObjectResponse, CreateObjectType } from "../types/create";
+import type {
+	CreateObjectOptions,
+	CreateObjectResponse,
+} from "../types/create";
 import type { ListObjectsResponse, ListObjectsType } from "../types/list";
 import { parsePathLike } from "../utils/path-like";
-import { assertCreateObjectResponse } from "../validation/assertions/create";
+import { makeCreateObjectPayload } from "../utils/payloads";
 import { assertListObjectsResponse } from "../validation/assertions/list";
-import { createObjectPayloadSchema } from "../validation/schemas/create";
 import { listObjectsPayloadSchema } from "../validation/schemas/list";
 
 export class ObjectsManager {
@@ -46,7 +49,7 @@ export class ObjectsManager {
 	/**
 	 * Uploads an object to the storage.
 	 *
-	 * @param object - An object to upload
+	 * @param data - An object to upload
 	 *
 	 * @example
 	 * ```js
@@ -64,24 +67,29 @@ export class ObjectsManager {
 	 * })
 	 * ```
 	 */
-	async create(object: CreateObjectType) {
-		const payload = createObjectPayloadSchema.parse(object);
+	async create(data: CreateObjectOptions) {
+		if (data.file instanceof Buffer && !data.mimeType) {
+			throw new SquareCloudBlobError(
+				"MIME_TYPE_REQUIRED",
+				"Mime type is required when using a Buffer",
+			);
+		}
+
+		const payload = makeCreateObjectPayload(data);
 		const file = await parsePathLike(payload.file);
-		const type = payload.mimeType || object.mimeType;
+		const type = payload.mimeType || data.mimeType;
 
 		const formData = new FormData();
-		formData.append("file", new Blob([file], { type }));
+		formData.append("file", new Blob([new Uint8Array(file)], { type }));
 
 		const { response } = await this.client.api.request<CreateObjectResponse>(
 			"objects",
 			{ method: "POST", body: formData, params: payload.params },
 		);
 
-		const objectData = assertCreateObjectResponse(response);
-
 		return new BlobObject({
-			idOrUrl: objectData.id,
-			size: objectData.size,
+			idOrUrl: response.id,
+			size: response.size,
 		});
 	}
 

src/types/create.ts

@@ -1,8 +1,37 @@
-import type { z } from "zod";
-import type {
-	createObjectResponseSchema,
-	createObjectSchema,
-} from "../validation/schemas/create";
+import type { MimeTypes } from "../utils/mimetype";
 
-export type CreateObjectType = z.infer<typeof createObjectSchema>;
-export type CreateObjectResponse = z.infer<typeof createObjectResponseSchema>;
+export interface 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)
+	 */
+	name: string;
+	/** Use absolute path, Buffer or Blob */
+	file: string | Buffer;
+	/**
+	 * A string representing the prefix for the file.
+	 * Must adhere to the a to z, A to Z, 0 to 9, and _ pattern. (3 to 32 characters)
+	 */
+	prefix?: string;
+	/** A string representing the MIME type of the file. */
+	mimeType?: MimeTypes;
+	/** A number indicating the expiration period of the file, ranging from 1 to 365 days. */
+	expiresIn?: number;
+	/** Set to true if a security hash is required. */
+	securityHash?: boolean;
+	/** Set to true if the file should be set for automatic download. */
+	autoDownload?: boolean;
+}
+
+export interface CreateObjectResponse {
+	/** The id of the uploaded file. */
+	id: string;
+	/** The name of the uploaded file. */
+	name: string;
+	/** The size of the uploaded file. */
+	size: number;
+	/** The URL of the uploaded file. (File distributed in Square Cloud CDN) */
+	url: string;
+	/** The prefix of the uploaded file. */
+	prefix?: string;
+}

src/utils/payloads.ts

@@ -0,0 +1,24 @@
+import type { CreateObjectOptions } from "../types/create";
+import { MimeTypeUtil } from "./mimetype";
+
+export function makeCreateObjectPayload({
+	file,
+	securityHash,
+	autoDownload,
+	expiresIn,
+	...rest
+}: CreateObjectOptions) {
+	return {
+		file,
+		mimeType:
+			typeof file === "string"
+				? MimeTypeUtil.fromExtension(file.split(".")[1])
+				: undefined,
+		params: {
+			...rest,
+			expire: expiresIn,
+			security_hash: securityHash,
+			auto_download: autoDownload,
+		},
+	};
+}

src/validation/assertions/create.ts

@@ -1,9 +1,9 @@
-import { type CreateObjectType, MimeTypes } from "../src";
+import { type CreateObjectOptions, MimeTypes } from "../src";
 import { blob } from "./index.test";
 
 // Create object using absolute path
 
-const createWithPathPayload: CreateObjectType = {
+const createWithPathPayload: CreateObjectOptions = {
 	file: "package.json",
 	name: "testing",
 };
@@ -12,7 +12,7 @@ blob.objects.create(createWithPathPayload).then(console.log);
 
 // Create object using buffer
 
-const createWithBufferPayload: CreateObjectType = {
+const createWithBufferPayload: CreateObjectOptions = {
 	file: Buffer.from("content".repeat(100)),
 	name: "testing",
 	mimeType: MimeTypes.TEXT_PLAIN,