cognova 0.2.3 → 0.2.5

package/.output/server/node_modules/discord.js/src/managers/GuildSoundboardSoundManager.js

@@ -0,0 +1,214 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { lazy } = require('@discordjs/util');
+const { Routes } = require('discord-api-types/v10');
+const CachedManager = require('./CachedManager.js');
+const { DiscordjsTypeError, ErrorCodes } = require('../errors/index.js');
+const { SoundboardSound } = require('../structures/SoundboardSound.js');
+const { resolveBase64, resolveFile } = require('../util/DataResolver.js');
+
+const fileTypeMime = lazy(() => require('magic-bytes.js').filetypemime);
+
+/**
+ * Manages API methods for Soundboard Sounds and stores their cache.
+ * @extends {CachedManager}
+ */
+class GuildSoundboardSoundManager extends CachedManager {
+  constructor(guild, iterable) {
+    super(guild.client, SoundboardSound, iterable);
+
+    /**
+     * The guild this manager belongs to
+     * @type {Guild}
+     */
+    this.guild = guild;
+  }
+
+  /**
+   * The cache of Soundboard Sounds
+   * @type {Collection<Snowflake, SoundboardSound>}
+   * @name GuildSoundboardSoundManager#cache
+   */
+
+  _add(data, cache) {
+    return super._add(data, cache, { extras: [this.guild], id: data.sound_id });
+  }
+
+  /**
+   * Data that resolves to give a SoundboardSound object. This can be:
+   * * A SoundboardSound object
+   * * A Snowflake
+   * @typedef {SoundboardSound|Snowflake} SoundboardSoundResolvable
+   */
+
+  /**
+   * Resolves a SoundboardSoundResolvable to a SoundboardSound object.
+   * @method resolve
+   * @memberof GuildSoundboardSoundManager
+   * @instance
+   * @param {SoundboardSoundResolvable} soundboardSound The SoundboardSound resolvable to identify
+   * @returns {?SoundboardSound}
+   */
+
+  /**
+   * Resolves a {@link SoundboardSoundResolvable} to a {@link SoundboardSound} id.
+   * @param {SoundboardSoundResolvable} soundboardSound The soundboard sound resolvable to resolve
+   * @returns {?Snowflake}
+   */
+  resolveId(soundboardSound) {
+    if (soundboardSound instanceof this.holds) return soundboardSound.soundId;
+    if (typeof soundboardSound === 'string') return soundboardSound;
+    return null;
+  }
+
+  /**
+   * Options used to create a soundboard sound in a guild.
+   * @typedef {Object} GuildSoundboardSoundCreateOptions
+   * @property {BufferResolvable|Stream} file The file for the soundboard sound
+   * @property {string} name The name for the soundboard sound
+   * @property {string} [contentType] The content type for the soundboard sound file
+   * @property {number} [volume] The volume (a double) for the soundboard sound, from 0 (inclusive) to 1. Defaults to 1
+   * @property {Snowflake} [emojiId] The emoji id for the soundboard sound
+   * @property {string} [emojiName] The emoji name for the soundboard sound
+   * @property {string} [reason] The reason for creating the soundboard sound
+   */
+
+  /**
+   * Creates a new guild soundboard sound.
+   * @param {GuildSoundboardSoundCreateOptions} options Options for creating a guild soundboard sound
+   * @returns {Promise<SoundboardSound>} The created soundboard sound
+   * @example
+   * // Create a new soundboard sound from a file on your computer
+   * guild.soundboardSounds.create({ file: './sound.mp3', name: 'sound' })
+   *   .then(sound => console.log(`Created new soundboard sound with name ${sound.name}!`))
+   *   .catch(console.error);
+   */
+  async create({ contentType, emojiId, emojiName, file, name, reason, volume }) {
+    const resolvedFile = await resolveFile(file);
+
+    const resolvedContentType = contentType ?? resolvedFile.contentType ?? fileTypeMime()(resolvedFile.data)[0];
+
+    const sound = resolveBase64(resolvedFile.data, resolvedContentType);
+
+    const body = { emoji_id: emojiId, emoji_name: emojiName, name, sound, volume };
+
+    const soundboardSound = await this.client.rest.post(Routes.guildSoundboardSounds(this.guild.id), {
+      body,
+      reason,
+    });
+
+    return this._add(soundboardSound);
+  }
+
+  /**
+   * Data for editing a soundboard sound.
+   * @typedef {Object} GuildSoundboardSoundEditOptions
+   * @property {string} [name] The name of the soundboard sound
+   * @property {?number} [volume] The volume (a double) of the soundboard sound, from 0 (inclusive) to 1
+   * @property {?Snowflake} [emojiId] The emoji id of the soundboard sound
+   * @property {?string} [emojiName] The emoji name of the soundboard sound
+   * @property {string} [reason] The reason for editing the soundboard sound
+   */
+
+  /**
+   * Edits a soundboard sound.
+   * @param {SoundboardSoundResolvable} soundboardSound The soundboard sound to edit
+   * @param {GuildSoundboardSoundEditOptions} [options={}] The new data for the soundboard sound
+   * @returns {Promise<SoundboardSound>}
+   */
+  async edit(soundboardSound, options = {}) {
+    const soundId = this.resolveId(soundboardSound);
+
+    if (!soundId) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'soundboardSound', 'SoundboardSoundResolvable');
+
+    const { emojiId, emojiName, name, reason, volume } = options;
+
+    const body = { emoji_id: emojiId, emoji_name: emojiName, name, volume };
+
+    const data = await this.client.rest.patch(Routes.guildSoundboardSound(this.guild.id, soundId), {
+      body,
+      reason,
+    });
+
+    const existing = this.cache.get(soundId);
+
+    if (existing) {
+      const clone = existing._clone();
+
+      clone._patch(data);
+      return clone;
+    }
+
+    return this._add(data);
+  }
+
+  /**
+   * Deletes a soundboard sound.
+   * @param {SoundboardSoundResolvable} soundboardSound The soundboard sound to delete
+   * @param {string} [reason] Reason for deleting this soundboard sound
+   * @returns {Promise<void>}
+   */
+  async delete(soundboardSound, reason) {
+    const soundId = this.resolveId(soundboardSound);
+
+    if (!soundId) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'soundboardSound', 'SoundboardSoundResolvable');
+
+    await this.client.rest.delete(Routes.guildSoundboardSound(this.guild.id, soundId), { reason });
+  }
+
+  /**
+   * Options used to fetch a soundboard sound.
+   * @typedef {BaseFetchOptions} FetchSoundboardSoundOptions
+   * @property {SoundboardSoundResolvable} soundboardSound The soundboard sound to fetch
+   */
+
+  /**
+   * Options used to fetch soundboard sounds from Discord
+   * @typedef {Object} FetchGuildSoundboardSoundsOptions
+   * @property {boolean} [cache] Whether to cache the fetched soundboard sounds
+   */
+
+  /* eslint-disable max-len */
+  /**
+   * Obtains one or more soundboard sounds from Discord, or the soundboard sound cache if they're already available.
+   * @param {SoundboardSoundResolvable|FetchSoundboardSoundOptions|FetchGuildSoundboardSoundsOptions} [options] Options for fetching soundboard sound(s)
+   * @returns {Promise<SoundboardSound|Collection<Snowflake, SoundboardSound>>}
+   * @example
+   * // Fetch a single soundboard sound
+   * guild.soundboardSounds.fetch('222078108977594368')
+   *   .then(sound => console.log(`The soundboard sound name is: ${sound.name}`))
+   *   .catch(console.error);
+   * @example
+   * // Fetch all soundboard sounds from the guild
+   * guild.soundboardSounds.fetch()
+   *   .then(sounds => console.log(`There are ${sounds.size} soundboard sounds.`))
+   *   .catch(console.error);
+   */
+  /* eslint-enable max-len */
+  async fetch(options) {
+    if (!options) return this._fetchMany();
+    const { cache, force, soundboardSound } = options;
+    const resolvedSoundboardSound = this.resolveId(soundboardSound ?? options);
+    if (resolvedSoundboardSound) return this._fetchSingle({ cache, force, soundboardSound: resolvedSoundboardSound });
+    return this._fetchMany({ cache });
+  }
+
+  async _fetchSingle({ cache, force, soundboardSound } = {}) {
+    if (!force) {
+      const existing = this.cache.get(soundboardSound);
+      if (existing) return existing;
+    }
+
+    const data = await this.client.rest.get(Routes.guildSoundboardSound(this.guild.id, soundboardSound));
+    return this._add(data, cache);
+  }
+
+  async _fetchMany({ cache } = {}) {
+    const data = await this.client.rest.get(Routes.guildSoundboardSounds(this.guild.id));
+
+    return data.items.reduce((coll, sound) => coll.set(sound.sound_id, this._add(sound, cache)), new Collection());
+  }
+}
+
+exports.GuildSoundboardSoundManager = GuildSoundboardSoundManager;

package/.output/server/node_modules/discord.js/src/managers/GuildStickerManager.js

@@ -0,0 +1,182 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { Routes } = require('discord-api-types/v10');
+const CachedManager = require('./CachedManager');
+const { DiscordjsTypeError, ErrorCodes } = require('../errors');
+const MessagePayload = require('../structures/MessagePayload');
+const { Sticker } = require('../structures/Sticker');
+
+/**
+ * Manages API methods for Guild Stickers and stores their cache.
+ * @extends {CachedManager}
+ */
+class GuildStickerManager extends CachedManager {
+  constructor(guild, iterable) {
+    super(guild.client, Sticker, iterable);
+
+    /**
+     * The guild this manager belongs to
+     * @type {Guild}
+     */
+    this.guild = guild;
+  }
+
+  /**
+   * The cache of Guild Stickers
+   * @type {Collection<Snowflake, Sticker>}
+   * @name GuildStickerManager#cache
+   */
+
+  _add(data, cache) {
+    return super._add(data, cache, { extras: [this.guild] });
+  }
+
+  /**
+   * Options used to create a guild sticker.
+   * @typedef {Object} GuildStickerCreateOptions
+   * @property {AttachmentPayload|BufferResolvable|Stream} file The file for the sticker
+   * @property {string} name The name for the sticker
+   * @property {string} tags The Discord name of a unicode emoji representing the sticker's expression
+   * @property {?string} [description] The description for the sticker
+   * @property {string} [reason] Reason for creating the sticker
+   */
+
+  /**
+   * Creates a new custom sticker in the guild.
+   * @param {GuildStickerCreateOptions} options Options for creating a guild sticker
+   * @returns {Promise<Sticker>} The created sticker
+   * @example
+   * // Create a new sticker from a URL
+   * guild.stickers.create({ file: 'https://i.imgur.com/w3duR07.png', name: 'rip', tags: 'headstone' })
+   *   .then(sticker => console.log(`Created new sticker with name ${sticker.name}!`))
+   *   .catch(console.error);
+   * @example
+   * // Create a new sticker from a file on your computer
+   * guild.stickers.create({ file: './memes/banana.png', name: 'banana', tags: 'banana' })
+   *   .then(sticker => console.log(`Created new sticker with name ${sticker.name}!`))
+   *   .catch(console.error);
+   */
+  async create({ file, name, tags, description, reason } = {}) {
+    const resolvedFile = await MessagePayload.resolveFile(file);
+    if (!resolvedFile) throw new DiscordjsTypeError(ErrorCodes.ReqResourceType);
+    file = { ...resolvedFile, key: 'file' };
+
+    const body = { name, tags, description: description ?? '' };
+
+    const sticker = await this.client.rest.post(Routes.guildStickers(this.guild.id), {
+      appendToFormData: true,
+      body,
+      files: [file],
+      reason,
+    });
+    return this.client.actions.GuildStickerCreate.handle(this.guild, sticker).sticker;
+  }
+
+  /**
+   * Data that resolves to give a Sticker object. This can be:
+   * * A Sticker object
+   * * A Snowflake
+   * @typedef {Sticker|Snowflake} StickerResolvable
+   */
+
+  /**
+   * Resolves a StickerResolvable to a Sticker object.
+   * @method resolve
+   * @memberof GuildStickerManager
+   * @instance
+   * @param {StickerResolvable} sticker The Sticker resolvable to identify
+   * @returns {?Sticker}
+   */
+
+  /**
+   * Resolves a StickerResolvable to a Sticker id string.
+   * @method resolveId
+   * @memberof GuildStickerManager
+   * @instance
+   * @param {StickerResolvable} sticker The Sticker resolvable to identify
+   * @returns {?Snowflake}
+   */
+
+  /**
+   * Edits a sticker.
+   * @param {StickerResolvable} sticker The sticker to edit
+   * @param {GuildStickerEditOptions} [options={}] The new data for the sticker
+   * @returns {Promise<Sticker>}
+   */
+  async edit(sticker, options = {}) {
+    const stickerId = this.resolveId(sticker);
+    if (!stickerId) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'sticker', 'StickerResolvable');
+
+    const d = await this.client.rest.patch(Routes.guildSticker(this.guild.id, stickerId), {
+      body: options,
+      reason: options.reason,
+    });
+
+    const existing = this.cache.get(stickerId);
+    if (existing) {
+      const clone = existing._clone();
+      clone._patch(d);
+      return clone;
+    }
+    return this._add(d);
+  }
+
+  /**
+   * Deletes a sticker.
+   * @param {StickerResolvable} sticker The sticker to delete
+   * @param {string} [reason] Reason for deleting this sticker
+   * @returns {Promise<void>}
+   */
+  async delete(sticker, reason) {
+    sticker = this.resolveId(sticker);
+    if (!sticker) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'sticker', 'StickerResolvable');
+
+    await this.client.rest.delete(Routes.guildSticker(this.guild.id, sticker), { reason });
+  }
+
+  /**
+   * Obtains one or more stickers from Discord, or the sticker cache if they're already available.
+   * @param {Snowflake} [id] The Sticker's id
+   * @param {BaseFetchOptions} [options] Additional options for this fetch
+   * @returns {Promise<Sticker|Collection<Snowflake, Sticker>>}
+   * @example
+   * // Fetch all stickers from the guild
+   * message.guild.stickers.fetch()
+   *   .then(stickers => console.log(`There are ${stickers.size} stickers.`))
+   *   .catch(console.error);
+   * @example
+   * // Fetch a single sticker
+   * message.guild.stickers.fetch('222078108977594368')
+   *   .then(sticker => console.log(`The sticker name is: ${sticker.name}`))
+   *   .catch(console.error);
+   */
+  async fetch(id, { cache = true, force = false } = {}) {
+    if (id) {
+      if (!force) {
+        const existing = this.cache.get(id);
+        if (existing) return existing;
+      }
+      const sticker = await this.client.rest.get(Routes.guildSticker(this.guild.id, id));
+      return this._add(sticker, cache);
+    }
+
+    const data = await this.client.rest.get(Routes.guildStickers(this.guild.id));
+    return new Collection(data.map(sticker => [sticker.id, this._add(sticker, cache)]));
+  }
+
+  /**
+   * Fetches the user who uploaded this sticker, if this is a guild sticker.
+   * @param {StickerResolvable} sticker The sticker to fetch the user for
+   * @returns {Promise<?User>}
+   */
+  async fetchUser(sticker) {
+    sticker = this.resolve(sticker);
+    if (!sticker) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'sticker', 'StickerResolvable');
+    const data = await this.client.rest.get(Routes.guildSticker(this.guild.id, sticker.id));
+    sticker._patch(data);
+    return sticker.user;
+  }
+}
+
+module.exports = GuildStickerManager;

package/.output/server/node_modules/discord.js/src/managers/GuildTextThreadManager.js

@@ -0,0 +1,91 @@
+'use strict';
+
+const { ChannelType, Routes } = require('discord-api-types/v10');
+const ThreadManager = require('./ThreadManager');
+const { DiscordjsTypeError, ErrorCodes } = require('../errors');
+
+/**
+ * Manages API methods for {@link ThreadChannel} objects and stores their cache.
+ * @extends {ThreadManager}
+ */
+class GuildTextThreadManager extends ThreadManager {
+  /**
+   * The channel this Manager belongs to
+   * @name GuildTextThreadManager#channel
+   * @type {TextChannel|NewsChannel}
+   */
+
+  /**
+   * Options for creating a thread. <warn>Only one of `startMessage` or `type` can be defined.</warn>
+   * @typedef {StartThreadOptions} GuildTextThreadCreateOptions
+   * @property {MessageResolvable} [startMessage] The message to start a thread from.
+   * <warn>If this is defined, then the `type` of thread gets inferred automatically and cannot be changed.</warn>
+   * @property {ThreadChannelTypes} [type] The type of thread to create.
+   * Defaults to {@link ChannelType.PublicThread} if created in a {@link TextChannel}
+   * <warn>When creating threads in a {@link NewsChannel}, this is ignored and is always
+   * {@link ChannelType.AnnouncementThread}</warn>
+   * @property {boolean} [invitable] Whether non-moderators can add other non-moderators to the thread
+   * <info>Can only be set when type will be {@link ChannelType.PrivateThread}</info>
+   */
+
+  /**
+   * Creates a new thread in the channel.
+   * @param {GuildTextThreadCreateOptions} [options] Options to create a new thread
+   * @returns {Promise<ThreadChannel>}
+   * @example
+   * // Create a new public thread
+   * channel.threads
+   *   .create({
+   *     name: 'food-talk',
+   *     autoArchiveDuration: ThreadAutoArchiveDuration.OneHour,
+   *     reason: 'Needed a separate thread for food',
+   *   })
+   *   .then(threadChannel => console.log(threadChannel))
+   *   .catch(console.error);
+   * @example
+   * // Create a new private thread
+   * channel.threads
+   *   .create({
+   *      name: 'mod-talk',
+   *      autoArchiveDuration: ThreadAutoArchiveDuration.OneHour,
+   *      type: ChannelType.PrivateThread,
+   *      reason: 'Needed a separate thread for moderation',
+   *    })
+   *   .then(threadChannel => console.log(threadChannel))
+   *   .catch(console.error);
+   */
+  async create({
+    name,
+    autoArchiveDuration = this.channel.defaultAutoArchiveDuration,
+    startMessage,
+    type,
+    invitable,
+    reason,
+    rateLimitPerUser,
+  } = {}) {
+    let resolvedType =
+      this.channel.type === ChannelType.GuildAnnouncement ? ChannelType.AnnouncementThread : ChannelType.PublicThread;
+    let startMessageId;
+    if (startMessage) {
+      startMessageId = this.channel.messages.resolveId(startMessage);
+      if (!startMessageId) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'startMessage', 'MessageResolvable');
+    } else if (this.channel.type !== ChannelType.GuildAnnouncement) {
+      resolvedType = type ?? resolvedType;
+    }
+
+    const data = await this.client.rest.post(Routes.threads(this.channel.id, startMessageId), {
+      body: {
+        name,
+        auto_archive_duration: autoArchiveDuration,
+        type: resolvedType,
+        invitable: resolvedType === ChannelType.PrivateThread ? invitable : undefined,
+        rate_limit_per_user: rateLimitPerUser,
+      },
+      reason,
+    });
+
+    return this.client.actions.ThreadCreate.handle(data).thread;
+  }
+}
+
+module.exports = GuildTextThreadManager;