new MimeTypeUtil

Author: joaotonaco

.changeset/real-spoons-pretend.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": patch
+---
+
+New `MimeTypeUtil` class for handling supported mime types

README.md

@@ -82,6 +82,21 @@ const objectsToDelete = [
 await blob.objects.delete(objectsToDelete)
 ```
 
+### Extras
+
+#### Mime types handling
+
+- _Check supported file types [here](https://docs.squarecloud.app/services/blob#supported-file-types)._
+
+```ts
+import { MimeTypeUtil } from "@squarecloud/blob"
+
+// Get a supported mime type from a file extension
+console.log(MimeTypeUtil.fromExtension("jpeg"))   // "image/jpeg"       | Supported
+console.log(MimeTypeUtil.fromExtension("json"))   // "application/json" | Supported
+console.log(MimeTypeUtil.fromExtension("potato")) // "text/plain"       | Unsupported, defaults to text/plain
+```
+
 ## Contributing
 
 Feel free to contribute with suggestions or bug reports at our [GitHub repository](https://github.com/squarecloudofc/sdk-blob-js).

src/index.ts

@@ -17,4 +17,4 @@ export class SquareCloudBlob {
 
 export * from "./types/create";
 export * from "./types/list";
-export { MimeTypes } from "./utils/mimetype";
+export * from "./utils/mimetype";

src/managers/objects.ts

@@ -2,7 +2,7 @@ import type { SquareCloudBlob } from "..";
 import { SquareCloudBlobError } from "../structures/error";
 import type { CreateObjectResponse, CreateObjectType } from "../types/create";
 import type { ListObjectsResponse } from "../types/list";
-import { getMimeTypeFromExtension } from "../utils/mimetype";
+import { MimeTypeUtil } from "../utils/mimetype";
 import { parsePathLike } from "../utils/pathlike";
 import { assertCreateObjectResponse } from "../validation/assertions/create";
 import { assertListObjectsResponse } from "../validation/assertions/list";
@@ -41,7 +41,7 @@ export class ObjectsManager {
 		const file = await parsePathLike(payload.file);
 		const mimeType =
 			typeof object.file === "string"
-				? getMimeTypeFromExtension(object.file.split(".")[1])
+				? MimeTypeUtil.fromExtension(object.file.split(".")[1])
 				: object.mimeType;
 
 		const formData = new FormData();

src/utils/mimetype.ts

@@ -0,0 +1,39 @@
+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",
+}

src/utils/mimetype/enum.ts

@@ -0,0 +1,38 @@
+import { type MimeType, mimeTypes, mimeTypesWithExtension } from "./mimetypes";
+
+// biome-ignore lint/complexity/noStaticOnlyClass: organization
+export class MimeTypeUtil {
+	/**
+	 * Supported mime types with their extensions
+	 */
+	static mimeTypesWithExtension = mimeTypesWithExtension;
+	/**
+	 * All supported mime types
+	 */
+	static mimeTypes = mimeTypes;
+
+	/**
+	 * Returns the corresponding MIME type for a given file extension.
+	 *
+	 * @param extension - The file extension to search for.
+	 * @return The MIME type associated with the extension, or "text/plain" if not found.
+	 *
+	 * @example
+	 * ```js
+	 * 	MimeTypeUtil.fromExtension("jpeg")   // "image/jpeg"       | Supported
+	 * 	MimeTypeUtil.fromExtension("json")   // "application/json" | Supported
+	 * 	MimeTypeUtil.fromExtension("potato") // "text/plain"       | Unsupported, defaults to text/plain
+	 * ```
+	 */
+	static fromExtension(extension: string): MimeType {
+		const entries = Object.entries(mimeTypesWithExtension);
+		const mimeType = entries.find(([, extensions]) =>
+			extensions.includes(extension),
+		)?.[0];
+
+		return (mimeType as MimeType) || "text/plain";
+	}
+}
+
+export * from "./enum";
+export { MimeType } from "./mimetypes";

src/utils/mimetype/index.ts

@@ -0,0 +1,46 @@
+export 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 const mimeTypes = Object.keys(mimeTypesWithExtension) as [
+	MimeType,
+	...MimeType[],
+];
+
+export type MimeType = keyof typeof mimeTypesWithExtension;

src/utils/mimetype/mimetypes.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { mimeTypes } from "../../utils/mimetype";
+import { MimeTypeUtil } from "../../utils/mimetype";
 import { nameLikeSchema } from "./common";
 
 export const createObjectSchema = z
@@ -9,7 +9,7 @@ export const createObjectSchema = z
 		/** 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(),
+		mimeType: z.enum(MimeTypeUtil.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. */