aboutsummaryrefslogtreecommitdiffstats
path: root/src/cli.js
blob: 8324522370245baad6ae8a4de1c18b0fcaab8815 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
import { parseArgs } from 'node:util';
import qrcode from 'qrcode-terminal';
import { METHODS, getMethod, resources, schema, validate } from './api/index.js';
import { accountName, paths, VERSION } from './config.js';
import { FORMATS } from './format/index.js';
import { HELPERS } from './helpers.js';
import { parseJsonArg, print } from './output.js';
import { WaError, call, ping } from './rpc.js';
import { Session } from './session.js';

// Same exit codes as gws, plus 4 = daemon.
const EXIT = { EAPI: 1, ENOTFOUND: 1, ETIMEOUT: 1, EAUTH: 2, EINVAL: 3, EAMBIGUOUS: 3, EDAEMON: 4, EINTERNAL: 5 };

const GLOBAL_OPTIONS = {
    account: { type: 'string', short: 'a' },
    format: { type: 'string' },
    params: { type: 'string' },
    json: { type: 'string' },
    output: { type: 'string', short: 'o' },
    'no-autostart': { type: 'boolean' },
    help: { type: 'boolean', short: 'h' },
    version: { type: 'boolean' },
};

// CLI commands that are not daemon methods.
const LOCAL_COMMANDS = {
    'auth.login': 'Link this device (QR in the terminal, or --phone for a code)',
    'daemon.start': 'Start the daemon in the background (--foreground for systemd)',
};
const LOCAL_ONLY = [
    '    wa format <FMT> < data.json',
];

const out = (s = '') => process.stdout.write(`${s}\n`);
const err = (s = '') => process.stderr.write(`${s}\n`);

export async function main(argv) {
    process.stdout.on('error', (e) => {
        if (e.code === 'EPIPE') process.exit(0);
    });
    try {
        return await run(argv);
    } catch (e) {
        return fail(e);
    }
}

function fail(e) {
    const known = e.code in EXIT;
    err(`wa: ${e.message}`);
    if (Array.isArray(e.data)) for (const c of e.data) err(`  ${c.name ?? ''} <${c.id}>`);
    if (!known && process.env.WA_CLI_DEBUG) err(e.stack);
    return known ? EXIT[e.code] : (e.name === 'TypeError' || e.name === 'ReferenceError' ? 5 : 1);
}

function parse(argv, extra = {}) {
    try {
        return parseArgs({ args: argv, options: { ...GLOBAL_OPTIONS, ...extra }, strict: true, allowPositionals: true });
    } catch (e) {
        throw new WaError('EINVAL', e.message);
    }
}

async function run(argv) {
    const pre = parseArgs({ args: argv, options: GLOBAL_OPTIONS, strict: false, allowPositionals: true });
    const [cmd, sub] = pre.positionals;

    if (pre.values.version) return out(VERSION), 0;
    if (!cmd || cmd === 'help') {
        if (sub && resources()[sub]) return resourceHelp(sub), 0;
        return mainHelp(), 0;
    }
    if (pre.values.format && !FORMATS[pre.values.format]) {
        throw new WaError('EINVAL', `unknown format: ${pre.values.format} (${Object.keys(FORMATS).join(', ')})`);
    }

    // ---- helpers
    if (cmd.startsWith('+')) {
        const helper = HELPERS[cmd];
        if (!helper) throw new WaError('EINVAL', `unknown helper: ${cmd} (${Object.keys(HELPERS).join(', ')})`);
        const spec = Object.fromEntries(Object.entries(helper.options || {}).map(([k, { description, ...o }]) => [k, o]));
        const { values, positionals } = parse(argv, spec);
        if (values.help) return helperHelp(cmd), 0;
        return helper.run(sessionFor(values), positionals.slice(1), values);
    }

    // ---- schema
    if (cmd === 'schema') {
        const { positionals } = parse(argv);
        if (positionals[1]) return print(schema(positionals[1]), pre.values.format || 'json'), 0;
        const all = Object.fromEntries(Object.entries(METHODS).map(([k, d]) => [k, d.description]));
        return print(all, pre.values.format || 'json'), 0;
    }

    // ---- format: JSON on stdin -> another format, without the daemon (e.g. in hooks)
    if (cmd === 'format') {
        const { values, positionals } = parse(argv, { columns: { type: 'string' } });
        const fmt = positionals[1] || values.format;
        if (!fmt || values.help) {
            out('Usage: wa format <FMT> [--columns a,b.c] < data.json\n');
            out('Converts JSON (the output of another `wa`) to another format without talking to the daemon.');
            out('E.g.: jq .data | wa format eml    (inside a hook)');
            return fmt || values.help ? 0 : 3;
        }
        const columns = values.columns?.split(',');
        print(parseJsonArg('-', 'stdin'), fmt, { columns, output: values.output });
        return 0;
    }

    // ---- auth login
    if (cmd === 'auth' && sub === 'login') {
        const { values } = parse(argv, { phone: { type: 'string' } });
        if (values.help) {
            out('Links this device to WhatsApp.\n');
            out('Usage: wa auth login [--phone NUMBER]\n');
            out('Without --phone it shows a QR: WhatsApp > Settings > Linked devices > Link a device.');
            out('With --phone (e.g. 5491122334455) it shows an 8-character code for');
            out('"Link with phone number instead" on that same screen.');
            return 0;
        }
        return authLogin(sessionFor(values), values.phone);
    }

    // ---- daemon
    if (cmd === 'daemon') return daemonCommand(argv, sub);

    // ---- generic API: wa <resource> <method>
    const res = resources()[cmd];
    if (!res) throw new WaError('EINVAL', `unknown resource: ${cmd} (see \`wa --help\`)`);
    if (!sub) return resourceHelp(cmd), pre.values.help ? 0 : 3;
    const method = `${cmd}.${sub}`;
    const def = getMethod(method);
    const { values, positionals } = parse(argv);
    if (values.help) return methodHelp(method), 0;
    if (positionals.length > 2) {
        throw new WaError('EINVAL', `unexpected argument: ${positionals[2]} (parameters go in --params '{...}')`);
    }
    const params = validate(method, {
        ...parseJsonArg(values.params, '--params'),
        ...parseJsonArg(values.json, '--json'),
    }, { cwd: process.cwd() });
    const session = sessionFor(values);

    if (def.stream) {
        await session.call(method, params, { onEvent: (ev) => print(ev, values.format || 'ndjson') });
        return 0;
    }
    const result = await session.call(method, params);
    print(result, values.format || 'json', { columns: def.columns, output: values.output });
    return 0;
}

function sessionFor(values) {
    return new Session(accountName(values.account), values['no-autostart'] ?