@lizzythelizard/whatsapp-mcp 0.1.3 → 0.1.6

package/.github/dependabot.yml

@@ -1,20 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-    open-pull-requests-limit: 10
-
-  - package-ecosystem: "docker"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"

package/.github/workflows/auto-merge.yml

@@ -1,19 +0,0 @@
-name: Dependabot Auto-Merge
-
-on:
-  pull_request_target:
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  auto-merge:
-    if: github.actor == 'dependabot[bot]'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Auto-merge Dependabot PRs
-        run: gh pr merge --auto --merge "$PR_URL"
-        env:
-          PR_URL: ${{ github.event.pull_request.html_url }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/ci.yml

@@ -1,75 +0,0 @@
-name: CI
-
-on:
-  pull_request:
-    branches: [main]
-  push:
-    branches: [main]
-
-env:
-  DOCKER_IMAGE: ${{ secrets.DOCKER_USERNAME }}/whatsapp-mcp
-
-jobs:
-  checks:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v7
-      - uses: actions/setup-node@v6
-        with:
-          node-version: 24
-          cache: npm
-      - run: npm ci
-      - run: npm run build
-      - run: npm run lint
-      - run: npm run typecheck
-      - run: npm test
-      - name: Check version can be published
-        run: npm publish --dry-run
-
-  docker:
-    runs-on: ubuntu-latest
-    needs: [checks]
-    permissions:
-      contents: read
-      packages: write
-    steps:
-      - uses: actions/checkout@v7
-      - uses: docker/setup-buildx-action@v4
-      - name: Log in to Docker Hub
-        if: github.ref == 'refs/heads/main'
-        uses: docker/login-action@v4
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-      - name: Extract metadata
-        id: meta
-        uses: docker/metadata-action@v6
-        with:
-          images: ${{ env.DOCKER_IMAGE }}
-          tags: |
-            type=sha,prefix=
-            type=raw,value=latest,enable=${{ github.ref == 'refs/heads/main' }}
-      - name: Build and push
-        uses: docker/build-push-action@v7
-        with:
-          context: .
-          push: ${{ github.ref == 'refs/heads/main' }}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-
-  npm-publish:
-    runs-on: ubuntu-latest
-    needs: [checks]
-    if: github.ref == 'refs/heads/main'
-    steps:
-      - uses: actions/checkout@v7
-      - uses: actions/setup-node@v6
-        with:
-          node-version: 24
-          cache: npm
-          registry-url: "https://registry.npmjs.org"
-      - run: npm ci
-      - run: npm run build
-      - run: npm publish

package/.vscode/extensions.json

@@ -1,7 +0,0 @@
-{
-    "recommendations": [
-        "dbaeumer.vscode-eslint",
-        "github.vscode-github-actions",
-        "vitest.explorer"
-    ]
-}

package/.vscode/settings.json

@@ -1,12 +0,0 @@
-{
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "always"
-  },
-  "eslint.validate": [
-    "javascript",
-    "typescript",
-    "javascriptreact",
-  	"typescriptreact"
-  ],
-  "eslint.format.enable": true
- }

package/AGENTS.md

@@ -1,42 +0,0 @@
-# AGENTS.md
-
-This file helps AI agents understand how to work with this project.
-
-## Project Overview
-
-A WhatsApp MCP (Model Context Protocol) server that exposes WhatsApp functionality as tools for AI assistants.
-
-## Key Conventions
-
-- TypeScript with ESM (`"type": "module"`)
-- Source code lives in `src/`, tests in `tests/`
-- Use `zod` for input validation
-- Follow existing tool patterns when adding new tools
-
-## Common Commands
-
-- `npm run dev` — start dev server with auto-reload
-- `npm test` — run test suite
-- `npm run build` — compile to JavaScript
-- `npm run lint` — check code quality
-- `npm run typecheck` — run TypeScript type checking
-
-## Architecture
-
-The MCP server uses `@modelcontextprotocol/sdk` with stdio transport. Tools are registered in `src/index.ts` via `server.setRequestHandler`. Each tool has:
-
-1. A `zod` schema for input validation
-2. A definition in `ListToolsRequestSchema`
-3. A handler in `CallToolRequestSchema`
-
-## Adding a New Tool
-
-1. Define a Zod schema for the tool's input
-2. Add the tool definition to `ListToolsRequestSchema`
-3. Add a case to the switch in `CallToolRequestSchema`
-
-## Testing
-
-- Write tests in `tests/` matching the source structure
-- Use `vitest` with `describe`/`it`/`expect`
-- Test input schemas and handler logic separately

package/Dockerfile

@@ -1,25 +0,0 @@
-FROM node:26-alpine AS build
-
-WORKDIR /app
-
-COPY package*.json ./
-RUN npm ci
-
-COPY tsconfig.json ./
-COPY src/ ./src/
-RUN npm run build
-
-FROM node:26-alpine AS production
-
-WORKDIR /app
-
-RUN addgroup -S appgroup && adduser -S appuser -G appgroup
-
-COPY package*.json ./
-RUN npm ci --omit=dev
-
-COPY --from=build /app/dist ./dist
-
-USER appuser
-
-CMD ["node", "dist/index.js"]

package/eslint.config.mjs

@@ -1,32 +0,0 @@
-import eslint from '@eslint/js'
-import tseslint from 'typescript-eslint'
-import { defineConfig, globalIgnores } from 'eslint/config'
-import stylistic from '@stylistic/eslint-plugin'
-
-export default defineConfig([
-  eslint.configs.recommended,
-  tseslint.configs.recommendedTypeChecked,
-  tseslint.configs.strictTypeChecked,
-  tseslint.configs.stylisticTypeChecked,
-  stylistic.configs.recommended,
-  globalIgnores(['node_modules/**', 'dist/**']),
-  {
-    languageOptions: {
-      parserOptions: {
-        tsconfigRootDir: import.meta.dirname,
-        projectService: {
-          allowDefaultProject: ['src/*.test.ts'],
-        },
-      },
-    },
-    rules: {
-      '@typescript-eslint/no-extraneous-class': ['off'],
-      '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
-      '@stylistic/max-statements-per-line': ['error', { max: 2 }],
-    },
-  },
-  {
-    files: ['**/*.js', '**/*.cjs', '**/*.mjs'],
-    extends: [tseslint.configs.disableTypeChecked],
-  },
-])

package/src/auth.test.ts

@@ -1,138 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { createExportableAuth } from './auth.js'
-
-describe('createExportableAuth', () => {
-  it('returns fresh auth with initAuthCreds when called without argument', () => {
-    const auth = createExportableAuth()
-    expect(auth.creds).toBeDefined()
-    expect(auth.keys).toBeDefined()
-    expect(typeof auth.toAuthState).toBe('function')
-  })
-
-  it('restores creds and keys from a JSON string', () => {
-    const original = createExportableAuth()
-    const json = original.toAuthState()
-    const restored = createExportableAuth(json)
-    expect(restored.creds.registrationId).toBe(original.creds.registrationId)
-    expect(restored.creds.noiseKey.public).toEqual(original.creds.noiseKey.public)
-  })
-
-  it('roundtrips through toAuthState and back', async () => {
-    const auth = createExportableAuth()
-    await auth.keys.set({ 'sender-key': { 'test@test:1': new Uint8Array([1, 2, 3]) } })
-    const json = auth.toAuthState()
-    const imported = createExportableAuth(json)
-    const retrieved = await imported.keys.get('sender-key', ['test@test:1'])
-    expect(retrieved['test@test:1']).toBeDefined()
-    expect(new Uint8Array(retrieved['test@test:1'])).toEqual(new Uint8Array([1, 2, 3]))
-  })
-
-  it('preserves Uint8Array values through export and import', async () => {
-    const auth = createExportableAuth()
-    const original = new Uint8Array([255, 254, 253])
-    await auth.keys.set({ 'sender-key': { 'test-id': original } })
-    const json = auth.toAuthState()
-    const imported = createExportableAuth(json)
-    const retrieved = await imported.keys.get('sender-key', ['test-id'])
-    expect(new Uint8Array(retrieved['test-id'])).toEqual(original)
-  })
-
-  it('handles undefined input and returns fresh auth', () => {
-    const auth = createExportableAuth(undefined)
-    expect(auth.creds).toBeDefined()
-    expect(auth.creds.registrationId).toBeGreaterThan(0)
-  })
-
-  it('throws on invalid JSON string', () => {
-    expect(() => createExportableAuth('not valid json')).toThrow()
-  })
-
-  it('handles empty JSON object (no creds)', () => {
-    const auth = createExportableAuth('{}')
-    expect(typeof auth.toAuthState).toBe('function')
-    expect(auth.toAuthState()).toBe('{}')
-  })
-})
-
-describe('keys store (set/get)', () => {
-  it('stores and retrieves session values', async () => {
-    const auth = createExportableAuth()
-    const value = new Uint8Array([10, 20, 30])
-    await auth.keys.set({ session: { 'session-id': value } })
-    const result = await auth.keys.get('session', ['session-id'])
-    expect(result['session-id']).toBeDefined()
-    expect(new Uint8Array(result['session-id'])).toEqual(value)
-  })
-
-  it('stores and retrieves string values (lid-mapping)', async () => {
-    const auth = createExportableAuth()
-    await auth.keys.set({ 'lid-mapping': { test: 'mapped-value' } })
-    const result = await auth.keys.get('lid-mapping', ['test'])
-    expect(result.test).toBe('mapped-value')
-  })
-
-  it('stores and retrieves string array values (device-list)', async () => {
-    const auth = createExportableAuth()
-    await auth.keys.set({ 'device-list': { test: ['dev1', 'dev2'] } })
-    const result = await auth.keys.get('device-list', ['test'])
-    expect(result.test).toEqual(['dev1', 'dev2'])
-  })
-
-  it('returns empty object for missing keys', async () => {
-    const auth = createExportableAuth()
-    const result = await auth.keys.get('session', ['nonexistent'])
-    expect(result).toEqual({})
-  })
-
-  it('overwrites existing values on successive sets', async () => {
-    const auth = createExportableAuth()
-    await auth.keys.set({ session: { s1: new Uint8Array([1]) } })
-    await auth.keys.set({ session: { s1: new Uint8Array([2]) } })
-    const result = await auth.keys.get('session', ['s1'])
-    expect(new Uint8Array(result.s1)).toEqual(new Uint8Array([2]))
-  })
-
-  it('deletes key when value is set to null', async () => {
-    const auth = createExportableAuth()
-    await auth.keys.set({ session: { s1: new Uint8Array([1]) } })
-    await auth.keys.set({ session: { s1: null } })
-    const result = await auth.keys.get('session', ['s1'])
-    expect(result).toEqual({})
-  })
-
-  it('retrieves multiple ids in a single get call', async () => {
-    const auth = createExportableAuth()
-    await auth.keys.set({ 'lid-mapping': { id1: 'val1', id2: 'val2' } })
-    const result = await auth.keys.get('lid-mapping', ['id1', 'id2'])
-    expect(result.id1).toBe('val1')
-    expect(result.id2).toBe('val2')
-  })
-
-  it('handles app-state-sync-key with correct protobuf conversion', async () => {
-    const auth = createExportableAuth()
-    const keyData = {
-      keyData: new Uint8Array([1, 2, 3]),
-      timestamp: 1234567890,
-    }
-    await auth.keys.set({ 'app-state-sync-key': { key1: keyData } })
-    const result = await auth.keys.get('app-state-sync-key', ['key1'])
-    expect(result.key1).toBeDefined()
-    expect(result.key1.keyData).toBeDefined()
-    expect(Number(result.key1.timestamp)).toBe(1234567890)
-  })
-
-  it('stores and retrieves sender-key-memory (boolean map)', async () => {
-    const auth = createExportableAuth()
-    await auth.keys.set({ 'sender-key-memory': { jid1: { user1: true } } })
-    const result = await auth.keys.get('sender-key-memory', ['jid1'])
-    expect(result.jid1.user1).toBe(true)
-  })
-
-  it('stores and retrieves tctoken', async () => {
-    const auth = createExportableAuth()
-    await auth.keys.set({ tctoken: { default: { token: Buffer.from('token-data'), timestamp: '123' } } })
-    const result = await auth.keys.get('tctoken', ['default'])
-    expect(result.default.token).toBeDefined()
-    expect(result.default.timestamp).toBe('123')
-  })
-})

package/src/auth.ts

@@ -1,58 +0,0 @@
-import { AuthenticationCreds, BufferJSON, initAuthCreds, SignalDataTypeMap, proto, SignalDataSet, AuthenticationState } from '@whiskeysockets/baileys'
-
-export interface ExportableAuthState extends AuthenticationState {
-  toAuthState: () => string
-}
-
-interface AuthStateInput { creds: AuthenticationCreds, keys: Record<string, string> }
-
-export function createExportableAuth(input?: string): ExportableAuthState {
-  const { creds, keys } = fromString<AuthStateInput>(input) ?? { creds: initAuthCreds(), keys: {} }
-  return {
-    creds,
-    keys: { get: (t, ids) => getKey(t, ids, keys), set: (data) => { setKey(data, keys) } },
-    toAuthState: () => toString({ creds, keys }),
-  }
-}
-
-// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
-function fromString<T>(str: string | undefined): T | undefined {
-  if (!str) return undefined
-  return JSON.parse(str, BufferJSON.reviver) as T
-}
-
-function toString(data: unknown): string {
-  return JSON.stringify(data, BufferJSON.replacer)
-}
-
-function getKey<T extends keyof SignalDataTypeMap>(type: T, ids: string[], keys: Record<string, string>): Record<string, SignalDataTypeMap[T]> {
-  return ids.reduce<Record<string, SignalDataTypeMap[T]>>((acc, id) => {
-    const value = fromString<SignalDataTypeMap[T]>(keys[`${type}-${id}`])
-    if (!value) return acc
-    if (type === 'app-state-sync-key') {
-      const typedValue = value as SignalDataTypeMap['app-state-sync-key']
-      const converted = proto.Message.AppStateSyncKeyData.fromObject(typedValue)
-      const typeResult = converted as unknown as SignalDataTypeMap[T]
-      acc[id] = typeResult
-    }
-    else {
-      acc[id] = value
-    }
-    return acc
-  }, {})
-}
-
-function setKey(data: SignalDataSet, keys: Record<string, string>): void {
-  for (const category in data) {
-    const dataCategory = data[category as keyof SignalDataTypeMap]
-    for (const id in dataCategory) {
-      const value = dataCategory[id]
-      if (!value)
-        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-        delete keys[`${category}-${id}`]
-      else {
-        keys[`${category}-${id}`] = JSON.stringify(value, BufferJSON.replacer)
-      }
-    }
-  }
-}

package/src/index.ts

@@ -1,45 +0,0 @@
-#!/usr/bin/env node
-
-import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
-import pkg from '../package.json' with { type: 'json' }
-import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
-import { createStore, DataStore } from './store.js'
-import { createHandler } from './sync.js'
-import { promises as fsp } from 'fs'
-import { registerWhatsAppTools } from './tools.js'
-
-const dataDir = process.env.DATA_DIR ?? './data'
-
-async function readDataFromFile(): Promise<DataStore | undefined> {
-  const canAccess = await fsp.access(dataDir).then(() => true).catch(() => false)
-  if (!canAccess) return undefined
-  const chats = await fsp.readFile(`${dataDir}/chats.json`, 'utf-8')
-  const messages = await fsp.readFile(`${dataDir}/messages.json`, 'utf-8')
-  const contacts = await fsp.readFile(`${dataDir}/contacts.json`, 'utf-8')
-  const auth = await fsp.readFile(`${dataDir}/auth.json`, 'utf-8')
-  return { chats, messages, contacts, auth }
-}
-
-async function writeDataToFile(data: DataStore): Promise<void> {
-  await fsp.mkdir(dataDir, { recursive: true })
-  await fsp.writeFile(`${dataDir}/chats.json`, data.chats, 'utf-8')
-  await fsp.writeFile(`${dataDir}/messages.json`, data.messages, 'utf-8')
-  await fsp.writeFile(`${dataDir}/contacts.json`, data.contacts, 'utf-8')
-  await fsp.writeFile(`${dataDir}/auth.json`, data.auth, 'utf-8')
-}
-
-async function main() {
-  const server = new McpServer({ name: pkg.name, version: pkg.version })
-  const transport = new StdioServerTransport()
-  const inputData = await readDataFromFile()
-  const whatsappStore = createStore(writeDataToFile, inputData)
-  const whatsappSync = createHandler(whatsappStore)
-  registerWhatsAppTools(server, whatsappStore, whatsappSync)
-  await server.connect(transport)
-  console.info('whatsapp-mcp server running on stdio')
-}
-
-main().catch((error: unknown) => {
-  console.error('Server error:', error)
-  process.exit(1)
-})