Support new options for editChannelPosition() (#1034)

Author: Khaaz

index.d.ts

@@ -1278,6 +1278,11 @@ declare namespace Eris {
     static from(data: BaseData, client: Client): AnyChannel;
   }
 
+  export interface EditChannelPositionOptions {
+    lockPermissions?: string;
+    parentID?: string;
+  }
+
   export class Client extends EventEmitter {
     application?: { id: string; flags: number };
     bot: boolean;
@@ -1455,7 +1460,7 @@ declare namespace Eris {
       type: string,
       reason?: string
     ): Promise<void>;
-    editChannelPosition(channelID: string, position: number): Promise<void>;
+    editChannelPosition(channelID: string, position: number, options?: EditChannelPositionOptions): Promise<void>;
     editGuild(guildID: string, options: GuildOptions, reason?: string): Promise<Guild>;
     editGuildDiscovery(guildID: string, options?: DiscoveryOptions): Promise<DiscoveryMetadata>;
     editGuildEmoji(
@@ -1917,7 +1922,7 @@ declare namespace Eris {
       type: PermissionType,
       reason?: string
     ): Promise<PermissionOverwrite>;
-    editPosition(position: number): Promise<void>;
+    editPosition(position: number, options?: EditChannelPositionOptions): Promise<void>;
     getInvites(): Promise<Invite[]>;
     permissionsOf(memberID: string | Member): Permission;
   }

lib/Client.js

@@ -930,9 +930,12 @@ class Client extends EventEmitter {
     * Edit a guild channel's position. Note that channel position numbers are lowest on top and highest at the bottom.
     * @arg {String} channelID The ID of the channel
     * @arg {Number} position The new position of the channel
+    * @arg {Object} [options] Additional options when editing position
+    * @arg {Boolean} [options.lockPermissions] Whether to sync the permissions with the new parent if moving to a new category
+    * @arg {String} [options.parentID] The new parent ID (category channel) for the channel that is moved
     * @returns {Promise}
     */
-    editChannelPosition(channelID, position) {
+    editChannelPosition(channelID, position, options = {}) {
         let channels = this.guilds.get(this.channelGuildMap[channelID]).channels;
         const channel = channels.get(channelID);
         if(!channel) {
@@ -956,7 +959,9 @@ class Client extends EventEmitter {
         }
         return this.requestHandler.request("PATCH", Endpoints.GUILD_CHANNELS(this.channelGuildMap[channelID]), true, channels.map((channel, index) => ({
             id: channel.id,
-            position: index + min
+            position: index + min,
+            lock_permissions: options.lockPermissions,
+            parent_id: options.parentID
         })));
     }
 

lib/structures/GuildChannel.js

@@ -102,10 +102,13 @@ class GuildChannel extends Channel {
     /**
     * Edit the channel's position. Note that channel position numbers are lowest on top and highest at the bottom.
     * @arg {Number} position The new position of the channel
+    * @arg {Object} [options] Additional options when editing position
+    * @arg {Boolean} [options.lockPermissions] Whether to sync the permissions with the new parent if moving to a new category
+    * @arg {String} [options.parentID] The new parent ID (category channel) for the channel that is moved
     * @returns {Promise}
     */
-    editPosition(position) {
-        return this.client.editChannelPosition.call(this.client, this.id, position);
+    editPosition(position, options) {
+        return this.client.editChannelPosition.call(this.client, this.id, position, options);
     }
 
     /**