website·Indexed 31 days ago
https://docs.fastwa.org/An open source framework for building applications with WhatsApp integration. Features include controllers for message handling, event listening with @On() decorators, pipes for data transformation, guards for authorization, and a schedule module via @fastwa/schedule.
A pipe in Fastwa is a class that implements the PipeTransform interface. Pipes are used for two primary purposes:
WAFactory.create method to initialize the app and then call app.listen() to start the connection process. You can enable printQrInTerminal to display the QR code for authentication directly in the console.import { WAFactory } from '@fastwa/core';
async function connectToWhatsapp() {
const app = await WAFactory.create(AppModule, {
printQrInTerminal: true
});
await app.listen();
}
connectToWhatsapp();useMultiFileAuthState from @whiskeysockets/baileys. This function saves the authentication state to a specified local folder. Pass the resulting state and saveCreds function into the WAFactory.create configuration.import {
fetchLatestBaileysVersion,
useMultiFileAuthState
} from '@whiskeysockets/baileys';
import { WAFactory } from '@fastwa/core';
async function connectToWhatsapp() {
// Save auth state in the './sessions' folder
const { state, saveCreds } = await useMultiFileAuthState('./sessions');
const app = await WAFactory.create(AppModule, {
auth: state,
printQRInTerminal: true,
saveCreds
});
await app.listen();
}
connectToWhatsapp();image) and the source. FastWA supports buffers, local URLs, and remote URLs. When using a URL, the media is encrypted as a readable stream rather than loading the entire buffer into memory, improving efficiency.return {
image: { url: './cat.jpeg' },
caption: "Look this cat",
}@Command. Returning a value from this method acknowledges the interaction and sends that value as a response message.@Controller()
export class AppController {
@Command('ping')
ping() {
return 'Pong!';
}
}@fastwa/builders package provides utility functions to format strings into the various styles supported by WhatsApp. These functions wrap the provided string in the specific characters required by the WhatsApp protocol to render bold, italic, strikethrough, or monospace text.import { bold, italic, strikethrough, monospace } from '@fastwa/builders';
const message = bold('This is bold'); // Returns *This is bold*
const slanted = italic('This is italic'); // Returns _This is italic_
const crossed = strikethrough('This is crossed'); // Returns ~This is crossed~
const code = monospace('This is monospace'); // Returns ```This is monospace```Controllers in Fastwa handle incoming messages and return replies. They are implemented using classes and decorators, which provide the necessary metadata for Fastwa to map interactions to the correct controller.
There are two ways to handle replies:
sock.sendMessage()). This is useful for advanced interactions that require native API access.sock.readMessages() and pass an array of message keys. Each key must include the message id, the remoteJid, and the participant.const key = {
id: 'AHASHH123123AHGA',
remoteJid: '1234-123@g.us',
participant: '912121232@s.whatsapp.net'
}
// Pass multiple keys to read multiple messages
await sock.readMessages([key]):id or :name). These segments act as variables that are replaced with actual values at runtime based on the user's message.// Example of a command with a dynamic segment ':name'
@Command('/hello :name')
async getHello(@Args('name') name: string) {
return `Hello, ${name}.`;
}state object with get and set methods that interact with your database or ORM, and a saveCreds function to persist the main credentials.import { initAuthCreds } from "@whiskeysockets/baileys"
export async function useDatabaseAuthState() {
const creds = initAuthCreds();
const state = {
creds,
keys: {
async get<T extends keyof SignalDataTypeMap>(types: T, ids: string[]) {
// TODO: Implement database retrieval (e.g., credsRepository.findOne())
return credsRepository.findOne();
},
async set(data: SignalDataSet) {
// TODO: Implement database update/insert (e.g., credsRepository.upsert())
credsRepository.upsert();
}
}
}
const saveCreds = () => credsRepository.save(creds)
return {
state,
saveCreds
}
}