@dynamicweb/cli 1.0.16 → 1.1.1

package/bin/commands/command.js

@@ -1,89 +1,164 @@
-import fetch from 'node-fetch';
-import path from 'path';
-import fs from 'fs';
-import { setupEnv, getAgent } from './env.js';
-import { setupUser } from './login.js';
-
-const exclude = ['_', '$0', 'command', 'list', 'json']
-
-export function commandCommand() {
-    return {
-        command: 'command [command]', 
-        describe: 'Runs the given command', 
-        builder: (yargs) => {
-            return yargs
-            .positional('command', {
-                describe: 'The command to execute'
-            })
-            .option('json', {
-                describe: 'Literal json or location of json file to send'
-            })
-            .option('list', {
-                alias: 'l',
-                describe: 'Lists all the properties for the command, currently not working'
-            })
-        },
-        handler: (argv) => {
-            if (argv.verbose) console.info(`Running command ${argv.command}`)
-            handleCommand(argv)
-        }
-    }
-}
-
-async function handleCommand(argv) {
-    let env = await setupEnv(argv);
-    let user = await setupUser(argv, env);
-    if (argv.list) {
-        console.log(await getProperties(env, user, argv.command))
-    } else {
-        let response = await runCommand(env, user, argv.command, getQueryParams(argv), parseJsonOrPath(argv.json))
-        console.log(response)
-    }
-}
-
-async function getProperties(env, user, command) {
-    return `This option currently doesn't work`
-    let res = await fetch(`${env.protocol}://${env.host}/Admin/Api/CommandByName?name=${command}`, {
-        method: 'GET',
-        headers: {
-            'Authorization': `Bearer ${user.apiKey}`
-        },
-        agent: getAgent(env.protocol)
-    })
-    if (res.ok) {
-        let body = await res.json()
-        return body.model.propertyNames
-    }
-}
-
-function getQueryParams(argv) {
-    let params = {}
-    Object.keys(argv).filter(k => !exclude.includes(k)).forEach(k => params['Command.' + k] = argv[k])
-    return params
-}
-
-function parseJsonOrPath(json) {
-    if (!json) return
-    if (fs.existsSync(json)) {
-        return JSON.parse(fs.readFileSync(path.resolve(json)))
-    } else {
-        return JSON.parse(json)
-    }
-}
-
-async function runCommand(env, user, command, queryParams, data) {
-    let res = await fetch(`${env.protocol}://${env.host}/Admin/Api/${command}?` + new URLSearchParams(queryParams), {
-        method: 'POST',
-        body: JSON.stringify(data),
-        headers: {
-            'Authorization': `Bearer ${user.apiKey}`,
-            'Content-Type': 'application/json'
-        },
-        agent: getAgent(env.protocol)
-    })
-    if (!res.ok) {
-        console.log(`Error when doing request ${res.url}`)
-        process.exit(1);
-    }
-    return await res.json()
-}
+import fetch from 'node-fetch';
+import path from 'path';
+import fs from 'fs';
+import { setupEnv, getAgent } from './env.js';
+import { setupUser } from './login.js';
+
+const exclude = ['_', '$0', 'command', 'list', 'json', 'verbose', 'v', 'host', 'protocol', 'apiKey', 'env', 'output']
+
+export function commandCommand() {
+    return {
+        command: 'command [command]', 
+        describe: 'Runs the given command', 
+        builder: (yargs) => {
+            return yargs
+            .positional('command', {
+                describe: 'The command to execute'
+            })
+            .option('json', {
+                describe: 'Literal json or location of json file to send'
+            })
+            .option('list', {
+                alias: 'l',
+                describe: 'Lists all the properties for the command, currently not working'
+            })
+            .option('output', {
+                choices: ['json'],
+                describe: 'Outputs a single JSON response for automation-friendly parsing'
+            })
+        },
+        handler: async (argv) => {
+            const output = createCommandOutput(argv);
+
+            try {
+                output.verboseLog(`Running command ${argv.command}`);
+                await handleCommand(argv, output);
+                output.finish();
+            } catch (err) {
+                output.fail(err);
+                output.finish();
+                process.exit(1);
+            }
+        }
+    }
+}
+
+async function handleCommand(argv, output) {
+    let env = await setupEnv(argv);
+    let user = await setupUser(argv, env);
+    if (argv.list) {
+        const properties = await getProperties(env, user, argv.command);
+        output.addData(properties);
+        output.log(properties);
+    } else {
+        let response = await runCommand(env, user, argv.command, getQueryParams(argv), parseJsonOrPath(argv.json));
+        output.addData(response);
+        output.log(response);
+    }
+}
+
+async function getProperties(env, user, command) {
+    return `This option currently doesn't work`
+    let res = await fetch(`${env.protocol}://${env.host}/Admin/Api/CommandByName?name=${command}`, {
+        method: 'GET',
+        headers: {
+            'Authorization': `Bearer ${user.apiKey}`
+        },
+        agent: getAgent(env.protocol)
+    })
+    if (res.ok) {
+        let body = await res.json()
+        return body.model.propertyNames
+    }
+}
+
+function getQueryParams(argv) {
+    let params = {}
+    Object.keys(argv).filter(k => !exclude.includes(k)).forEach(k => params['Command.' + k] = argv[k])
+    return params
+}
+
+function parseJsonOrPath(json) {
+    if (!json) return
+    if (fs.existsSync(json)) {
+        return JSON.parse(fs.readFileSync(path.resolve(json)))
+    } else {
+        return JSON.parse(json)
+    }
+}
+
+async function runCommand(env, user, command, queryParams, data) {
+    let res = await fetch(`${env.protocol}://${env.host}/Admin/Api/${command}?` + new URLSearchParams(queryParams), {
+        method: 'POST',
+        body: JSON.stringify(data),
+        headers: {
+            'Authorization': `Bearer ${user.apiKey}`,
+            'Content-Type': 'application/json'
+        },
+        agent: getAgent(env.protocol)
+    })
+    if (!res.ok) {
+        throw createCommandError(`Error when doing request ${res.url}`, res.status, await parseJsonSafe(res));
+    }
+    return await res.json()
+}
+
+function createCommandOutput(argv) {
+    const response = {
+        ok: true,
+        command: 'command',
+        operation: argv.list ? 'list' : 'run',
+        status: 200,
+        data: [],
+        errors: [],
+        meta: {
+            commandName: argv.command
+        }
+    };
+
+    return {
+        json: argv.output === 'json',
+        response,
+        log(value) {
+            if (!this.json) {
+                console.log(value);
+            }
+        },
+        verboseLog(...args) {
+            if (argv.verbose && !this.json) {
+                console.info(...args);
+            }
+        },
+        addData(entry) {
+            response.data.push(entry);
+        },
+        fail(err) {
+            response.ok = false;
+            response.status = err?.status || 1;
+            response.errors.push({
+                message: err?.message || 'Unknown command error.',
+                details: err?.details ?? null
+            });
+        },
+        finish() {
+            if (this.json) {
+                console.log(JSON.stringify(response, null, 2));
+            }
+        }
+    };
+}
+
+function createCommandError(message, status, details = null) {
+    const error = new Error(message);
+    error.status = status;
+    error.details = details;
+    return error;
+}
+
+async function parseJsonSafe(res) {
+    try {
+        return await res.json();
+    } catch {
+        return null;
+    }
+}

package/bin/commands/config.js

@@ -1,55 +1,55 @@
-import os from 'os';
-import fs from 'fs';
-
-const configLocation = os.homedir() + '/.dwc';
-let localConfig;
-
-export function configCommand() {
-    return {
-        command: 'config',
-        describe: 'Edit the configs located in usr/.dwc',
-        handler: (argv) => handleConfig(argv),
-        builder: {
-            prop: {
-                type: 'string',
-                describe: 'Path to your config property, i.e --env.dev.host=newHost:1000'
-            }
-        }
-    }
-}
-
-export function setupConfig() {
-    try {
-        localConfig = JSON.parse(fs.readFileSync(configLocation));
-    } catch (e) {
-        localConfig = {}
-    }
-}
-
-export function getConfig() {
-    return localConfig;
-}
-
-export function handleConfig(argv) {
-    Object.keys(argv).forEach(a => {
-        if (a != '_' && a != '$0') {
-            resolveConfig(a, argv[a], config[a]);
-            updateConfig();
-        }
-    })
-}
-
-export function updateConfig() {
-    fs.writeFileSync(configLocation, JSON.stringify(localConfig));
-}
-
-function resolveConfig(key, obj, conf) {
-    if (typeof obj !== 'object' || !(obj instanceof Object)) {
-        return obj;
-    }
-    Object.keys(obj).forEach(a => {
-        conf[a] = conf[a] || {};
-        conf[a] = resolveConfig(key, obj[a], conf[a]);
-    })
-    return conf;
+import os from 'os';
+import fs from 'fs';
+
+const configLocation = os.homedir() + '/.dwc';
+let localConfig;
+
+export function configCommand() {
+    return {
+        command: 'config',
+        describe: 'Edit the configs located in ~/.dwc',
+        handler: (argv) => handleConfig(argv),
+        builder: {
+            prop: {
+                type: 'string',
+                describe: 'Path to your config property, i.e --env.dev.host=newHost:1000'
+            }
+        }
+    }
+}
+
+export function setupConfig() {
+    try {
+        localConfig = JSON.parse(fs.readFileSync(configLocation));
+    } catch (e) {
+        localConfig = {}
+    }
+}
+
+export function getConfig() {
+    return localConfig;
+}
+
+export function handleConfig(argv) {
+    Object.keys(argv).forEach(a => {
+        if (a != '_' && a != '$0') {
+            localConfig[a] = resolveConfig(a, argv[a], localConfig[a] || {});
+            updateConfig();
+        }
+    })
+}
+
+export function updateConfig() {
+    fs.writeFileSync(configLocation, JSON.stringify(localConfig));
+}
+
+function resolveConfig(key, obj, conf) {
+    if (typeof obj !== 'object' || !(obj instanceof Object)) {
+        return obj;
+    }
+    Object.keys(obj).forEach(a => {
+        conf[a] = conf[a] || {};
+        conf[a] = resolveConfig(key, obj[a], conf[a]);
+    })
+    return conf;
 }

package/bin/commands/database.js

@@ -1,72 +1,66 @@
-import fetch from 'node-fetch';
-import fs from 'fs';
-import _path from 'path';
-import { setupEnv, getAgent } from './env.js';
-import { setupUser } from './login.js';
-
-export function databaseCommand() {
-    return {
-        command: 'database [path]', 
-        describe: 'Handles database', 
-        builder: (yargs) => {
-            return yargs
-            .positional('path', {
-                describe: 'Path to the .bacpac file',
-                default: '.'
-            })
-            .option('export', {
-                alias: 'e',
-                type: 'boolean',
-                description: 'Exports the solutions database to a .bacpac file at [path]'
-            })
-        },
-        handler: (argv) => {
-            if (argv.verbose) console.info(`Handling database with path: ${argv.path}`)
-            handleDatabase(argv)
-        }
-    }
-}
-
-async function handleDatabase(argv) {
-    let env = await setupEnv(argv);
-    let user = await setupUser(argv, env);
-
-    if (argv.export) {
-        await download(env, user, argv.path, argv.verbose);
-    }
-}
-
-async function download(env, user, path, verbose) {
-    let filename = 'database.bacpac';
-    fetch(`${env.protocol}://${env.host}/Admin/Api/DatabaseDownload`, {
-        method: 'POST',
-        headers: {
-            'Authorization': `Bearer ${user.apiKey}`,
-            'content-type': 'application/json'
-        },
-        agent: getAgent(env.protocol)
-    }).then(async (res) => {
-        if (verbose) console.log(res)
-        const header = res.headers.get('Content-Disposition');
-        const parts = header?.split(';');
-        if (!parts || !header.includes('attachment')) {
-            console.log('Failed download, check users database permissions')
-            if (verbose) console.log(await res.json())
-            return;
-        }
-        filename = parts[1].split('=')[1];
-        return res;
-    }).then(async (res) => {
-        if (!res) {
-            process.exit(1);
-        }
-        const fileStream = fs.createWriteStream(_path.resolve(`${_path.resolve(path)}/${filename}`));
-        await new Promise((resolve, reject) => {
-            res.body.pipe(fileStream);
-            res.body.on("error", reject);
-            fileStream.on("finish", resolve);
-        });
-        console.log(`Finished downloading`);
-        return res;
-    });
+import fetch from 'node-fetch';
+import fs from 'fs';
+import _path from 'path';
+import { setupEnv, getAgent } from './env.js';
+import { setupUser } from './login.js';
+
+export function databaseCommand() {
+    return {
+        command: 'database [path]', 
+        describe: 'Handles database', 
+        builder: (yargs) => {
+            return yargs
+            .positional('path', {
+                describe: 'Path to the .bacpac file',
+                default: '.'
+            })
+            .option('export', {
+                alias: 'e',
+                type: 'boolean',
+                description: 'Exports the solutions database to a .bacpac file at [path]'
+            })
+        },
+        handler: async (argv) => {
+            if (argv.verbose) console.info(`Handling database with path: ${argv.path}`)
+            await handleDatabase(argv)
+        }
+    }
+}
+
+async function handleDatabase(argv) {
+    let env = await setupEnv(argv);
+    let user = await setupUser(argv, env);
+
+    if (argv.export) {
+        await download(env, user, argv.path, argv.verbose);
+    }
+}
+
+async function download(env, user, path, verbose) {
+    const res = await fetch(`${env.protocol}://${env.host}/Admin/Api/DatabaseDownload`, {
+        method: 'POST',
+        headers: {
+            'Authorization': `Bearer ${user.apiKey}`,
+            'content-type': 'application/json'
+        },
+        agent: getAgent(env.protocol)
+    });
+
+    if (verbose) console.log(res)
+    const header = res.headers.get('Content-Disposition');
+    const parts = header?.split(';');
+    if (!parts || !header.includes('attachment')) {
+        console.log('Failed download, check users database permissions')
+        if (verbose) console.log(await res.json())
+        process.exit(1);
+    }
+
+    const filename = parts[1].split('=')[1];
+    const fileStream = fs.createWriteStream(_path.resolve(`${_path.resolve(path)}/${filename}`));
+    await new Promise((resolve, reject) => {
+        res.body.pipe(fileStream);
+        res.body.on("error", reject);
+        fileStream.on("finish", resolve);
+    });
+    console.log(`Finished downloading`);
 }