new mimeType prop for objects.put

joaotonaco · joaotonaco · commit a73de9f46a6c · 2024-06-12T21:50:19.000-03:00
diff --git a/.changeset/gorgeous-cougars-wave.md b/.changeset/gorgeous-cougars-wave.md
@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": minor
+---
+
+New `mimeType` prop for `objects.put` method, required if file is a Buffer
diff --git a/.changeset/ninety-tips-collect.md b/.changeset/ninety-tips-collect.md
diff --git a/README.md b/README.md
@@ -48,8 +48,22 @@ const objects = await blob.objects.list()
 
 ```ts
 const blobObject = await blob.objects.put({
-  file: "path/to/file.png", // Absolute path to your file, Buffer or Blob
-  name: "my_image.png" // File name with extension
+  file: "path/to/file.png", // Absolute path to your file or Buffer
+  name: "my_image",         // File name without extension
+})
+
+console.log(blobObject.url)
+```
+
+#### Advanced usage with Buffer
+
+```ts
+import { MimeTypes } from "@squarecloud/blob"
+
+const blobObject = await blob.objects.put({
+  file: Buffer.from("content"),
+  name: "my_image",
+  mimeType: MimeTypes.IMAGE_JPEG, // Also accepts an string "image/jpeg"
 })
 
 console.log(blobObject.url)
diff --git a/src/managers/objects.ts b/src/managers/objects.ts
@@ -1,11 +1,12 @@
-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";
 import type { ListObjectsResponse } from "../types/list";
 import type { PutObjectResponse, PutObjectType } from "../types/put";
+import { getMimeTypeFromExtension } from "../utils/mimetype";
+import { parsePathLike } from "../utils/pathlike";
+import { assertListObjectsResponse } from "../validation/assertions/list";
+import { assertPutObjectResponse } from "../validation/assertions/put";
+import { putObjectPayloadSchema } from "../validation/schemas/put";
 
 export class BlobObjectsManager {
 	constructor(private readonly client: SquareCloudBlob) {}
@@ -37,14 +38,22 @@ export class BlobObjectsManager {
 	 */
 	async put(object: PutObjectType) {
 		const payload = putObjectPayloadSchema.parse(object);
-		const file = await this.parseFile(payload.file);
+		const file = await parsePathLike(payload.file);
+		const mimeType =
+			typeof object.file === "string"
+				? getMimeTypeFromExtension(object.file.split(".")[1])
+				: object.mimeType;
 
 		const formData = new FormData();
-		formData.append("file", file instanceof Blob ? file : new Blob([file]));
+		formData.append("file", new Blob([file], { type: mimeType }));
 
 		const { response } = await this.client.api.request<PutObjectResponse>(
 			"put",
-			{ method: "PUT", body: formData, params: payload.params },
+			{
+				method: "PUT",
+				body: formData,
+				params: payload.params,
+			},
 		);
 
 		return assertPutObjectResponse(response);
@@ -57,7 +66,7 @@ export class BlobObjectsManager {
 	 *
 	 * @example
 	 * ```js
-	 * await blob.objects.delete("ID/prefix/name1_xxx-xxx.zip", "ID/prefix/name_xxx-xxx-xxx.png");
+	 * await blob.objects.delete("ID/prefix/name1_xxx-xxx.mp4", "ID/prefix/name_xxx-xxx-xxx.png");
 	 * ```
 	 */
 	async delete(...objects: string[] | string[][]) {
@@ -71,20 +80,11 @@ export class BlobObjectsManager {
 		return response.status === "success";
 	}
 
-	private async parseFile(file: string | Buffer | Blob) {
-		let result: Buffer | Blob | undefined;
-
-		if (typeof file === "string") {
-			result = await readFile(file).catch(() => undefined);
-		}
-
-		if (!result) {
-			throw new SquareCloudBlobError("INVALID_FILE", "File not found");
-		}
-
-		return result;
-	}
-
+	/**
+	 * Parses the object URL to extract id, prefix, and name.
+	 *
+	 * @param url - The object URL to parse.
+	 */
 	parseObjectUrl(url: string) {
 		const pattern =
 			/^https:\/\/public-blob\.squarecloud\.dev\/([^\/]+)\/([^\/]+\/)?([^_]+)_[\w-]+\.\w+$/;
diff --git a/src/schemas/put.ts b/src/schemas/put.ts
diff --git a/src/structures/error.ts b/src/structures/error.ts
@@ -4,8 +4,6 @@ export class SquareCloudBlobError extends Error {
 
 		this.name = SquareCloudBlobError.name;
 		this.message = this.getMessage(code);
-
-		Error.captureStackTrace(this, SquareCloudBlobError);
 	}
 
 	private getMessage(rawCode: string) {
diff --git a/src/types/list.ts b/src/types/list.ts
@@ -1,4 +1,4 @@
 import type { z } from "zod";
-import type { listObjectsResponseSchema } from "../schemas/list";
+import type { listObjectsResponseSchema } from "../validation/schemas/list";
 
 export type ListObjectsResponse = z.infer<typeof listObjectsResponseSchema>;
diff --git a/src/types/put.ts b/src/types/put.ts
@@ -1,5 +1,8 @@
 import type { z } from "zod";
-import type { putObjectResponseSchema, putObjectSchema } from "../schemas/put";
+import type {
+	putObjectResponseSchema,
+	putObjectSchema,
+} from "../validation/schemas/put";
 
 export type PutObjectType = z.infer<typeof putObjectSchema>;
 export type PutObjectResponse = z.infer<typeof putObjectResponseSchema>;
diff --git a/src/utils/mimetype.ts b/src/utils/mimetype.ts
@@ -0,0 +1,95 @@
+const mimeTypesWithExtension = {
+	"video/mp4": ["mp4"],
+	"video/mpeg": ["mpeg"],
+	"video/webm": ["webm"],
+	"video/x-flv": ["flv"],
+	"video/x-m4v": ["m4v"],
+	"image/jpeg": ["jpg", "jpeg"],
+	"image/png": ["png"],
+	"image/apng": ["apng"],
+	"image/tiff": ["tiff"],
+	"image/gif": ["gif"],
+	"image/webp": ["webp"],
+	"image/bmp": ["bmp"],
+	"image/svg+xml": ["svg"],
+	"image/x-icon": ["ico"],
+	"image/ico": ["ico"],
+	"image/cur": ["cur"],
+	"image/heic": ["heic"],
+	"image/heif": ["heif"],
+	"audio/wav": ["wav"],
+	"audio/ogg": ["ogg"],
+	"audio/opus": ["opus"],
+	"audio/mp4": ["mp4"],
+	"audio/mpeg": ["mp3"],
+	"audio/aac": ["aac"],
+	"text/plain": ["txt"],
+	"text/html": ["html"],
+	"text/css": ["css"],
+	"text/csv": ["csv"],
+	"text/x-sql": ["sql"],
+	"application/xml": ["xml"],
+	"application/sql": ["sql"],
+	"application/x-sql": ["sql"],
+	"application/x-sqlite3": ["sqlite3"],
+	"application/x-pkcs12": ["pfx"],
+	"application/pdf": ["pdf"],
+	"application/json": ["json"],
+	"application/javascript": ["js"],
+};
+
+export enum MimeTypes {
+	VIDEO_MP4 = "video/mp4",
+	VIDEO_MPEG = "video/mpeg",
+	VIDEO_WEBM = "video/webm",
+	VIDEO_X_FLV = "video/x-flv",
+	VIDEO_X_M4V = "video/x-m4v",
+	IMAGE_JPEG = "image/jpeg",
+	IMAGE_PNG = "image/png",
+	IMAGE_APNG = "image/apng",
+	IMAGE_TIFF = "image/tiff",
+	IMAGE_GIF = "image/gif",
+	IMAGE_WEBP = "image/webp",
+	IMAGE_BMP = "image/bmp",
+	IMAGE_SVG = "image/svg+xml",
+	IMAGE_X_ICON = "image/x-icon",
+	IMAGE_ICO = "image/ico",
+	IMAGE_CUR = "image/cur",
+	IMAGE_HEIC = "image/heic",
+	IMAGE_HEIF = "image/heif",
+	AUDIO_WAV = "audio/wav",
+	AUDIO_OGG = "audio/ogg",
+	AUDIO_OPUS = "audio/opus",
+	AUDIO_MP4 = "audio/mp4",
+	AUDIO_MPEG = "audio/mpeg",
+	AUDIO_AAC = "audio/aac",
+	TEXT_PLAIN = "text/plain",
+	TEXT_HTML = "text/html",
+	TEXT_CSS = "text/css",
+	TEXT_CSV = "text/csv",
+	TEXT_X_SQL = "text/x-sql",
+	APPLICATION_XML = "application/xml",
+	APPLICATION_SQL = "application/sql",
+	APPLICATION_X_SQL = "application/x-sql",
+	APPLICATION_X_SQLITE3 = "application/x-sqlite3",
+	APPLICATION_X_PKCS12 = "application/x-pkcs12",
+	APPLICATION_PDF = "application/pdf",
+	APPLICATION_JSON = "application/json",
+	APPLICATION_JAVASCRIPT = "application/javascript",
+}
+
+export const mimeTypes = Object.keys(mimeTypesWithExtension) as [
+	MimeType,
+	...MimeType[],
+];
+
+export type MimeType = keyof typeof mimeTypesWithExtension;
+
+export function getMimeTypeFromExtension(extension: string): MimeType {
+	const entries = Object.entries(mimeTypesWithExtension);
+	const mimeType = entries.find(([, extensions]) =>
+		extensions.includes(extension),
+	)?.[0];
+
+	return (mimeType as MimeType) || "text/plain";
+}
diff --git a/src/utils/pathlike.ts b/src/utils/pathlike.ts
@@ -0,0 +1,18 @@
+import { readFile } from "fs/promises";
+import { SquareCloudBlobError } from "../structures/error";
+
+export async function parsePathLike(
+	pathLike: string | Buffer,
+): Promise<Buffer> {
+	if (typeof pathLike === "string") {
+		const fileBuffer = await readFile(pathLike).catch(() => undefined);
+
+		if (!fileBuffer) {
+			throw new SquareCloudBlobError("INVALID_FILE", "File not found");
+		}
+
+		return fileBuffer;
+	}
+
+	return pathLike;
+}
diff --git a/src/validation/assertions/handlers.ts b/src/validation/assertions/handlers.ts
@@ -2,11 +2,11 @@ import type { ZodIssue } from "zod";
 import {
 	SquareCloudBlobError,
 	SquareCloudValidationError,
-} from "../structures/error";
+} from "../../structures/error";
 import type {
 	APIObjectAssertionProps,
 	LiteralAssertionProps,
-} from "../types/assertions";
+} from "../../types/assertions";
 
 export function handleLiteralAssertion({
 	schema,
diff --git a/src/validation/assertions/list.ts b/src/validation/assertions/list.ts
@@ -1,5 +1,5 @@
+import type { ListObjectsResponse } from "../../types/list";
 import { listObjectsResponseSchema } from "../schemas/list";
-import type { ListObjectsResponse } from "../types/list";
 import { handleAPIObjectAssertion } from "./handlers";
 
 export function assertListObjectsResponse(value: unknown): ListObjectsResponse {
diff --git a/src/validation/assertions/literal.ts b/src/validation/assertions/literal.ts
diff --git a/src/validation/assertions/put.ts b/src/validation/assertions/put.ts
@@ -1,5 +1,5 @@
+import type { PutObjectResponse } from "../../types/put";
 import { putObjectResponseSchema } from "../schemas/put";
-import type { PutObjectResponse } from "../types/put";
 import { handleAPIObjectAssertion } from "./handlers";
 
 export function assertPutObjectResponse(value: unknown): PutObjectResponse {
diff --git a/src/validation/schemas/common.ts b/src/validation/schemas/common.ts
diff --git a/src/validation/schemas/list.ts b/src/validation/schemas/list.ts
diff --git a/src/validation/schemas/put.ts b/src/validation/schemas/put.ts
@@ -0,0 +1,41 @@
+import { z } from "zod";
+import { mimeTypes } from "../../utils/mimetype";
+import { nameLikeSchema } from "./common";
+
+export const putObjectSchema = z
+	.object({
+		/** A string representing the name for the file. */
+		name: nameLikeSchema,
+		/** Use absolute path, Buffer or Blob */
+		file: z.string().or(z.instanceof(Buffer)),
+		/** A string representing the MIME type of the file. */
+		mimeType: z.enum(mimeTypes).optional(),
+		/** A string representing the prefix for the file. */
+		prefix: nameLikeSchema.optional(),
+		/** A number indicating the expiration period of the file, ranging from 1 to 365 days. */
+		expire: z.number().min(1).max(365).optional(),
+		/** Set to true if a security hash is required. */
+		securityHash: z.boolean().optional(),
+		/** Set to true if the file should be set for automatic download. */
+		autoDownload: z.boolean().optional(),
+	})
+	.refine(({ file, mimeType }) => !(file instanceof Buffer && !mimeType), {
+		message: "mimeType is required if file is a Buffer",
+		path: ["mimeType"],
+	});
+
+export const putObjectPayloadSchema = putObjectSchema.transform(
+	({ file, securityHash, autoDownload, ...rest }) => ({
+		file,
+		params: {
+			...rest,
+			security_hash: securityHash,
+			auto_download: autoDownload,
+		},
+	}),
+);
+
+export const putObjectResponseSchema = z.object({
+	/** The URL of the uploaded file. (File distributed in Square Cloud CDN) */
+	url: z.string(),
+});

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@squarecloud/blob": minor
 +---
++
 +New `mimeType` prop for `objects.put` method, required if file is a Buffer
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,6 @@ export class SquareCloudBlobError extends Error {`
`4`	`4`
`5`	`5`	`this.name = SquareCloudBlobError.name;`
`6`	`6`	`this.message = this.getMessage(code);`
`7`		`-`
`8`		`- Error.captureStackTrace(this, SquareCloudBlobError);`
`9`	`7`	`}`
`10`	`8`
`11`	`9`	`private getMessage(rawCode: string) {`