catto.js 0.1.9 → 0.2.1

package/Application.js

@@ -1,4 +1,26 @@
+/**
+ * A class representing an application's information.
+ * @class
+ */
 module.exports = class {
+  /**
+   * Creates an instance of Application.
+   * @param {Object} [options={}] - An object containing information about the application.
+   * @property {String} options.id - The ID of the application.
+   * @property {String} options.name - The name of the application.
+   * @property {String} options.icon - The hash for the application's icon.
+   * @property {String} options.description - A description of the application.
+   * @property {String} options.cover_image - The hash for the application's cover image.
+   * @property {String} options.guild_id - The ID of the server the application is connected to.
+   * @property {Boolean} options.bot_public - A flag indicating whether the bot is public.
+   * @property {Boolean} options.bot_require_code_grant - A flag indicating whether the bot requires code grant.
+   * @property {String} options.terms_of_service_url - The URL for the application's terms of service.
+   * @property {String} options.privacy_policy_url - The URL for the application's privacy policy.
+   * @property {Object} options.install_params - Installation parameters for the application.
+   * @property {String} options.verify_key - A verify key for the application.
+   * @property {Number} options.flags - A number representing the application's flags.
+   * @property {Array} options.tags - An array of tags for the application.
+   */
   constructor(options) {
     this.options = Object.assign({
       "id": "",
@@ -17,42 +39,94 @@ module.exports = class {
       "tags": []
     }, options || {});
   }
+  /**
+   * Gets the ID of the application.
+   * @returns {String} - The ID of the application.
+   */
   get id() {
     return this.options.id;
   }
+  /**
+   * Gets the name of the application.
+   * @returns {String} - The name of the application.
+   */
   get name() {
     return this.options.name;
   }
+  /**
+   * Gets the hash for the application's icon.
+   * @returns {String} - The hash for the application's icon.
+   */
   get iconHash() {
     return this.options.icon;
   }
+  /**
+   * Gets the description of the application.
+   * @returns {String} - A description of the application.
+   */
   get description() {
     return this.options.description;
   }
-  get coverImageHas() {
+  /**
+   * Gets the hash for the application's cover image.
+   * @returns {String} - The hash for the application's cover image.
+   */
+  get coverImageHash() {
     return this.options.cover_image;
   }
+  /**
+   * Gets the ID of the server the application is connected to.
+   * @returns {String} - The ID of the server the application is connected to.
+   */
   get server() {
     return this.options.guild_id;
   }
+  /**
+   * Gets a flag indicating whether the bot is public.
+   * @returns {Boolean} - A flag indicating whether the bot is public.
+   */
   get isPublic() {
     return this.options.bot_public;
   }
+  /**
+   * Gets a flag indicating whether the bot requires code grant.
+   * @returns {Boolean} - A flag indicating whether the bot requires code grant.
+   */
   get requireCodeGrant() {
     return this.options.bot_require_code_grant;
   }
+  /**
+   * Getter method to return the URL for the Terms of Service for this bot application.
+   * @returns {string} URL for the Terms of Service.
+   */
   get TOS() {
     return this.options.terms_of_service_url;
   }
+  /**
+   * Getter method to return the URL for the Privacy Policy for this bot application.
+   * @returns {string} URL for the Privacy Policy.
+   */
   get privacyPolicy() {
     return this.options.privacy_policy_url;
   }
+  /**
+   * Getter method to return the installation parameters for this bot application.
+   * @returns {object} Installation parameters.
+   */
   get installParams() {
     return this.options.install_params;
   }
+  /**
+   * Getter method to return the verification key for this bot application.
+   * @returns {string} Verification key.
+   */
   get verifyKey() {
     return this.options.verify_key;
   }
+  /**
+   * Getter method to return an array of badges for this bot application.
+   * @returns {Array} Array of badges.
+   */
   get badges() {
     var i = 24;
     var p = this.options.flags;
@@ -91,21 +165,45 @@ module.exports = class {
     ];
     return f.map(n => fl[n]).filter(n => n);
   }
+  /**
+   * Getter method to return an array of tags for this bot application.
+   * @returns {Array} Array of tags.
+   */
   get tags() {
     return this.options.tags;
   }
+  /**
+   * Getter method to return an array of intents for this bot application.
+   * @returns {Array} Array of intents.
+   */
   get intents() {
     return this.badges.filter(badge => ![null, "VERIFICATION_PENDING_GUILD_LIMIT", "EMBEDDED", "APPLICATION_COMMAND_BADGE"].includes(badge));
   }
+  /**
+   * Gets a boolean indicating if the application cannot be verified.
+   * @returns {boolean} A boolean indicating if the application cannot be verified.
+   */
   get cannotVerify() {
     return this.badges.has("VERIFICATION_PENDING_GUILD_LIMIT");
   }
+  /**
+   * Gets a boolean indicating if the application can be verified.
+   * @returns {boolean} A boolean indicating if the application can be verified.
+   */
   get canVerify() {
     return !this.cannotVerify;
   }
+  /**
+   * Gets a boolean indicating if the application is embedded.
+   * @returns {boolean} A boolean indicating if the application is embedded.
+   */
   get isEmbedded() {
     return this.badges.has("EMBEDDED");
   }
+  /**
+   * Gets a boolean indicating if the application supports the slash command.
+   * @returns {boolean} A boolean indicating if the application supports the slash command.
+   */
   get supportsSlash() {
     return this.badges.has("APPLICATION_COMMAND_BADGE");
   }

package/Base64.js

@@ -1,8 +1,22 @@
+/**
+ * Encodes a string to base64.
+ * @function
+ * @param {string} text - The text to be encoded.
+ * @returns {string} - The encoded text in base64.
+ */
+function encode(text) {
+  return Buffer.from(text, "utf-8").toString("base64")
+}
+/**
+ * Decodes a base64 string.
+ * @function
+ * @param {string} text - The text to be decoded.
+ * @returns {string} - The decoded text.
+ */
+function decode(text) {
+  return Buffer.from(text, "base64").toString("utf-8")
+}
 module.exports = {
-  "encode": text => {
-    return Buffer.from(text, "utf-8").toString("base64")
-  },
-  "decode": text => {
-    return Buffer.from(text, "base64").toString("utf-8")
-  }
-};
+  encode,
+  decode
+};

package/Bot.js

@@ -67,7 +67,7 @@ module.exports = class extends EventEmitter {
               var option = new Discord.SlashCommandUserOption();
               option.setName(opt.name);
               option.setDescription(opt.description);
-              option.setRequired(opt.req);
+              option.setRequired(opt.required);
               cmdo.addUserOption(option);
               break;
             case "channel":
@@ -139,8 +139,10 @@ module.exports = class extends EventEmitter {
               "bot": this
             });
           } catch(e) {
-            console.error(e);
+            console.log(e);
           }
+        } else {
+          interaction.reply({}).catch(() => {});
         }
       }
       if (interaction.isButton()) {
@@ -159,8 +161,10 @@ module.exports = class extends EventEmitter {
               "bot": this
             });
           } catch(e) {
-            console.error(e);
+            console.log(e);
           }
+        } else {
+          interaction.reply({}).catch(() => {});
         }
       }
     });
@@ -184,7 +188,7 @@ module.exports = class extends EventEmitter {
             "bot": this
           });
         } catch(e) {
-          console.error(e);
+          console.log(e);
         }
       }
       this.emit("message", message);

package/GitHub.js

@@ -1,6 +1,22 @@
 var request = require("./request");
 var Base64 = require("./Base64");
-module.exports = class {
+/**
+ * Class for reading and writing data to a Github repository.
+ * 
+ * @class Github
+ */
+class GitHub {
+  /**
+   * Creates an instance of Github.
+   * 
+   * @constructor
+   * @param {object} [options={}] - Options to initialize the instance.
+   * @param {string} [options.token=""] - Github API token.
+   * @param {string} [options.username=""] - Github username.
+   * @param {string} [options.repository=""] - Name of the repository.
+   * @param {string} [options.message="cattojs"] - Commit message.
+   * 
+   */
   constructor(options) {
     this.options = Object.assign({
       "token": "",
@@ -9,6 +25,16 @@ module.exports = class {
       "message": "cattojs"
     }, options || {});
   }
+  /**
+   * Reads data from a file in the Github repository.
+   * 
+   * @param {string} file - Path to the file to be read.
+   * 
+   * @returns {(string|object)} - The content of the file. If the file is a JSON file, returns a parsed object, otherwise returns a string.
+   * 
+   * @async
+   * @throws {Error} If there is a problem with the API request.
+   */
   async read(file) {
     var value = Base64.decode((await request.get({
       "url": `https://api.github.com/repos/${this.options.username}/${this.options.repository}/contents/${file}`,
@@ -22,6 +48,17 @@ module.exports = class {
     } catch(e) {}
     return value;
   }
+  /**
+   * Writes data to a file in the Github repository.
+   * 
+   * @param {string} file - Path to the file to be written.
+   * @param {(string|object)} value - The data to be written to the file. If it is an object, it will be stringified as a JSON file.
+   * 
+   * @returns {boolean} - Returns true if the write was successful.
+   * 
+   * @async
+   * @throws {Error} If there is a problem with the API request.
+   */
   async write(file, value) {
     if (typeof value === "object") {
       value = JSON.stringify(value);
@@ -40,4 +77,5 @@ module.exports = class {
     });
     return !0;
   }
-};
+}
+module.exports = GitHub;

package/HTML.js

@@ -1,5 +1,11 @@
+/**
+ * Disables HTML tags in a given string.
+ * @param {string} text - The string to disable HTML tags in.
+ * @returns {string} - The string with HTML tags disabled.
+ */
+function disable(text) {
+  return text.split("<").join("&lt;").split(">").join("&gt;");
+}
 module.exports = {
-  "disable": text => {
-    return text.split("<").join("&lt;").split(">").join("&gt;");
-  }
-};
+  disable
+};

package/MessageBuilder.js

@@ -1,5 +1,5 @@
 var Discord = require("discord.js");
-module.exports = class MessageBuilder {
+class MessageBuilder {
   constructor(bot) {
     this.bot = bot;
     this.data = {};
@@ -101,4 +101,24 @@ module.exports = class MessageBuilder {
     }
     return this;
   }
-};
+  ephemeral() {
+    this.data.ephemeral = !0;
+    return this;
+  }
+  notEphemeral() {
+    this.data.ephemeral = !1;
+    return this;
+  }
+  embed(d) {
+    if (!this.data.embeds) {
+      this.data.embeds = [];
+    }
+    if (this.data.embeds.length < 10) {
+      this.data.embeds.push(d);
+      return this;
+    } else {
+      throw new Error("Message can't have more than 10 embeds.");
+    }
+  }
+}
+module.exports = MessageBuilder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "catto.js",
-  "version": "0.1.9",
+  "version": "0.2.1",
   "description": "Universal module for everything.",
   "main": "index.js",
   "scripts": {