Merge pull request #13 from Secreto31126:error-improvements

Thrown errors improvements

Author: Secreto31126

package.json

@@ -1,6 +1,6 @@
 {
   "name": "whatsapp-api-js",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "A Whatsapp Official API helper for Node.js",
   "main": "index.js",
   "scripts": {

types/interactive.js

@@ -95,15 +95,20 @@ class Header {
      * @param {(Document|Image|Text|Video)} object The message object for the header
      * @throws {Error} If object is not provided
      * @throws {Error} If object is not a Document, Image, Text, or Video
+     * @throws {Error} If object is a Text and is over 60 characters
      */
     constructor(object) {
         if (!object) throw new Error("Header must have an object");
         if (!["text", "video", "image", "document"].includes(object._)) throw new Error(`Header object must be either Text, Video, Image or Document.`);
 
         this.type = object._;
         delete object._;
+
         // Text type can go to hell
-        this[this.type] = this.type === "text" ? object.body : object;
+        if (this.type === "text") {
+            if (object.body > 60) throw new Error("Header text must be 60 characters or less");
+            this[this.type] = object.body;
+        } else this[this.type] = object;
     }
 }
 
@@ -124,11 +129,13 @@ class ActionList {
      * @throws {Error} If button is not provided
      * @throws {Error} If button is over 20 characters
      * @throws {Error} If no sections are provided or are over 10
+     * @throws {Error} If more than 1 section is provided and at least one doesn't have a title
      */
     constructor(button, ...sections) {
         if (!button) throw new Error("Action must have a button content");
         if (button.length > 20) throw new Error("Button content must be 20 characters or less");
         if (!sections?.length || sections.length > 10) throw new Error("Action must have between 1 and 10 sections");
+        if (sections.length > 1) sections.forEach(s => { if (!s.title) throw new Error("Sections must have a title if more than 1 section is provided") });
 
         this._ = "list";
         this.button = button;
@@ -146,18 +153,16 @@ class Section {
     /**
      * Builds a section component for ActionList
      * 
-     * @param {String} title Title of the section
+     * @param {String} title Title of the section, only required if there are more than one section
      * @param {...Row} rows Rows of the section
-     * @throws {Error} If title is not provided
-     * @throws {Error} If title is over 24 characters
+     * @throws {Error} If title is over 24 characters if provided
      * @throws {Error} If no rows are provided or are over 10
      */
     constructor(title, ...rows) {
-        if (!title) throw new Error("Section must have a title");
-        if (title.length > 24) throw new Error("Section title must be 24 characters or less");
+        if (title && title.length > 24) throw new Error("Section title must be 24 characters or less");
         if (!rows?.length || rows.length > 10) throw new Error("Section must have between 1 and 10 rows");
 
-        this.title = title;
+        if (title) this.title = title;
         this.rows = rows;
     }
 }

types/template.js

@@ -23,16 +23,9 @@ class Template {
         if (!name) throw new Error("Template must have a name");
         if (!language) throw new Error("Template must have a language");
 
-        const temp = [];
-        for (let component of components) {
-            if (component instanceof ButtonComponent) temp.push(...component.build());
-            else temp.push(component);
-        }
-        components = temp;
-
         this.name = name;
         this.language = language instanceof Language ? language : new Language(language);
-        if (components) this.components = components;
+        if (components) this.components = components.map(c => c.build ? c.build() : c).flat();;
 
         this._ = "template";
     }
@@ -131,7 +124,7 @@ class ButtonComponent {
      */
     constructor(sub_type, ...parameters) {
         if (!["url", "quick_reply"].includes(sub_type)) throw new Error("ButtonComponent sub_type must be either 'url' or 'quick_reply'");
-        if (!parameters?.length) throw new Error("ButtonComponent must have a parameter at least 1 parameter");
+        if (!parameters?.length) throw new Error("ButtonComponent must have at least 1 parameter");
         if (parameters.length > 3) throw new Error("ButtonComponent can only have up to 3 parameters");
 
         const buttonType = sub_type === "url" ? "text" : "payload";
@@ -193,7 +186,7 @@ class HeaderComponent {
      */
     constructor(...parameters) {
         this.type = "header";
-        if (parameters) this.parameters = parameters.map(e => e instanceof Parameter ? e : new Parameter(e));
+        if (parameters) this.parameters = parameters.map(e => e instanceof Parameter ? e : new Parameter(e, "header"));
     }
 }
 
@@ -211,7 +204,7 @@ class BodyComponent {
      */
     constructor(...parameters) {
         this.type = "body";
-        if (parameters) this.parameters = parameters.map(e => e instanceof Parameter ? e : new Parameter(e));
+        if (parameters) this.parameters = parameters.map(e => e instanceof Parameter ? e : new Parameter(e, "body"));
     }
 }
 
@@ -233,14 +226,22 @@ class Parameter {
      * For Document parameter, only PDF documents are supported for document-based message templates.
      * 
      * @param {(Text|Currency|DateTime|Image|Document|Video)} parameter The parameter to be used in the template
+     * @param {String} whoami The parent component, used to check if a Text object is too long. Can be either 'header' or 'body'
      * @throws {Error} If parameter is not provided
+     * @throws {Error} If parameter is a Text and the parent component (whoami) is "header" and the text over 60 characters
+     * @throws {Error} If parameter is a Text and the parent component (whoami) is "body" and the text over 1024 characters
      */
-    constructor(parameter) {
-        if (!parameter) throw new Error("Parameter must have a parameter");
+    constructor(parameter, whoami) {
+        if (!parameter) throw new Error("Parameter object must have a parameter parameter");
         this.type = parameter._;
         delete parameter._;
+
         // Text type can go to hell
-        if (this.type === "text") this.text = parameter.body; else this[this.type] = parameter;
+        if (this.type === "text") {
+            if (whoami === "header" && object.body > 60) throw new Error("Header text must be 60 characters or less");
+            if (whoami === "body" && object.body > 1024) throw new Error("Body text must be 1024 characters or less");
+            this[this.type] = object.body;
+        } else this[this.type] = object;
     }
 }
 

types/text.js

@@ -1,7 +1,7 @@
 /**
  * Text API object
  * 
- * @property {String} body Body of the message. Maximum length: 1024 characters.
+ * @property {String} body Body of the message. Maximum length: 4096 characters.
  * @property {Boolean} preview_url Whether to enable preview for the text message
  * @property {String} _ The type of the object, for internal use only
  */
@@ -12,11 +12,11 @@
      * @param {String} body The text of the text message which can contain formatting and URLs which begin with http:// or https://
      * @param {Boolean} preview_url By default, WhatsApp recognizes URLs and makes them clickable, but you can also include a preview box with more information about the link. Set this field to true if you want to include a URL preview box. Defaults to false.
      * @throws {Error} If body is not provided
-     * @throws {Error} If body is over 1024 characters
+     * @throws {Error} If body is over 4096 characters
      */
     constructor(body, preview_url = false) {
         if (!body) throw new Error("Text must have a body object");
-        if (body.length > 1024) throw new Error("Text body must be less than 1024 characters");
+        if (body.length > 4096) throw new Error("Text body must be less than 4096 characters");
         this.body = body;
         if (preview_url) this.preview_url = preview_url;
         this._ = "text";