test(structures): add tests for Emoji and Entitlement

Author: AsadHumayun

packages/structures/__tests__/emoji.test.ts

@@ -0,0 +1,53 @@
+import { DiscordSnowflake } from '@sapphire/snowflake';
+import type { APIEmoji, APIUser } from 'discord-api-types/v10';
+import { describe, expect, test } from 'vitest';
+import { Emoji } from '../src/emojis/Emoji.js';
+import { kPatch } from '../src/utils/symbols.js';
+
+describe('Emoji structure', () => {
+	const user: APIUser = {
+		id: '1',
+		username: 'username',
+		discriminator: '0000',
+		global_name: 'djs.structures.user.global_name',
+		avatar: 'djs.structures.user.avatar',
+	};
+
+	const data: APIEmoji = {
+		id: '1',
+		name: 'name',
+		roles: ['1', '2', '3'],
+		user,
+		require_colons: true,
+		managed: true,
+		animated: true,
+		available: true,
+	};
+
+	const instance = new Emoji(data);
+
+	test('Emoji has all properties', () => {
+		expect(instance.id).toBe(data.id);
+		expect(instance.name).toBe(data.name);
+		expect(instance.requireColons).toBe(data.require_colons);
+		expect(instance.managed).toBe(data.managed);
+		expect(instance.animated).toBe(data.animated);
+		expect(instance.available).toBe(data.available);
+
+		expect(instance.createdTimestamp).toBe(DiscordSnowflake.timestampFrom(instance.id!));
+		expect(instance.createdAt).toEqual(new Date(instance.createdTimestamp!));
+	});
+
+	test('toJSON() is accurate', () => {
+		expect(instance.toJSON()).toStrictEqual(data);
+	});
+
+	test('Patching the Emoji works in place', () => {
+		const patched = instance[kPatch]({
+			available: false,
+		});
+
+		expect(patched.toJSON()).not.toEqual(data);
+		expect(patched).toBe(instance);
+	});
+});

packages/structures/__tests__/entitlement.test.ts

@@ -0,0 +1,58 @@
+import { DiscordSnowflake } from '@sapphire/snowflake';
+import { type APIEntitlement, EntitlementType } from 'discord-api-types/v10';
+import { describe, expect, test } from 'vitest';
+import { Entitlement } from '../src/entitlements/Entitlement.js';
+import { kPatch } from '../src/utils/symbols.js';
+
+describe('Entitlement structure', () => {
+	const data: APIEntitlement = {
+		id: '1',
+		sku_id: '1',
+		application_id: '1',
+		user_id: '1',
+		type: EntitlementType.Purchase,
+		deleted: false,
+		starts_at: '2020-10-10T13:50:17.209000+00:00',
+		ends_at: '2020-10-10T15:50:17.209000+00:00',
+		consumed: false,
+		// note guild_id is missing (to test kPatch)
+	};
+
+	const instance = new Entitlement(data);
+
+	test('Entitlement has all properties', () => {
+		expect(instance.id).toBe(data.id);
+		expect(instance.skuId).toBe(data.sku_id);
+		expect(instance.applicationId).toBe(data.application_id);
+		expect(instance.userId).toBe(data.user_id);
+		expect(instance.type).toBe(data.type);
+		expect(instance.guildId).toBe(data.guild_id);
+		expect(instance.consumed).toBe(data.consumed);
+
+		expect(instance.createdTimestamp).toBe(DiscordSnowflake.timestampFrom(instance.id!));
+		expect(instance.createdAt).toEqual(new Date(instance.createdTimestamp!));
+	});
+
+	test('toJSON() is accurate', () => {
+		expect(instance.toJSON()).toStrictEqual(data);
+	});
+
+	test('Patching the Entitlement works in place', () => {
+		const guildId = '111111';
+		const consumed = true;
+
+		const patched = instance[kPatch]({
+			guild_id: guildId,
+			consumed,
+		});
+
+		expect(patched.guildId).toBe(instance.guildId);
+		expect(patched.guildId).toBe(instance.guildId);
+
+		expect(patched.guildId).toEqual(guildId);
+		expect(patched.consumed).toEqual(consumed);
+
+		expect(patched.toJSON()).not.toEqual(data);
+		expect(patched).toBe(instance);
+	});
+});