@elara-services/packages 4.5.1 → 4.8.0

package/CHANGELOG

@@ -1,3 +1,13 @@
+# v4.8.0
+- Added: `dmPermission` (`dm_permission`) for SlashBuilder.create
+- Added: `defaultMemberPermissions` (`default_member_permissions`) for SlashBuilder.create
+- Deprecated `defaultPermission` (`default_permission`) for SlashBuilder.create
+- Updated: Typings for SlashBuilder.create
+
+# v4.7.0
+Added `locale` option for `<SlashBuilder>.create`, `<SlashBuilder>.option`, `<SlashBuilder.context.user/message>`
+
+
 # v4.0.3, v4.0.2
 Added 
 - fetch (useful with `@elara-services/fetch`)

package/index.d.ts

@@ -56,13 +56,30 @@ declare module "@elara-services/packages" {
         max_value?: number;
         choices?: { name: string, value: string }[];
         options?: SlashOptions[];
+        locale?: {
+            names?: object;
+            descriptions?: object;
+        }
     }
 
     export type Slash = {
         type?: number;
+
+        dmPermission?: boolean;
+        dm_permission?: boolean;
+
+        defaultMemberPermissions?: string;
+        default_member_permissions?: string;
+        
+        options?: SlashOptions[];
+        locale?: {
+            names?: object;
+            descriptions?: object;
+        }
+        /** @deprecated - Use defaultMemberPermissions or dmPermission */
         defaultPermission?: boolean;
+        /** @deprecated - Use defaultMemberPermissions or dmPermission */
         default_permission?: boolean;
-        options?: SlashOptions[];
     }
 
     export class SlashBuilder {
@@ -87,8 +104,8 @@ declare module "@elara-services/packages" {
         };
 
         public static context: {
-            user(name: string): Slash;
-            message(name: string): Slash;
+            user(name: string, locale?: { names?: object }): Slash;
+            message(name: string, locale?: { names?: object }): Slash;
         };
 
         public static choice(name: string, value: string|number): { name: string, value: string|number };
@@ -191,5 +208,15 @@ declare module "@elara-services/packages" {
         static validate(value: string): boolean;
         static parse(value: string): number | null;
         static determineTimeType(str: string): number;
+    };
+
+    export class Tasks extends null {
+        static create(options: {
+            id: string;
+            time: string;
+            shouldCancel?: boolean
+        }, run: Function): void;
+        
+        static delete(id: string): void;
     }
 }

package/index.js

@@ -7,4 +7,5 @@ exports.Languages = require("./packages/languages");
 exports.SlashBuilder = require("./packages/SlashBuilder");
 exports.Interactions = require("./packages/Interactions");
 exports.fetch = require("./packages/fetch");
-exports.Duration = require("./packages/duration");
+exports.Duration = require("./packages/duration");
+exports.Tasks = require("./packages/Tasks");

package/package.json

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

package/packages/SlashBuilder.js

@@ -24,8 +24,8 @@ module.exports = class SlashBuilder extends null {
 
     static get context() {
         return {
-            user: (name) => this.create(name, "", { type: 2 }),
-            message: (name) => this.create(name, "", { type: 3 })
+            user: (name, locale) => this.create(name, "", { type: this.types.context.user, locale }),
+            message: (name, locale) => this.create(name, "", { type: this.types.context.message, locale })
         }
     };
     
@@ -34,15 +34,29 @@ module.exports = class SlashBuilder extends null {
     };
 
     static option(data) {
-        return data;
+        let _data = { ...data };
+        if (_data.locale?.names) _data.name_localizations = _data.locale.names;
+        if (_data.locale?.descriptions) _data.description_localizations = _data.locale.descriptions;
+        if ("locale" in _data) delete _data["locale"];
+        return _data;
     };
 
     static create(name, description, options = { }) {
         let obj = { name, description };
+        if (options?.locale?.names) obj.name_localizations = options.locale.names;
+        if (options?.locale?.descriptions) obj.description_localizations = options.locale.descriptions;
         if (options?.options?.length) obj.options = options.options;
-        if (options.type) obj.type = options.type;
-        if (typeof options.defaultPermission === "boolean") obj.default_permission = options.defaultPermission;
-        else if (typeof options.default_permission === "boolean") obj.default_permission = options.default_permission;
+        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 = obj.dmPermission;
+        else if ("dm_permission" in options) obj.dm_permission = obj.dm_permission;
+        
+        if ("default_member_permissions" in options) obj.default_member_permissions = options.default_member_permissions;
+        else if ("defaultMemberPermissions" in options) obj.default_member_permissions = options.defaultMemberPermissions;
         return obj;
     };
 };

package/packages/Tasks.js

@@ -0,0 +1,22 @@
+let nodeSchedule;
+
+try {
+    nodeSchedule = require("node-schedule");
+} catch { };
+
+module.exports = class Tasks extends null {
+    static create({ id = "", time = "", shouldCancel = true } = {}, run) {
+        if (!nodeSchedule) return `[Tasks:Create:ERROR]: I was unable to locate the 'node-schedule' package!`;
+        if (!id || !time || !run) return `[Tasks:Create:ERROR]: You didn't provide a valid ID, Time or Run function`;
+        if (nodeSchedule.scheduledJobs[id]) return `[Tasks:Create:ERROR]: Found (${id}) already in the scheduledJobs object.`;
+        return nodeSchedule.scheduleJob(id, time, () => {
+            run();
+            if (shouldCancel) return nodeSchedule.cancelJob(id);
+        });
+    };
+
+    static delete(id) {
+        if (!nodeSchedule) return null;
+        return nodeSchedule.cancelJob(id);
+    };
+};