Merge pull request #367 from Secreto31126/improved-types

Improved types

package.json

@@ -1,6 +1,6 @@
 {
     "name": "whatsapp-api-js",
-    "version": "4.0.0",
+    "version": "4.0.1",
     "author": "Secreto31126",
     "description": "A TypeScript server agnostic Whatsapp's Official API framework",
     "license": "MIT",

src/index.ts

@@ -322,8 +322,8 @@ export class WhatsAppAPI<EmittersReturnType = void> {
         message: ClientMessage,
         batch_size = 50,
         delay = 1000
-    ): Array<ReturnType<typeof this.sendMessage>> {
-        const responses = [] as ReturnType<typeof this.sendMessage>[];
+    ): Array<ReturnType<WhatsAppAPI["sendMessage"]>> {
+        const responses = [] as ReturnType<WhatsAppAPI["sendMessage"]>[];
 
         if (batch_size < 1) {
             throw new RangeError("batch_size must be greater than 0");

src/messages/contacts.ts

@@ -126,7 +126,7 @@ export class Contacts extends ClientMessage {
      * @override
      * @internal
      */
-    _build() {
+    _build(): string {
         return JSON.stringify(this.component);
     }
 }
@@ -245,7 +245,7 @@ export class Birthday extends ContactUniqueComponent {
      * @override
      * @internal
      */
-    _build() {
+    _build(): string {
         return this.birthday;
     }
 }

src/messages/template.ts

@@ -157,7 +157,11 @@ export class Template extends ClientMessage {
      * @param code - The one time password to be sent
      * @returns A Template object for the API
      */
-    static OTP(name: string, language: string | Language, code: string) {
+    static OTP(
+        name: string,
+        language: string | Language,
+        code: string
+    ): Template {
         return new Template(
             name,
             language,
@@ -324,7 +328,7 @@ export abstract class ButtonComponent implements TemplateComponent {
      * @override
      * @internal
      */
-    _build(pointers: BuildingPointers) {
+    _build(pointers: BuildingPointers): this {
         this.index = pointers.button_counter++;
         return this;
     }
@@ -603,7 +607,7 @@ export class SkipButtonComponent extends ButtonComponent {
      * @override
      * @internal
      */
-    _build(pointers: BuildingPointers) {
+    _build(pointers: BuildingPointers): this {
         pointers.button_counter++;
         return null as unknown as this;
     }
@@ -638,7 +642,7 @@ export class HeaderComponent implements TemplateComponent {
      * @override
      * @internal
      */
-    _build() {
+    _build(): this {
         return this;
     }
 }
@@ -762,7 +766,7 @@ export class BodyComponent implements TemplateComponent {
      * @internal
      * @throws If theres_only_body is false and one of the parameters is a string and it's over 1024 characters
      */
-    _build({ theres_only_body }: BuildingPointers) {
+    _build({ theres_only_body }: BuildingPointers): this {
         // If it needs to check for the shorter max text length
         if (!theres_only_body) {
             for (const param of this.parameters) {
@@ -868,7 +872,7 @@ export class CarouselComponent
      * @override
      * @internal
      */
-    _build() {
+    _build(): this {
         return this;
     }
 }
@@ -919,7 +923,7 @@ export class CarouselCard implements ClientBuildableMessageComponent {
      * @override
      * @internal
      */
-    _build(ptr: { counter: number }) {
+    _build(ptr: { counter: number }): this {
         this.card_index = ptr.counter++;
         return this;
     }
@@ -974,7 +978,7 @@ export class LTOComponent implements TemplateComponent {
      * @override
      * @internal
      */
-    _build() {
+    _build(): this {
         return this;
     }
 }

src/middleware/adonis.ts

@@ -31,7 +31,7 @@ export class WhatsAppAPI extends WhatsAppAPIMiddleware {
      * @param req - The request object from AdonisJS
      * @returns The status code to be sent to the client
      */
-    async handle_post(req: Request) {
+    async handle_post(req: Request): Promise<number> {
         try {
             await this.post(
                 req.body() as PostData,
@@ -74,7 +74,7 @@ export class WhatsAppAPI extends WhatsAppAPIMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: Request) {
+    handle_get(req: Request): string {
         try {
             return this.get(req.qs() as GetParams);
         } catch (e) {

src/middleware/bun.ts

@@ -29,7 +29,7 @@ export class WhatsAppAPI extends WebStandardMiddleware {
      * @param req - The request object
      * @returns The status code to be sent to the client
      */
-    async handle_post(req: Request) {
+    async handle_post(req: Request): Promise<number> {
         return super.handle_post(req);
     }
 
@@ -61,7 +61,7 @@ export class WhatsAppAPI extends WebStandardMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: Request) {
+    handle_get(req: Request): string {
         return super.handle_get(req);
     }
 }

src/middleware/deno.ts

@@ -29,7 +29,7 @@ export class WhatsAppAPI extends WebStandardMiddleware {
      * @param req - The request object
      * @returns The status code to be sent to the client
      */
-    async handle_post(req: Request) {
+    async handle_post(req: Request): Promise<number> {
         return super.handle_post(req);
     }
 
@@ -61,7 +61,7 @@ export class WhatsAppAPI extends WebStandardMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: Request) {
+    handle_get(req: Request): string {
         return super.handle_get(req);
     }
 }

src/middleware/express.ts

@@ -41,7 +41,7 @@ export class WhatsAppAPI extends WhatsAppAPIMiddleware {
      * @param req - The request object from Express.js
      * @returns The status code to be sent to the client
      */
-    async handle_post(req: Request) {
+    async handle_post(req: Request): Promise<number> {
         try {
             await this.post(
                 JSON.parse(req.body ?? "{}"),
@@ -85,7 +85,7 @@ export class WhatsAppAPI extends WhatsAppAPIMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: Request) {
+    handle_get(req: Request): string {
         try {
             return this.get(req.query as GetParams);
         } catch (e) {

src/middleware/next.ts

@@ -27,7 +27,7 @@ export class WhatsAppAPI extends WebStandardMiddleware {
      * @param req - The request object
      * @returns The status code to be sent to the client
      */
-    async handle_post(req: Request) {
+    async handle_post(req: Request): Promise<number> {
         return super.handle_post(req);
     }
 
@@ -57,7 +57,7 @@ export class WhatsAppAPI extends WebStandardMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: Request) {
+    handle_get(req: Request): string {
         return super.handle_get(req);
     }
 }

src/middleware/node-http.ts

@@ -38,7 +38,7 @@ export class WhatsAppAPI extends WhatsAppAPIMiddleware {
      * @param req - The request object
      * @returns The status code to be sent to the client
      */
-    async handle_post(req: IncomingMessage) {
+    async handle_post(req: IncomingMessage): Promise<number> {
         /**
          * Copy pasted from an issue on Deno's repository :)
          *
@@ -101,7 +101,7 @@ export class WhatsAppAPI extends WhatsAppAPIMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: IncomingMessage) {
+    handle_get(req: IncomingMessage): string {
         try {
             return this.get(
                 Object.fromEntries(

src/middleware/sveltekit.ts

@@ -31,7 +31,7 @@ export class WhatsAppAPI extends WebStandardMiddleware {
      * @param req - The request object
      * @returns The status code to be sent to the client
      */
-    async handle_post(req: Request) {
+    async handle_post(req: Request): Promise<number> {
         return super.handle_post(req);
     }
 
@@ -63,7 +63,7 @@ export class WhatsAppAPI extends WebStandardMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: Request) {
+    handle_get(req: Request): string {
         return super.handle_get(req);
     }
 }

src/middleware/vercel.ts

@@ -43,7 +43,7 @@ export class WhatsAppAPI extends NodeHTTPMiddleware {
      * @param req - The request object
      * @returns The status code to be sent to the client
      */
-    handle_post(req: VercelRequest) {
+    handle_post(req: VercelRequest): Promise<number> {
         return super.handle_post(req);
     }
 
@@ -78,7 +78,7 @@ export class WhatsAppAPI extends NodeHTTPMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: VercelRequest) {
+    handle_get(req: VercelRequest): string {
         try {
             return this.get(req.query as GetParams);
         } catch (e) {

src/middleware/web-standard.ts

@@ -14,7 +14,7 @@ export class WhatsAppAPI extends WhatsAppAPIMiddleware {
      * @param req - The request object
      * @returns The status code to be sent to the client
      */
-    async handle_post(req: Request) {
+    async handle_post(req: Request): Promise<number> {
         try {
             const body = await req.text();
 
@@ -39,7 +39,7 @@ export class WhatsAppAPI extends WhatsAppAPIMiddleware {
      * @returns The challenge string to be sent to the client
      * @throws The error code
      */
-    handle_get(req: Request) {
+    handle_get(req: Request): string {
         try {
             return this.get(
                 Object.fromEntries(new URL(req.url).searchParams) as GetParams