dfx 0.99.1 → 0.100.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/types.ts CHANGED
@@ -91,6 +91,34 @@ export const ActivityFlag = {
91
91
  PARTY_PRIVACY_VOICE_CHANNEL: 1 << 7,
92
92
  EMBEDDED: 1 << 8,
93
93
  } as const
94
+ export interface ActivityInstance {
95
+ /** Application ID */
96
+ readonly application_id: Snowflake
97
+ /** Activity Instance ID */
98
+ readonly instance_id: string
99
+ /** Unique identifier for the launch */
100
+ readonly launch_id: Snowflake
101
+ /** The Location the instance is runnning in */
102
+ readonly location: ActivityLocation
103
+ /** The IDs of the Users currently connected to the instance */
104
+ readonly users: Array<Snowflake>
105
+ }
106
+ export interface ActivityLocation {
107
+ /** The unique identifier for the location */
108
+ readonly id: string
109
+ /** Enum describing kind of location */
110
+ readonly kind: ActivityLocationKind
111
+ /** The id of the Channel */
112
+ readonly channel_id: Snowflake
113
+ /** The id of the Guild */
114
+ readonly guild_id?: Snowflake | null
115
+ }
116
+ export enum ActivityLocationKind {
117
+ /** The Location is a Guild Channel */
118
+ GC = "'gc'",
119
+ /** The Location is a Private Channel, such as a DM or GDM */
120
+ PC = "'pc'",
121
+ }
94
122
  export interface ActivityParty {
95
123
  /** ID of the party */
96
124
  readonly id?: string
@@ -149,6 +177,12 @@ export enum AllowedMentionType {
149
177
  /** Controls @everyone and @here mentions */
150
178
  EVERYONE_MENTIONS = "everyone",
151
179
  }
180
+ export enum AnimationType {
181
+ /** A fun animation, sent by a Nitro subscriber */
182
+ PREMIUM = 0,
183
+ /** The standard animation */
184
+ BASIC = 1,
185
+ }
152
186
  export interface Application {
153
187
  /** ID of the app */
154
188
  readonly id: Snowflake
@@ -192,6 +226,8 @@ export interface Application {
192
226
  readonly flags?: number
193
227
  /** Approximate count of guilds the app has been added to */
194
228
  readonly approximate_guild_count?: number
229
+ /** Approximate count of users that have installed the app */
230
+ readonly approximate_user_install_count?: number
195
231
  /** Array of redirect URIs for the app */
196
232
  readonly redirect_uris?: Array<string>
197
233
  /** Interactions endpoint URL for the app */
@@ -240,21 +276,23 @@ export interface ApplicationCommand {
240
276
  readonly contexts?: Array<InteractionContextType> | null
241
277
  /** Autoincrementing version identifier updated during substantial record changes */
242
278
  readonly version: Snowflake
279
+ /** Determines whether the interaction is handled by the app's interactions handler or by Discord */
280
+ readonly handler?: EntryPointCommandHandlerType
243
281
  }
244
282
  export interface ApplicationCommandDatum {
245
- /** the ID of the invoked command */
283
+ /** ID of the invoked command */
246
284
  readonly id: Snowflake
247
- /** the name of the invoked command */
285
+ /** name of the invoked command */
248
286
  readonly name: string
249
- /** the type of the invoked command */
287
+ /** type of the invoked command */
250
288
  readonly type: number
251
- /** converted users + roles + channels + attachments */
289
+ /** Converted users + roles + channels + attachments */
252
290
  readonly resolved?: ResolvedDatum
253
- /** the params + values from the user */
291
+ /** Params + values from the user */
254
292
  readonly options?: Array<ApplicationCommandInteractionDataOption>
255
- /** the id of the guild the command is registered to */
293
+ /** ID of the guild the command is registered to */
256
294
  readonly guild_id?: Snowflake
257
- /** id of the user or message targeted by a user or message command */
295
+ /** ID of the user or message targeted by a user or message command */
258
296
  readonly target_id?: Snowflake
259
297
  }
260
298
  export interface ApplicationCommandInteractionDataOption {
@@ -342,6 +380,8 @@ export enum ApplicationCommandType {
342
380
  USER = 2,
343
381
  /** A UI-based command that shows up when you right click or tap on a message */
344
382
  MESSAGE = 3,
383
+ /** A UI-based command that represents the primary way to invoke an app's Activity */
384
+ PRIMARY_ENTRY_POINT = 4,
345
385
  }
346
386
  export const ApplicationFlag = {
347
387
  /** Indicates if an app uses the Auto Moderation API */
@@ -1784,6 +1824,12 @@ export function createRoutes<O = any>(
1784
1824
  params,
1785
1825
  options,
1786
1826
  }),
1827
+ getApplicationActivityInstance: (applicationId, instanceId, options) =>
1828
+ fetch({
1829
+ method: "GET",
1830
+ url: `/applications/${applicationId}/activity-instances/${instanceId}`,
1831
+ options,
1832
+ }),
1787
1833
  getApplicationCommandPermissions: (
1788
1834
  applicationId,
1789
1835
  guildId,
@@ -2032,6 +2078,12 @@ export function createRoutes<O = any>(
2032
2078
  params,
2033
2079
  options,
2034
2080
  }),
2081
+ getGuildRole: (guildId, roleId, options) =>
2082
+ fetch({
2083
+ method: "GET",
2084
+ url: `/guilds/${guildId}/roles/${roleId}`,
2085
+ options,
2086
+ }),
2035
2087
  getGuildRoles: (guildId, options) =>
2036
2088
  fetch({
2037
2089
  method: "GET",
@@ -2162,6 +2214,12 @@ export function createRoutes<O = any>(
2162
2214
  url: `/stickers/${stickerId}`,
2163
2215
  options,
2164
2216
  }),
2217
+ getStickerPack: (packId, options) =>
2218
+ fetch({
2219
+ method: "GET",
2220
+ url: `/sticker-packs/${packId}`,
2221
+ options,
2222
+ }),
2165
2223
  getThreadMember: (channelId, userId, params, options) =>
2166
2224
  fetch({
2167
2225
  method: "GET",
@@ -2835,6 +2893,8 @@ export enum EmbedType {
2835
2893
  ARTICLE = "article",
2836
2894
  /** link embed */
2837
2895
  LINK = "link",
2896
+ /** poll result embed */
2897
+ POLL_RESULT = "poll_result",
2838
2898
  }
2839
2899
  export interface EmbedVideo {
2840
2900
  /** source url of video */
@@ -3025,7 +3085,7 @@ export interface Endpoints<O> {
3025
3085
  params?: Partial<CreateGuildTemplateParams>,
3026
3086
  options?: O,
3027
3087
  ) => RestResponse<GuildTemplate>
3028
- /** Create a response to an Interaction from the gateway. Body is an interaction response. Returns 204 No Content. */
3088
+ /** Create a response to an Interaction. Body is an interaction response. Returns 204 unless with_response is set to true which returns 200 with the body as interaction response. */
3029
3089
  createInteractionResponse: (
3030
3090
  interactionId: string,
3031
3091
  interactionToken: string,
@@ -3315,6 +3375,12 @@ The emoji must be URL Encoded or the request will fail with 10014: Unknown Emoji
3315
3375
  params?: Partial<GetAnswerVoterParams>,
3316
3376
  options?: O,
3317
3377
  ) => RestResponse<GetAnswerVoterResponse>
3378
+ /** Returns a serialized activity instance, if it exists. Useful for preventing unwanted activity sessions. */
3379
+ getApplicationActivityInstance: (
3380
+ applicationId: string,
3381
+ instanceId: string,
3382
+ options?: O,
3383
+ ) => RestResponse<any>
3318
3384
  /** Fetches permissions for a specific command for your application in a guild. Returns a guild application command permissions object. */
3319
3385
  getApplicationCommandPermissions: (
3320
3386
  applicationId: string,
@@ -3499,6 +3565,12 @@ If the user is not in the guild, then the guild must be discoverable. */
3499
3565
  params?: Partial<GetGuildPruneCountParams>,
3500
3566
  options?: O,
3501
3567
  ) => RestResponse<any>
3568
+ /** Returns a role object for the specified role. */
3569
+ getGuildRole: (
3570
+ guildId: string,
3571
+ roleId: string,
3572
+ options?: O,
3573
+ ) => RestResponse<Role>
3502
3574
  /** Returns a list of role objects for the guild. */
3503
3575
  getGuildRoles: (guildId: string, options?: O) => RestResponse<Array<Role>>
3504
3576
  /** Get a guild scheduled event. Returns a guild scheduled event object on success. */
@@ -3592,6 +3664,8 @@ The emoji must be URL Encoded or the request will fail with 10014: Unknown Emoji
3592
3664
  getStageInstance: (channelId: string, options?: O) => RestResponse<any>
3593
3665
  /** Returns a sticker object for the given sticker ID. */
3594
3666
  getSticker: (stickerId: string, options?: O) => RestResponse<Sticker>
3667
+ /** Returns a sticker pack object for the given sticker pack ID. */
3668
+ getStickerPack: (packId: string, options?: O) => RestResponse<StickerPack>
3595
3669
  /** Returns a thread member object for the specified user if they are a member of the thread, returns a 404 response otherwise. */
3596
3670
  getThreadMember: (
3597
3671
  channelId: string,
@@ -3982,6 +4056,10 @@ export enum EntitlementType {
3982
4056
  APPLICATION_SUBSCRIPTION = 8,
3983
4057
  }
3984
4058
  export type EntitlementUpdateEvent = Entitlement
4059
+ export enum EntryPointCommandHandlerType {
4060
+ APP_HANDLER = 1,
4061
+ DISCORD_LAUNCH_ACTIVITY = 2,
4062
+ }
3985
4063
  export enum EventType {
3986
4064
  /** when a member sends or edits a message in the guild */
3987
4065
  MESSAGE_SEND = 1,
@@ -4689,7 +4767,7 @@ export interface GuildScheduledEventRecurrenceRule {
4689
4767
  readonly end?: string | null
4690
4768
  /** How often the event occurs */
4691
4769
  readonly frequency: GuildScheduledEventRecurrenceRuleFrequency
4692
- /** The spacing between the events, defined by frequency. For example, frecency of WEEKLY and an interval of 2 would be "every-other week" */
4770
+ /** The spacing between the events, defined by frequency. For example, frequency of WEEKLY and an interval of 2 would be "every-other week" */
4693
4771
  readonly interval: number
4694
4772
  /** Set of specific days within a week for the event to recur on */
4695
4773
  readonly by_weekday?: Array<GuildScheduledEventRecurrenceRuleWeekday> | null
@@ -4972,6 +5050,24 @@ export interface Interaction {
4972
5050
  /** Context where the interaction was triggered from */
4973
5051
  readonly context?: InteractionContextType
4974
5052
  }
5053
+ export interface InteractionCallback {
5054
+ /** */
5055
+ readonly id: Snowflake
5056
+ /** Interaction type */
5057
+ readonly type: InteractionType
5058
+ /** Instance ID of the Activity if one was launched or joined */
5059
+ readonly activity_instance_id?: string
5060
+ /** ID of the message that was created by the interaction */
5061
+ readonly response_message_id?: Snowflake
5062
+ /** Whether or not the message is in a loading state */
5063
+ readonly response_message_loading?: boolean
5064
+ /** Whether or not the response message was ephemeral */
5065
+ readonly response_message_ephemeral?: boolean
5066
+ }
5067
+ export interface InteractionCallbackActivityInstanceResource {
5068
+ /** Instance ID of the Activity if one was launched or joined. */
5069
+ readonly id: string
5070
+ }
4975
5071
  export interface InteractionCallbackAutocomplete {
4976
5072
  /** autocomplete choices (max of 25 choices) */
4977
5073
  readonly choices: Array<ApplicationCommandOptionChoice>
@@ -4981,48 +5077,64 @@ export type InteractionCallbackDatum =
4981
5077
  | InteractionCallbackMessage
4982
5078
  | InteractionCallbackModal
4983
5079
  export interface InteractionCallbackMessage {
4984
- /** is the response TTS */
5080
+ /** Whether the response is TTS */
4985
5081
  readonly tts?: boolean
4986
- /** message content */
5082
+ /** Message content */
4987
5083
  readonly content?: string
4988
- /** supports up to 10 embeds */
5084
+ /** Supports up to 10 embeds */
4989
5085
  readonly embeds?: Array<Embed>
4990
- /** allowed mentions object */
5086
+ /** Allowed mentions object */
4991
5087
  readonly allowed_mentions?: AllowedMention
4992
- /** message flags combined as a bitfield (only SUPPRESS_EMBEDS, EPHEMERAL, and SUPPRESS_NOTIFICATIONS can be set) */
5088
+ /** Message flags combined as a bitfield (only SUPPRESS_EMBEDS, EPHEMERAL, and SUPPRESS_NOTIFICATIONS can be set) */
4993
5089
  readonly flags?: number
4994
- /** message components */
5090
+ /** Message components */
4995
5091
  readonly components?: Array<Component>
4996
- /** attachment objects with filename and description */
5092
+ /** Attachment objects with filename and description */
4997
5093
  readonly attachments?: Array<Attachment>
4998
- /** A poll! */
5094
+ /** Details about the poll */
4999
5095
  readonly poll?: PollCreateRequest
5000
5096
  }
5001
5097
  export interface InteractionCallbackModal {
5002
- /** a developer-defined identifier for the modal, max 100 characters */
5098
+ /** Developer-defined identifier for the modal, max 100 characters */
5003
5099
  readonly custom_id: string
5004
- /** the title of the popup modal, max 45 characters */
5100
+ /** Title of the popup modal, max 45 characters */
5005
5101
  readonly title: string
5006
- /** between 1 and 5 (inclusive) components that make up the modal */
5102
+ /** Between 1 and 5 (inclusive) components that make up the modal */
5007
5103
  readonly components: Array<Component>
5008
5104
  }
5105
+ export interface InteractionCallbackResource {
5106
+ /** Interaction callback type */
5107
+ readonly type: InteractionCallbackType
5108
+ /** Represents the Activity launched by this interaction. */
5109
+ readonly activity_instance?: InteractionCallbackActivityInstanceResource
5110
+ /** Message created by the interaction. */
5111
+ readonly message?: Message
5112
+ }
5113
+ export interface InteractionCallbackResponse {
5114
+ /** The interaction object associated with the */
5115
+ readonly interaction: InteractionCallback
5116
+ /** The resource that was created by the interaction response. */
5117
+ readonly resource?: InteractionCallbackResource
5118
+ }
5009
5119
  export enum InteractionCallbackType {
5010
5120
  /** ACK a Ping */
5011
5121
  PONG = 1,
5012
- /** respond to an interaction with a message */
5122
+ /** Respond to an interaction with a message */
5013
5123
  CHANNEL_MESSAGE_WITH_SOURCE = 4,
5014
5124
  /** ACK an interaction and edit a response later, the user sees a loading state */
5015
5125
  DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE = 5,
5016
- /** for components, ACK an interaction and edit the original message later; the user does not see a loading state */
5126
+ /** For components, ACK an interaction and edit the original message later; the user does not see a loading state */
5017
5127
  DEFERRED_UPDATE_MESSAGE = 6,
5018
- /** for components, edit the message the component was attached to */
5128
+ /** For components, edit the message the component was attached to */
5019
5129
  UPDATE_MESSAGE = 7,
5020
- /** respond to an autocomplete interaction with suggested choices */
5130
+ /** Respond to an autocomplete interaction with suggested choices */
5021
5131
  APPLICATION_COMMAND_AUTOCOMPLETE_RESULT = 8,
5022
- /** respond to an interaction with a popup modal */
5132
+ /** Respond to an interaction with a popup modal */
5023
5133
  MODAL = 9,
5024
5134
  /** Deprecated; respond to an interaction with an upgrade button, only available for apps with monetization enabled */
5025
5135
  PREMIUM_REQUIRED = 10,
5136
+ /** Launch the Activity associated with the app. Only available for apps with Activities enabled */
5137
+ LAUNCH_ACTIVITY = 12,
5026
5138
  }
5027
5139
  export enum InteractionContextType {
5028
5140
  /** Interaction can be used within servers */
@@ -5038,9 +5150,9 @@ export type InteractionDatum =
5038
5150
  | MessageComponentDatum
5039
5151
  | ModalSubmitDatum
5040
5152
  export interface InteractionResponse {
5041
- /** the type of response */
5153
+ /** Type of response */
5042
5154
  readonly type: InteractionCallbackType
5043
- /** an optional response message */
5155
+ /** An optional response message */
5044
5156
  readonly data?: InteractionCallbackDatum
5045
5157
  }
5046
5158
  export enum InteractionType {
@@ -5381,13 +5493,13 @@ export interface MessageCall {
5381
5493
  readonly ended_timestamp?: string | null
5382
5494
  }
5383
5495
  export interface MessageComponentDatum {
5384
- /** the custom_id of the component */
5496
+ /** custom_id of the component */
5385
5497
  readonly custom_id: string
5386
- /** the type of the component */
5498
+ /** type of the component */
5387
5499
  readonly component_type: ComponentType
5388
- /** values the user selected in a select menu component */
5500
+ /** Values the user selected in a select menu component */
5389
5501
  readonly values?: Array<SelectOption>
5390
- /** resolved entities from selected options */
5502
+ /** Resolved entities from selected options */
5391
5503
  readonly resolved?: ResolvedDatum
5392
5504
  }
5393
5505
  export type MessageCreateEvent = Message & MessageCreateExtra
@@ -5606,6 +5718,7 @@ export enum MessageType {
5606
5718
  GUILD_INCIDENT_REPORT_RAID = 38,
5607
5719
  GUILD_INCIDENT_REPORT_FALSE_ALARM = 39,
5608
5720
  PURCHASE_NOTIFICATION = 44,
5721
+ POLL_RESULT = 46,
5609
5722
  }
5610
5723
  export type MessageUpdateEvent = MessageCreateEvent
5611
5724
  export enum MfaLevel {
@@ -5615,9 +5728,9 @@ export enum MfaLevel {
5615
5728
  ELEVATED = 1,
5616
5729
  }
5617
5730
  export interface ModalSubmitDatum {
5618
- /** the custom_id of the modal */
5731
+ /** custom_id of the modal */
5619
5732
  readonly custom_id: string
5620
- /** the values submitted by the user */
5733
+ /** Values submitted by the user */
5621
5734
  readonly components: Array<Component>
5622
5735
  }
5623
5736
  export interface ModifyApplicationEmojiParams {
@@ -5866,7 +5979,7 @@ export interface ModifyGuildScheduledEventParams {
5866
5979
  /** the cover image of the scheduled event */
5867
5980
  readonly image?: string
5868
5981
  /** the definition for how often this event should recur */
5869
- readonly recurrence_rule?: GuildScheduledEventRecurrenceRule
5982
+ readonly recurrence_rule?: GuildScheduledEventRecurrenceRule | null
5870
5983
  }
5871
5984
  export interface ModifyGuildStickerParams {
5872
5985
  /** name of the sticker (2-30 characters) */
@@ -6321,6 +6434,7 @@ export type ReceiveEvent =
6321
6434
  | StageInstanceDeleteEvent
6322
6435
  | TypingStartEvent
6323
6436
  | UserUpdateEvent
6437
+ | VoiceChannelEffectSendEvent
6324
6438
  | VoiceStateUpdateEvent
6325
6439
  | VoiceServerUpdateEvent
6326
6440
  | WebhooksUpdateEvent
@@ -6391,6 +6505,7 @@ export interface ReceiveEvents {
6391
6505
  STAGE_INSTANCE_DELETE: StageInstanceDeleteEvent
6392
6506
  TYPING_START: TypingStartEvent
6393
6507
  USER_UPDATE: UserUpdateEvent
6508
+ VOICE_CHANNEL_EFFECT_SEND: VoiceChannelEffectSendEvent
6394
6509
  VOICE_STATE_UPDATE: VoiceStateUpdateEvent
6395
6510
  VOICE_SERVER_UPDATE: VoiceServerUpdateEvent
6396
6511
  WEBHOOKS_UPDATE: WebhooksUpdateEvent
@@ -6413,17 +6528,17 @@ export interface RequestGuildMember {
6413
6528
  readonly nonce?: string
6414
6529
  }
6415
6530
  export interface ResolvedDatum {
6416
- /** the ids and User objects */
6531
+ /** IDs and User objects */
6417
6532
  readonly users?: Record<Snowflake, User>
6418
- /** the ids and partial Member objects */
6533
+ /** IDs and partial Member objects */
6419
6534
  readonly members?: Record<Snowflake, GuildMember>
6420
- /** the ids and Role objects */
6535
+ /** IDs and Role objects */
6421
6536
  readonly roles?: Record<Snowflake, Role>
6422
- /** the ids and partial Channel objects */
6537
+ /** IDs and partial Channel objects */
6423
6538
  readonly channels?: Record<Snowflake, Channel>
6424
- /** the ids and partial Message objects */
6539
+ /** IDs and partial Message objects */
6425
6540
  readonly messages?: Record<Snowflake, Message>
6426
- /** the ids and attachment objects */
6541
+ /** IDs and attachment objects */
6427
6542
  readonly attachments?: Record<Snowflake, Attachment>
6428
6543
  }
6429
6544
  export interface Response {
@@ -7043,6 +7158,24 @@ export enum VisibilityType {
7043
7158
  /** visible to everyone */
7044
7159
  EVERYONE = 1,
7045
7160
  }
7161
+ export interface VoiceChannelEffectSendEvent {
7162
+ /** ID of the channel the effect was sent in */
7163
+ readonly channel_id: Snowflake
7164
+ /** ID of the guild the effect was sent in */
7165
+ readonly guild_id: Snowflake
7166
+ /** ID of the user who sent the effect */
7167
+ readonly user_id: Snowflake
7168
+ /** The emoji sent, for emoji reaction and soundboard effects */
7169
+ readonly emoji?: Emoji | null
7170
+ /** The type of emoji animation, for emoji reaction and soundboard effects */
7171
+ readonly animation_type?: AnimationType | null
7172
+ /** The ID of the emoji animation, for emoji reaction and soundboard effects */
7173
+ readonly animation_id?: number
7174
+ /** The ID of the soundboard sound, for soundboard effects */
7175
+ readonly sound_id?: Snowflake
7176
+ /** The volume of the soundboard sound, from 0 to 1, for soundboard effects */
7177
+ readonly sound_volume?: number
7178
+ }
7046
7179
  export enum VoiceOpcode {
7047
7180
  /** Begin a voice websocket connection. */
7048
7181
  IDENTIFY = 0,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const LIB_VERSION = "0.99.1";
1
+ export const LIB_VERSION = "0.100.1";