[core] build proto on package install

.dockerignore

@@ -1,5 +1,6 @@
 Dockerfile
 src/core/engines/gows/grpc
+src/core/engines/gows/proto
 .*sessions
 sessions
 files

.eslintignore

@@ -1 +1,2 @@
 src/core/engines/gows/grpc/*
+src/core/engines/gows/proto/*

.gitignore

@@ -1,4 +1,5 @@
 src/core/engines/gows/grpc
+src/core/engines/gows/proto
 .env
 *.heapsnapshot
 .yarn

.pre-commit-config.yaml

@@ -3,6 +3,7 @@ exclude: |
     ^src/dashboard/.*|
     ^src/core/engines/webjs/.*html|
     ^src/core/engines/gows/grpc/.*|
+    ^src/core/engines/gows/proto/.*|
     ^src/plus/engines/webjs/.*html|
     ^.yarn/.*
   )$
@@ -75,4 +76,5 @@ repos:
               ^src/core/engines/webjs/session.webjs.core.ts|
               ^src/core/engines/webjs/_lodash.js|
               ^tests/perf/.*|
+              ^scripts/.*|
           )$

Dockerfile

@@ -1,9 +1,3 @@
-# GOWS
-ARG GOWS_GITHUB_REPO=devlikeapro/gows
-ARG GOWS_SHA=39ba4dcceeeb6e6fab172ee71ad1c09deea4db16
-ARG WAHA_DASHBOARD_GITHUB_REPO=devlikeapro/dashboard
-ARG WAHA_DASHBOARD_SHA=a1c839d8da94d1cade182addffdfc42fc0cf7ed3
-
 #
 # Build
 #
@@ -11,12 +5,8 @@ ARG NODE_VERSION=22.8-bullseye
 FROM node:${NODE_VERSION} AS build
 ENV PUPPETEER_SKIP_DOWNLOAD=True
 
-# install protoc
-RUN apt-get update && \
-    apt-get install protobuf-compiler -y
-
 # npm packages
-WORKDIR /src
+WORKDIR /git
 COPY package.json .
 COPY yarn.lock .
 ENV YARN_CHECKSUM_BEHAVIOR=update
@@ -25,19 +15,10 @@ RUN yarn set version 3.6.3
 RUN yarn install
 
 # App
-WORKDIR /src
-ADD . /src
+WORKDIR /git
+ADD . /git
 RUN yarn install
-
-# Build node grpc client for GOWS engine
-WORKDIR /gows/proto
-ARG GOWS_GITHUB_REPO
-ARG GOWS_SHA
-RUN wget https://raw.githubusercontent.com/${GOWS_GITHUB_REPO}/${GOWS_SHA}/proto/gows.proto
-WORKDIR /src
-
-RUN make proto-gows
-
+RUN yarn gows:proto
 RUN yarn build && find ./dist -name "*.d.ts" -delete
 
 #
@@ -45,10 +26,13 @@ RUN yarn build && find ./dist -name "*.d.ts" -delete
 #
 FROM node:${NODE_VERSION} AS dashboard
 
-# Download WAHA Dashboard
-ARG WAHA_DASHBOARD_GITHUB_REPO
-ARG WAHA_DASHBOARD_SHA
+# jq to parse json
+RUN apt-get update && apt-get install -y jq && rm -rf /var/lib/apt/lists/*
+
+COPY waha.config.json /tmp/waha.config.json
 RUN \
+    WAHA_DASHBOARD_GITHUB_REPO=$(jq -r '.waha.dashboard.repo' /tmp/waha.config.json) && \
+    WAHA_DASHBOARD_SHA=$(jq -r '.waha.dashboard.ref' /tmp/waha.config.json) && \
     wget https://github.com/${WAHA_DASHBOARD_GITHUB_REPO}/archive/${WAHA_DASHBOARD_SHA}.zip \
     && unzip ${WAHA_DASHBOARD_SHA}.zip -d /tmp/dashboard \
     && mkdir -p /dashboard \
@@ -60,6 +44,10 @@ RUN \
 # GOWS
 #
 FROM golang:1.23-bullseye AS gows
+
+# jq to parse json
+RUN apt-get update && apt-get install -y jq && rm -rf /var/lib/apt/lists/*
+
 # install protoc
 RUN apt-get update && \
     apt-get install protobuf-compiler -y
@@ -69,9 +57,11 @@ RUN apt-get update  \
     && apt-get install -y libvips-dev \
     && rm -rf /var/lib/apt/lists/*
 
-ARG GOWS_GITHUB_REPO
-ARG GOWS_SHA
-RUN git clone https://github.com/${GOWS_GITHUB_REPO} gows && \
+COPY waha.config.json /tmp/waha.config.json
+RUN \
+    GOWS_GITHUB_REPO=$(jq -r '.waha.gows.repo' /tmp/waha.config.json) && \
+    GOWS_SHA=$(jq -r '.waha.gows.ref' /tmp/waha.config.json) && \
+    git clone https://github.com/${GOWS_GITHUB_REPO} gows && \
     cd gows && \
     git checkout ${GOWS_SHA}
 
@@ -163,8 +153,8 @@ ENV WHATSAPP_DEFAULT_ENGINE=$WHATSAPP_DEFAULT_ENGINE
 # Attach sources, install packages
 WORKDIR /app
 COPY package.json ./
-COPY --from=build /src/node_modules ./node_modules
-COPY --from=build /src/dist ./dist
+COPY --from=build /git/node_modules ./node_modules
+COPY --from=build /git/dist ./dist
 COPY --from=dashboard /dashboard ./dist/dashboard
 COPY --from=gows /go/gows/bin/gows /app/gows
 ENV WAHA_GOWS_PATH /app/gows

Makefile

@@ -47,15 +47,7 @@ start-proxy:
 	docker run --rm -d --name squid-container -e TZ=UTC -p 3128:3128 ubuntu/squid:5.2-22.04_beta
 
 proto-gows:
-	rm -rf src/core/engines/gows/grpc
-	mkdir -p src/core/engines/gows/grpc
-	protoc \
-	--plugin=protoc-gen-ts=node_modules/.bin/protoc-gen-ts \
-	--plugin=protoc-gen-grpc=node_modules/.bin/grpc_tools_node_protoc_plugin \
-	--js_out=import_style=commonjs,binary:src/core/engines/gows/grpc \
-	--grpc_out=grpc_js:src/core/engines/gows/grpc \
-	--ts_out=grpc_js:src/core/engines/gows/grpc \
-	-I ../gows/proto ../gows/proto/gows.proto
+	node scripts/gows-proto.js build --dir ../gows/proto
 
 gows:
 	cd ../gows && \

README.md

@@ -9,19 +9,13 @@
 [![Docker Pulls](https://img.shields.io/docker/pulls/devlikeapro/whatsapp-http-api)](https://hub.docker.com/r/devlikeapro/waha)
 
 - Documentation: [https://waha.devlike.pro/](https://waha.devlike.pro/)
+- Dashboard Example: [https://waha.devlike.pro/dashboard](https://waha.devlike.pro/dashboard)
 - Swagger Example: [https://waha.devlike.pro/swagger](https://waha.devlike.pro/swagger)
 
 # Tables of Contents
 
 <!-- toc -->
 
-- [Features](#features)
-  * [Messages](#messages)
-  * [Sessions](#sessions)
-  * [Security](#security)
-  * [Updates](#updates)
-  * [Groups](#groups)
-  * [Contacts](#contacts)
 - [Quick start](#quick-start)
   * [Requirements](#requirements)
   * [Send your first message](#send-your-first-message)
@@ -32,52 +26,11 @@
     + [5. Get the screenshot](#5-get-the-screenshot)
     + [6. Send a text message](#6-send-a-text-message)
   * [What is next?](#what-is-next)
+- [Development](#development)
+  * [Start the project](#start-the-project)
 
 <!-- tocstop -->
 
-# Features
-
-## Messages
-- Send messages  
-- Receive messages  
-- Message replies  
-- Send location  
-- Receive location  
-- React to messages  
-- Send media (images/documents/files) 
-- Send voice messages 
-- Receive media (images/audio/video/documents) 
-- Receive messages - webhook retries 
-
-## Sessions
-- Multi Device  
-- Get the screenshot  
-- Session saving (don't have to scan QR on every restart) 
-- Single WhatsApp account running inside one container 
-- Multiple WhatsApp account running inside one container 
-
-## Security
-- Swagger panel authentication 
-- API authentication 
-
-## Updates
-- Bug fixes and updates come as soon as they are implemented. 
-
-## Groups
-- Create a group
-- Get invite for group
-- Modify group info (subject, description)
-- Add group participants
-- Kick group participants
-- Promote/demote group participants
-
-## Contacts
-- Mute/unmute chats
-- Block/unblock contacts
-- Get contact info
-- Get profile pictures
-- Get presence (online\offline\typing) status
-
 # Quick start
 
 ## Requirements
@@ -87,13 +40,6 @@ instruction <a href="https://docs.docker.com/get-docker/" target="_blank" rel="n
 
 When you are ready - come back and follows the below steps to send the first text message to WhatsApp via HTTP API!
 
-{{< details "Why Docker?" >}}
-Docker makes it easy to ship all-in-one solution with the runtime and dependencies. You don't have to worry about
-language-specific libraries or chrome installation.
-
-Also Docker makes installation and update processes so simple, just one command!
-{{< /details >}}
-
 ## Send your first message
 
 Let's go over steps that allow you to send your first text message via WhatsApp HTTP API!
@@ -114,7 +60,7 @@ docker pull devlikeapro/waha-plus
 docker logout
 ```
 
-Read more about how to get `PASSWORD` for [Plus Version →]({{< relref "plus-version" >}})
+Read more about how to get `PASSWORD` for [**➕ WAHA Plus**](https://waha.devlike.pro/docs/how-to/waha-plus/)
 
 ### 2. Run WhatsApp HTTP API
 
@@ -195,3 +141,19 @@ curl -d "{\"chatId\": \"${PHONE}@c.us\", \"text\": \"Hello from WhatsApp HTTP AP
 
 ## What is next?
 [Go and read the full documentation!](https://waha.devlike.pro/docs/overview/introduction/)
+
+# Development
+
+## Start the project
+1. Clone the repository
+2. Make sure you're using node>=22
+3. Run the following commands:
+```bash
+# Install dependencies
+yarn install
+# Fetch and compile proto files
+yarn gows:proto
+# Run
+yarn start
+# open http://localhost:3000
+```

package.json

@@ -20,7 +20,10 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "gows:proto:fetch": "node scripts/gows-proto.js fetch",
+    "gows:proto:build": "node scripts/gows-proto.js build",
+    "gows:proto": "yarn gows:proto:fetch && yarn gows:proto:build"
   },
   "dependencies": {
     "@adiwajshing/baileys": "github:devlikeapro/Baileys#fork-master-channels-678",

scripts/gows-proto.js

@@ -0,0 +1,144 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const fs = require('fs');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const path = require('path');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const axios = require('axios');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { execSync } = require('child_process');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const yargs = require('yargs');
+
+// Defaults
+const CONFIG_FILE = 'waha.config.json';
+// Load defaults from package.json
+gows = (() => {
+  try {
+    const config = JSON.parse(fs.readFileSync(CONFIG_FILE, 'utf8'));
+    return config.waha.gows || {};
+  } catch (error) {
+    return {};
+  }
+})();
+
+const DEFAULT_REPO = gows.repo;
+if (!DEFAULT_REPO) {
+  throw new Error(`Missing default repo in ${CONFIG_FILE}`);
+}
+const DEFAULT_REF = gows.ref;
+if (!DEFAULT_REF) {
+  throw new Error('Missing default ref in ${CONFIG_FILE}');
+}
+const DEFAULT_DIR = './src/core/engines/gows/proto';
+
+const PROTO_FILES = ['gows.proto'];
+const PROTO_OUTPUT = './src/core/engines/gows/grpc';
+
+// Helper function to clean directory
+function cleanDirectory(directory, suffix) {
+  if (!fs.existsSync(directory)) {
+    fs.mkdirSync(directory, { recursive: true });
+    return;
+  }
+
+  const files = fs.readdirSync(directory);
+  for (const file of files) {
+    const filePath = path.join(directory, file);
+    if (file.endsWith(suffix)) {
+      fs.unlinkSync(filePath);
+    }
+  }
+}
+
+// Helper function to download files
+async function downloadFiles(repo, ref, directory) {
+  for (const file of PROTO_FILES) {
+    const url = `https://raw.githubusercontent.com/${repo}/${ref}/proto/${file}`;
+    const filePath = path.join(directory, file);
+    try {
+      const response = await axios.get(url, { responseType: 'arraybuffer' });
+      fs.writeFileSync(filePath, response.data);
+      console.log(`Downloaded: ${file}`);
+    } catch (error) {
+      console.error(`Failed to download ${file}: ${error.message}`);
+    }
+  }
+}
+
+// Handler for fetch command
+async function handleFetch(repo, ref, dir) {
+  console.log(`Fetching .proto files from ${repo}@${ref} to ${dir}...`);
+  cleanDirectory(dir, '.proto');
+  await downloadFiles(repo, ref, dir);
+}
+
+// Handler for build command
+function handleBuild(dir) {
+  console.log('Building gRPC files...');
+  cleanDirectory(PROTO_OUTPUT);
+
+  const command = `grpc_tools_node_protoc \
+        --plugin=protoc-gen-ts=node_modules/.bin/protoc-gen-ts \
+        --plugin=protoc-gen-grpc=node_modules/.bin/grpc_tools_node_protoc_plugin \
+        --js_out=import_style=commonjs,binary:${PROTO_OUTPUT} \
+        --grpc_out=grpc_js:${PROTO_OUTPUT} \
+        --ts_out=grpc_js:${PROTO_OUTPUT} \
+        -I ${dir} ${dir}/gows.proto`;
+
+  try {
+    execSync(command, { stdio: 'inherit' });
+    console.log('gRPC files built successfully.');
+  } catch (error) {
+    console.error(`Failed to build gRPC files: ${error.message}`);
+  }
+}
+
+//
+// Commands
+//
+
+// fetch
+yargs.command(
+  'fetch',
+  'Fetch .proto files from GitHub',
+  (yargs) => {
+    yargs
+      .option('repo', {
+        describe: 'GitHub repository (owner/repo)',
+        type: 'string',
+        default: DEFAULT_REPO,
+      })
+      .option('ref', {
+        describe: 'Git reference (branch or commit SHA)',
+        type: 'string',
+        default: DEFAULT_REF,
+      })
+      .option('dir', {
+        describe: 'Directory to output .proto files',
+        type: 'string',
+        default: DEFAULT_DIR,
+      });
+  },
+  async (argv) => {
+    await handleFetch(argv.repo, argv.ref, argv.dir);
+  },
+);
+
+// build
+yargs.command(
+  'build',
+  'Build gRPC files from .proto files',
+  (yargs) => {
+    yargs.option('dir', {
+      describe: 'Directory containing .proto files',
+      type: 'string',
+      default: DEFAULT_DIR,
+    });
+  },
+  (argv) => {
+    handleBuild(argv.dir);
+  },
+);
+
+// Parse arguments
+yargs.parse();

tsconfig.build.json

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts", "scripts/*.js"]
 }

waha.config.json

@@ -0,0 +1,12 @@
+{
+  "waha": {
+    "gows": {
+      "repo": "devlikeapro/gows",
+      "ref": "32baf0cc2e8c35388b0b6d4a1a446cca0f3525a8"
+    },
+    "dashboard": {
+      "repo": "devlikeapro/dashboard",
+      "ref": "a1c839d8da94d1cade182addffdfc42fc0cf7ed3"
+    }
+  }
+}