@ovencord/discord.js 14.16.3

package/src/structures/GuildTemplate.ts

@@ -0,0 +1,229 @@
+import { RouteBases, Routes  } from 'discord-api-types/v10';
+import { Base  } from './Base.js';
+
+/**
+ * Represents the template for a guild.
+ *
+ * @extends {Base}
+ */
+export class GuildTemplate extends Base {
+  public client: any;
+  public code: any;
+  public name: any;
+  public description: any;
+  public usageCount: any;
+  public creatorId: any;
+  public creator: any;
+  public createdTimestamp: any;
+  public updatedTimestamp: any;
+  public guildId: any;
+  public serializedGuild: any;
+  public unSynced: any;
+  /**
+   * A regular expression that matches guild template links.
+   * The `code` group property is present on the `exec()` result of this expression.
+   *
+   * @type {RegExp}
+   * @memberof GuildTemplate
+   */
+  static GuildTemplatesPattern = /discord(?:app)?\.(?:com\/template|new)\/(?<code>[\w-]{2,255})/i;
+
+  constructor(client, data) {
+    super(client);
+    this._patch(data);
+  }
+
+  _patch(data) {
+    if ('code' in data) {
+      /**
+       * The unique code of this template
+       *
+       * @type {string}
+       */
+      this.code = data.code;
+    }
+
+    if ('name' in data) {
+      /**
+       * The name of this template
+       *
+       * @type {string}
+       */
+      this.name = data.name;
+    }
+
+    if ('description' in data) {
+      /**
+       * The description of this template
+       *
+       * @type {?string}
+       */
+      this.description = data.description;
+    }
+
+    if ('usage_count' in data) {
+      /**
+       * The amount of times this template has been used
+       *
+       * @type {number}
+       */
+      this.usageCount = data.usage_count;
+    }
+
+    if ('creator_id' in data) {
+      /**
+       * The id of the user that created this template
+       *
+       * @type {Snowflake}
+       */
+      this.creatorId = data.creator_id;
+    }
+
+    if ('creator' in data) {
+      /**
+       * The user that created this template
+       *
+       * @type {User}
+       */
+      this.creator = this.client.users._add(data.creator);
+    }
+
+    if ('created_at' in data) {
+      /**
+       * The timestamp of when this template was created at
+       *
+       * @type {number}
+       */
+      this.createdTimestamp = Date.parse(data.created_at);
+    }
+
+    if ('updated_at' in data) {
+      /**
+       * The timestamp of when this template was last synced to the guild
+       *
+       * @type {number}
+       */
+      this.updatedTimestamp = Date.parse(data.updated_at);
+    }
+
+    if ('source_guild_id' in data) {
+      /**
+       * The id of the guild that this template belongs to
+       *
+       * @type {Snowflake}
+       */
+      this.guildId = data.source_guild_id;
+    }
+
+    if ('serialized_source_guild' in data) {
+      /**
+       * The data of the guild that this template would create
+       *
+       * @type {APIGuild}
+       */
+      this.serializedGuild = data.serialized_source_guild;
+    }
+
+    /**
+     * Whether this template has unsynced changes
+     *
+     * @type {?boolean}
+     */
+    this.unSynced = 'is_dirty' in data ? Boolean(data.is_dirty) : null;
+
+    return this;
+  }
+
+  /**
+   * Options used to edit a guild template.
+   *
+   * @typedef {Object} GuildTemplateEditOptions
+   * @property {string} [name] The name of this template
+   * @property {string} [description] The description of this template
+   */
+
+  /**
+   * Updates the metadata of this template.
+   *
+   * @param {GuildTemplateEditOptions} [options] Options for editing the template
+   * @returns {Promise<GuildTemplate>}
+   */
+  async edit({ name, description } = {}) {
+    const data = await this.client.rest.patch(Routes.guildTemplate(this.guildId, this.code), {
+      body: { name, description },
+    });
+    return this._patch(data);
+  }
+
+  /**
+   * Deletes this template.
+   *
+   * @returns {Promise<GuildTemplate>}
+   */
+  async delete() {
+    await this.client.rest.delete(Routes.guildTemplate(this.guildId, this.code));
+    return this;
+  }
+
+  /**
+   * Syncs this template to the current state of the guild.
+   *
+   * @returns {Promise<GuildTemplate>}
+   */
+  async sync() {
+    const data = await this.client.rest.put(Routes.guildTemplate(this.guildId, this.code));
+    return this._patch(data);
+  }
+
+  /**
+   * The time when this template was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * The time when this template was last synced to the guild
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get updatedAt() {
+    return new Date(this.updatedTimestamp);
+  }
+
+  /**
+   * The guild that this template belongs to
+   *
+   * @type {?Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.resolve(this.guildId);
+  }
+
+  /**
+   * The URL of this template
+   *
+   * @type {string}
+   * @readonly
+   */
+  get url() {
+    return `${RouteBases.template}/${this.code}`;
+  }
+
+  /**
+   * When concatenated with a string, this automatically returns the template's code instead of the template object.
+   *
+   * @returns {string}
+   * @example
+   * // Logs: Template: FKvmczH2HyUf
+   * console.log(`Template: ${guildTemplate}!`);
+   */
+  toString() {
+    return this.code;
+  }
+}

package/src/structures/Integration.ts

@@ -0,0 +1,257 @@
+import { Routes  } from 'discord-api-types/v10';
+import { Base  } from './Base.js';
+import { IntegrationApplication  } from './IntegrationApplication.js';
+
+/**
+ * The information account for an integration
+ *
+ * @typedef {Object} IntegrationAccount
+ * @property {Snowflake|string} id The id of the account
+ * @property {string} name The name of the account
+ */
+
+/**
+ * The type of an {@link Integration}. This can be:
+ * - `twitch`
+ * - `youtube`
+ * - `discord`
+ * - `guild_subscription`
+ *
+ * @typedef {string} IntegrationType
+ */
+
+/**
+ * Represents a guild integration.
+ *
+ * @extends {Base}
+ */
+export class Integration extends Base {
+  public client: any;
+  public guild: any;
+  public id: any;
+  public name: any;
+  public type: any;
+  public enabled: any;
+  public syncing: any;
+  public role: any;
+  public enableEmoticons: any;
+  public user: any;
+  public account: any;
+  public syncedTimestamp: any;
+  public subscriberCount: any;
+  public revoked: any;
+  public expireBehavior: any;
+  public expireGracePeriod: any;
+  public application: any;
+  public scopes: any;
+  constructor(client, data, guild) {
+    super(client);
+
+    /**
+     * The guild this integration belongs to
+     *
+     * @type {Guild}
+     */
+    this.guild = guild;
+
+    /**
+     * The integration id
+     *
+     * @type {Snowflake|string}
+     */
+    this.id = data.id;
+
+    /**
+     * The integration name
+     *
+     * @type {string}
+     */
+    this.name = data.name;
+
+    /**
+     * The integration type
+     *
+     * @type {IntegrationType}
+     */
+    this.type = data.type;
+
+    /**
+     * Whether this integration is enabled
+     *
+     * @type {?boolean}
+     */
+    this.enabled = data.enabled ?? null;
+
+    if ('syncing' in data) {
+      /**
+       * Whether this integration is syncing
+       *
+       * @type {?boolean}
+       */
+      this.syncing = data.syncing;
+    } else {
+      this.syncing ??= null;
+    }
+
+    /**
+     * The role that this integration uses for subscribers
+     *
+     * @type {?Role}
+     */
+    this.role = this.guild.roles.resolve(data.role_id);
+
+    if ('enable_emoticons' in data) {
+      /**
+       * Whether emoticons should be synced for this integration (twitch only currently)
+       *
+       * @type {?boolean}
+       */
+      this.enableEmoticons = data.enable_emoticons;
+    } else {
+      this.enableEmoticons ??= null;
+    }
+
+    if (data.user) {
+      /**
+       * The user for this integration
+       *
+       * @type {?User}
+       */
+      this.user = this.client.users._add(data.user);
+    } else {
+      this.user ??= null;
+    }
+
+    /**
+     * The account integration information
+     *
+     * @type {IntegrationAccount}
+     */
+    this.account = data.account;
+
+    if ('synced_at' in data) {
+      /**
+       * The timestamp at which this integration was last synced at
+       *
+       * @type {?number}
+       */
+      this.syncedTimestamp = Date.parse(data.synced_at);
+    } else {
+      this.syncedTimestamp ??= null;
+    }
+
+    if ('subscriber_count' in data) {
+      /**
+       * How many subscribers this integration has
+       *
+       * @type {?number}
+       */
+      this.subscriberCount = data.subscriber_count;
+    } else {
+      this.subscriberCount ??= null;
+    }
+
+    if ('revoked' in data) {
+      /**
+       * Whether this integration has been revoked
+       *
+       * @type {?boolean}
+       */
+      this.revoked = data.revoked;
+    } else {
+      this.revoked ??= null;
+    }
+
+    this._patch(data);
+  }
+
+  /**
+   * The date at which this integration was last synced at
+   *
+   * @type {?Date}
+   * @readonly
+   */
+  get syncedAt() {
+    return this.syncedTimestamp && new Date(this.syncedTimestamp);
+  }
+
+  /**
+   * All roles that are managed by this integration
+   *
+   * @type {Collection<Snowflake, Role>}
+   * @readonly
+   */
+  get roles() {
+    const roles = this.guild.roles.cache;
+    return roles.filter(role => role.tags?.integrationId === this.id);
+  }
+
+  _patch(data) {
+    if ('expire_behavior' in data) {
+      /**
+       * The behavior of expiring subscribers
+       *
+       * @type {?IntegrationExpireBehavior}
+       */
+      this.expireBehavior = data.expire_behavior;
+    } else {
+      this.expireBehavior ??= null;
+    }
+
+    if ('expire_grace_period' in data) {
+      /**
+       * The grace period (in days) before expiring subscribers
+       *
+       * @type {?number}
+       */
+      this.expireGracePeriod = data.expire_grace_period;
+    } else {
+      this.expireGracePeriod ??= null;
+    }
+
+    if ('application' in data) {
+      if (this.application) {
+        this.application._patch(data.application);
+      } else {
+        /**
+         * The application for this integration
+         *
+         * @type {?IntegrationApplication}
+         */
+        this.application = new IntegrationApplication(this.client, data.application);
+      }
+    } else {
+      this.application ??= null;
+    }
+
+    if ('scopes' in data) {
+      /**
+       * The scopes this application has been authorized for
+       *
+       * @type {OAuth2Scopes[]}
+       */
+      this.scopes = data.scopes;
+    } else {
+      this.scopes ??= [];
+    }
+  }
+
+  /**
+   * Deletes this integration.
+   *
+   * @returns {Promise<Integration>}
+   * @param {string} [reason] Reason for deleting this integration
+   */
+  async delete(reason) {
+    await this.client.rest.delete(Routes.guildIntegration(this.guild.id, this.id), { reason });
+    return this;
+  }
+
+  toJSON() {
+    return super.toJSON({
+      role: 'roleId',
+      guild: 'guildId',
+      user: 'userId',
+    });
+  }
+}

package/src/structures/IntegrationApplication.ts

@@ -0,0 +1,84 @@
+import { Application  } from './interfaces/Application.js';
+
+/**
+ * Represents an Integration's OAuth2 Application.
+ *
+ * @extends {Application}
+ */
+export class IntegrationApplication extends Application {
+  public bot: any;
+  public termsOfServiceURL: any;
+  public privacyPolicyURL: any;
+  public rpcOrigins: any;
+  public cover: any;
+  public verifyKey: any;
+  _patch(data) {
+    super._patch(data);
+
+    if ('bot' in data) {
+      /**
+       * The bot user for this application
+       *
+       * @type {?User}
+       */
+      this.bot = this.client.users._add(data.bot);
+    } else {
+      this.bot ??= null;
+    }
+
+    if ('terms_of_service_url' in data) {
+      /**
+       * The URL of the application's terms of service
+       *
+       * @type {?string}
+       */
+      this.termsOfServiceURL = data.terms_of_service_url;
+    } else {
+      this.termsOfServiceURL ??= null;
+    }
+
+    if ('privacy_policy_url' in data) {
+      /**
+       * The URL of the application's privacy policy
+       *
+       * @type {?string}
+       */
+      this.privacyPolicyURL = data.privacy_policy_url;
+    } else {
+      this.privacyPolicyURL ??= null;
+    }
+
+    if ('rpc_origins' in data) {
+      /**
+       * The Array of RPC origin URLs
+       *
+       * @type {string[]}
+       */
+      this.rpcOrigins = data.rpc_origins;
+    } else {
+      this.rpcOrigins ??= [];
+    }
+
+    if ('cover_image' in data) {
+      /**
+       * The hash of the application's cover image
+       *
+       * @type {?string}
+       */
+      this.cover = data.cover_image;
+    } else {
+      this.cover ??= null;
+    }
+
+    if ('verify_key' in data) {
+      /**
+       * The hex-encoded key for verification in interactions and the GameSDK's GetTicket
+       *
+       * @type {?string}
+       */
+      this.verifyKey = data.verify_key;
+    } else {
+      this.verifyKey ??= null;
+    }
+  }
+}

package/src/structures/InteractionCallback.ts

@@ -0,0 +1,86 @@
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+
+/**
+ * Represents an interaction callback response from Discord
+ */
+export class InteractionCallback {
+  public client: any;
+  public id: any;
+  public type: any;
+  public activityInstanceId: any;
+  public responseMessageId: any;
+  public responseMessageLoading: any;
+  public responseMessageEphemeral: any;
+  constructor(client, data) {
+    /**
+     * The client that instantiated this.
+     *
+     * @name InteractionCallback#client
+     * @type {Client}
+     * @readonly
+     */
+    Object.defineProperty(this, 'client', { value: client });
+
+    /**
+     * The id of the original interaction response
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    /**
+     * The type of the original interaction
+     *
+     * @type {InteractionType}
+     */
+    this.type = data.type;
+
+    /**
+     * The instance id of the Activity if one was launched or joined
+     *
+     * @type {?string}
+     */
+    this.activityInstanceId = data.activity_instance_id ?? null;
+
+    /**
+     * The id of the message that was created by the interaction
+     *
+     * @type {?Snowflake}
+     */
+    this.responseMessageId = data.response_message_id ?? null;
+
+    /**
+     * Whether the message is in a loading state
+     *
+     * @type {?boolean}
+     */
+    this.responseMessageLoading = data.response_message_loading ?? null;
+
+    /**
+     * Whether the response message was ephemeral
+     *
+     * @type {?boolean}
+     */
+    this.responseMessageEphemeral = data.response_message_ephemeral ?? null;
+  }
+
+  /**
+   * The timestamp the original interaction was created at
+   *
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the original interaction was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+}

package/src/structures/InteractionCallbackResource.ts

@@ -0,0 +1,57 @@
+import { lazy  } from '@ovencord/util';
+
+const getMessage = lazy(() => require('./Message.js').Message);
+
+/**
+ * Represents the resource that was created by the interaction response.
+ */
+export class InteractionCallbackResource {
+  public client: any;
+  public type: any;
+  public activityInstance: any;
+  public message: any;
+  constructor(client, data) {
+    /**
+     * The client that instantiated this
+     *
+     * @name InteractionCallbackResource#client
+     * @type {Client}
+     * @readonly
+     */
+    Object.defineProperty(this, 'client', { value: client });
+
+    /**
+     * The interaction callback type
+     *
+     * @type {InteractionResponseType}
+     */
+    this.type = data.type;
+
+    /**
+     * The Activity launched by an interaction
+     *
+     * @typedef {Object} ActivityInstance
+     * @property {string} id The instance id of the Activity
+     */
+
+    /**
+     * Represents the Activity launched by this interaction
+     *
+     * @type {?ActivityInstance}
+     */
+    this.activityInstance = data.activity_instance ?? null;
+
+    if ('message' in data) {
+      /**
+       * The message created by the interaction
+       *
+       * @type {?Message}
+       */
+      this.message =
+        this.client.channels.cache.get(data.message.channel_id)?.messages._add(data.message) ??
+        new (getMessage())(client, data.message);
+    } else {
+      this.message = null;
+    }
+  }
+}