(type: ElementType
) => ForwardRef extends true + ? ForwardRefExoticComponent & Props> + : ComponentClass & Props>; + DeviceSettingsStore: typeof UserAgnosticStore; + Emitter: Emitter; + initialize: typeof Store["initialize"]; + OfflineCacheStore: typeof UserAgnosticStore; + PersistedStore: typeof PersistedStore; + Store: typeof Store; +} diff --git a/packages/discord-types/src/flux/utils.ts b/packages/discord-types/src/flux/utils.ts new file mode 100644 index 000000000..5e6928459 --- /dev/null +++ b/packages/discord-types/src/flux/utils.ts @@ -0,0 +1,79 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish } from "../internal"; +import type { Store } from "./Store"; + +// For createFetchStore +export type FetchStoreFactory< + StoreConstraint extends Store = Store, + StateConstraint = unknown, + DependenciesConstraint extends readonly unknown[] = readonly unknown[], + IsLoadingConstraint extends boolean = boolean +> = < + S extends StoreConstraint, + State extends StateConstraint, + Dependencies extends DependenciesConstraint, + IsLoading extends IsLoadingConstraint +>( + store: S, + options: { + dangerousAbortOnCleanup?: boolean | undefined /* = false */; + get: (...dependencies: Dependencies) => State; + getIsLoading: (...dependencies: Dependencies) => IsLoading; + load: (signal: AbortSignal, ...dependencies: Dependencies) => Promise; + useStateHook: StoreStateHook<[S], State, Dependencies>; + } +) => (...dependencies: Dependencies) => { + data: State; + error: unknown; + isLoading: IsLoading; +}; + +// For useStateFromStores +export type StoreStateHook< + Stores extends readonly Store[] = readonly Store[], + StateConstraint = unknown, + Dependencies extends readonly unknown[] | Nullish = readonly unknown[] | Nullish +> = ( + stores: Stores, + getStateFromStores: () => State, + ...args: [ + ...undefined extends Dependencies + ? [dependencies?: Dependencies] + : [dependencies: Dependencies], + areStatesEqual?: ((prevState: State, nextState: State) => boolean) | undefined + ] +) => State; + +// For useStateFromStoresObject +export type StoreObjectStateHook< + Stores extends readonly Store[] = readonly Store[], + StateConstraint extends {} = {}, + Dependencies extends readonly unknown[] | Nullish = readonly unknown[] | Nullish +> = ( + stores: Stores, + getStateFromStores: () => State, + ...dependencies: undefined extends Dependencies + ? [dependencies?: Dependencies] + : [dependencies: Dependencies] +) => State; + +// For useStateFromStoresArray +export type StoreArrayStateHook< + Stores extends readonly Store[] = readonly Store[], + StateConstraint extends readonly unknown[] = readonly unknown[], + Dependencies extends readonly unknown[] | Nullish = readonly unknown[] | Nullish +> = ( + stores: Stores, + getStateFromStores: () => State, + ...dependencies: undefined extends Dependencies + ? [dependencies?: Dependencies] + : [dependencies: Dependencies] +) => State; + +// For statesWillNeverBeEqual +export type UnequatableStateComparator = () => false; diff --git a/packages/discord-types/src/general/Activity.ts b/packages/discord-types/src/general/Activity.ts new file mode 100644 index 000000000..aa688b6c2 --- /dev/null +++ b/packages/discord-types/src/general/Activity.ts @@ -0,0 +1,95 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +/** @todo May have more properties. */ +export interface Activity { + application_id?: string | number; + assets?: ActivityAssets; + buttons?: string[]; + created_at: number; + details?: string; + emoji?: ActivityEmoji; + flags?: ActivityFlags; + id: string; + metadata?: Record; + name: string; + party?: ActivityParty; + platform?: ActivityGamePlatform; + session_id?: string; + state?: string; + supported_platforms?: ActivityPlatform[]; + sync_id?: string; + timestamps?: ActivityTimestamps; + type: ActivityType; + url?: string; +} + +export interface ActivityAssets { + large_image?: string; + large_text?: string; + small_image?: string; + small_text?: string; +} + +export type ActivityEmoji = ActivityUnicodeEmoji | ActivityGuildEmoji; + +export interface ActivityUnicodeEmoji { + name: string; +} + +export interface ActivityGuildEmoji { + animated: boolean; + id: string; + name: string; +} + +export enum ActivityFlags { + INSTANCE = 1 << 0, + JOIN = 1 << 1, + SYNC = 1 << 4, + PLAY = 1 << 5, + PARTY_PRIVACY_FRIENDS = 1 << 6, + PARTY_PRIVACY_VOICE_CHANNEL = 1 << 7, + EMBEDDED = 1 << 8, +} + +export interface ActivityParty { + id?: string; + size?: [minimumSize: number, maximumSize: number]; +} + +// Original name: ActivityGamePlatforms +export enum ActivityGamePlatform { + ANDROID = "android", + DESKTOP = "desktop", + EMBEDDED = "embedded", + IOS = "ios", + PS4 = "ps4", + PS5 = "ps5", + SAMSUNG = "samsung", + XBOX = "xbox", +} + +export enum ActivityPlatform { + DESKTOP = "desktop", + MOBILE = "mobile", +} + +export interface ActivityTimestamps { + end?: number; + start?: number; +} + +// Original name: ActivityTypes +export enum ActivityType { + PLAYING = 0, + STREAMING = 1, + LISTENING = 2, + WATCHING = 3, + CUSTOM_STATUS = 4, + COMPETING = 5, + HANG_STATUS = 6, +} diff --git a/packages/discord-types/src/general/ApplicationCommand.ts b/packages/discord-types/src/general/ApplicationCommand.ts new file mode 100644 index 000000000..c207b6cd8 --- /dev/null +++ b/packages/discord-types/src/general/ApplicationCommand.ts @@ -0,0 +1,140 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { ApplicationIntegrationType } from "./ApplicationRecord"; +import type { ChannelType } from "./channels/ChannelRecord"; + +export type ApplicationCommand = { + application_id: string; + contexts?: InteractionContextType[] | null; + /** Permissions serialized as a string. */ + default_member_permissions: string | null; + default_permission?: boolean | null; + description: CommandType extends ApplicationCommandType.CHAT ? string : ""; + description_localizations?: { [locale: string]: string; } | null; + dm_permission?: boolean; + guild_id?: string; + id: string; + integration_types?: ApplicationIntegrationType[]; + name: string; + name_localizations?: { [locale: string]: string; } | null; + nsfw?: boolean; + type?: ApplicationCommandType; + version: string; +} & (CommandType extends ApplicationCommandType.CHAT ? { options?: ApplicationCommandOption[]; } : {}); + +export enum InteractionContextType { + GUILD = 0, + BOT_DM = 1, + PRIVATE_CHANNEL = 2, +} + +export enum ApplicationCommandType { + CHAT = 1, + USER = 2, + MESSAGE = 3, + PRIMARY_ENTRY_POINT = 4, +} + +export type ApplicationCommandOption = ApplicationCommandSubcommandOption | ApplicationCommandSubcommandGroupOption | ApplicationCommandNonSubOption; + +export interface ApplicationCommandOptionBase extends Pick { + type: ApplicationCommandOptionType; +} + +export interface ApplicationCommandSubcommandOption extends ApplicationCommandOptionBase { + options?: ApplicationCommandNonSubOption[]; + type: ApplicationCommandOptionType.SUB_COMMAND; +} + +export interface ApplicationCommandSubcommandGroupOption extends ApplicationCommandOptionBase { + options?: ApplicationCommandOption[]; + type: ApplicationCommandOptionType.SUB_COMMAND; +} + +export type ApplicationCommandNonSubOption = ApplicationCommandChoicesOption | ApplicationCommandBooleanOption | ApplicationCommandUserOption | ApplicationCommandChannelOption | ApplicationCommandRoleOption | ApplicationCommandMentionableOption | ApplicationCommandAttachmentOption; + +export interface ApplicationCommandNonSubOptionBase extends ApplicationCommandOptionBase { + required?: boolean; +} + +type ApplicationCommandChoiceOptionType = ApplicationCommandOptionType.STRING | ApplicationCommandOptionType.INTEGER | ApplicationCommandOptionType.NUMBER; + +export type ApplicationCommandChoicesOption = ApplicationCommandStringOption | ApplicationCommandNumericOption; + +export type ApplicationCommandChoicesOptionBase = ApplicationCommandNonSubOptionBase + & { type: ApplicationCommandChoiceOptionType; } + & ({ autocomplete?: false; choice: ApplicationCommandOptionChoice[]; } + | { autocomplete?: boolean; }); + +export interface ApplicationCommandOptionChoice< + OptionType extends ApplicationCommandChoiceOptionType = ApplicationCommandChoiceOptionType +> extends Pick { + value: OptionType extends ApplicationCommandOptionType.STRING ? string + : OptionType extends ApplicationCommandOptionType.INTEGER | ApplicationCommandOptionType.NUMBER ? number + : never; +} + +export type ApplicationCommandStringOption = ApplicationCommandChoicesOptionBase & { + max_length?: number; + min_length?: number; + type: ApplicationCommandOptionType.STRING; +}; + +export type ApplicationCommandNumericOption = ApplicationCommandIntegerOption | ApplicationCommandNumberOption; + +export type ApplicationCommandNumericOptionBase = ApplicationCommandChoicesOptionBase & { + max_value?: number; + min_value?: number; + type: ApplicationCommandOptionType.INTEGER | ApplicationCommandOptionType.NUMBER; +}; + +export type ApplicationCommandIntegerOption = ApplicationCommandNumericOptionBase & { + type: ApplicationCommandOptionType.INTEGER; +}; + +export type ApplicationCommandNumberOption = ApplicationCommandNumericOptionBase & { + type: ApplicationCommandOptionType.NUMBER; +}; + +export interface ApplicationCommandBooleanOption extends ApplicationCommandNonSubOptionBase { + type: ApplicationCommandOptionType.BOOLEAN; +} + +export interface ApplicationCommandUserOption extends ApplicationCommandNonSubOptionBase { + type: ApplicationCommandOptionType.USER; +} + +export interface ApplicationCommandChannelOption extends ApplicationCommandNonSubOptionBase { + channel_types?: ChannelType[]; + type: ApplicationCommandOptionType.CHANNEL; +} + +export interface ApplicationCommandRoleOption extends ApplicationCommandNonSubOptionBase { + type: ApplicationCommandOptionType.ROLE; +} + +export interface ApplicationCommandMentionableOption extends ApplicationCommandNonSubOptionBase { + type: ApplicationCommandOptionType.MENTIONABLE; +} + +export interface ApplicationCommandAttachmentOption extends ApplicationCommandNonSubOptionBase { + type: ApplicationCommandOptionType.ATTACHMENT; +} + +export enum ApplicationCommandOptionType { + SUB_COMMAND = 1, + SUB_COMMAND_GROUP = 2, + STRING = 3, + INTEGER = 4, + BOOLEAN = 5, + USER = 6, + CHANNEL = 7, + ROLE = 8, + MENTIONABLE = 9, + NUMBER = 10, + ATTACHMENT = 11, +} diff --git a/packages/discord-types/src/general/ApplicationRecord.ts b/packages/discord-types/src/general/ApplicationRecord.ts new file mode 100644 index 000000000..ac34e63e2 --- /dev/null +++ b/packages/discord-types/src/general/ApplicationRecord.ts @@ -0,0 +1,217 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish, Optional, PartialOnUndefined, SnakeCasedProperties } from "../internal"; +import type { CompanyRecord } from "./CompanyRecord"; +import type { IconSource } from "./misc"; +import type { RecordBase } from "./Record"; +import type { UserRecord } from "./UserRecord"; + +export type ApplicationRecordOwnProperties = Pick; + +export type ApplicationProperties = Optional>, Nullish, "id" | "integrationTypesConfig" | "maxParticipants" | "name" | "primarySkuId" | "privacyPolicyUrl" | "roleConnectionsVerificationUrl" | "storefront_available" | "storeListingSkuId" | "team" | "termsOfServiceUrl" | "type", true> + & SnakeCasedProperties>> + & { executables: Readonly; }; + +export declare class ApplicationRecord< + OwnProperties extends ApplicationRecordOwnProperties = ApplicationRecordOwnProperties +> extends RecordBase { + constructor(applicationProperties: ApplicationProperties); + + /** @todo */ + static createFromServer(applicationFromServer: Record): ApplicationRecord; + static supportsOutOfProcessOverlay(overlayMethods?: ApplicationOverlayMethodFlags | null): boolean; + + get destinationSkuId(): string | undefined; + getCoverImageURL(imageSize?: number): string | null; + getIconSource(iconSize?: number, iconFormat?: string | null): IconSource | null; + getIconURL(iconSize?: number, iconFormat?: string | null): string | null; + getMaxParticipants(): number; + getSplashURL(splashSize?: number, splashFormat?: string | null): string | null; + supportsIntegrationTypes(...integrationTypes: ApplicationIntegrationType[]): boolean; + get supportsOutOfProcessOverlay(): boolean; + + aliases: string[]; + bot: UserRecord | null; + coverImage: string | null; + customInstallUrl: string | undefined; + description: string | null; + developers: CompanyRecord[]; + embeddedActivityConfig: EmbeddedActivityConfig | undefined; + eulaId: string | null; + executables: ApplicationExecutable[]; + flags: ApplicationFlags; + /** @todo This is not a GuildRecord; it is a guild object from the API. */ + guild: Record | null; + guildId: string | null; + hashes: string[]; + hook: boolean; + icon: string | null; + id: string; + installParams: ApplicationInstallParams | undefined; + integrationTypesConfig: Partial> | null; + isMonetized: boolean; + isVerified: boolean; + maxParticipants: number | undefined; + name: string; + overlay: boolean; + overlayCompatibilityHook: boolean; + overlayMethods: ApplicationOverlayMethodFlags; + overlayWarn: boolean; + primarySkuId: string | undefined; + privacyPolicyUrl: string | undefined; + publishers: CompanyRecord[]; + roleConnectionsVerificationUrl: string | undefined; + slug: string | null; + splash: string | null; + storefront_available: boolean | undefined; + storeListingSkuId: string | undefined; + tags: string[]; + /** @todo This is a team object from the API. */ + team: Record | null; + termsOfServiceUrl: string | undefined; + thirdPartySkus: string[]; + type: ApplicationType | null; +} + +/** @todo Some properties may not actually be optional or unlikely may also be null. */ +export interface EmbeddedActivityConfig { + application_id: string; + client_platform_config: Partial>; + default_orientation_lock_state?: OrientationLockState; + displays_advertisements?: boolean; + has_csp_exception?: boolean; + requires_age_gate?: boolean; + shelf_rank?: number; + supported_platforms?: EmbeddedActivitySupportedPlatform[]; + tablet_default_orientation_lock_state?: OrientationLockState; +} + +// Original name: EmbeddedActivitySupportedPlatforms +export enum EmbeddedActivitySupportedPlatform { + ANDROID = "android", + IOS = "ios", + WEB = "web", +} + +/** @todo Some properties may not actually be optional or unlikely may also be null. */ +export interface EmbeddedActivityClientPlatformConfig { + label_type?: EmbeddedActivityLabelType; + label_until?: string | null; + release_phase: string; +} + +// Original name: EmbeddedActivityLabelTypes +export enum EmbeddedActivityLabelType { + NONE = 0, + NEW = 1, + UPDATED = 2, +} + +export enum OrientationLockState { + UNLOCKED = 1, + PORTRAIT = 2, + LANDSCAPE = 3, +} + +export interface ApplicationExecutable { + arguments?: string[]; + isLauncher?: boolean; + name: string; + os: string; +} + +export interface ApplicationInstallParams { + /** Permissions serialized as a string. */ + permissions: string; + scopes: OAuth2Scope[]; +} + +// Original name: OAuth2Scopes +export enum OAuth2Scope { + ACCOUNT_GLOBAL_NAME_UPDATE = "account.global_name.update", + ACTIVITIES_READ = "activities.read", + ACTIVITIES_WRITE = "activities.write", + APPLICATIONS_BUILDS_READ = "applications.builds.read", + APPLICATIONS_BUILDS_UPLOAD = "applications.builds.upload", + APPLICATIONS_COMMANDS = "applications.commands", + APPLICATIONS_COMMANDS_PERMISSIONS_UPDATE = "applications.commands.permissions.update", + APPLICATIONS_COMMANDS_UPDATE = "applications.commands.update", + APPLICATIONS_ENTITLEMENTS = "applications.entitlements", + APPLICATIONS_STORE_UPDATE = "applications.store.update", + BOT = "bot", + CONNECTIONS = "connections", + DM_CHANNELS_MESSAGES_READ = "dm_channels.messages.read", + DM_CHANNELS_MESSAGES_WRITE = "dm_channels.messages.write", + DM_CHANNELS_READ = "dm_channels.read", + EMAIL = "email", + GATEWAY_CONNECT = "gateway.connect", + GDM_JOIN = "gdm.join", + GUILDS = "guilds", + GUILDS_CHANNELS_READ = "guilds.channels.read", + GUILDS_JOIN = "guilds.join", + GUILDS_MEMBERS_READ = "guilds.members.read", + IDENTIFY = "identify", + MESSAGES_READ = "messages.read", + OPENID = "openid", + PAYMENT_SOURCES_COUNTRY_CODE = "payment_sources.country_code", + PRESENCES_READ = "presences.read", + PRESENCES_WRITE = "presences.write", + RELATIONSHIPS_READ = "relationships.read", + RELATIONSHIPS_WRITE = "relationships.write", + ROLE_CONNECTIONS_WRITE = "role_connections.write", + RPC = "rpc", + RPC_ACTIVITIES_WRITE = "rpc.activities.write", + RPC_NOTIFICATIONS_READ = "rpc.notifications.read", + RPC_SCREENSHARE_READ = "rpc.screenshare.read", + RPC_SCREENSHARE_WRITE = "rpc.screenshare.write", + RPC_VIDEO_READ = "rpc.video.read", + RPC_VIDEO_WRITE = "rpc.video.write", + RPC_VOICE_READ = "rpc.voice.read", + RPC_VOICE_WRITE = "rpc.voice.write", + SDK_SOCIAL_LAYER = "sdk.social_layer", + VOICE = "voice", + WEBHOOK_INCOMING = "webhook.incoming", +} + +export enum ApplicationIntegrationType { + GUILD_INSTALL = 0, + USER_INSTALL = 1, +} + +export interface ApplicationIntegrationTypeConfig { + oauth2InstallParams: ApplicationInstallParams | undefined; +} + +export enum ApplicationFlags { + EMBEDDED_RELEASED = 1 << 1, + EMBEDDED_IAP = 1 << 3, + APPLICATION_AUTO_MODERATION_RULE_CREATE_BADGE = 1 << 6, + GATEWAY_PRESENCE = 1 << 12, + GATEWAY_PRESENCE_LIMITED = 1 << 13, + GATEWAY_GUILD_MEMBERS = 1 << 14, + GATEWAY_GUILD_MEMBERS_LIMITED = 1 << 15, + EMBEDDED = 1 << 17, + GATEWAY_MESSAGE_CONTENT = 1 << 18, + GATEWAY_MESSAGE_CONTENT_LIMITED = 1 << 19, + EMBEDDED_FIRST_PARTY = 1 << 20, + APPLICATION_COMMAND_BADGE = 1 << 23, + SOCIAL_LAYER_INTEGRATION = 1 << 27, + PROMOTED = 1 << 29, + PARTNER = 1 << 30, +} + +export enum ApplicationOverlayMethodFlags { + DEFAULT = 0, + OUT_OF_PROCESS = 1 << 0, +} + +// Original name: ApplicationTypes +export enum ApplicationType { + GAME = 1, + TICKETED_EVENTS = 3, + GUILD_ROLE_SUBSCRIPTIONS = 4, +} diff --git a/packages/discord-types/src/general/Clan.ts b/packages/discord-types/src/general/Clan.ts new file mode 100644 index 000000000..74a8aa708 --- /dev/null +++ b/packages/discord-types/src/general/Clan.ts @@ -0,0 +1,75 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +export interface Clan { + badge: { + badgeKind: ClanBadgeKind; + primaryColor: string; + secondaryColor: string; + }; + banner: ClanBannerKind; + bannerHash: string | null; + branding: { + primaryColor: string; + secondaryColor: string; + }; + description: string | null; + games: string[]; + icon: string | null; + id: string; + memberCount: number; + name: string; + playstyle: ClanPlaystyle; + tag: string; + traits: string[]; + wildcardDescriptors: string[]; +} + +export enum ClanBadgeKind { + SWORD = 0, + WATER_DROP = 1, + SKULL = 2, + TOADSTOOL = 3, + MOON = 4, + LIGHTNING = 5, + LEAF = 6, + HEART = 7, + FIRE = 8, + COMPASS = 9, + CROSSHAIRS = 10, + FLOWER = 11, + FORCE = 12, + GEM = 13, + LAVA = 14, + PSYCHIC = 15, + SMOKE = 16, + SNOW = 17, + SOUND = 18, + SUN = 19, + WIND = 20, +} + +export enum ClanBannerKind { + NIGHT_SKY = 0, + CASTLE = 1, + WORLD_MAP = 2, + SEA_FOAM = 3, + WARP_TUNNEL = 4, + HOUSE = 5, + HEIGHTMAP = 6, + MESH = 7, + SPATTER = 8, +} + +// Original name: ClanPlaystyles +export enum ClanPlaystyle { + NONE = 0, + SOCIAL = 1, + CASUAL = 2, + COMPETITIVE = 3, + CREATIVE = 4, + VERY_HARDCORE = 5, +} diff --git a/packages/discord-types/src/general/CompanyRecord.ts b/packages/discord-types/src/general/CompanyRecord.ts new file mode 100644 index 000000000..09c7174d3 --- /dev/null +++ b/packages/discord-types/src/general/CompanyRecord.ts @@ -0,0 +1,20 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { RecordBase } from "./Record"; + +export type CompanyRecordOwnProperties = Pick; + +export declare class CompanyRecord< + OwnProperties extends CompanyRecordOwnProperties = CompanyRecordOwnProperties +> extends RecordBase { + constructor(companyProperties: CompanyRecordOwnProperties); + + static createFromServer(companyFromServer: CompanyRecordOwnProperties): CompanyRecord; + + id: string; + name: string; +} diff --git a/packages/discord-types/src/general/DisplayProfile.ts b/packages/discord-types/src/general/DisplayProfile.ts new file mode 100644 index 000000000..02e2917eb --- /dev/null +++ b/packages/discord-types/src/general/DisplayProfile.ts @@ -0,0 +1,68 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish, OptionalTuple } from "../internal"; +import type { GuildMemberProfile } from "./GuildMemberProfile"; +import type { ProfileBadge, ProfileThemeColors, UserProfile } from "./UserProfile"; + +export declare class DisplayProfile< + FetchFailed extends boolean = boolean, + Guild extends boolean = boolean +> { + constructor( + userProfile: UserProfile, + ...guildMemberProfile: Guild extends true + ? [guildMemberProfile: GuildMemberProfile] + : [guildMemberProfile?: null] + ); + + get application(): UserProfile["application"]; + get canEditThemes(): boolean; + get canUsePremiumProfileCustomization(): boolean; + getBadges(): ProfileBadge[]; + getBannerURL(options: { + canAnimate?: boolean /* = false */; + size: number; + }): string | undefined; + getLegacyUsername(): UserProfile["legacyUsername"]; + getPreviewBanner( + pendingBanner?: string | null, + canAnimate?: boolean, + size?: number /* = 480 */ + ): string | Nullish; + getPreviewBio(pendingBio?: string | null): Guild | false extends infer GuildValue + ? GuildValue extends true + ? { isUsingGuildValue: true; value: string; } + : { isUsingGuildValue: false; value: string | undefined; } + : never; + getPreviewThemeColors( + pendingThemeColors?: OptionalTuple | null + ): UserProfile["themeColors"]; + hasFullProfile(): boolean; + hasPremiumCustomization(): boolean; + hasThemeColors(): boolean; + isUsingGuildMemberBanner(): Guild | false; + isUsingGuildMemberBio(): Guild | false; + isUsingGuildMemberPronouns(): Guild | false; + get premiumGuildSince(): UserProfile["premiumGuildSince"]; + get premiumSince(): UserProfile["premiumSince"]; + get premiumType(): UserProfile["premiumType"]; + get primaryColor(): UserProfile["accentColor"]; + + _guildMemberProfile: Guild extends true ? GuildMemberProfile : Nullish; + _userProfile: UserProfile; + accentColor: UserProfile["accentColor"]; + banner: UserProfile["banner"]; + bio: UserProfile["bio"]; + guildId: Guild extends true ? string : undefined; + /** @todo Does not seem to be implemented. */ + popoutAnimationParticleType: UserProfile["popoutAnimationParticleType"]; + profileEffectExpiresAt: UserProfile["profileEffectExpiresAt"]; + profileEffectId: UserProfile["profileEffectId"]; + pronouns: UserProfile["pronouns"]; + themeColors: UserProfile["themeColors"]; + userId: UserProfile["userId"]; +} diff --git a/packages/discord-types/src/general/Draft.ts b/packages/discord-types/src/general/Draft.ts new file mode 100644 index 000000000..a1c6d98cb --- /dev/null +++ b/packages/discord-types/src/general/Draft.ts @@ -0,0 +1,45 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +/** @todo It seems that the other DraftTypes are either not handled by DraftStore or not yet implemented. */ +export type Draft + = Type extends DraftType.CHANNEL_MESSAGE | DraftType.FIRST_THREAD_MESSAGE ? DraftMessage + : Type extends DraftType.THREAD_SETTINGS ? DraftThreadSettings + : never; + +// Enum keys made screaming snake case for consistency. +export enum DraftType { + CHANNEL_MESSAGE = 0, + THREAD_SETTINGS = 1, + FIRST_THREAD_MESSAGE = 2, + APPLICATION_LAUNCHER_COMMAND = 3, + POLL = 4, + SLASH_COMMAND = 5, +} + +export interface DraftBase { + timestamp: number; +} + +export interface DraftMessage extends DraftBase { + draft: string; +} + +export type DraftThreadSettings = DraftForumThreadSettings | DraftNonForumThreadSettings; + +export interface DraftThreadSettingsBase extends DraftBase { + name?: string; + parentChannelId: string; +} + +export interface DraftForumThreadSettings extends DraftThreadSettingsBase { + appliedTags?: Set; +} + +export interface DraftNonForumThreadSettings extends DraftThreadSettingsBase { + isPrivate?: boolean; + parentMessageId?: string | undefined; +} diff --git a/packages/discord-types/src/general/Frecency.ts b/packages/discord-types/src/general/Frecency.ts new file mode 100644 index 000000000..0a25b3d9e --- /dev/null +++ b/packages/discord-types/src/general/Frecency.ts @@ -0,0 +1,70 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish } from "../internal"; + +export declare class Frecency { + constructor(options: { + afterCompute: Frecency["afterCompute"]; + computeBonus: Frecency["computeBonus"]; + computeFrecency?: Frecency["computeFrecency"] | undefined /* = frecencyAlgorithms.original */; + computeWeight: Frecency["computeWeight"]; + lookupKey: Frecency["lookupKey"]; + maxSamples?: number | undefined /* = 10 */; + numFrequentlyItems?: number | undefined /* = 32 */; + }); + + compute(): void; + get frequently(): Value[]; + set frequently(values: Value[]); + getEntry(key?: Key | null): FrecencyUsageHistoryEntry | Nullish; + getFrecency(key?: Key | null): number | null; + getScore(key?: Key | null): number | null; + isDirty(): boolean; + markDirty(): void; + overwriteHistory( + usageHistory?: Omit | null, + track?: readonly { + key?: Key | Nullish; + timestamp?: number | Nullish; + }[] | null + ): void; + replaceEntryComputeFunctions( + computeWeight: Frecency["computeWeight"], + computeFrecency: Frecency["computeFrecency"], + calculateMaxTotalUse: Frecency["calculateMaxTotalUse"] + ): void; + track(key?: Key | null, timestamp?: number | null): void; + + _frequently: Value[]; + afterCompute: ( + usageHistory: Frecency["usageHistory"], + frequently: Frecency["frequently"] + ) => void; + calculateMaxTotalUse: boolean; + computeBonus: (key: Key) => number; + computeFrecency: ( + totalUses: number, + score: number, + usageStats: { + maxTotalUse: number | undefined; + numOfRecentUses: number; + } + ) => number; + computeWeight: (daysSinceUsage: number) => number; + dirty: boolean; + lookupKey: (key: Key) => Value; + maxSamples: number; + numFrequentlyItems: number; + usageHistory: Partial>; +} + +export interface FrecencyUsageHistoryEntry { + frecency: number; + recentUses: number[]; + score: number; + totalUses: number; +} diff --git a/packages/discord-types/src/general/GuildMember.ts b/packages/discord-types/src/general/GuildMember.ts new file mode 100644 index 000000000..d4ddbc447 --- /dev/null +++ b/packages/discord-types/src/general/GuildMember.ts @@ -0,0 +1,43 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish } from "../internal"; +import type { AvatarDecorationData } from "./UserRecord"; + +export interface GuildMember { + avatar: string | null; + avatarDecoration: AvatarDecorationData | undefined; + colorRoleId: string | undefined; + colorString: string | undefined; + communicationDisabledUntil: string | null; + flags: GuildMemberFlags; + fullProfileLoadedTimestamp: number | undefined; + guildId: string; + highestRoleId: string | undefined; + hoistRoleId: string | undefined; + iconRoleId: string | undefined; + isPending: boolean; + joinedAt: string; + nick: string | null; + premiumSince: string | null; + roles: string[]; + unusualDMActivityUntil: string | Nullish; + userId: string; +} + +export enum GuildMemberFlags { + DID_REJOIN = 1 << 0, + COMPLETED_ONBOARDING = 1 << 1, + BYPASSES_VERIFICATION = 1 << 2, + STARTED_ONBOARDING = 1 << 3, + IS_GUEST = 1 << 4, + STARTED_HOME_ACTIONS = 1 << 5, + COMPLETED_HOME_ACTIONS = 1 << 6, + AUTOMOD_QUARANTINED_USERNAME_OR_GUILD_NICKNAME = 1 << 7, + AUTOMOD_QUARANTINED_BIO = 1 << 8, + DM_SETTINGS_UPSELL_ACKNOWLEDGED = 1 << 9, + AUTOMOD_QUARANTINED_CLAN_TAG = 1 << 10, +} diff --git a/packages/discord-types/src/general/GuildMemberProfile.ts b/packages/discord-types/src/general/GuildMemberProfile.ts new file mode 100644 index 000000000..3b7c57fba --- /dev/null +++ b/packages/discord-types/src/general/GuildMemberProfile.ts @@ -0,0 +1,23 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish } from "../internal"; +import type { ProfileBadge, ProfileThemeColors } from "./UserProfile"; + +export interface GuildMemberProfile { + accentColor: number | Nullish; + badges: ProfileBadge[]; + banner: string | Nullish; + bio: string | undefined; + guildId: string; + /** @todo Does not seem to be implemented. */ + popoutAnimationParticleType: any /* | Nullish */; + profileEffectExpiresAt: number | Nullish; + profileEffectId: string | undefined; + pronouns: string; + themeColors: ProfileThemeColors | Nullish; + userId: string; +} diff --git a/packages/discord-types/src/general/GuildRecord.ts b/packages/discord-types/src/general/GuildRecord.ts new file mode 100644 index 000000000..3399bf8cb --- /dev/null +++ b/packages/discord-types/src/general/GuildRecord.ts @@ -0,0 +1,221 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish, Optional } from "../internal"; +import type { Clan } from "./Clan"; +import type { IconSource } from "./misc"; +import type { RecordBase } from "./Record"; +import type { UserRecord } from "./UserRecord"; + +export type GuildRecordOwnProperties = Pick; + +export type GuildProperties = Optional, Nullish, "afkTimeout" | "hubType" | "id" | "systemChannelFlags", true> & { + features?: Iterable | ArrayLike | Nullish; + joinedAt: Date | string | number; +}; + +export declare class GuildRecord< + OwnProperties extends GuildRecordOwnProperties = GuildRecordOwnProperties +> extends RecordBase { + constructor(guildProperties: GuildProperties); + + get acronym(): string; + canHaveRaidActivityAlerts(): boolean; + getApplicationId(): string | null; + getEveryoneRoleId(): string; + getIconSource(iconSize?: number, canAnimate?: boolean /* = false */): IconSource; + getIconURL(iconSize?: number, canAnimate?: boolean /* = false */): string; + getMaxEmojiSlots(): number; + getMaxRoleSubscriptionEmojiSlots(): number; + getMaxSoundboardSlots(): number; + getSafetyAlertsChannelId(): string | null; + hasCommunityInfoSubheader(): boolean; + hasFeature(guildFeature: GuildFeature): boolean; + hasVerificationGate(): boolean; + isCommunity(): boolean; + isLurker(): boolean; + isNew(): boolean; + isOwner(userOrUserId?: UserRecord | string | null): boolean; + isOwnerWithRequiredMfaLevel(userOrUserId?: UserRecord | string | null): boolean; + updateJoinedAt(joinedAt: Date | string): this; + + afkChannelId: string | null; + afkTimeout: number; + application_id: string | null; + banner: string | null; + clan: Clan | null; + defaultMessageNotifications: UserNotificationSetting; + description: string | null; + discoverySplash: string | null; + explicitContentFilter: GuildExplicitContentFilterType; + features: Set; + homeHeader: string | null; + hubType: GuildHubType | null; + icon: string | null; + id: string; + joinedAt: Date; + latestOnboardingQuestionId: string | null; + maxMembers: number; + maxStageVideoChannelUsers: number; + maxVideoChannelUsers: number; + mfaLevel: MFALevel; + name: string; + nsfwLevel: GuildNSFWContentLevel; + ownerId: string | null; + preferredLocale: string; + premiumProgressBarEnabled: boolean; + premiumSubscriberCount: number; + premiumTier: BoostedGuildTier; + publicUpdatesChannelId: string | null; + rulesChannelId: string | null; + safetyAlertsChannelId: string | null; + splash: string | null; + systemChannelFlags: SystemChannelFlags; + systemChannelId: string | null; + vanityURLCode: string | null; + verificationLevel: VerificationLevel; +} + +// Original name: UserNotificationSettings +export enum UserNotificationSetting { + ALL_MESSAGES = 0, + ONLY_MENTIONS = 1, + NO_MESSAGES = 2, + NULL = 3, +} + +// Original name: GuildExplicitContentFilterTypes +export enum GuildExplicitContentFilterType { + DISABLED = 0, + MEMBERS_WITHOUT_ROLES = 1, + ALL_MEMBERS = 2, +} + +// Original name: GuildFeatures +export enum GuildFeature { + ACTIVITY_FEED_DISABLED_BY_USER = "ACTIVITY_FEED_DISABLED_BY_USER", + ACTIVITY_FEED_ENABLED_BY_USER = "ACTIVITY_FEED_ENABLED_BY_USER", + ANIMATED_BANNER = "ANIMATED_BANNER", + ANIMATED_ICON = "ANIMATED_ICON", + AUTO_MODERATION = "AUTO_MODERATION", + AUTOMOD_TRIGGER_USER_PROFILE = "AUTOMOD_TRIGGER_USER_PROFILE", + BANNER = "BANNER", + BURST_REACTIONS = "BURST_REACTIONS", + CHANNEL_ICON_EMOJIS_GENERATED = "CHANNEL_ICON_EMOJIS_GENERATED", + CLAN = "CLAN", + CLAN_DISCOVERY_DISABLED = "CLAN_DISCOVERY_DISABLED", + CLAN_PILOT_GENSHIN = "CLAN_PILOT_GENSHIN", + CLAN_PILOT_VALORANT = "CLAN_PILOT_VALORANT", + CLYDE_DISABLED = "CLYDE_DISABLED", + CLYDE_ENABLED = "CLYDE_ENABLED", + COMMERCE = "COMMERCE", + COMMUNITY = "COMMUNITY", + CREATOR_MONETIZABLE = "CREATOR_MONETIZABLE", + CREATOR_MONETIZABLE_DISABLED = "CREATOR_MONETIZABLE_DISABLED", + CREATOR_MONETIZABLE_PENDING_NEW_OWNER_ONBOARDING = "CREATOR_MONETIZABLE_PENDING_NEW_OWNER_ONBOARDING", + CREATOR_MONETIZABLE_PROVISIONAL = "CREATOR_MONETIZABLE_PROVISIONAL", + CREATOR_MONETIZABLE_RESTRICTED = "CREATOR_MONETIZABLE_RESTRICTED", + CREATOR_MONETIZABLE_WHITEGLOVE = "CREATOR_MONETIZABLE_WHITEGLOVE", + CREATOR_STORE_PAGE = "CREATOR_STORE_PAGE", + DISCOVERABLE = "DISCOVERABLE", + ENABLED_DISCOVERABLE_BEFORE = "ENABLED_DISCOVERABLE_BEFORE", + ENABLED_MODERATION_EXPERIENCE_FOR_NON_COMMUNITY = "ENABLED_MODERATION_EXPERIENCE_FOR_NON_COMMUNITY", + EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT = "EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT", + FEATURABLE = "FEATURABLE", + GENSHIN_L30 = "GENSHIN_L30", + GUILD_HOME_DEPRECATION_OVERRIDE = "GUILD_HOME_DEPRECATION_OVERRIDE", + GUILD_HOME_OVERRIDE = "GUILD_HOME_OVERRIDE", + GUILD_HOME_TEST = "GUILD_HOME_TEST", + GUILD_ONBOARDING = "GUILD_ONBOARDING", + GUILD_ONBOARDING_EVER_ENABLED = "GUILD_ONBOARDING_EVER_ENABLED", + GUILD_ONBOARDING_HAS_PROMPTS = "GUILD_ONBOARDING_HAS_PROMPTS", + GUILD_PRODUCTS_ALLOW_ARCHIVED_FILE = "GUILD_PRODUCTS_ALLOW_ARCHIVED_FILE", + GUILD_SERVER_GUIDE = "GUILD_SERVER_GUIDE", + GUILD_WEB_PAGE_VANITY_URL = "GUILD_WEB_PAGE_VANITY_URL", + HAS_DIRECTORY_ENTRY = "HAS_DIRECTORY_ENTRY", + HUB = "HUB", + INTERNAL_EMPLOYEE_ONLY = "INTERNAL_EMPLOYEE_ONLY", + INVITE_SPLASH = "INVITE_SPLASH", + INVITES_DISABLED = "INVITES_DISABLED", + LINKED_TO_HUB = "LINKED_TO_HUB", + MEMBER_VERIFICATION_GATE_ENABLED = "MEMBER_VERIFICATION_GATE_ENABLED", + MEMBER_VERIFICATION_MANUAL_APPROVAL = "MEMBER_VERIFICATION_MANUAL_APPROVAL", + MORE_EMOJI = "MORE_EMOJI", + MORE_SOUNDBOARD = "MORE_SOUNDBOARD", + MORE_STICKERS = "MORE_STICKERS", + NEW_THREAD_PERMISSIONS = "NEW_THREAD_PERMISSIONS", + NEWS = "NEWS", + NON_COMMUNITY_RAID_ALERTS = "NON_COMMUNITY_RAID_ALERTS", + PARTNERED = "PARTNERED", + PREVIEW_ENABLED = "PREVIEW_ENABLED", + PRODUCTS_AVAILABLE_FOR_PURCHASE = "PRODUCTS_AVAILABLE_FOR_PURCHASE", + RAID_ALERTS_DISABLED = "RAID_ALERTS_DISABLED", + RAPIDASH_TEST = "RAPIDASH_TEST", + ROLE_ICONS = "ROLE_ICONS", + ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE = "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE", + ROLE_SUBSCRIPTIONS_ENABLED = "ROLE_SUBSCRIPTIONS_ENABLED", + SHARD = "SHARD", + SOUNDBOARD = "SOUNDBOARD", + SUMMARIES_ENABLED_BY_USER = "SUMMARIES_ENABLED_BY_USER", + SUMMARIES_ENABLED_GA = "SUMMARIES_ENABLED_GA", + SUMMARIES_OPT_OUT_EXPERIENCE = "SUMMARIES_OPT_OUT_EXPERIENCE", + TEXT_IN_STAGE_ENABLED = "TEXT_IN_STAGE_ENABLED", + TEXT_IN_VOICE_ENABLED = "TEXT_IN_VOICE_ENABLED", + THREADS_ENABLED = "THREADS_ENABLED", + THREADS_ENABLED_TESTING = "THREADS_ENABLED_TESTING", + VALORANT_L30 = "VALORANT_L30", + VANITY_URL = "VANITY_URL", + VERIFIED = "VERIFIED", + VIP_REGIONS = "VIP_REGIONS", + WELCOME_SCREEN_ENABLED = "WELCOME_SCREEN_ENABLED", +} + +// Original name: GuildHubTypes +export enum GuildHubType { + DEFAULT = 0, + HIGH_SCHOOL = 1, + COLLEGE = 2, +} + +// Original name: MFALevels +export enum MFALevel { + NONE = 0, + ELEVATED = 1, +} + +export enum GuildNSFWContentLevel { + DEFAULT = 0, + EXPLICIT = 1, + SAFE = 2, + AGE_RESTRICTED = 3, +} + +// Original name: BoostedGuildTiers +export enum BoostedGuildTier { + NONE = 0, + TIER_1 = 1, + TIER_2 = 2, + TIER_3 = 3, +} + +export enum SystemChannelFlags { + SUPPRESS_JOIN_NOTIFICATIONS = 1 << 0, + SUPPRESS_PREMIUM_SUBSCRIPTIONS = 1 << 1, + SUPPRESS_GUILD_REMINDER_NOTIFICATIONS = 1 << 2, + SUPPRESS_JOIN_NOTIFICATION_REPLIES = 1 << 3, + SUPPRESS_ROLE_SUBSCRIPTION_PURCHASE_NOTIFICATIONS = 1 << 4, + SUPPRESS_ROLE_SUBSCRIPTION_PURCHASE_NOTIFICATION_REPLIES = 1 << 5, + SUPPRESS_CHANNEL_PROMPT_DEADCHAT = 1 << 7, +} + +// Original name: VerificationLevels +export enum VerificationLevel { + NONE = 0, + LOW = 1, + MEDIUM = 2, + HIGH = 3, + VERY_HIGH = 4, +} diff --git a/packages/discord-types/src/general/Permissions.ts b/packages/discord-types/src/general/Permissions.ts new file mode 100644 index 000000000..af48f258b --- /dev/null +++ b/packages/discord-types/src/general/Permissions.ts @@ -0,0 +1,78 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +/* +// bigint enums are not yet possible: https://github.com/microsoft/TypeScript/issues/37783 +export enum Permissions { + CREATE_INSTANT_INVITE = 1n << 0n, + KICK_MEMBERS = 1n << 1n, + BAN_MEMBERS = 1n << 2n, + ADMINISTRATOR = 1n << 3n, + MANAGE_CHANNELS = 1n << 4n, + MANAGE_GUILD = 1n << 5n, + ADD_REACTIONS = 1n << 6n, + VIEW_AUDIT_LOG = 1n << 7n, + PRIORITY_SPEAKER = 1n << 8n, + STREAM = 1n << 9n, + VIEW_CHANNEL = 1n << 10n, + SEND_MESSAGES = 1n << 11n, + SEND_TTS_MESSAGES = 1n << 12n, + MANAGE_MESSAGES = 1n << 13n, + EMBED_LINKS = 1n << 14n, + ATTACH_FILES = 1n << 15n, + READ_MESSAGE_HISTORY = 1n << 16n, + MENTION_EVERYONE = 1n << 17n, + USE_EXTERNAL_EMOJIS = 1n << 18n, + VIEW_GUILD_ANALYTICS = 1n << 19n, + CONNECT = 1n << 20n, + SPEAK = 1n << 21n, + MUTE_MEMBERS = 1n << 22n, + DEAFEN_MEMBERS = 1n << 23n, + MOVE_MEMBERS = 1n << 24n, + USE_VAD = 1n << 25n, + CHANGE_NICKNAME = 1n << 26n, + MANAGE_NICKNAMES = 1n << 27n, + MANAGE_ROLES = 1n << 28n, + MANAGE_WEBHOOKS = 1n << 29n, + MANAGE_GUILD_EXPRESSIONS = 1n << 30n, + USE_APPLICATION_COMMANDS = 1n << 31n, + REQUEST_TO_SPEAK = 1n << 32n, + MANAGE_EVENTS = 1n << 33n, + MANAGE_THREADS = 1n << 34n, + CREATE_PUBLIC_THREADS = 1n << 35n, + CREATE_PRIVATE_THREADS = 1n << 36n, + USE_EXTERNAL_STICKERS = 1n << 37n, + SEND_MESSAGES_IN_THREADS = 1n << 38n, + USE_EMBEDDED_ACTIVITIES = 1n << 39n, + MODERATE_MEMBERS = 1n << 40n, + VIEW_CREATOR_MONETIZATION_ANALYTICS = 1n << 41n, + USE_SOUNDBOARD = 1n << 42n, + CREATE_GUILD_EXPRESSIONS = 1n << 43n, + CREATE_EVENTS = 1n << 44n, + USE_EXTERNAL_SOUNDS = 1n << 45n, + SEND_VOICE_MESSAGES = 1n << 46n, + USE_CLYDE_AI = 1n << 47n, + SET_VOICE_CHANNEL_STATUS = 1n << 48n, + SEND_POLLS = 1n << 49n, + USE_EXTERNAL_APPS = 1n << 50n, +} +*/ + +export interface PermissionOverwriteMap { + [roleIdOrUserId: string]: PermissionOverwrite; +} + +export interface PermissionOverwrite { + allow: /* Permissions */ bigint; + deny: /* Permissions */ bigint; + id: string; + type: PermissionOverwriteType; +} + +export enum PermissionOverwriteType { + ROLE = 0, + MEMBER = 1, +} diff --git a/packages/discord-types/src/general/ReadState.ts b/packages/discord-types/src/general/ReadState.ts new file mode 100644 index 000000000..896080d33 --- /dev/null +++ b/packages/discord-types/src/general/ReadState.ts @@ -0,0 +1,224 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish, Optional } from "../internal"; +import type { BasicPermissionsObject } from "../stores/PermissionStore"; +import type { GuildChannelRecord } from "./channels/ChannelRecord"; + +export declare class ReadState { + constructor(channelId: string, type?: Type & ChannelIdReadStateType); + constructor(userId: string, type: Type & UserIdReadStateType); + constructor(guildId: string, type: Type & GuildIdReadStateType); + + static _guildReadStateSentinels: { [guildId: string]: { unreadsSentinel: number; }; }; + static _mentionChannels: Set; + static _readStates: { [T in ChannelIdReadStateType]?: { [channelId: string]: ReadState; }; } + & { [T in UserIdReadStateType]?: { [userId: string]: ReadState; }; } + & { [T in GuildIdReadStateType]?: { [guildId: string]: ReadState; }; }; + static clear(channelId: string, type?: ChannelIdReadStateType): boolean; + static clear(userId: string, type: UserIdReadStateType): boolean; + static clear(guildId: string, type: GuildIdReadStateType): boolean; + static clearAll(): void; + /** + * @param callback The iteratee. Iteration will terminate early if it returns false. + */ + static forEach(callback: (value: ReadState) => unknown): void; + static get(channelId: string, type?: ChannelIdReadStateType): ReadState; + static get(userId: string, type: T): ReadState; + static get(guildId: string, type: T): ReadState; + static getGuildSentinels(guildId: string): typeof ReadState["_guildReadStateSentinels"]; + static getIfExists(channelId: string, type?: ChannelIdReadStateType): ReadState | undefined; + static getIfExists(userId: string, type: T): ReadState | undefined; + static getIfExists(guildId: string, type: T): ReadState | undefined; + static getMentionChannelIds(): string[]; + static getValue( + channelId: string, + type: ChannelIdReadStateType | undefined, + getter: (readState: ReadState | undefined) => GetterReturn, + defaultValue?: DefaultValue + ): GetterReturn | DefaultValue; + static getValue( + userId: string, + type: T, + getter: (readState: ReadState | undefined) => GetterReturn, + defaultValue?: DefaultValue + ): GetterReturn | DefaultValue; + static getValue( + guildId: string, + type: T, + getter: (readState: ReadState | undefined) => GetterReturn, + defaultValue?: DefaultValue + ): GetterReturn | DefaultValue; + static resetGuildSentinels(): void; + + _ack(location: string, trackAnalytics: boolean): void; + _nonChannelAck(): void; + _shouldAck( + force?: boolean, + local?: boolean, + isExplicitUserAction?: boolean + ): boolean; + ack(options: { + force?: boolean | undefined /* = false */; + immediate?: boolean | undefined /* = false */; + isExplicitUserAction?: boolean | undefined /* = false */; + local?: boolean | undefined /* = false */; + location?: { section: string; } /* = { section: AnalyticsSections.CHANNEL } */; + messageId?: string | Nullish /* = this.lastMessageId */; + trackAnalytics?: boolean | undefined /* = true */; + }): boolean; + get ackMessageId(): ReadState["_ackMessageId"]; + set ackMessageId(messageId: ReadState["_ackMessageId"]); + ackPins(isoTimestamp?: string | null): boolean; + canBeUnread(): boolean; + canHaveMentions(): boolean; + canTrackUnreads(): boolean; + clearOutgoingAck(): void; + delete(remote?: boolean): void; + deserializeForOverlay(serlizedReadState: Optional, Nullish, "_isJoinedThread" | "estimated" | "_isActiveThread" | "isManualAck" | "_isThread" | "loadedMessages" | "oldestUnreadMessageIdStale" | "type"> & { + _isActiveJoinedThread?: boolean | Nullish; + _unreadCount?: number | Nullish; + }): void; + getAckTimestamp(): number; + getGuildChannelUnreadState( + guildChannel: BasicPermissionsObject | GuildChannelRecord, + isOptInEnabled: boolean, + guildChannelOverrides: { [channelId: string]: GuildChannelOverride; }, + isChannelMuted: boolean, + isReadStateTypeUnread?: boolean + ): { + mentionCount: number; + unread: boolean; + }; + getMentionCount(): number; + guessAckMessageId(): string | null; + get guildId(): GuildIdFromReadStateType; + handleGuildEventRemoval(guildId: string, guildEventId: string): void; + hasMentions(): boolean; + hasRecentlyVisitedAndRead(): boolean; + hasUnread(): boolean; + hasUnreadOrMentions(): boolean; + incrementGuildUnreadsSentinel(): void; + isForumPostUnread(): boolean; + isPrivate(): boolean; + get lastMessageId(): ReadState["_lastMessageId"]; + set lastMessageId(messageId: ReadState["_lastMessageId"] | Nullish); + get lastMessageTimestamp(): ReadState["_lastMessageTimestamp"]; + get mentionCount(): ReadState["_mentionCount"]; + set mentionCount(count: ReadState["_mentionCount"]); + get oldestUnreadMessageId(): ReadState["_oldestUnreadMessageId"]; + set oldestUnreadMessageId(messageId: ReadState["_oldestUnreadMessageId"]); + get oldestUnreadTimestamp(): number; + rebuildChannelState( + ackMessageId?: string | null, + resetMentionCount?: boolean /* = false */, + newMentionCount?: number | null + ): void; + recalculateFlags(): ReadStateFlags | undefined; + recordLastViewedTime(): void; + serialize(forCache: ForCache): SerializedReadState; + shouldDeleteReadState(expirationTimestamp: string): boolean; + syncThreadSettings(): boolean; + takeSnapshot(): ReadStateSnapshot; + get unreadCount(): number; + set unreadCount(count: number); + + _ackMessageId: string | null; + _ackMessageTimestamp: number; + _guildId: GuildIdFromReadStateType | null; + _isActiveThread: boolean; + _isJoinedThread: boolean; + _isResourceChannel: boolean; + _isThread: boolean; + _lastMessageId: string | null; + _lastMessageTimestamp: number; + _mentionCount: number; + _oldestUnreadMessageId: string | null; + _persisted: boolean; + _unreadCount: number; + ackedWhileCached: undefined; + ackMessageIdAtChannelSelect: string | null; + ackPinTimestamp: number; + /** + * Not always a channel ID. + * @see {@link ReadState} + */ + channelId: string; + estimated: boolean; + flags: ReadStateFlags | undefined; + isManualAck: boolean; + lastPinTimestamp: number; + lastViewed: number | undefined; + loadedMessages: boolean; + oldestUnreadMessageIdStale: boolean; + outgoingAck: string | null; + outgoingAckTimer: number | null; + snapshot: ReadStateSnapshot | undefined; + type: Type; +} + +export type SerializedReadState + = ForCache extends true + ? SerializedForCache + : Serialized; + +type SerializedForCache = Pick, "_ackMessageId" | "_ackMessageTimestamp" | "_guildId" | "_isActiveThread" | "_isJoinedThread" | "_isThread" | "_lastMessageId" | "_lastMessageTimestamp" | "_mentionCount" | "_persisted" | "ackPinTimestamp" | "channelId" | "flags" | "lastPinTimestamp" | "lastViewed" | "type">; + +type Serialized = SerializedForCache & Pick, "_oldestUnreadMessageId" | "estimated" | "isManualAck" | "loadedMessages" | "oldestUnreadMessageIdStale">; + +export interface GuildChannelOverride { + channel_id: string; + collapsed: boolean; + flags?: ChannelNotificationSettingsFlags; + message_notifications: number; + mute_config: GuildChannelOverrideMuteConfig | null; + muted: boolean; +} + +export enum ChannelNotificationSettingsFlags { + UNREADS_ONLY_MENTIONS = 1 << 9, + UNREADS_ALL_MESSAGES = 1 << 10, + FAVORITED = 1 << 11, + OPT_IN_ENABLED = 1 << 12, + NEW_FORUM_THREADS_OFF = 1 << 13, + NEW_FORUM_THREADS_ON = 1 << 14, +} + +export interface GuildChannelOverrideMuteConfig { + end_time: string | null; + selected_time_window: number | null; +} + +export interface ReadStateSnapshot { + guildMentionCount: number; + guildUnread: boolean; + mentionCount: number; + takenAt: number; + unread: boolean; +} + +export enum ReadStateFlags { + IS_GUILD_CHANNEL = 1 << 0, + IS_THREAD = 1 << 1, +} + +export type ChannelIdReadStateType = ReadStateType.CHANNEL; + +export type UserIdReadStateType = ReadStateType.NOTIFICATION_CENTER | ReadStateType.MESSAGE_REQUESTS; + +export type GuildIdReadStateType = ReadStateType.GUILD_EVENT | ReadStateType.GUILD_HOME | ReadStateType.GUILD_ONBOARDING_QUESTION; + +// Original name: ReadStateTypes +export enum ReadStateType { + CHANNEL = 0, + GUILD_EVENT = 1, + NOTIFICATION_CENTER = 2, + GUILD_HOME = 3, + GUILD_ONBOARDING_QUESTION = 4, + MESSAGE_REQUESTS = 5, +} + +type GuildIdFromReadStateType = Type extends UserIdReadStateType ? null : string; diff --git a/packages/discord-types/src/general/Record.ts b/packages/discord-types/src/general/Record.ts new file mode 100644 index 000000000..d0937174b --- /dev/null +++ b/packages/discord-types/src/general/Record.ts @@ -0,0 +1,28 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { StringProperties } from "../internal"; + +// Original name: Record +// Renamed to avoid name conflicts with TypeScripts's Record utility type. +export declare abstract class RecordBase< + OwnProperties extends Record = Record +> { + constructor(properties: OwnProperties); + + merge(collection: Partial> & Pick): this; + set(key: Key, value: OwnProperties[Key]): this; + toJS(): OwnProperties; + update( + key: Key, + updater: (value: OwnProperties[Key]) => OwnProperties[Key] + ): this; + update( + key: Key, + notSetValue: OwnProperties[Key], + updater: (value: OwnProperties[Key]) => OwnProperties[Key] + ): this; +} diff --git a/packages/discord-types/src/general/Role.ts b/packages/discord-types/src/general/Role.ts new file mode 100644 index 000000000..b8dd6849c --- /dev/null +++ b/packages/discord-types/src/general/Role.ts @@ -0,0 +1,35 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +export interface Role { + color: number; + colorString: string | null; + flags: RoleFlags; + hoist: boolean; + icon: string | null; + id: string; + managed: boolean; + mentionable: boolean; + name: string; + originalPosition: number; + permissions: /* Permissions */ bigint; + position: number; + tags: RoleTags; + unicodeEmoji: string | null; +} + +export enum RoleFlags { + IN_PROMPT = 1, +} + +export interface RoleTags { + available_for_purchase?: null; + bot_id?: string; + guild_connections?: null; + integration_id?: string; + premium_subscriber?: null; + subscription_listing_id?: string; +} diff --git a/packages/discord-types/src/general/UserProfile.ts b/packages/discord-types/src/general/UserProfile.ts new file mode 100644 index 000000000..2f16884de --- /dev/null +++ b/packages/discord-types/src/general/UserProfile.ts @@ -0,0 +1,107 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish } from "../internal"; +import type { ApplicationInstallParams, ApplicationIntegrationType, ApplicationRecordOwnProperties } from "./ApplicationRecord"; +import type { PremiumType } from "./UserRecord"; + +export type UserProfile = FetchFailed extends true + ? UserProfileFetchFailed + : UserProfileFetchSucceeded; + +export interface UserProfileBase { + accentColor: number | Nullish; + application: ProfileApplicationData | null; + applicationRoleConnections: ProfileApplicationRoleConnectionData[]; + badges?: ProfileBadge[]; + banner: string | Nullish; + bio: string; + connectedAccounts: ProfileConnectedAccountData[]; + lastFetched: number; + legacyUsername: string | Nullish; + /** @todo Does not seem to be implemented. */ + popoutAnimationParticleType?: any /* | Nullish */; + premiumGuildSince: Date | null; + premiumSince: Date | null; + premiumType?: PremiumType | Nullish; + profileEffectExpiresAt?: number | Nullish; + profileEffectId?: string | undefined; + profileFetchFailed: boolean; + pronouns: string; + themeColors?: ProfileThemeColors | Nullish; + userId: string; +} + +export interface UserProfileFetchSucceeded extends Required { + profileFetchFailed: false; +} + +export interface UserProfileFetchFailed extends UserProfileBase { + profileFetchFailed: true; +} + +export interface ProfileApplicationData extends Pick { + integrationTypesConfig: Partial>; + popularApplicationCommandIds: string[] | undefined; +} + +export interface ProfileApplicationRoleConnectionData { + metadata: Record; + platform_name: string | null; + platform_username: string | null; +} + +export interface ProfileBadge { + description: string; + icon: string; + id: string; + link?: string; +} + +export interface ProfileConnectedAccountData { + id: string; + metadata?: Record; + name: string; + type: PlatformType; + verified: boolean; +} + +// Original name: PlatformTypes +export enum PlatformType { + AMAZON_MUSIC = "amazon-music", + BATTLENET = "battlenet", + BUNGIE = "bungie", + CONTACTS = "contacts", + CRUNCHYROLL = "crunchyroll", + DOMAIN = "domain", + EBAY = "ebay", + EPIC_GAMES = "epicgames", + FACEBOOK = "facebook", + GITHUB = "github", + INSTAGRAM = "instagram", + LEAGUE_OF_LEGENDS = "leagueoflegends", + PAYPAL = "paypal", + PLAYSTATION = "playstation", + PLAYSTATION_STAGING = "playstation-stg", + REDDIT = "reddit", + RIOT_GAMES = "riotgames", + ROBLOX = "roblox", + SAMSUNG = "samsung", + SKYPE = "skype", + SOUNDCLOUD = "soundcloud", + SPOTIFY = "spotify", + STEAM = "steam", + TIKTOK = "tiktok", + TWITCH = "twitch", + TWITTER = "twitter", + TWITTER_LEGACY = "twitter_legacy", + XBOX = "xbox", + YOUTUBE = "youtube", +} + +export type ProfileThemeColors = [primaryColor: number, accentColor: number]; diff --git a/packages/discord-types/src/general/UserRecord.ts b/packages/discord-types/src/general/UserRecord.ts new file mode 100644 index 000000000..ed1d5b27d --- /dev/null +++ b/packages/discord-types/src/general/UserRecord.ts @@ -0,0 +1,140 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish, Optional, SnakeCasedProperties } from "../internal"; +import type { IconSource } from "./misc"; +import type { RecordBase } from "./Record"; + +export type UserRecordOwnProperties = Pick; + +export type UserProperties = Optional, Nullish, "id", true> + & SnakeCasedProperties, Nullish>> + & Partial> + & Partial> + & { clan?: SnakeCasedProperties | UserClanData | Nullish; }; + +export declare class UserRecord< + OwnProperties extends UserRecordOwnProperties = UserRecordOwnProperties +> extends RecordBase { + constructor(userProperties: UserProperties); + + addGuildAvatarHash(guildId: string, avatarHash: string): this; + get avatarDecoration(): AvatarDecorationData | null; + set avatarDecoration(avatarDecorationData: { + asset: string; + sku_id?: string; + skuId?: string; + } | null); + get createdAt(): Date; + getAvatarSource( + guildId?: string | null, + canAnimate?: boolean /* = false */, + avatarSize?: number /* = 128 */ + ): IconSource; + getAvatarURL( + guildId?: string | null, + avatarSize?: number /* = 128 */, + canAnimate?: boolean /* = false */ + ): string; + hasAvatarForGuild(guildId?: string | null): boolean; + hasFreePremium(): boolean; + hasHadPremium(): boolean; + hasHadSKU(skuId: string): boolean; + hasPremiumUsageFlag(flag: number): boolean; + hasPurchasedFlag(flag: number): boolean; + hasUrgentMessages(): boolean; + hasVerifiedEmailOrPhone(): boolean; + isClaimed(): boolean; + isClyde(): boolean; + isLocalBot(): boolean; + isNonUserBot(): boolean; + isPhoneVerified(): boolean; + isPomelo(): boolean; + isProvisional(): boolean; + isSystemUser(): boolean; + isVerifiedBot(): boolean; + removeGuildAvatarHash(guildId: string): this; + get tag(): string; + + avatar: string | null; + avatarDecorationData: AvatarDecorationData | null; + banner: string | Nullish; + bot: boolean; + clan: UserClanData | null; + desktop: boolean; + discriminator: string; + email: string | null; + flags: UserFlags; + globalName: string | Nullish; + guildMemberAvatars: { [guildId: string]: string; }; + hasAnyStaffLevel: () => boolean; + hasBouncedEmail: boolean; + hasFlag: (flag: number) => boolean; + id: string; + isStaff: () => boolean; + isStaffPersonal: () => boolean; + mfaEnabled: boolean; + mobile: boolean; + nsfwAllowed: boolean; + personalConnectionId: string | null; + phone: string | null; + premiumType: PremiumType | Nullish; + premiumUsageFlags: number; + publicFlags: UserFlags; + purchasedFlags: number; + system: boolean; + username: string; + verified: boolean; +} + +export interface AvatarDecorationData { + asset: string; + skuId: string; +} + +// Original name: PremiumTypes +export enum PremiumType { + /** Nitro Classic */ + TIER_1 = 1, + /** Nitro Standard */ + TIER_2 = 2, + /** Nitro Basic */ + TIER_0 = 3, +} + +export interface UserClanData { + badge: string | null; + identityEnabled: boolean | null; + identityGuildId: string | null; + tag: string | null; +} + +export enum UserFlags { + STAFF = 1 << 0, + PARTNER = 1 << 1, + HYPESQUAD = 1 << 2, + BUG_HUNTER_LEVEL_1 = 1 << 3, + MFA_SMS = 1 << 4, + PREMIUM_PROMO_DISMISSED = 1 << 5, + HYPESQUAD_ONLINE_HOUSE_1 = 1 << 6, + HYPESQUAD_ONLINE_HOUSE_2 = 1 << 7, + HYPESQUAD_ONLINE_HOUSE_3 = 1 << 8, + PREMIUM_EARLY_SUPPORTER = 1 << 9, + TEAM_PSEUDO_USER = 1 << 10, + HAS_UNREAD_URGENT_MESSAGES = 1 << 13, + BUG_HUNTER_LEVEL_2 = 1 << 14, + VERIFIED_BOT = 1 << 16, + VERIFIED_DEVELOPER = 1 << 17, + CERTIFIED_MODERATOR = 1 << 18, + BOT_HTTP_INTERACTIONS = 1 << 19, + SPAMMER = 1 << 20, + DISABLE_PREMIUM = 1 << 21, + ACTIVE_DEVELOPER = 1 << 22, + PROVISIONAL_ACCOUNT = 1 << 23, + QUARANTINED = 0x10_00_00_00_00_00, + COLLABORATOR = 0x4_00_00_00_00_00_00, + RESTRICTED_COLLABORATOR = 0x8_00_00_00_00_00_00 +} diff --git a/packages/discord-types/src/general/channels/ChannelRecord.ts b/packages/discord-types/src/general/channels/ChannelRecord.ts new file mode 100644 index 000000000..892d0ba7a --- /dev/null +++ b/packages/discord-types/src/general/channels/ChannelRecord.ts @@ -0,0 +1,267 @@ +/* + * discord-types + * Copyright (C) 2024 Vencord project contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import type { Nullish, Optional, SnakeCasedProperties } from "../../internal"; +import type { PermissionOverwriteMap } from "../Permissions"; +import type { AvatarDecorationData, UserClanData, UserFlags } from "../UserRecord"; +import type { ForumChannelRecord } from "./ForumChannelRecord"; +import type { GuildCategoryChannelRecord, GuildDirectoryChannelRecord, GuildTextualChannelRecord } from "./GuildTextualChannelRecord"; +import type { GuildStageVoiceChannelRecord, GuildVocalChannelRecord, GuildVoiceChannelRecord } from "./GuildVocalChannelRecord"; +import type { DMChannelRecord, GroupDMChannelRecord, PrivateChannelRecord } from "./PrivateChannelRecord"; +import type { ThreadChannelRecord } from "./ThreadChannelRecord"; + +export type ChannelRecord = GuildChannelRecord | PrivateChannelRecord | ThreadChannelRecord; + +export type GuildChannelRecord = GuildTextualChannelRecord | GuildVocalChannelRecord | ForumChannelRecord; + +export type GuildSelectableChannelRecord = Exclude; + +type ChannelRecordOwnPropertyKeys = "application_id" | "appliedTags" | "availableTags" | "bitrate_" | "blockedUserWarningDismissed" | "defaultAutoArchiveDuration" | "defaultForumLayout" | "defaultReactionEmoji" | "defaultSortOrder" | "defaultThreadRateLimitPerUser" | "flags_" | "guild_id" | "icon" | "iconEmoji" | "id" | "isMessageRequest" | "isMessageRequestTimestamp" | "isSpam" | "lastMessageId" | "lastPinTimestamp" | "linkedLobby" | "member" | "memberCount" | "memberIdsPreview" | "memberListId" | "messageCount" | "name" | "nicks" | "nsfw_" | "originChannelId" | "ownerId" | "parentChannelThreadType" | "parent_id" | "permissionOverwrites_" | "position_" | "rateLimitPerUser_" | "rawRecipients" | "recipients" | "rtcRegion" | "safetyWarnings" | "template" | "themeColor" | "threadMetadata" | "topic_" | "totalMessageSent" | "type" | "userLimit_" | "version" | "videoQualityMode"; + +export type ChannelRecordOwnProperties = Pick; + +export declare abstract class ChannelRecordBase extends ChannelRecordProperties { + get accessPermissions(): /* Permissions */ bigint; + get bitrate(): number; + computeLurkerPermissionsAllowList(): /* Permissions */ bigint | undefined; + get flags(): ChannelFlags; + getApplicationId(): this["application_id"]; + getDefaultLayout(): ForumLayout; + getDefaultSortOrder(): ThreadSortOrder; + getGuildId(): this["guild_id"]; + hasFlag(flag: ChannelFlags): boolean; + isActiveThread(): boolean; + isAnnouncementThread(): this is ThreadChannelRecord; + isArchivedLockedThread(): boolean; + isArchivedThread(): boolean; + isBroadcastChannel(): boolean; + isCategory(): this is GuildCategoryChannelRecord; + isDirectory(): this is GuildDirectoryChannelRecord; + isDM(): this is DMChannelRecord; + isForumChannel(): this is ForumChannelRecord; + isForumLikeChannel(): this is ForumChannelRecord; + isForumPost(): boolean; + isGroupDM(): this is GroupDMChannelRecord; + isGuildStageVoice(): this is GuildStageVoiceChannelRecord; + isGuildVocal(): this is GuildVocalChannelRecord; + isGuildVocalOrThread(): this is GuildVocalChannelRecord | ThreadChannelRecord; + isGuildVoice(): this is GuildVoiceChannelRecord; + isListenModeCapable(): this is GuildStageVoiceChannelRecord; + isLockedThread(): boolean; + isManaged(): boolean; + isMediaChannel(): this is ForumChannelRecord; + isMediaPost(): boolean; + /** This method is functionally the same as {@link isGroupDM}. */ + isMultiUserDM(): this is GroupDMChannelRecord; + isNSFW(): boolean; + isOwner(userId: string): boolean; + isPrivate(): this is PrivateChannelRecord; + isRoleSubscriptionTemplatePreviewChannel(): boolean; + isScheduledForDeletion(): boolean; + isSystemDM(): boolean; + isThread(): this is ThreadChannelRecord; + isVocal(): this is PrivateChannelRecord | GuildVocalChannelRecord | ThreadChannelRecord; + isVocalThread(): this is ThreadChannelRecord; + merge(collection: Partial>): this; + get nsfw(): boolean; + get permissionOverwrites(): PermissionOverwriteMap; + get position(): number; + get rateLimitPerUser(): number; + set(key: Key, value: ChannelRecordOwnProperties