@discordjs/structures 0.2.0-dev.1769083302-838cd2da3 → 0.2.0-dev.1769385723-323d8e757

package/dist/index.mjs

@@ -1,6 +1,338 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
+// src/utils/symbols.ts
+var kData = /* @__PURE__ */ Symbol.for("djs.structures.data");
+var kClone = /* @__PURE__ */ Symbol.for("djs.structures.clone");
+var kPatch = /* @__PURE__ */ Symbol.for("djs.structures.patch");
+var kExpiresTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.expiresTimestamp");
+var kEndedTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.endedTimestamp");
+var kCreatedTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.createdTimestamp");
+var kEditedTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.editedTimestamp");
+var kArchiveTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.archiveTimestamp");
+var kStartsTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.startsTimestamp");
+var kEndsTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.endsTimestamp");
+var kAllow = /* @__PURE__ */ Symbol.for("djs.structures.allow");
+var kDeny = /* @__PURE__ */ Symbol.for("djs.structures.deny");
+var kBurstColors = /* @__PURE__ */ Symbol.for("djs.structures.burstColors");
+var kLastPinTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.lastPinTimestamp");
+var kMixinConstruct = /* @__PURE__ */ Symbol.for("djs.structures.mixin.construct");
+var kMixinToJSON = /* @__PURE__ */ Symbol.for("djs.structures.mixin.toJSON");
+
+// src/Structure.ts
+var DataTemplatePropertyName = "DataTemplate";
+var OptimizeDataPropertyName = "optimizeData";
+var Structure = class {
+  static {
+    __name(this, "Structure");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each Structure.
+   *
+   * @remarks This template should be overridden in all subclasses to provide more accurate type information.
+   * The template in the base {@link Structure} class will have no effect on most subclasses for this reason.
+   */
+  static DataTemplate = {};
+  /**
+   * @returns A cloned version of the data template, ready to create a new data object.
+   */
+  getDataTemplate() {
+    return Object.create(this.constructor.DataTemplate);
+  }
+  /**
+   * The raw data from the API for this structure
+   *
+   * @internal
+   */
+  [kData];
+  /**
+   * Creates a new structure to represent API data
+   *
+   * @param data - the data from the API that this structure will represent
+   * @remarks To be made public in subclasses
+   * @internal
+   */
+  constructor(data, ..._rest) {
+    this[kData] = Object.assign(this.getDataTemplate(), data);
+    this[kMixinConstruct]?.(data);
+  }
+  /**
+   * Patches the raw data of this object in place
+   *
+   * @param data - the updated data from the API to patch with
+   * @remarks To be made public in subclasses
+   * @returns this
+   * @internal
+   */
+  [kPatch](data) {
+    this[kData] = Object.assign(this.getDataTemplate(), this[kData], data);
+    this.optimizeData(data);
+    return this;
+  }
+  /**
+   * Creates a clone of this structure
+   *
+   * @returns a clone of this
+   * @internal
+   */
+  [kClone](patchPayload) {
+    const clone = this.toJSON();
+    return new this.constructor(
+      // Ensure the ts-expect-error only applies to the constructor call
+      patchPayload ? Object.assign(clone, patchPayload) : clone
+    );
+  }
+  /**
+   * Function called to ensure stored raw data is in optimized formats, used in tandem with a data template
+   *
+   * @example created_timestamp is an ISO string, this can be stored in optimized form as a number
+   * @param _data - the raw data received from the API to optimize
+   * @remarks Implementation to be done in subclasses and mixins where needed.
+   * For typescript users, mixins must use the closest ancestors access modifier.
+   * @remarks Automatically called in Structure[kPatch] but must be called manually in the constructor
+   * of any class implementing this method.
+   * @remarks Additionally, when implementing, ensure to call `super._optimizeData` if any class in the super chain aside
+   * from Structure contains an implementation.
+   * Note: mixins do not need to call super ever as the process of mixing walks the prototype chain.
+   * @virtual
+   * @internal
+   */
+  optimizeData(_data) {
+  }
+  /**
+   * Transforms this object to its JSON format with raw API data (or close to it),
+   * automatically called by `JSON.stringify()` when this structure is stringified
+   *
+   * @remarks
+   * The type of this data is determined by omissions at runtime and is only guaranteed for default omissions
+   * @privateRemarks
+   * When omitting properties at the library level, this must be overridden to re-add those properties
+   */
+  toJSON() {
+    const data = (
+      // Spread is way faster than structuredClone, but is shallow. So use it only if there is no nested objects
+      Object.values(this[kData]).some((value) => typeof value === "object" && value !== null) ? structuredClone(this[kData]) : { ...this[kData] }
+    );
+    this[kMixinToJSON]?.(data);
+    return data;
+  }
+};
+
+// src/automoderation/actions/AutoModerationAction.ts
+var AutoModerationAction = class extends Structure {
+  static {
+    __name(this, "AutoModerationAction");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each auto moderation action
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the auto moderation action
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * The {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-types | action type}
+   */
+  get type() {
+    return this[kData].type;
+  }
+};
+
+// src/automoderation/actions/AutoModerationActionMetadata.ts
+var AutoModerationActionMetadata = class extends Structure {
+  static {
+    __name(this, "AutoModerationActionMetadata");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each auto moderation action metadata
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the auto moderation action metadata
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * Channel to which user content should be logged. This must be an existing channel
+   *
+   * Associated action types: {@link AutoModerationActionType.SendAlertMessage}
+   */
+  get channelId() {
+    return this[kData].channel_id;
+  }
+  /**
+   * Timeout duration in seconds. Maximum of 2419200 seconds (4 weeks).
+   *
+   * A `TIMEOUT` action can only be set up for {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.MentionSpam}.
+   *
+   * The `MODERATE_MEMBERS` permission is required to use {@link AutoModerationActionType.Timeout} actions.
+   *
+   * Associated action types: {@link AutoModerationActionType.Timeout}
+   */
+  get durationSeconds() {
+    return this[kData].duration_seconds;
+  }
+  /**
+   * Additional explanation that will be shown to members whenever their message is blocked. Maximum of 150 characters
+   *
+   * Associated action types: {@link AutoModerationActionType.BlockMessage}
+   */
+  get customMessage() {
+    return this[kData].custom_message;
+  }
+};
+
+// src/automoderation/AutoModerationRule.ts
+var AutoModerationRule = class extends Structure {
+  static {
+    __name(this, "AutoModerationRule");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each auto moderation rule
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the auto moderation rule
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * The id of this rule
+   */
+  get id() {
+    return this[kData].id;
+  }
+  /**
+   * The id of the guild which this rule belongs to
+   */
+  get guildId() {
+    return this[kData].guild_id;
+  }
+  /**
+   * The rule name
+   */
+  get name() {
+    return this[kData].name;
+  }
+  /**
+   * The user who first created this rule
+   */
+  get creatorId() {
+    return this[kData].creator_id;
+  }
+  /**
+   * The rule {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-event-types | event type}
+   */
+  get eventType() {
+    return this[kData].event_type;
+  }
+  /**
+   * The rule {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types | trigger type}
+   */
+  get triggerType() {
+    return this[kData].trigger_type;
+  }
+  /**
+   * Whether the rule is enabled
+   */
+  get enabled() {
+    return this[kData].enabled;
+  }
+};
+
+// src/automoderation/AutoModerationRuleTriggerMetadata.ts
+var AutoModerationRuleTriggerMetadata = class extends Structure {
+  static {
+    __name(this, "AutoModerationRuleTriggerMetadata");
+  }
+  /**
+   * The template used for removing data from the raw data stored for each auto moderation rule trigger metadata
+   */
+  static DataTemplate = {};
+  /**
+   * @param data - The raw data received from the API for the auto moderation rule trigger metadata
+   */
+  constructor(data) {
+    super(data);
+  }
+  /**
+   * Substrings which will be searched for in content (Maximum of 1000)
+   *
+   * A keyword can be a phrase which contains multiple words.
+   *
+   * Wildcard symbols can be used to customize how each keyword will be matched. Each keyword must be 60 characters or less.
+   *
+   * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-matching-strategies | Keyword matching strategies}
+   *
+   * Associated trigger types: {@link AutoModerationRuleTriggerType.Keyword}, {@link AutoModerationRuleTriggerType.MemberProfile}
+   */
+  get keywordFilter() {
+    return this[kData].keyword_filter;
+  }
+  /**
+   * Regular expression patterns which will be matched against content (Maximum of 10)
+   *
+   * Only Rust flavored regex is currently supported, which can be tested in online editors such as {@link https://rustexp.lpil.uk/ | Rustexp}.
+   *
+   * Each regex pattern must be 260 characters or less.
+   *
+   * Associated trigger types: {@link AutoModerationRuleTriggerType.Keyword}, {@link AutoModerationRuleTriggerType.MemberProfile}
+   */
+  get regexPatterns() {
+    return this[kData].regex_patterns;
+  }
+  /**
+   * The internally pre-defined wordsets which will be searched for in content
+   *
+   * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-preset-types | Keyword preset types}
+   *
+   * Associated trigger types: {@link AutoModerationRuleTriggerType.KeywordPreset}
+   */
+  get presets() {
+    return this[kData].presets;
+  }
+  /**
+   * Substrings which should not trigger the rule (Maximum of 100 or 1000).
+   *
+   * Wildcard symbols can be used to customize how each keyword will be matched (see Keyword matching strategies).
+   *
+   * Each `allow_list` keyword can be a phrase which contains multiple words.
+   *
+   * Rules with `KEYWORD` triggerType accept a maximum of 100 keywords.
+   *
+   * Rules with `KEYWORD_PRESET` triggerType accept a maximum of 1000 keywords.
+   *
+   * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types | triggerType}
+   * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-matching-strategies | Keyword matching strategies}
+   *
+   * Associated trigger types: {@link AutoModerationRuleTriggerType.Keyword}, {@link AutoModerationRuleTriggerType.KeywordPreset}, {@link AutoModerationRuleTriggerType.MemberProfile}
+   */
+  get allowList() {
+    return this[kData].allow_list;
+  }
+  /**
+   * Total number of unique role and user mentions allowed per message (Maximum of 50)
+   *
+   * Associated trigger types: {@link AutoModerationRuleTriggerType.MentionSpam}
+   */
+  get mentionTotalLimit() {
+    return this[kData].mention_total_limit;
+  }
+  /**
+   * Whether to automatically detect mention raids
+   *
+   * Associated trigger types: {@link AutoModerationRuleTriggerType.MentionSpam}
+   */
+  get mentionRaidProtectionEnabled() {
+    return this[kData].mention_raid_protection_enabled;
+  }
+};
+
 // src/bitfields/BitField.ts
 var BitField = class _BitField {
   static {
@@ -271,24 +603,6 @@ var PermissionsBitField = class extends BitField {
   }
 };
 
-// src/utils/symbols.ts
-var kData = /* @__PURE__ */ Symbol.for("djs.structures.data");
-var kClone = /* @__PURE__ */ Symbol.for("djs.structures.clone");
-var kPatch = /* @__PURE__ */ Symbol.for("djs.structures.patch");
-var kExpiresTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.expiresTimestamp");
-var kEndedTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.endedTimestamp");
-var kCreatedTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.createdTimestamp");
-var kEditedTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.editedTimestamp");
-var kArchiveTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.archiveTimestamp");
-var kStartsTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.startsTimestamp");
-var kEndsTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.endsTimestamp");
-var kAllow = /* @__PURE__ */ Symbol.for("djs.structures.allow");
-var kDeny = /* @__PURE__ */ Symbol.for("djs.structures.deny");
-var kBurstColors = /* @__PURE__ */ Symbol.for("djs.structures.burstColors");
-var kLastPinTimestamp = /* @__PURE__ */ Symbol.for("djs.structures.lastPinTimestamp");
-var kMixinConstruct = /* @__PURE__ */ Symbol.for("djs.structures.mixin.construct");
-var kMixinToJSON = /* @__PURE__ */ Symbol.for("djs.structures.mixin.toJSON");
-
 // src/channels/mixins/AppliedTagsMixin.ts
 var AppliedTagsMixin = class {
   static {
@@ -645,105 +959,6 @@ var VoiceChannelMixin = class extends TextChannelMixin {
   }
 };
 
-// src/Structure.ts
-var DataTemplatePropertyName = "DataTemplate";
-var OptimizeDataPropertyName = "optimizeData";
-var Structure = class {
-  static {
-    __name(this, "Structure");
-  }
-  /**
-   * The template used for removing data from the raw data stored for each Structure.
-   *
-   * @remarks This template should be overridden in all subclasses to provide more accurate type information.
-   * The template in the base {@link Structure} class will have no effect on most subclasses for this reason.
-   */
-  static DataTemplate = {};
-  /**
-   * @returns A cloned version of the data template, ready to create a new data object.
-   */
-  getDataTemplate() {
-    return Object.create(this.constructor.DataTemplate);
-  }
-  /**
-   * The raw data from the API for this structure
-   *
-   * @internal
-   */
-  [kData];
-  /**
-   * Creates a new structure to represent API data
-   *
-   * @param data - the data from the API that this structure will represent
-   * @remarks To be made public in subclasses
-   * @internal
-   */
-  constructor(data, ..._rest) {
-    this[kData] = Object.assign(this.getDataTemplate(), data);
-    this[kMixinConstruct]?.(data);
-  }
-  /**
-   * Patches the raw data of this object in place
-   *
-   * @param data - the updated data from the API to patch with
-   * @remarks To be made public in subclasses
-   * @returns this
-   * @internal
-   */
-  [kPatch](data) {
-    this[kData] = Object.assign(this.getDataTemplate(), this[kData], data);
-    this.optimizeData(data);
-    return this;
-  }
-  /**
-   * Creates a clone of this structure
-   *
-   * @returns a clone of this
-   * @internal
-   */
-  [kClone](patchPayload) {
-    const clone = this.toJSON();
-    return new this.constructor(
-      // Ensure the ts-expect-error only applies to the constructor call
-      patchPayload ? Object.assign(clone, patchPayload) : clone
-    );
-  }
-  /**
-   * Function called to ensure stored raw data is in optimized formats, used in tandem with a data template
-   *
-   * @example created_timestamp is an ISO string, this can be stored in optimized form as a number
-   * @param _data - the raw data received from the API to optimize
-   * @remarks Implementation to be done in subclasses and mixins where needed.
-   * For typescript users, mixins must use the closest ancestors access modifier.
-   * @remarks Automatically called in Structure[kPatch] but must be called manually in the constructor
-   * of any class implementing this method.
-   * @remarks Additionally, when implementing, ensure to call `super._optimizeData` if any class in the super chain aside
-   * from Structure contains an implementation.
-   * Note: mixins do not need to call super ever as the process of mixing walks the prototype chain.
-   * @virtual
-   * @internal
-   */
-  optimizeData(_data) {
-  }
-  /**
-   * Transforms this object to its JSON format with raw API data (or close to it),
-   * automatically called by `JSON.stringify()` when this structure is stringified
-   *
-   * @remarks
-   * The type of this data is determined by omissions at runtime and is only guaranteed for default omissions
-   * @privateRemarks
-   * When omitting properties at the library level, this must be overridden to re-add those properties
-   */
-  toJSON() {
-    const data = (
-      // Spread is way faster than structuredClone, but is shallow. So use it only if there is no nested objects
-      Object.values(this[kData]).some((value) => typeof value === "object" && value !== null) ? structuredClone(this[kData]) : { ...this[kData] }
-    );
-    this[kMixinToJSON]?.(data);
-    return data;
-  }
-};
-
 // src/channels/ForumTag.ts
 var ForumTag = class extends Structure {
   static {
@@ -4044,6 +4259,10 @@ export {
   AppliedTagsMixin,
   Attachment,
   AttachmentFlagsBitField,
+  AutoModerationAction,
+  AutoModerationActionMetadata,
+  AutoModerationRule,
+  AutoModerationRuleTriggerMetadata,
   AvatarDecorationData,
   BitField,
   ButtonComponent,