@elara-services/packages 4.8.1 → 5.2.0

package/CHANGELOG

@@ -1,3 +1,19 @@
+# v5.2.0
+- Added `textInput` for `Interactions`
+- Added typings for `textInput` helper function.
+
+# v5.1.0
+- Added `name_localizations` for `SlashBuilder.choice`
+- Added typings for `min_length` and `max_length` for `SlashBuilder.option` for STRING options.
+- Fixed typings for `Interactions.button` to have `label` and `title`
+- Fixed `Interactions.button` to allow for `title` and `label`
+
+
+# v5.0.0
+### BREAKING CHANGES
+- `locale` option for `SlashBuilder.context.user` and `SlashBuilder.context.message` was turned into `options` taking in more options (to support both permissions and locale)
+- `defaultPermission`/`default_permission` was removed, since it's deprecated. (if you want to use it then stay on v4.8.1)
+
 # v4.8.0/v4.8.1
 - Added: `dmPermission` (`dm_permission`) for SlashBuilder.create
 - Added: `defaultMemberPermissions` (`default_member_permissions`) for SlashBuilder.create

package/index.d.ts

@@ -41,10 +41,33 @@ declare module "@elara-services/packages" {
         public static button(options: ButtonOptions): Button;
         public static select(options: SelectOptions): Select;
         public static modal(options: ModalOptions): Modal;
+        public static textInput(options: TextInputOptions, row?: boolean): TextInput | { type: number, components: [ TextInput ] };
     }
 
     export type ChannelTypes = 'GUILD_TEXT' | 'DM' | 'GUILD_VOICE' | 'GROUP_DM' | 'GUILD_CATEGORY' | 'GUILD_NEWS' | 'GUILD_STORE' | 'GUILD_NEWS_THREAD' | 'GUILD_PUBLIC_THREAD' | 'GUILD_PRIVATE_THREAD' | 'GUILD_STAGE_VOICE';
 
+    export type TextInputOptions = {
+        id?: string;
+        type?: number;
+        title?: string;
+        style?: number;
+        min?: number;
+        max?: number;
+        holder?: string;
+    } & TextInput;
+
+    export type TextInput = {
+        custom_id?: string;
+        type?: number;
+        label?: string;
+        style?: number;
+        min_length?: number;
+        max_length?: number;
+        placeholder?: string;
+        value?: string;
+        required?: boolean;
+    }
+
     export type SlashOptions = {
         type: number;
         name: string;
@@ -54,6 +77,8 @@ declare module "@elara-services/packages" {
         autocomplete?: boolean;
         min_value?: number;
         max_value?: number;
+        min_length?: number;
+        max_length?: number;
         choices?: { name: string, value: string }[];
         options?: SlashOptions[];
         locale?: {
@@ -76,10 +101,6 @@ declare module "@elara-services/packages" {
             names?: object;
             descriptions?: object;
         }
-        /** @deprecated - Use defaultMemberPermissions or dmPermission */
-        defaultPermission?: boolean;
-        /** @deprecated - Use defaultMemberPermissions or dmPermission */
-        default_permission?: boolean;
     }
 
     export class SlashBuilder {
@@ -104,11 +125,11 @@ declare module "@elara-services/packages" {
         };
 
         public static context: {
-            user(name: string, locale?: { names?: object }): Slash;
-            message(name: string, locale?: { names?: object }): Slash;
+            user(name: string, options?: Omit<Slash, "options"|"type">): Slash;
+            message(name: string, options?: Omit<Slash, "options"|"type">): Slash;
         };
 
-        public static choice(name: string, value: string|number): { name: string, value: string|number };
+        public static choice(name: string, value: string|number, name_localizations?: object): { name: string, value: string|number, name_localizations: object };
         public static option(data: SlashOptions): Slash;
         public static create(name: string, description: string, options: Slash): Slash;
     }
@@ -125,6 +146,8 @@ declare module "@elara-services/packages" {
 
     export type ButtonOptions = {
         id?: Button['custom_id'];
+        title?: Button['label'];
+        label?: Button['label'];
         custom_id?: Button['custom_id'];
         type?: Button['type'];
         style?: ButtonStyles | Button['style'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elara-services/packages",
-  "version": "4.8.1",
+  "version": "5.2.0",
   "description": "",
   "main": "index.js",
   "types": "./index.d.ts",

package/packages/Interactions.js

@@ -12,7 +12,7 @@ module.exports = class Interactions extends null {
         }
         return {
             custom_id: options?.id ?? options?.custom_id ?? "",
-            label: options?.title ?? "",
+            label: options?.title ?? options?.label ?? "",
             type: options?.type ?? 2,
             style: options?.style ? options.style : 2,
             disabled: Boolean(options.disabled),
@@ -41,4 +41,35 @@ module.exports = class Interactions extends null {
             components: options.components
         };
     };
+
+    static textInput(options = {}, row = false) {
+        let data = {};
+
+        if (options.type) data.type = options.type;
+        else data.type = 4;
+
+        if (options.id) data.custom_id = options.id;
+        else if (options.custom_id) data.custom_id = options.custom_id;
+
+        if (options.label) data.label = options.label;
+        else if (options.title) data.label = options.title;
+        
+        if (options.style) data.style = options.style;
+        else data.style = 1;
+
+        if (options.min) data.min_length = options.min;
+        else if (options.min_length) data.min_length = options.min_length;
+        
+        if (options.max) data.max_length = options.max;
+        else if (options.max_length) data.max_length = options.max_length;
+
+        if (options.holder) data.placeholder = options.holder;
+        else if (options.placeholder) data.placeholder = options.placeholder;
+
+        if (typeof options.required === "boolean") data.required = options.required;
+        if (options.value) data.value = options.value;
+
+        if (row) return data;
+        return { type: 1, components: [ data ] };
+    };
 };

package/packages/SlashBuilder.js

@@ -24,13 +24,13 @@ module.exports = class SlashBuilder extends null {
 
     static get context() {
         return {
-            user: (name, locale) => this.create(name, "", { type: this.types.context.user, locale }),
-            message: (name, locale) => this.create(name, "", { type: this.types.context.message, locale })
+            user: (name, options) => this.create(name, "", { type: this.types.context.user, ...options }),
+            message: (name, options) => this.create(name, "", { type: this.types.context.message, ...options })
         }
     };
     
-    static choice(name, value) {
-        return { name, value };
+    static choice(name, value, name_localizations) {
+        return { name, value, name_localizations };
     };
 
     static option(data) {
@@ -48,10 +48,6 @@ module.exports = class SlashBuilder extends null {
         if (options?.options?.length) obj.options = options.options;
         if (options?.type) obj.type = options.type;
 
-        // TODO: Remove this, as it's deprecated.
-        if ("defaultPermission" in options) obj.default_permission = options.defaultPermission;
-        else if ("default_permission" in options) obj.default_permission = options.default_permission;
-
         if ("dmPermission" in options) obj.dm_permission = options.dmPermission;
         else if ("dm_permission" in options) obj.dm_permission = options.dm_permission;