rename tag props to name

Author: joaotonaco

.changeset/tidy-cheetahs-brake.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/api": minor
+---
+
+Rename all `tag` properties (user and application) to `name` as API deprecated them.

package-lock.json

@@ -16,13 +16,13 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@squarecloud/api-types": "^0.2.3",
     "form-data": "^4.0.0",
     "zod": "^3.22.4"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.5.3",
     "@changesets/cli": "^2.27.1",
+    "@squarecloud/api-types": "^0.2.4",
     "@types/node": "^20.11.16",
     "husky": "^9.0.10",
     "ts-node": "^10.9.2",

package.json

@@ -10,13 +10,11 @@ const applicationSchema = z
 		cluster: z.string(),
 		ram: z.number(),
 		language: z.nativeEnum(ApplicationLanguage),
-		isWebsite: z.boolean(),
 	})
 	.passthrough();
 
 const websiteApplicationSchema = applicationSchema
 	.extend({
-		isWebsite: z.literal(true),
 		domain: z.string(),
 		custom: z.string().nullable().optional(),
 	})

src/assertions/application.ts

@@ -5,7 +5,7 @@ import { handleAPIObjectAssertion } from "./common";
 const userSchema = z
 	.object({
 		id: z.string(),
-		tag: z.string(),
+		name: z.string(),
 		email: z.string(),
 		plan: z.object({
 			name: z.nativeEnum(UserPlanName),
@@ -22,12 +22,11 @@ const userSchema = z
 const userApplicationSchema = z
 	.object({
 		id: z.string(),
-		tag: z.string(),
+		name: z.string(),
 		desc: z.string().optional(),
 		ram: z.number(),
 		lang: z.nativeEnum(ApplicationLanguage),
 		cluster: z.string(),
-		isWebsite: z.boolean(),
 	})
 	.passthrough();
 

src/assertions/user.ts

@@ -25,8 +25,7 @@ export class SquareCloudAPI extends TypedEventEmitter<ClientEvents> {
 	/**
 	 * Creates an API instance
 	 *
-	 * @param apiKey - Your API Token (generate at [Square Cloud Dashboard](https://squarecloud.app/dashboard))
-	 * @param options.experimental - Whether to enable experimental features
+	 * @param apiKey - Your API Token (request at [Square Cloud Dashboard](https://squarecloud.app/dashboard))
 	 */
 	constructor(apiKey: string) {
 		super();

src/index.ts

@@ -56,7 +56,7 @@ export class Application extends BaseApplication {
 		data: APIApplication,
 	) {
 		assertApplication(data);
-		super(client, { ...data, tag: data.name, lang: data.language });
+		super(client, { ...data, lang: data.language });
 
 		const { id, name, desc, cluster, ram, language } = data;
 

src/structures/application/application.ts

@@ -42,10 +42,10 @@ export class BaseApplication {
 		public readonly client: SquareCloudAPI,
 		data: APIUserApplication,
 	) {
-		const { id, tag, desc, ram, lang, cluster, isWebsite } = data;
+		const { id, name, desc, ram, lang, cluster } = data;
 
 		this.id = id;
-		this.name = tag;
+		this.name = name;
 		this.description = desc;
 		this.ram = ram;
 		this.language = lang;
@@ -56,7 +56,7 @@ export class BaseApplication {
 	async fetch(): Promise<Application> {
 		const data = await this.client.api.application("", this.id);
 
-		if (data.response.isWebsite) {
+		if ("domain" in data.response && data.response.domain) {
 			return new WebsiteApplication(
 				this.client,
 				data.response as APIWebsiteApplication,

src/structures/application/base.ts

@@ -194,7 +194,7 @@ export class Collection<K, V> extends Map<K, V> {
 	 * @param thisArg - Value to use as `this` when executing function
 	 * @example
 	 * ```ts
-	 * collection.map(user => user.tag);
+	 * collection.map(user => user.name);
 	 * ```
 	 */
 	public map<T>(fn: (value: V, key: K, collection: this) => T): T[];

src/structures/collection.ts

@@ -13,8 +13,8 @@ import { BaseApplication, Collection, SquareCloudAPI } from "..";
 export class User {
 	/** The user's id */
 	id: string;
-	/** The user's Discord tag */
-	tag: string;
+	/** The user's display name */
+	name: string;
 	/** The user's current plan */
 	plan: UserPlan;
 	/** The user's registered email */
@@ -26,11 +26,11 @@ export class User {
 		assertUserInfo(data);
 
 		const { user, applications } = data;
-		const { id, tag, plan, email } = user;
+		const { id, name, plan, email } = user;
 		const { duration } = plan;
 
 		this.id = id;
-		this.tag = tag;
+		this.name = name;
 		this.email = email;
 		this.plan = {
 			...plan,