new stats method

Author: joaotonaco

.changeset/lovely-garlics-wait.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/blob": minor
+---
+
+New `SquareCloudBlob#stats` method for checking account stats

package.json

@@ -13,10 +13,11 @@
 		"build:ts": "tsup ./src",
 		"lint": "biome check --apply .",
 		"test": "node --env-file=.env -r ts-node/register",
-		"test:list": "npm run test ./test/list.test.ts",
-		"test:create": "npm run test ./test/create.test.ts",
-		"test:delete": "npm run test ./test/delete.test.ts",
-		"test:mime": "npm run test ./test/mimetypes.test.ts",
+		"test:stats": "npm test ./test/stats.test.ts",
+		"test:list": "npm test ./test/list.test.ts",
+		"test:create": "npm test ./test/create.test.ts",
+		"test:delete": "npm test ./test/delete.test.ts",
+		"test:mime": "npm test ./test/mimetypes.test.ts",
 		"prepare": "husky"
 	},
 	"engines": {

src/index.ts

@@ -1,5 +1,7 @@
 import { APIManager } from "./managers/api";
 import { ObjectsManager } from "./managers/objects";
+import type { StatsResponse } from "./types/stats";
+import { assertStatsResponse } from "./validation/assertions/stats";
 
 export class SquareCloudBlob {
 	public static apiInfo = {
@@ -13,6 +15,11 @@ export class SquareCloudBlob {
 	constructor(apiKey: string) {
 		this.api = new APIManager(apiKey);
 	}
+
+	async stats() {
+		const { response } = await this.api.request<StatsResponse>("account/stats");
+		return assertStatsResponse(response);
+	}
 }
 
 export * from "./structures/object";

src/types/stats.ts

@@ -0,0 +1,4 @@
+import type { z } from "zod";
+import type { statsResponseSchema } from "../validation/schemas/stats";
+
+export type StatsResponse = z.infer<typeof statsResponseSchema>;

src/validation/assertions/stats.ts

@@ -0,0 +1,11 @@
+import type { StatsResponse } from "../../types/stats";
+import { statsResponseSchema } from "../schemas/stats";
+import { handleAPIObjectAssertion } from "./handlers";
+
+export function assertStatsResponse(value: unknown): StatsResponse {
+	return handleAPIObjectAssertion({
+		schema: statsResponseSchema,
+		code: "ACCOUNT_STATS",
+		value,
+	});
+}

src/validation/schemas/stats.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+
+export const statsResponseSchema = z.object({
+	/** The total number of objects in your account. */
+	objects: z.number(),
+	/** The total size of all objects in your account, in bytes. */
+	size: z.number(),
+	/** The total price of storage for all objects in your account, in BRL. */
+	storagePrice: z.number(),
+	/** The total price of all objects in your account, in BRL. */
+	objectsPrice: z.number(),
+	/** The total price of all objects in your account, in BRL. */
+	totalEstimate: z.number(),
+});

test/stats.test.ts

@@ -0,0 +1,5 @@
+// Check account stats
+
+import { blob } from "./index.test";
+
+blob.stats().then(console.log);