@ovencord/discord.js 14.16.3

package/src/structures/Widget.ts

@@ -0,0 +1,110 @@
+import { Collection  } from '@ovencord/collection';
+import { Routes  } from 'discord-api-types/v10';
+import { Base  } from './Base.js';
+import { WidgetMember  } from './WidgetMember.js';
+
+/**
+ * Represents a Widget.
+ *
+ * @extends {Base}
+ */
+export class Widget extends Base {
+  public client: any;
+  public id: any;
+  public name: any;
+  public instantInvite: any;
+  public channels: any;
+  public members: any;
+  public presenceCount: any;
+  constructor(client, data) {
+    super(client);
+    this._patch(data);
+  }
+
+  /**
+   * Represents a channel in a Widget
+   *
+   * @typedef {Object} WidgetChannel
+   * @property {Snowflake} id Id of the channel
+   * @property {string} name Name of the channel
+   * @property {number} position Position of the channel
+   */
+
+  _patch(data) {
+    /**
+     * The id of the guild.
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    if ('name' in data) {
+      /**
+       * The name of the guild.
+       *
+       * @type {string}
+       */
+      this.name = data.name;
+    }
+
+    if ('instant_invite' in data) {
+      /**
+       * The invite of the guild.
+       *
+       * @type {?string}
+       */
+      this.instantInvite = data.instant_invite;
+    }
+
+    /**
+     * The list of channels in the guild.
+     *
+     * @type {Collection<Snowflake, WidgetChannel>}
+     */
+    this.channels = new Collection();
+    for (const channel of data.channels) {
+      this.channels.set(channel.id, channel);
+    }
+
+    /**
+     * The list of members in the guild.
+     * These strings are just arbitrary numbers, they aren't Snowflakes.
+     *
+     * @type {Collection<string, WidgetMember>}
+     */
+    this.members = new Collection();
+    for (const member of data.members) {
+      this.members.set(member.id, new WidgetMember(this.client, member));
+    }
+
+    if ('presence_count' in data) {
+      /**
+       * The number of members online.
+       *
+       * @type {number}
+       */
+      this.presenceCount = data.presence_count;
+    }
+  }
+
+  /**
+   * Update the Widget.
+   *
+   * @returns {Promise<Widget>}
+   */
+  async fetch() {
+    const data = await this.client.rest.get(Routes.guildWidgetJSON(this.id));
+    this._patch(data);
+    return this;
+  }
+
+  /**
+   * Returns a URL for the PNG widget of the guild.
+   *
+   * @param {GuildWidgetStyle} [style] The style for the widget image
+   * @returns {string}
+   */
+  imageURL(style) {
+    return this.client.guilds.widgetImageURL(this.id, style);
+  }
+}

package/src/structures/WidgetMember.ts

@@ -0,0 +1,124 @@
+import { Base  } from './Base.js';
+
+/**
+ * Represents a WidgetMember.
+ *
+ * @extends {Base}
+ */
+export class WidgetMember extends Base {
+  public client: any;
+  public id: any;
+  public username: any;
+  public discriminator: any;
+  public avatar: any;
+  public status: any;
+  public deaf: any;
+  public mute: any;
+  public selfDeaf: any;
+  public selfMute: any;
+  public suppress: any;
+  public channelId: any;
+  public avatarURL: any;
+  public activity: any;
+  /**
+   * Activity sent in a {@link WidgetMember}.
+   *
+   * @typedef {Object} WidgetActivity
+   * @property {string} name The name of the activity
+   */
+
+  constructor(client, data) {
+    super(client);
+
+    /**
+     * The id of the user. It's an arbitrary number.
+     *
+     * @type {string}
+     */
+    this.id = data.id;
+
+    /**
+     * The username of the member.
+     *
+     * @type {string}
+     */
+    this.username = data.username;
+
+    /**
+     * The discriminator of the member.
+     *
+     * @type {string}
+     */
+    this.discriminator = data.discriminator;
+
+    /**
+     * The avatar of the member.
+     *
+     * @type {?string}
+     */
+    this.avatar = data.avatar;
+
+    /**
+     * The status of the member.
+     *
+     * @type {PresenceStatus}
+     */
+    this.status = data.status;
+
+    /**
+     * If the member is server deafened
+     *
+     * @type {?boolean}
+     */
+    this.deaf = data.deaf ?? null;
+
+    /**
+     * If the member is server muted
+     *
+     * @type {?boolean}
+     */
+    this.mute = data.mute ?? null;
+
+    /**
+     * If the member is self deafened
+     *
+     * @type {?boolean}
+     */
+    this.selfDeaf = data.self_deaf ?? null;
+
+    /**
+     * If the member is self muted
+     *
+     * @type {?boolean}
+     */
+    this.selfMute = data.self_mute ?? null;
+
+    /**
+     * If the member is suppressed
+     *
+     * @type {?boolean}
+     */
+    this.suppress = data.suppress ?? null;
+
+    /**
+     * The id of the voice channel the member is in, if any
+     *
+     * @type {?Snowflake}
+     */
+    this.channelId = data.channel_id ?? null;
+
+    /**
+     * The avatar URL of the member.
+     *
+     * @type {string}
+     */
+    this.avatarURL = data.avatar_url;
+
+    /**
+     * The activity of the member.
+     *
+     * @type {?WidgetActivity}
+     */
+    this.activity = data.activity ?? null;
+  }
+}

package/src/structures/interfaces/Application.ts

@@ -0,0 +1,179 @@
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+import { Base  } from '../Base.js';
+
+/**
+ * Represents an OAuth2 Application.
+ *
+ * @extends {Base}
+ * @abstract
+ */
+export class Application extends Base {
+  public client: any;
+  public id: any;
+  public name: any;
+  public description: any;
+  public icon: any;
+  public termsOfServiceURL: any;
+  public privacyPolicyURL: any;
+  public rpcOrigins: any;
+  public cover: any;
+  public verifyKey: any;
+  constructor(client, data) {
+    super(client);
+    this._patch(data);
+  }
+
+  _patch(data) {
+    /**
+     * The application's id
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    if ('name' in data) {
+      /**
+       * The name of the application
+       *
+       * @type {?string}
+       */
+      this.name = data.name;
+    } else {
+      this.name ??= null;
+    }
+
+    if ('description' in data) {
+      /**
+       * The application's description
+       *
+       * @type {?string}
+       */
+      this.description = data.description;
+    } else {
+      this.description ??= null;
+    }
+
+    if ('icon' in data) {
+      /**
+       * The application's icon hash
+       *
+       * @type {?string}
+       */
+      this.icon = data.icon;
+    } else {
+      this.icon ??= 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 application's RPC origins, if enabled
+       *
+       * @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;
+    }
+  }
+
+  /**
+   * The timestamp the application was created at
+   *
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the application was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * A link to the application's icon.
+   *
+   * @param {ImageURLOptions} [options={}] Options for the image URL
+   * @returns {?string}
+   */
+  iconURL(options = {}) {
+    return this.icon && this.client.rest.cdn.appIcon(this.id, this.icon, options);
+  }
+
+  /**
+   * A link to this application's cover image.
+   *
+   * @param {ImageURLOptions} [options={}] Options for the image URL
+   * @returns {?string}
+   */
+  coverURL(options = {}) {
+    return this.cover && this.client.rest.cdn.appIcon(this.id, this.cover, options);
+  }
+
+  /**
+   * When concatenated with a string, this automatically returns the application's name instead of the
+   * Application object.
+   *
+   * @returns {?string}
+   * @example
+   * // Logs: Application name: My App
+   * console.log(`Application name: ${application}`);
+   */
+  toString() {
+    return this.name;
+  }
+
+  toJSON() {
+    return super.toJSON({ createdTimestamp: true });
+  }
+}