refactor(api): deprecate users in favor of user module

Author: joaotonaco

.changeset/eleven-sites-stay.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/api": patch
+---
+
+Deprecate `SquareCloudAPI#users` in favor of `SquareCloudAPI#user`. Deprecated property will be removed in the the next major version.

src/index.ts

@@ -14,8 +14,8 @@ export class SquareCloudAPI extends TypedEventEmitter<ClientEvents> {
 
 	/** The applications module */
 	public readonly applications = new ApplicationsModule(this);
-	/** The users module */
-	public readonly users = new UserModule(this);
+	/** The user module */
+	public readonly user = new UserModule(this);
 	/** The global cache service */
 	public readonly cache = new GlobalCacheService();
 
@@ -30,6 +30,14 @@ export class SquareCloudAPI extends TypedEventEmitter<ClientEvents> {
 		assertString(apiKey, "API_KEY");
 		this.api = new APIService(apiKey);
 	}
+
+	/** @deprecated Use SquareCloudAPI#user instead. */
+	get users() {
+		console.warn(
+			"[SquareCloudAPI] The 'users' property is deprecated and will be removed in the next major version. Use SquareCloudAPI#user instead.",
+		);
+		return this.user;
+	}
 }
 
 export * from "./structures";

src/structures/application/base.ts

@@ -78,7 +78,7 @@ export class BaseApplication {
 	/** @deprecated Use `Application#backups` instead */
 	get backup() {
 		console.warn(
-			"Application#backup is deprecated. Use Application#backups instead.",
+			"[SquareCloudAPI] The 'backup' property is deprecated and will be removed in the the next major version. Use Application#backups instead.",
 		);
 		return this.backups;
 	}

test/user.test.js

@@ -6,7 +6,7 @@ test("UserModule", async (t) => {
 	const client = new SquareCloudAPI(process.env.SQUARE_API_KEY);
 
 	await t.test("should get user information", async () => {
-		const user = await client.users.get();
+		const user = await client.user.get();
 
 		assert.ok(user);
 		assert.ok(user.id);
@@ -17,7 +17,7 @@ test("UserModule", async (t) => {
 	});
 
 	await t.test("should update cache on user fetch", async () => {
-		const firstUser = await client.users.get();
+		const firstUser = await client.user.get();
 		const cachedUser = client.cache.get("user");
 
 		assert.strictEqual(cachedUser?.id, firstUser.id);
@@ -34,7 +34,7 @@ test("UserModule", async (t) => {
 			emitted = true;
 		});
 
-		await client.users.get();
+		await client.user.get();
 		assert.ok(emitted, "userUpdate event should have been emitted");
 	});
 });