refactor: make things optional and nullable where applicable (#361)

BREAKING CHANGE: The deprecated `asset` field for stickers is correctly marked as optional now. The `image` field for Guild Scheduled Events is now correctly typed as optional.
discordjs · Mar 9, 2022 · 10fdeaa · 10fdeaa
1 parent fddff21
commit 10fdeaa
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 8 deletions.
diff --git a/deno/payloads/v10/guildScheduledEvent.ts b/deno/payloads/v10/guildScheduledEvent.ts
@@ -66,7 +66,7 @@ interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType>
 	/**
 	 * The cover image of the scheduled event
 	 */
-	image: string | null;
+	image?: string | null;
 }
 
 export interface APIStageInstanceGuildScheduledEvent

diff --git a/deno/payloads/v10/sticker.ts b/deno/payloads/v10/sticker.ts
@@ -33,7 +33,7 @@ export interface APISticker {
 	 * Previously the sticker asset hash, now an empty string
 	 * @deprecated
 	 */
-	asset: '';
+	asset?: '';
 	/**
 	 * Type of sticker
 	 *

diff --git a/deno/payloads/v9/guildScheduledEvent.ts b/deno/payloads/v9/guildScheduledEvent.ts
@@ -66,7 +66,7 @@ interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType>
 	/**
 	 * The cover image of the scheduled event
 	 */
-	image: string | null;
+	image?: string | null;
 }
 
 export interface APIStageInstanceGuildScheduledEvent

diff --git a/deno/payloads/v9/sticker.ts b/deno/payloads/v9/sticker.ts
@@ -33,7 +33,7 @@ export interface APISticker {
 	 * Previously the sticker asset hash, now an empty string
 	 * @deprecated
 	 */
-	asset: '';
+	asset?: '';
 	/**
 	 * Type of sticker
 	 *

diff --git a/deno/rest/v10/guildScheduledEvent.ts b/deno/rest/v10/guildScheduledEvent.ts
@@ -95,6 +95,14 @@ export type RESTPatchAPIGuildScheduledEventJSONBody = StrictPartial<RESTPostAPIG
 		 * The status of the scheduled event
 		 */
 		status?: GuildScheduledEventStatus;
+		/**
+		 * The entity metadata of the scheduled event
+		 */
+		entity_metadata?: APIGuildScheduledEventEntityMetadata | null;
+		/**
+		 * The description of the guild event
+		 */
+		description?: string | null;
 	}>;
 
 /**

diff --git a/deno/rest/v9/guildScheduledEvent.ts b/deno/rest/v9/guildScheduledEvent.ts
@@ -95,6 +95,14 @@ export type RESTPatchAPIGuildScheduledEventJSONBody = StrictPartial<RESTPostAPIG
 		 * The status of the scheduled event
 		 */
 		status?: GuildScheduledEventStatus;
+		/**
+		 * The entity metadata of the scheduled event
+		 */
+		entity_metadata?: APIGuildScheduledEventEntityMetadata | null;
+		/**
+		 * The description of the guild event
+		 */
+		description?: string | null;
 	}>;
 
 /**

diff --git a/payloads/v10/guildScheduledEvent.ts b/payloads/v10/guildScheduledEvent.ts
@@ -66,7 +66,7 @@ interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType>
 	/**
 	 * The cover image of the scheduled event
 	 */
-	image: string | null;
+	image?: string | null;
 }
 
 export interface APIStageInstanceGuildScheduledEvent

diff --git a/payloads/v10/sticker.ts b/payloads/v10/sticker.ts
@@ -33,7 +33,7 @@ export interface APISticker {
 	 * Previously the sticker asset hash, now an empty string
 	 * @deprecated
 	 */
-	asset: '';
+	asset?: '';
 	/**
 	 * Type of sticker
 	 *

diff --git a/payloads/v9/guildScheduledEvent.ts b/payloads/v9/guildScheduledEvent.ts
@@ -66,7 +66,7 @@ interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType>
 	/**
 	 * The cover image of the scheduled event
 	 */
-	image: string | null;
+	image?: string | null;
 }
 
 export interface APIStageInstanceGuildScheduledEvent

diff --git a/payloads/v9/sticker.ts b/payloads/v9/sticker.ts
@@ -33,7 +33,7 @@ export interface APISticker {
 	 * Previously the sticker asset hash, now an empty string
 	 * @deprecated
 	 */
-	asset: '';
+	asset?: '';
 	/**
 	 * Type of sticker
 	 *

diff --git a/rest/v10/guildScheduledEvent.ts b/rest/v10/guildScheduledEvent.ts
@@ -95,6 +95,14 @@ export type RESTPatchAPIGuildScheduledEventJSONBody = StrictPartial<RESTPostAPIG
 		 * The status of the scheduled event
 		 */
 		status?: GuildScheduledEventStatus;
+		/**
+		 * The entity metadata of the scheduled event
+		 */
+		entity_metadata?: APIGuildScheduledEventEntityMetadata | null;
+		/**
+		 * The description of the guild event
+		 */
+		description?: string | null;
 	}>;
 
 /**

diff --git a/rest/v9/guildScheduledEvent.ts b/rest/v9/guildScheduledEvent.ts
@@ -95,6 +95,14 @@ export type RESTPatchAPIGuildScheduledEventJSONBody = StrictPartial<RESTPostAPIG
 		 * The status of the scheduled event
 		 */
 		status?: GuildScheduledEventStatus;
+		/**
+		 * The entity metadata of the scheduled event
+		 */
+		entity_metadata?: APIGuildScheduledEventEntityMetadata | null;
+		/**
+		 * The description of the guild event
+		 */
+		description?: string | null;
 	}>;
 
 /**