@dynamicweb/cli 1.1.0 → 2.0.0-beta.0

package/bin/commands/query.js

@@ -1,9 +1,9 @@
 import fetch from 'node-fetch';
-import { setupEnv, getAgent } from './env.js';
+import { setupEnv, getAgent, createCommandError } from './env.js';
 import { setupUser } from './login.js';
 import { input } from '@inquirer/prompts';
 
-const exclude = ['_', '$0', 'query', 'list', 'i', 'l', 'interactive', 'verbose', 'v', 'host', 'protocol', 'apiKey', 'env']
+const exclude = ['_', '$0', 'query', 'list', 'i', 'l', 'interactive', 'verbose', 'v', 'host', 'protocol', 'apiKey', 'env', 'output', 'auth', 'clientId', 'clientSecret', 'clientIdEnv', 'clientSecretEnv', 'oauth']
 
 export function queryCommand() {
     return {
@@ -22,30 +22,47 @@ export function queryCommand() {
                     alias: 'i',
                     describe: 'Runs in interactive mode to ask for query parameters one by one'
                 })
+                .option('output', {
+                    choices: ['json'],
+                    describe: 'Outputs a single JSON response for automation-friendly parsing',
+                    conflicts: 'interactive'
+                })
         },
-        handler: (argv) => {
-            if (argv.verbose) console.info(`Running query ${argv.query}`)
-            handleQuery(argv)
+        handler: async (argv) => {
+            const output = createQueryOutput(argv);
+
+            try {
+                output.verboseLog(`Running query ${argv.query}`);
+                await handleQuery(argv, output);
+            } catch (err) {
+                output.fail(err);
+                if (!output.json) {
+                    console.error(err.stack || err.message || String(err));
+                }
+                process.exitCode = 1;
+            } finally {
+                output.finish();
+            }
         }
     }
 }
 
-async function handleQuery(argv) {
-    let env = await setupEnv(argv);
+async function handleQuery(argv, output) {
+    let env = await setupEnv(argv, output);
     let user = await setupUser(argv, env);
     if (argv.list) {
-        console.log(await getProperties(argv))
+        const properties = await getProperties(env, user, argv.query);
+        output.addData(properties);
+        output.log(properties);
     } else {
-        let response = await runQuery(env, user, argv.query, await getQueryParams(argv))
-        console.log(response)
+        let response = await runQuery(env, user, argv.query, await getQueryParams(env, user, argv, output));
+        output.addData(response);
+        output.log(response);
     }
 }
 
-async function getProperties(argv) {
-    let env = await setupEnv(argv);
-    let user = await setupUser(argv, env);
-
-    let res = await fetch(`${env.protocol}://${env.host}/Admin/Api/QueryByName?name=${argv.query}`, {
+async function getProperties(env, user, query) {
+    let res = await fetch(`${env.protocol}://${env.host}/Admin/Api/QueryByName?name=${encodeURIComponent(query)}`, {
         method: 'GET',
         headers: {
             'Authorization': `Bearer ${user.apiKey}`
@@ -54,23 +71,21 @@ async function getProperties(argv) {
     })
     if (res.ok) {
         let body = await res.json()
-        if (body.model.properties.groups === undefined) {
-            console.log('Unable to fetch query parameters');
-            process.exit(1);
+        if (body?.model?.properties?.groups === undefined) {
+            throw createCommandError('Unable to fetch query parameters.', res.status, body);
         }
         return body.model.properties.groups.filter(g => g.name === 'Properties')[0].fields.map(field => `${field.name} (${field.typeName})`)
     }
-    console.log('Unable to fetch query parameters');
-    console.log(res);
-    process.exit(1);
+
+    throw createCommandError('Unable to fetch query parameters.', res.status, await parseJsonSafe(res));
 }
 
-async function getQueryParams(argv) {
+async function getQueryParams(env, user, argv, output) {
     let params = {}
     if (argv.interactive) {
-        let properties = await getProperties(argv);
-        console.log('The following properties will be requested:')
-        console.log(properties)
+        let properties = await getProperties(env, user, argv.query);
+        output.log('The following properties will be requested:')
+        output.log(properties)
         for (const p of properties) {
             const value = await input({ message: p });
             if (value) {
@@ -93,8 +108,61 @@ async function runQuery(env, user, query, params) {
         agent: getAgent(env.protocol)
     })
     if (!res.ok) {
-        console.log(`Error when doing request ${res.url}`)
-        process.exit(1);
+        throw createCommandError(`Error when doing request ${res.url}`, res.status, await parseJsonSafe(res));
     }
     return await res.json()
-}
+}
+
+function createQueryOutput(argv) {
+    const response = {
+        ok: true,
+        command: 'query',
+        operation: argv.list ? 'list' : 'run',
+        status: 200,
+        data: [],
+        errors: [],
+        meta: {
+            query: argv.query
+        }
+    };
+
+    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 query command error.',
+                details: err?.details ?? null
+            });
+        },
+        finish() {
+            if (this.json) {
+                console.log(JSON.stringify(response, null, 2));
+            }
+        }
+    };
+}
+
+
+async function parseJsonSafe(res) {
+    try {
+        return await res.json();
+    } catch {
+        return null;
+    }
+}

package/bin/downloader.js

@@ -9,7 +9,7 @@ import fs from 'fs';
 export function getFileNameFromResponse(res, dirPath) {
     const header = res.headers.get('content-disposition');
     const parts = header?.split(';');
-    
+
     if (!parts) {
         const msg = `No files found in directory '${dirPath}', if you want to download all folders recursively include the -r flag`;
         throw new Error(msg);
@@ -24,13 +24,16 @@ export function getFileNameFromResponse(res, dirPath) {
  *
  * @param {Object} res - The HTTP response object to extract the file name from.
  * @param {string} dirPath - The directory path to use for file name resolution.
+ * @param {boolean} verbose - Whether to log missing download information.
  * @returns {string|null} The extracted file name, or null if extraction fails.
  */
-export function tryGetFileNameFromResponse(res, dirPath) {
+export function tryGetFileNameFromResponse(res, dirPath, verbose = false) {
     try {
         return getFileNameFromResponse(res, dirPath);
     } catch (err) {
-        console.error(err.message);
+        if (verbose) {
+            console.log(err.message);
+        }
         return null;
     }
 }
@@ -56,7 +59,7 @@ export function downloadWithProgress(res, filePath, options) {
         res.body.on("data", chunk => {
             const isFirstChunk = receivedBytes === 0;
             const elapsed = Date.now() - startTime;
-            
+
             receivedBytes += chunk.length;
 
             if (options?.onData) {
@@ -64,4 +67,4 @@ export function downloadWithProgress(res, filePath, options) {
             }
         });
     });
-}
+}

package/bin/index.js

@@ -33,14 +33,30 @@ yargs(hideBin(process.argv))
         description: 'Run with verbose logging'
     })
     .option('protocol', {
-        description: 'Allows setting the protocol used, only used together with --host, defaulting to https'
+        description: 'Set the protocol used with --host (defaults to https)'
     })
     .option('host', {
-        description: 'Allows setting the host used, only allowed if an --apiKey is specified'
+        description: 'Allows setting the host used, only allowed if an --apiKey or OAuth client credentials are specified'
     })
     .option('apiKey', {
         description: 'Allows setting the apiKey for an environmentless execution of the CLI command'
     })
+    .option('auth', {
+        choices: ['user', 'oauth'],
+        description: 'Overrides the authentication mode for the command'
+    })
+    .option('clientId', {
+        description: 'OAuth client ID used together with --auth oauth'
+    })
+    .option('clientSecret', {
+        description: 'OAuth client secret used together with --auth oauth. WARNING: passing this on the command line can expose the secret via shell history and process listings. Prefer using --clientSecretEnv to reference a secret stored in an environment variable instead.'
+    })
+    .option('clientIdEnv', {
+        description: 'Environment variable name that contains the OAuth client ID'
+    })
+    .option('clientSecretEnv', {
+        description: 'Environment variable name that contains the OAuth client secret'
+    })
     .demandCommand()
     .parse()
 
@@ -49,14 +65,27 @@ function baseCommand() {
         command: '$0',
         describe: 'Shows the current env and user being used',
         handler: () => {
-            if (Object.keys(getConfig()).length === 0) {
+            const cfg = getConfig();
+            if (Object.keys(cfg).length === 0) {
                 console.log('To login to a solution use `dw login`')
                 return;
-            } 
-            console.log(`Environment: ${getConfig()?.current?.env}`)
-            console.log(`User: ${getConfig()?.env[getConfig()?.current?.env]?.current?.user}`)
-            console.log(`Protocol: ${getConfig()?.env[getConfig()?.current?.env]?.protocol}`)
-            console.log(`Host: ${getConfig()?.env[getConfig()?.current?.env]?.host}`)
+            }
+            const currentEnv = cfg?.env?.[cfg?.current?.env];
+            if (!currentEnv) {
+                console.log(`Environment '${cfg?.current?.env}' is not configured.`);
+                console.log('To login to a solution use `dw login`');
+                return;
+            }
+            const authType = currentEnv?.current?.authType;
+
+            console.log(`Environment: ${cfg?.current?.env}`);
+            if (authType === 'oauth_client_credentials') {
+                console.log('Authentication: OAuth client credentials');
+            } else if (currentEnv?.current?.user) {
+                console.log(`User: ${currentEnv.current.user}`);
+            }
+            console.log(`Protocol: ${currentEnv.protocol}`);
+            console.log(`Host: ${currentEnv.host}`);
         }
     }
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@dynamicweb/cli",
   "type": "module",
   "description": "CLI for interacting with Dynamicweb 10 solutions from the command line.",
-  "version": "1.1.0",
+  "version": "2.0.0-beta.0",
   "main": "bin/index.js",
   "files": [
     "bin/**"