create blob objects manager and put method

Author: joaotonaco

.changeset/funny-melons-prove.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": minor
+---
+
+Add `BlobObjectsManager#put` method for creating blobs

.changeset/two-moose-exercise.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": minor
+---
+
+New blob objects manager for creating, deleting and listing blobs

src/assertions/put.ts

@@ -0,0 +1,14 @@
+import { putBlobObjectResponseSchema } from "../schemas/put";
+import type { PutBlobObjectResponse } from "../types/put";
+import { handleAPIObjectAssertion } from "./handlers";
+
+export function assertPutBlobObjectResponse(
+	value: unknown,
+): PutBlobObjectResponse {
+	return handleAPIObjectAssertion({
+		schema: putBlobObjectResponseSchema,
+		code: "PUT_OBJECT",
+		route: "/put",
+		value,
+	});
+}

src/index.ts

@@ -1,4 +1,5 @@
 import { APIManager } from "./managers/api";
+import { BlobObjectsManager } from "./managers/objects";
 
 export class SquareCloudBlob {
 	public static apiInfo = {
@@ -7,6 +8,7 @@ export class SquareCloudBlob {
 	};
 
 	public readonly api: APIManager;
+	public readonly objects = new BlobObjectsManager(this);
 
 	constructor(apiKey: string) {
 		this.api = new APIManager(apiKey);

src/managers/objects.ts

@@ -0,0 +1,61 @@
+import { readFile } from "fs/promises";
+import type { SquareCloudBlob } from "..";
+import { assertPutBlobObjectResponse } from "../assertions/put";
+import { putBlobObjectPayloadSchema } from "../schemas/put";
+import { SquareCloudBlobError } from "../structures/error";
+import type { PutBlobObjectResponse, PutBlobObjectType } from "../types/put";
+
+export class BlobObjectsManager {
+	constructor(private readonly client: SquareCloudBlob) {}
+
+	async put(object: PutBlobObjectType) {
+		const payload = putBlobObjectPayloadSchema.parse(object);
+		const file = await this.parseFile(payload.file);
+
+		const formData = new FormData();
+		formData.append("file", new Blob([file]));
+
+		const { response } = await this.client.api.request<PutBlobObjectResponse>(
+			"blob/put",
+			{
+				method: "POST",
+				body: formData,
+				params: payload.params,
+			},
+		);
+
+		return assertPutBlobObjectResponse(response);
+	}
+
+	private async parseFile(file: string | Buffer) {
+		let result: Buffer | undefined;
+
+		if (typeof file === "string") {
+			result = await readFile(file).catch(() => undefined);
+		}
+
+		if (!result) {
+			throw new SquareCloudBlobError("INVALID_FILE", "File not found");
+		}
+
+		return result;
+	}
+
+	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/schemas/put.ts

@@ -0,0 +1,33 @@
+import { z } from "zod";
+import { nameLikeStringSchema } from "./common";
+
+export const putBlobObjectSchema = z.object({
+	/** A string representing the name for the file. */
+	name: nameLikeStringSchema,
+	/** Use absolute path or Buffer, can be a single file or compressed (zip) */
+	file: z.string().or(z.instanceof(Buffer)),
+	/** A string representing the prefix for the file. */
+	prefix: nameLikeStringSchema.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(),
+});
+
+export const putBlobObjectPayloadSchema = putBlobObjectSchema.transform(
+	({ file, securityHash, autoDownload, ...rest }) => ({
+		file,
+		params: {
+			...rest,
+			security_hash: securityHash,
+			auto_download: autoDownload,
+		},
+	}),
+);
+
+export const putBlobObjectResponseSchema = z.object({
+	/** The URL of the uploaded file. (File distributed in Square Cloud CDN) */
+	url: z.string(),
+});

src/types/put.ts

@@ -0,0 +1,8 @@
+import type { z } from "zod";
+import type {
+	putBlobObjectResponseSchema,
+	putBlobObjectSchema,
+} from "../schemas/put";
+
+export type PutBlobObjectType = z.infer<typeof putBlobObjectSchema>;
+export type PutBlobObjectResponse = z.infer<typeof putBlobObjectResponseSchema>;