update api routes and rename objects.put to create

Author: joaotonaco

.changeset/giant-zoos-compete.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": major
+---
+
+Rename `objects.put` and related to `objects.create`

.changeset/warm-beds-fry.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": major
+---
+
+Update to new Blob API routes

README.md

@@ -47,7 +47,7 @@ const objects = await blob.objects.list()
 - _Check supported file types [here](https://docs.squarecloud.app/services/blob#supported-file-types)._
 
 ```ts
-const blobObject = await blob.objects.put({
+const blobObject = await blob.objects.create({
   file: "path/to/file.png", // Absolute path to your file
   name: "my_image",         // File name without extension
 })
@@ -61,7 +61,7 @@ console.log(blobObject.url)
 import { MimeTypes } from "@squarecloud/blob"
 // CommonJS => const { MimeTypes } = require("@squarecloud/blob")
 
-const blobObject = await blob.objects.put({
+const blobObject = await blob.objects.create({
   file: Buffer.from("content"),
   name: "my_image",
   mimeType: MimeTypes.IMAGE_JPEG, // Also accepts an string "image/jpeg"

src/index.ts

@@ -1,5 +1,5 @@
 import { APIManager } from "./managers/api";
-import { BlobObjectsManager } from "./managers/objects";
+import { ObjectsManager } from "./managers/objects";
 
 export class SquareCloudBlob {
 	public static apiInfo = {
@@ -8,13 +8,13 @@ export class SquareCloudBlob {
 	};
 
 	public readonly api: APIManager;
-	public readonly objects = new BlobObjectsManager(this);
+	public readonly objects = new ObjectsManager(this);
 
 	constructor(apiKey: string) {
 		this.api = new APIManager(apiKey);
 	}
 }
 
+export * from "./types/create";
 export * from "./types/list";
-export * from "./types/put";
 export { MimeTypes } from "./utils/mimetype";

src/managers/objects.ts

@@ -1,14 +1,14 @@
 import type { SquareCloudBlob } from "..";
 import { SquareCloudBlobError } from "../structures/error";
+import type { CreateObjectResponse, CreateObjectType } from "../types/create";
 import type { ListObjectsResponse } from "../types/list";
-import type { PutObjectResponse, PutObjectType } from "../types/put";
 import { getMimeTypeFromExtension } from "../utils/mimetype";
 import { parsePathLike } from "../utils/pathlike";
+import { assertCreateObjectResponse } from "../validation/assertions/create";
 import { assertListObjectsResponse } from "../validation/assertions/list";
-import { assertPutObjectResponse } from "../validation/assertions/put";
-import { putObjectPayloadSchema } from "../validation/schemas/put";
+import { createObjectPayloadSchema } from "../validation/schemas/create";
 
-export class BlobObjectsManager {
+export class ObjectsManager {
 	constructor(private readonly client: SquareCloudBlob) {}
 
 	/**
@@ -21,7 +21,7 @@ export class BlobObjectsManager {
 	 */
 	async list() {
 		const { response } =
-			await this.client.api.request<ListObjectsResponse>("list");
+			await this.client.api.request<ListObjectsResponse>("objects");
 
 		return assertListObjectsResponse(response)?.objects;
 	}
@@ -33,11 +33,11 @@ export class BlobObjectsManager {
 	 *
 	 * @example
 	 * ```js
-	 * await blob.objects.put({ file: "path/to/file.jpeg", name: "my_image" });
+	 * await blob.objects.create({ file: "path/to/file.jpeg", name: "my_image" });
 	 * ```
 	 */
-	async put(object: PutObjectType) {
-		const payload = putObjectPayloadSchema.parse(object);
+	async create(object: CreateObjectType) {
+		const payload = createObjectPayloadSchema.parse(object);
 		const file = await parsePathLike(payload.file);
 		const mimeType =
 			typeof object.file === "string"
@@ -47,16 +47,16 @@ export class BlobObjectsManager {
 		const formData = new FormData();
 		formData.append("file", new Blob([file], { type: mimeType }));
 
-		const { response } = await this.client.api.request<PutObjectResponse>(
-			"put",
+		const { response } = await this.client.api.request<CreateObjectResponse>(
+			"objects",
 			{
-				method: "PUT",
+				method: "POST",
 				body: formData,
 				params: payload.params,
 			},
 		);
 
-		return assertPutObjectResponse(response);
+		return assertCreateObjectResponse(response);
 	}
 
 	/**
@@ -72,12 +72,12 @@ export class BlobObjectsManager {
 	async delete(...objects: string[] | string[][]) {
 		const ids = objects.flat();
 
-		const response = await this.client.api.request("delete", {
+		const { status } = await this.client.api.request("objects", {
 			method: "DELETE",
 			body: { objects: ids },
 		});
 
-		return response.status === "success";
+		return status === "success";
 	}
 
 	/**

src/types/assertions.ts

@@ -12,5 +12,4 @@ export type LiteralAssertionProps = BaseAssertionProps & {
 
 export type APIObjectAssertionProps = BaseAssertionProps & {
 	code: string;
-	route: string;
 };

src/types/create.ts

@@ -0,0 +1,8 @@
+import type { z } from "zod";
+import type {
+	createObjectResponseSchema,
+	createObjectSchema,
+} from "../validation/schemas/create";
+
+export type CreateObjectType = z.infer<typeof createObjectSchema>;
+export type CreateObjectResponse = z.infer<typeof createObjectResponseSchema>;

src/types/put.ts

@@ -0,0 +1,13 @@
+import type { CreateObjectResponse } from "../../types/create";
+import { createObjectResponseSchema } from "../schemas/create";
+import { handleAPIObjectAssertion } from "./handlers";
+
+export function assertCreateObjectResponse(
+	value: unknown,
+): CreateObjectResponse {
+	return handleAPIObjectAssertion({
+		schema: createObjectResponseSchema,
+		code: "CREATE_OBJECT",
+		value,
+	});
+}

src/validation/assertions/create.ts

@@ -28,7 +28,6 @@ export function handleAPIObjectAssertion({
 	schema,
 	value,
 	code,
-	route,
 }: APIObjectAssertionProps) {
 	const name = code.toLowerCase().replaceAll("_", " ");
 
@@ -42,7 +41,7 @@ export function handleAPIObjectAssertion({
 
 		throw new SquareCloudBlobError(
 			`INVALID_API_${code}`,
-			`Invalid ${name} object received from API ${route}`,
+			`Invalid ${name} object received from API`,
 			{ cause },
 		);
 	}

src/validation/assertions/handlers.ts

@@ -6,7 +6,6 @@ export function assertListObjectsResponse(value: unknown): ListObjectsResponse {
 	return handleAPIObjectAssertion({
 		schema: listObjectsResponseSchema,
 		code: "LIST_OBJECTS",
-		route: "/list",
 		value,
 	});
 }

src/validation/assertions/list.ts

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { mimeTypes } from "../../utils/mimetype";
 import { nameLikeSchema } from "./common";
 
-export const putObjectSchema = z
+export const createObjectSchema = z
 	.object({
 		/** A string representing the name for the file. */
 		name: nameLikeSchema,
@@ -24,7 +24,7 @@ export const putObjectSchema = z
 		path: ["mimeType"],
 	});
 
-export const putObjectPayloadSchema = putObjectSchema.transform(
+export const createObjectPayloadSchema = createObjectSchema.transform(
 	({ file, securityHash, autoDownload, ...rest }) => ({
 		file,
 		params: {
@@ -35,7 +35,7 @@ export const putObjectPayloadSchema = putObjectSchema.transform(
 	}),
 );
 
-export const putObjectResponseSchema = z.object({
+export const createObjectResponseSchema = z.object({
 	/** The id of the uploaded file. */
 	id: z.string(),
 	/** The name of the uploaded file. */