diff --git a/examples/advanced/src/bot.ts b/examples/advanced/src/bot.ts index 6b1d50885..f9b1f6d0f 100644 --- a/examples/advanced/src/bot.ts +++ b/examples/advanced/src/bot.ts @@ -23,7 +23,7 @@ export const bot = createProxyCache( // By default, bot.logger will use an instance of the logger from @discordeno/bot, this logger supports depth and we need to change it, so we need to say to TS that we know what we are doing with as ;(bot.logger as typeof discordenoLogger).setDepth(LogDepth.Full) -// Setup desired proprieties +// Setup desired properties bot.transformers.desiredProperties.interaction.id = true bot.transformers.desiredProperties.interaction.type = true bot.transformers.desiredProperties.interaction.data = true diff --git a/examples/beginner/src/bot.ts b/examples/beginner/src/bot.ts index e2602b3b5..c863e6a41 100644 --- a/examples/beginner/src/bot.ts +++ b/examples/beginner/src/bot.ts @@ -18,7 +18,7 @@ export const bot = createProxyCache( }, ) -// Setup desired proprieties +// Setup desired properties bot.transformers.desiredProperties.interaction.id = true bot.transformers.desiredProperties.interaction.type = true bot.transformers.desiredProperties.interaction.data = true diff --git a/examples/bigbot/src/bot/bot.ts b/examples/bigbot/src/bot/bot.ts index 3f85880aa..ac43cdbc2 100644 --- a/examples/bigbot/src/bot/bot.ts +++ b/examples/bigbot/src/bot/bot.ts @@ -19,7 +19,7 @@ export const bot = createCustomBot( overrideGatewayImplementations(bot) -// TEMPLATE-SETUP: Add/Remove the desired proprieties that you don't need +// TEMPLATE-SETUP: Add/Remove the desired properties that you don't need const props = bot.transformers.desiredProperties props.interaction.id = true @@ -32,7 +32,7 @@ props.interaction.guildId = true props.user.id = true props.user.username = true -// TEMPLATE-SETUP: If you want/need to add any custom proprieties on the Bot type, you can do it in this function and the `CustomBot` type below. Make sure to do it in both or else you will get an error by TypeScript +// TEMPLATE-SETUP: If you want/need to add any custom properties on the Bot type, you can do it in this function and the `CustomBot` type below. Make sure to do it in both or else you will get an error by TypeScript function createCustomBot(rawBot: TBot): CustomBot { const bot = rawBot as CustomBot diff --git a/examples/minimal/src/bot.ts b/examples/minimal/src/bot.ts index fb2cab077..7002eff9d 100644 --- a/examples/minimal/src/bot.ts +++ b/examples/minimal/src/bot.ts @@ -7,7 +7,7 @@ const rawBot = createBot({ intents: Intents.Guilds, }) -// Setup desired proprieties +// Setup desired properties rawBot.transformers.desiredProperties.interaction.id = true rawBot.transformers.desiredProperties.interaction.type = true rawBot.transformers.desiredProperties.interaction.data = true diff --git a/packages/bot/src/bot.ts b/packages/bot/src/bot.ts index c0ccccf99..b4a339f82 100644 --- a/packages/bot/src/bot.ts +++ b/packages/bot/src/bot.ts @@ -6,7 +6,7 @@ import type { BigString, DiscordGatewayPayload, DiscordReady, GatewayIntents, Re import { type Collection, createLogger, getBotIdFromToken, type logger } from '@discordeno/utils' import { createBotGatewayHandlers } from './handlers.js' import { type BotHelpers, createBotHelpers } from './helpers.js' -import { type Transformers, type TransformersDesiredProprieties, createTransformers } from './transformers.js' +import { type Transformers, type TransformersDesiredProperties, createTransformers } from './transformers.js' import type { AuditLogEntry, AutoModerationActionExecution, @@ -135,11 +135,11 @@ export interface CreateBotOptions { */ defaultDesiredPropertiesValue?: boolean /** - * Set the desired proprieties for the bot + * Set the desired properties for the bot * * @default {} */ - desiredProperties?: RecursivePartial + desiredProperties?: RecursivePartial /** * This factory will be invoked to create the logger for gateway, rest and bot * diff --git a/packages/bot/src/transformers.ts b/packages/bot/src/transformers.ts index 01e7d89b2..a86d29cff 100644 --- a/packages/bot/src/transformers.ts +++ b/packages/bot/src/transformers.ts @@ -243,7 +243,7 @@ export interface Transformers { pollMedia: (bot: Bot, payload: DiscordPollMedia, pollMedia: PollMedia) => any avatarDecorationData: (bot: Bot, payload: DiscordAvatarDecorationData, avatarDecorationData: AvatarDecorationData) => any } - desiredProperties: TransformersDesiredProprieties + desiredProperties: TransformersDesiredProperties reverse: { allowedMentions: (bot: Bot, payload: AllowedMentions) => DiscordAllowedMentions embed: (bot: Bot, payload: Embed) => DiscordEmbed @@ -316,7 +316,7 @@ export interface Transformers { avatarDecorationData: (bot: Bot, payload: DiscordAvatarDecorationData) => AvatarDecorationData } -export interface TransformersDesiredProprieties { +export interface TransformersDesiredProperties { attachment: { id: boolean filename: boolean @@ -805,7 +805,7 @@ export function createTransformers(options: RecursivePartial, opts pollMedia: options.customizers?.pollMedia ?? defaultCustomizer, avatarDecorationData: options.customizers?.avatarDecorationData ?? defaultCustomizer, }, - desiredProperties: createDesiredProprietiesObject(options.desiredProperties ?? {}, opts?.defaultDesiredPropertiesValue ?? false), + desiredProperties: createDesiredPropertiesObject(options.desiredProperties ?? {}, opts?.defaultDesiredPropertiesValue ?? false), reverse: { allowedMentions: options.reverse?.allowedMentions ?? transformAllowedMentionsToDiscordAllowedMentions, embed: options.reverse?.embed ?? transformEmbedToDiscordEmbed, @@ -879,10 +879,10 @@ export function createTransformers(options: RecursivePartial, opts } } -export function createDesiredProprietiesObject( - desiredProperties: RecursivePartial, +export function createDesiredPropertiesObject( + desiredProperties: RecursivePartial, defaultValue = false, -): TransformersDesiredProprieties { +): TransformersDesiredProperties { return { attachment: { id: defaultValue, diff --git a/packages/discordeno/src/bin/config.ts b/packages/discordeno/src/bin/config.ts index fdd4aa4fc..95ae3b4eb 100644 --- a/packages/discordeno/src/bin/config.ts +++ b/packages/discordeno/src/bin/config.ts @@ -1,12 +1,12 @@ import { unlink, writeFile } from 'node:fs/promises' import { dirname } from 'node:path' import { pathToFileURL } from 'node:url' -import { type TransformersDesiredProprieties, createDesiredProprietiesObject, gray } from '@discordeno/bot' +import { type TransformersDesiredProperties, createDesiredPropertiesObject, gray } from '@discordeno/bot' import type { RecursivePartial } from '@discordeno/types' import { findUp } from 'find-up' import ts from 'typescript' -export enum DesiredProprietiesBehavior { +export enum DesiredPropertiesBehavior { Remove, TypeAsNever, } @@ -23,8 +23,8 @@ export const typescriptOptions: ts.CompilerOptions = { export function defineConfig(config: RecursivePartial): DiscordenoConfig { return { desiredProperties: { - behavior: config.desiredProperties?.behavior ?? DesiredProprietiesBehavior.TypeAsNever, - properties: createDesiredProprietiesObject(config.desiredProperties?.properties ?? {}), + behavior: config.desiredProperties?.behavior ?? DesiredPropertiesBehavior.TypeAsNever, + properties: createDesiredPropertiesObject(config.desiredProperties?.properties ?? {}), }, } } @@ -82,7 +82,7 @@ function buildConfig(path: string) { export interface DiscordenoConfig { desiredProperties: { - behavior: DesiredProprietiesBehavior - properties: RecursivePartial + behavior: DesiredPropertiesBehavior + properties: TransformersDesiredProperties } } diff --git a/packages/discordeno/src/bin/generate/desiredProperty.ts b/packages/discordeno/src/bin/generate/desiredProperty.ts index 6c4817f55..abfa78118 100644 --- a/packages/discordeno/src/bin/generate/desiredProperty.ts +++ b/packages/discordeno/src/bin/generate/desiredProperty.ts @@ -1,7 +1,7 @@ import type { DiscordenoConfig } from '../config.js' /** Mapping to all the dependencies a specific getter has */ -const computedDesiredProprieties = { +const computedDesiredProperties = { channel: { archived: ['toggles'], invitable: ['toggles'], @@ -73,9 +73,9 @@ export function isPropertyDesired(config: DiscordenoConfig, interfaceName: strin const name = pascalCaseToCamelCase(interfaceName) const interfaceProps = desiredProperties[name as keyof typeof desiredProperties] - const computedProps = computedDesiredProprieties[name as keyof typeof computedDesiredProprieties] + const computedProps = computedDesiredProperties[name as keyof typeof computedDesiredProperties] - // This interface does not support desired proprieties, so we include them + // This interface does not support desired properties, so we include them if (!interfaceProps) { return true } @@ -101,7 +101,7 @@ export function isPropertyDesired(config: DiscordenoConfig, interfaceName: strin export function getPropertyDependencies(interfaceName: string, memberName: string): string[] | undefined { const name = pascalCaseToCamelCase(interfaceName) - const computedProps = computedDesiredProprieties[name as keyof typeof computedDesiredProprieties] + const computedProps = computedDesiredProperties[name as keyof typeof computedDesiredProperties] if (!computedProps) return undefined diff --git a/packages/discordeno/src/bin/generate/typescript.ts b/packages/discordeno/src/bin/generate/typescript.ts index 120e57ad4..cf30307a4 100644 --- a/packages/discordeno/src/bin/generate/typescript.ts +++ b/packages/discordeno/src/bin/generate/typescript.ts @@ -1,7 +1,7 @@ import assert from 'node:assert' import { type WriteStream, createWriteStream } from 'node:fs' import ts from 'typescript' -import { DesiredProprietiesBehavior, type DiscordenoConfig, typescriptOptions } from '../config.js' +import { DesiredPropertiesBehavior, type DiscordenoConfig, typescriptOptions } from '../config.js' import { getPropertyDependencies, isPropertyDesired } from './desiredProperty.js' import { writeInterfaceMember, writeJSDoc } from './emitter.js' @@ -102,7 +102,7 @@ function handleUndesiredProperty( typeText: string, isOptional: boolean, ) { - if (config.desiredProperties.behavior === DesiredProprietiesBehavior.Remove) return + if (config.desiredProperties.behavior === DesiredPropertiesBehavior.Remove) return const dependencies = getPropertyDependencies(interfaceName, memberName) diff --git a/packages/types/src/discordeno.ts b/packages/types/src/discordeno.ts index 94a99bbeb..2a63a090e 100644 --- a/packages/types/src/discordeno.ts +++ b/packages/types/src/discordeno.ts @@ -1183,7 +1183,7 @@ export interface EditMessage { components?: MessageComponents } -/** Additional proprieties for https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions and https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions */ +/** Additional properties for https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions and https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions */ export interface GetApplicationCommandPermissionOptions { /** Access token of the user. Requires the `applications.commands.permissions.update` scope */ accessToken: string