new BlobObject structure

Author: joaotonaco

.changeset/little-ads-fix.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": minor
+---
+
+New `BlobObject` structure

src/index.ts

@@ -15,6 +15,7 @@ export class SquareCloudBlob {
 	}
 }
 
+export * from "./structures/object";
 export * from "./types/create";
 export * from "./types/list";
 export * from "./utils/mimetype";

src/managers/objects.ts

@@ -1,9 +1,9 @@
 import type { SquareCloudBlob } from "..";
-import { SquareCloudBlobError } from "../structures/error";
+import { BlobObject } from "../structures/object";
 import type { CreateObjectResponse, CreateObjectType } from "../types/create";
 import type { ListObjectsResponse } from "../types/list";
 import { MimeTypeUtil } from "../utils/mimetype";
-import { parsePathLike } from "../utils/pathlike";
+import { parsePathLike } from "../utils/path-like";
 import { assertCreateObjectResponse } from "../validation/assertions/create";
 import { assertListObjectsResponse } from "../validation/assertions/list";
 import { createObjectPayloadSchema } from "../validation/schemas/create";
@@ -22,8 +22,23 @@ export class ObjectsManager {
 	async list() {
 		const { response } =
 			await this.client.api.request<ListObjectsResponse>("objects");
+		const list = assertListObjectsResponse(response);
 
-		return assertListObjectsResponse(response)?.objects;
+		if (!list.objects) {
+			return [];
+		}
+
+		return list.objects.map(
+			(object) =>
+				new BlobObject({
+					idOrUrl: object.id,
+					size: object.size,
+					createdAt: new Date(object.created_at),
+					expiresAt: object.expires_at
+						? new Date(object.expires_at)
+						: undefined,
+				}),
+		);
 	}
 
 	/**
@@ -56,7 +71,12 @@ export class ObjectsManager {
 			},
 		);
 
-		return assertCreateObjectResponse(response);
+		const objectData = assertCreateObjectResponse(response);
+
+		return new BlobObject({
+			idOrUrl: objectData.id,
+			size: objectData.size,
+		});
 	}
 
 	/**
@@ -79,27 +99,4 @@ export class ObjectsManager {
 
 		return status === "success";
 	}
-
-	/**
-	 * 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+$/;
-		const match = pattern.exec(url);
-
-		if (!match) {
-			throw new SquareCloudBlobError(
-				"INVALID_BLOB_URL",
-				"Invalid blob object URL",
-			);
-		}
-
-		let [, id, prefix, name] = match;
-		prefix = prefix ? prefix.slice(0, -1) : "";
-
-		return { id, prefix, name };
-	}
 }

src/structures/object.ts

@@ -0,0 +1,35 @@
+import type { BlobObjectData } from "../types/object";
+import { type MimeType, MimeTypeUtil } from "../utils/mimetype";
+import { parseObjectUrl } from "../utils/object-url";
+
+export class BlobObject {
+	id: string;
+	url: string;
+	name: string;
+	prefix?: string;
+	hash: string;
+	userId: string;
+	extension: string;
+	mimeType: MimeType;
+	size: number;
+	expiresAt?: Date;
+	createdAt?: Date;
+
+	constructor(data: BlobObjectData) {
+		const { id, name, prefix, hash, userId, extension } = parseObjectUrl(
+			data.idOrUrl,
+		);
+
+		this.id = id;
+		this.url = `https://public-blob.squarecloud.dev/${id}`;
+		this.name = name;
+		this.prefix = prefix;
+		this.hash = hash;
+		this.userId = userId;
+		this.extension = extension;
+		this.mimeType = MimeTypeUtil.fromExtension(extension);
+		this.size = data.size;
+		this.expiresAt = data.expiresAt;
+		this.createdAt = data.createdAt;
+	}
+}

src/types/object.ts

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

src/utils/object-url.ts

@@ -0,0 +1,32 @@
+import { SquareCloudBlobError } from "../structures/error";
+
+const objectUrlRegex =
+	/^(?<url>https:\/\/public-blob\.squarecloud\.dev)?\/?(?<userId>\d+\/)(?<prefix>[\w\d-_]+\/)?(?<name>[\w\d_]+)-(?<hash>[\w\d]+)\.(?<extension>\w+)$/;
+
+/**
+ * Parses the object URL to extract id, userId, prefix, name, hash and extension.
+ *
+ * @param url - The object URL to parse.
+ */
+export function parseObjectUrl(url: string) {
+	const match = url.match(objectUrlRegex);
+
+	if (!match?.groups) {
+		throw new SquareCloudBlobError("Invalid object URL");
+	}
+
+	const payload = {
+		userId: match.groups.userId.replace("/", ""),
+		prefix: match.groups.prefix?.replace("/", ""),
+		name: match.groups.name,
+		hash: match.groups.hash,
+		extension: match.groups.extension,
+	};
+
+	return {
+		id: `${payload.userId}/${payload.prefix ? `${payload.prefix}/` : ""}${
+			payload.name
+		}-${payload.hash}.${payload.extension}`,
+		...payload,
+	};
+}