@xcelera/cli 2.4.0 → 3.0.0

package/dist/cli.js

@@ -62,7 +62,7 @@ function isNetworkError(error) {
 	return errorMessages.has(message);
 }
 
-async function requestAudit(url, token, context, auth) {
+async function requestAudit(ref, token, context, auth) {
     const apiUrl = `${getApiBaseUrl()}/api/v1/audit`;
     try {
         const response = await fetch(apiUrl, {
@@ -72,7 +72,7 @@ async function requestAudit(url, token, context, auth) {
                 Authorization: `Bearer ${token}`
             },
             body: JSON.stringify({
-                url,
+                ref,
                 context,
                 ...(auth && { auth })
             })
@@ -9412,7 +9412,7 @@ function parseEpochSeconds(value, lineNumber, sourceLabel) {
     return num;
 }
 
-async function runAuditCommand(url, token, authOptions) {
+async function runAuditCommand(ref, token, authOptions) {
     const output = [];
     const errors = [];
     try {
@@ -9424,13 +9424,13 @@ async function runAuditCommand(url, token, authOptions) {
             output.push('🔐 Authentication credentials detected');
             output.push('');
         }
-        const response = await requestAudit(url, token, buildContext, auth);
+        const response = await requestAudit(ref, token, buildContext, auth);
         if (!response.success) {
             const { message, details } = response.error;
             errors.push('❌ Unable to schedule audit :(');
             errors.push(` ↳ ${message}`);
             if (details) {
-                errors.push(` ↳ ${details}`);
+                errors.push(` ↳ ${JSON.stringify(details)}`);
             }
             return { exitCode: 1, output, errors };
         }
@@ -9563,7 +9563,7 @@ function parseCookie(cookie) {
 
 /* istanbul ignore file */
 const options = {
-    url: {
+    ref: {
         type: 'string',
         required: true
     },
@@ -9604,17 +9604,17 @@ if (command !== 'audit') {
     printHelp();
     process.exit(1);
 }
-const { url, token, cookie, header } = values;
+const { ref, token, cookie, header } = values;
 const cookieFile = values['cookie-file'];
-if (!url) {
-    console.error('URL is required. Use --url <url> to specify the URL to audit.');
+if (!ref) {
+    console.error('Page ref is required. Use --ref <ref> to specify the page reference to audit. This can be found on the page definition in the xcelera dashboard.');
     process.exit(1);
 }
 if (!token) {
     console.error('A token is required. Use --token or set XCELERA_TOKEN environment variable.');
     process.exit(1);
 }
-const result = await runAuditCommand(url, token, {
+const result = await runAuditCommand(ref, token, {
     cookieFile,
     cookies: cookie,
     headers: header
@@ -9623,12 +9623,12 @@ result.output.forEach((line) => console.log(line));
 result.errors.forEach((line) => console.error(line));
 process.exit(result.exitCode);
 function printHelp() {
-    console.log('Usage: xcelera audit --url <url> [options]');
+    console.log('Usage: xcelera audit --ref <ref> [options]');
     console.log('');
     console.log('Options:');
     console.log('  --token <token>    The xcelera API token.');
     console.log('                     Can also be set with XCELERA_TOKEN env var.');
-    console.log('  --url <url>        The URL to audit.');
+    console.log('  --ref <ref>        The reference of the page to audit.');
     console.log('');
     console.log('Authentication (for pages behind login):');
     console.log('  --cookie <cookie>  Cookie in "name=value" format.');
@@ -9640,21 +9640,21 @@ function printHelp() {
     console.log('');
     console.log('Examples:');
     console.log('  # Basic audit');
-    console.log('  xcelera audit --url https://example.com');
+    console.log('  xcelera audit --ref example-page-xdfd');
     console.log('');
     console.log('  # With session cookie');
-    console.log('  xcelera audit --url https://myapp.com/dashboard --cookie "session=abc123"');
+    console.log('  xcelera audit --ref example-page-xdfd --cookie "session=abc123"');
     console.log('');
     console.log('  # With bearer token');
-    console.log('  xcelera audit --url https://api.myapp.com/admin \\');
+    console.log('  xcelera audit --ref example-page-xdfd \\');
     console.log('    --header "Authorization: Bearer eyJhbG..."');
     console.log('');
     console.log('  # Multiple cookies');
-    console.log('  xcelera audit --url https://myapp.com/dashboard \\');
+    console.log('  xcelera audit --ref example-page-xdfd \\');
     console.log('    --cookie "session=abc123" --cookie "csrf=xyz"');
     console.log('');
     console.log('  # With cookie file (Netscape cookies.txt format)');
-    console.log('  xcelera audit --url https://myapp.com/dashboard --cookie-file ./cookies.txt');
+    console.log('  xcelera audit --ref example-page-xdfd --cookie-file ./cookies.txt');
     console.log('');
 }
 //# sourceMappingURL=cli.js.map