@drupal-canvas/cli 0.5.1 → 0.6.1

package/README.md

@@ -40,7 +40,6 @@ to get started.
 | `--client-id`     | `CANVAS_CLIENT_ID`     | OAuth client ID.                                              |
 | `--client-secret` | `CANVAS_CLIENT_SECRET` | OAuth client secret.                                          |
 | `--dir`           | `CANVAS_COMPONENT_DIR` | Directory where code components are stored in the filesystem. |
-| `--verbose`       | `CANVAS_VERBOSE`       | Verbose CLI output for troubleshooting. Defaults to `false`.  |
 | `--scope`         | `CANVAS_SCOPE`         | (Optional) Space-separated list of OAuth scopes to request.   |
 
 **Note:** The `--scope` parameter defaults to

package/dist/index.js

@@ -25,7 +25,7 @@ import { parse } from '@babel/parser';
 
 // package.json
 var package_default = {
-  version: "0.5.1"};
+  };
 function loadEnvFiles() {
   const homeDir = process.env.HOME || process.env.USERPROFILE || "";
   if (homeDir) {
@@ -46,7 +46,6 @@ var config = {
   clientSecret: process.env.CANVAS_CLIENT_SECRET || "",
   scope: process.env.CANVAS_SCOPE || "canvas:js_component canvas:asset_library",
   componentDir: process.env.CANVAS_COMPONENT_DIR || "./components",
-  verbose: process.env.CANVAS_VERBOSE === "true",
   userAgent: process.env.CANVAS_USER_AGENT || ""
 };
 function getConfig() {
@@ -10672,107 +10671,138 @@ var ApiService = class _ApiService {
       throw new Error("Failed to update global asset library");
     }
   }
-  handleApiError(error) {
-    const config2 = getConfig();
-    const verbose = config2.verbose;
-    if (axios.isAxiosError(error)) {
-      if (error.response) {
-        const status = error.response.status;
-        const data = error.response.data;
-        if (verbose && status !== 404) {
-          console.error("API Error Details:");
-          console.error(`- Status: ${status}`);
-          console.error(`- URL: ${error.config?.url || "unknown"}`);
-          console.error(
-            `- Method: ${error.config?.method?.toUpperCase() || "unknown"}`
-          );
-          console.error("- Response data:", JSON.stringify(data, null, 2));
-          const safeHeaders = { ...error.config?.headers };
-          if (safeHeaders && safeHeaders.Authorization) {
-            safeHeaders.Authorization = "Bearer ********";
-          }
-          console.error(
-            "- Request headers:",
-            JSON.stringify(safeHeaders, null, 2)
-          );
-        }
-        if (status === 401) {
-          throw new Error(
-            "Authentication failed. Please check your client ID and secret."
-          );
-        } else if (status === 403) {
-          throw new Error(
-            "You do not have permission to perform this action. Check your configured scope."
-          );
-        } else if (data && (data.error || data.error_description || data.hint)) {
-          throw new Error(
-            `API Error (${status}): ${[
-              data.error,
-              data.error_description,
-              data.hint
-            ].filter(Boolean).join(" | ")}`
-          );
-        } else {
-          throw new Error(`API Error (${status}): ${error.message}`);
+  /**
+   * Parse Canvas API error responses into user-friendly messages.
+   * Handles both structured validation errors and simple string errors.
+   */
+  parseCanvasErrors(data) {
+    if (data && typeof data === "object" && "errors" in data && Array.isArray(data.errors)) {
+      return data.errors.map((err) => {
+        if (typeof err === "string") {
+          return err.trim();
         }
-      } else if (error.request) {
-        if (verbose) {
-          console.error("Network Error Details:");
-          console.error(`- No response received from server`);
-          console.error(`- URL: ${error.config?.url || "unknown"}`);
-          console.error(
-            `- Method: ${error.config?.method?.toUpperCase() || "unknown"}`
-          );
-          const safeHeaders = { ...error.config?.headers };
-          if (safeHeaders && safeHeaders.Authorization) {
-            safeHeaders.Authorization = "Bearer ********";
+        if (err && typeof err === "object" && "detail" in err) {
+          let message = typeof err.detail === "string" ? err.detail : String(err.detail);
+          message = message.replace(/<[^>]*>/g, "").replace(/&quot;/g, '"').replace(/&#039;/g, "'").replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&").trim();
+          if (!message) {
+            return "";
           }
-          console.error(
-            "- Request headers:",
-            JSON.stringify(safeHeaders, null, 2)
-          );
-          if (this.siteUrl.includes("ddev.site")) {
-            console.error("\nDDEV Local Development Troubleshooting Tips:");
-            console.error('1. Make sure DDEV is running: try "ddev status"');
-            console.error(
-              '2. Try using HTTP instead of HTTPS: use "http://drupal-dev.ddev.site" as URL'
-            );
-            console.error("3. Check if the site is accessible in your browser");
-            console.error(
-              '4. For HTTPS issues: Try "ddev auth ssl" to set up local SSL certificates'
-            );
+          if ("source" in err && err.source && typeof err.source === "object" && "pointer" in err.source && typeof err.source.pointer === "string" && err.source.pointer !== "") {
+            message = `[${err.source.pointer}] ${message}`;
           }
+          return message;
         }
-        if (this.siteUrl.includes("ddev.site")) {
-          throw new Error(
-            `Network error: No response from DDEV site. Is DDEV running? Try using HTTP instead of HTTPS.`
-          );
-        } else {
-          throw new Error(
-            `Network error: No response from server. Check your site URL and internet connection.`
-          );
-        }
+        return "";
+      }).filter((msg) => msg !== "");
+    }
+    return [];
+  }
+  /**
+   * Throws an appropriate error based on the API response.
+   */
+  throwApiError(status, data, error, canvasErrors) {
+    if (canvasErrors.length > 0) {
+      const errorList = canvasErrors.join("\n\n").trim();
+      if (errorList) {
+        throw new Error(errorList);
+      }
+    }
+    if (status === 401) {
+      let message = "Authentication failed. Please check your client ID and secret.";
+      if (data && typeof data === "object" && "error_description" in data && typeof data.error_description === "string") {
+        message = `Authentication Error: ${data.error_description}
+
+${message}`;
+      }
+      throw new Error(message);
+    }
+    if (status === 403) {
+      throw new Error(
+        "You do not have permission to perform this action. Check your configured scope."
+      );
+    }
+    if (status === 404) {
+      const url2 = error.config?.url || "unknown";
+      let message = `API endpoint not found: ${url2}
+
+`;
+      if (this.siteUrl.includes("ddev.site")) {
+        message += "Possible causes:\n";
+        message += "  \u2022 DDEV is not running (run: ddev start)\n";
+        message += "  \u2022 Canvas module is not enabled (run: ddev drush en canvas -y)\n";
+        message += "  \u2022 Site URL is incorrect";
       } else {
-        if (verbose) {
-          console.error("Request Setup Error:");
-          console.error(`- Error: ${error.message}`);
-          console.error("- Stack:", error.stack);
-        }
-        throw new Error(`Request setup error: ${error.message}`);
+        message += "Possible causes:\n";
+        message += "  \u2022 Canvas module is not enabled\n";
+        message += "  \u2022 Site URL is incorrect\n";
+        message += "  \u2022 Server is not responding correctly";
+      }
+      throw new Error(message);
+    }
+    if (data && typeof data === "object" && "message" in data && typeof data.message === "string") {
+      throw new Error(data.message);
+    }
+    if (data && typeof data === "object") {
+      const errorParts = [];
+      if ("error" in data && typeof data.error === "string") {
+        errorParts.push(data.error);
       }
-    } else if (error instanceof Error) {
-      if (verbose) {
-        console.error("General Error:");
-        console.error(`- Message: ${error.message}`);
-        console.error("- Stack:", error.stack);
+      if ("error_description" in data && typeof data.error_description === "string") {
+        errorParts.push(data.error_description);
       }
-      throw new Error(`Network error: ${error.message}`);
+      if ("hint" in data && typeof data.hint === "string") {
+        errorParts.push(data.hint);
+      }
+      if (errorParts.length > 0) {
+        throw new Error(`API Error (${status}): ${errorParts.join(" | ")}`);
+      }
+    }
+    const url = error.config?.url || "unknown";
+    const method = error.config?.method?.toUpperCase() || "unknown";
+    throw new Error(
+      `API Error (${status}): ${error.message}
+
+URL: ${url}
+Method: ${method}`
+    );
+  }
+  /**
+   * Handles network errors (no response from server).
+   */
+  handleNetworkError() {
+    let message = `No response from: ${this.siteUrl}
+
+`;
+    if (this.siteUrl.includes("ddev.site")) {
+      message += "Troubleshooting tips:\n";
+      message += "  \u2022 Check if DDEV is running: ddev status\n";
+      message += "  \u2022 Try HTTP instead of HTTPS\n";
+      message += "  \u2022 Verify site is accessible in browser\n";
+      message += "  \u2022 For HTTPS issues, try: ddev auth ssl";
     } else {
-      if (verbose) {
-        console.error("Unknown Error:", error);
+      message += "Check your site URL and internet connection.";
+    }
+    throw new Error(message);
+  }
+  /**
+   * Main error handler for API requests.
+   */
+  handleApiError(error) {
+    if (!axios.isAxiosError(error)) {
+      if (error instanceof Error) {
+        throw error;
       }
       throw new Error("Unknown API error occurred");
     }
+    if (error.response) {
+      const { status, data } = error.response;
+      const canvasErrors = this.parseCanvasErrors(data);
+      this.throwApiError(status, data, error, canvasErrors);
+    }
+    if (error.request) {
+      this.handleNetworkError();
+    }
+    throw new Error(`Request setup error: ${error.message}`);
   }
 };
 function createApiService() {
@@ -11114,7 +11144,6 @@ function updateConfigFromOptions(options) {
   if (options.dir) setConfig({ componentDir: options.dir });
   if (options.scope) setConfig({ scope: options.scope });
   if (options.all) setConfig({ all: options.all });
-  if (options.verbose) setConfig({ verbose: true });
 }
 function pluralizeComponent(count) {
   return count === 1 ? "component" : "components";
@@ -18091,7 +18120,7 @@ function buildCommand(program2) {
   ).option("--all", "Build all components").option(
     "-c, --components <names>",
     "Specific component(s) to build (comma-separated)"
-  ).option("--no-tailwind", "Skip Tailwind CSS building").option("-y, --yes", "Skip confirmation prompts").option("--client-id <id>", "Client ID").option("--client-secret <secret>", "Client Secret").option("--site-url <url>", "Site URL").option("--verbose", "Enable verbose output").action(async (options) => {
+  ).option("--no-tailwind", "Skip Tailwind CSS building").option("-y, --yes", "Skip confirmation prompts").option("--client-id <id>", "Client ID").option("--client-secret <secret>", "Client Secret").option("--site-url <url>", "Site URL").action(async (options) => {
     try {
       p.intro(chalk2.bold("Drupal Canvas CLI: build"));
       validateComponentOptions(options);
@@ -18161,7 +18190,7 @@ function downloadCommand(program2) {
   ).option("--all", "Download all components").option("-y, --yes", "Skip all confirmation prompts").option(
     "--skip-overwrite",
     "Skip downloading components that already exist locally"
-  ).option("--skip-css", "Skip downloading global CSS").option("--css-only", "Download only global CSS (skip components)").option("--verbose", "Enable verbose output").action(async (options) => {
+  ).option("--skip-css", "Skip downloading global CSS").option("--css-only", "Download only global CSS (skip components)").action(async (options) => {
     p.intro(chalk2.bold("Drupal Canvas CLI: download"));
     try {
       validateComponentOptions(options);
@@ -18351,11 +18380,10 @@ function scaffoldCommand(program2) {
   ).option(
     "-d, --dir <directory>",
     "Component directory to create component in"
-  ).option("--verbose", "Enable verbose output").action(async (options) => {
+  ).action(async (options) => {
     p.intro(chalk2.bold("Drupal Canvas CLI: scaffold"));
     try {
       if (options.dir) setConfig({ componentDir: options.dir });
-      if (options.verbose) setConfig({ verbose: options.verbose });
       const config2 = getConfig();
       const baseDir = config2.componentDir;
       let componentName = options.name;
@@ -18450,7 +18478,7 @@ var getDataDependenciesFromAst = (ast) => ast.program.body.filter((d2) => d2.typ
   const source = d2.source.value;
   if (
     // Only consider imports from these two modules.
-    source !== "@/lib/drupal-utils" && source !== "@drupal-api-client/json-api-client"
+    source !== "@/lib/drupal-utils" && source !== "@drupal-api-client/json-api-client" && source !== "drupal-canvas"
   ) {
     return carry;
   }
@@ -18707,7 +18735,7 @@ function uploadCommand(program2) {
   program2.command("upload").description("build and upload local components and global CSS assets").option("--client-id <id>", "Client ID").option("--client-secret <secret>", "Client Secret").option("--site-url <url>", "Site URL").option("--scope <scope>", "Scope").option("-d, --dir <directory>", "Component directory").option(
     "-c, --components <names>",
     "Specific component(s) to upload (comma-separated)"
-  ).option("--all", "Upload all components").option("-y, --yes", "Skip confirmation prompts").option("--verbose", "Verbose output").option("--no-tailwind", "Skip Tailwind CSS building").option("--skip-css", "Skip global CSS upload").option("--css-only", "Upload only global CSS (skip components)").action(async (options) => {
+  ).option("--all", "Upload all components").option("-y, --yes", "Skip confirmation prompts").option("--no-tailwind", "Skip Tailwind CSS building").option("--skip-css", "Skip global CSS upload").option("--css-only", "Upload only global CSS (skip components)").action(async (options) => {
     const allFlag = options.all || options.yes && !options.components || false;
     const skipTailwind = !options.tailwind;
     try {
@@ -18738,6 +18766,7 @@ function uploadCommand(program2) {
         selectMessage: "Select items to upload"
       });
       const apiService = await createApiService();
+      await apiService.listComponents();
       let componentResults = [];
       if (!options.cssOnly && componentsToUpload.length > 0) {
         componentResults = await getBuildAndUploadResults(
@@ -18924,12 +18953,13 @@ async function getBuildAndUploadResults(componentsToUpload, apiService, includeG
         ]
       });
     } else {
+      const errorMessage = uploadResult.error?.message || "Unknown upload error";
       results.push({
         itemName: component.componentName,
         success: false,
         details: [
           {
-            content: uploadResult.error?.message || "Unknown upload error"
+            content: errorMessage.trim() || "Unknown upload error"
           }
         ]
       });
@@ -19009,7 +19039,7 @@ function validateCommand(program2) {
   ).option(
     "-c, --components <names>",
     "Specific component(s) to validate (comma-separated)"
-  ).option("--all", "Validate all components").option("-y, --yes", "Skip confirmation prompts").option("--verbose", "Enable verbose output").option(
+  ).option("--all", "Validate all components").option("-y, --yes", "Skip confirmation prompts").option(
     "--fix",
     "Apply available automatic fixes for linting issues",
     false
@@ -19060,7 +19090,7 @@ function validateCommand(program2) {
 // src/index.ts
 var version = package_default.version;
 var program = new Command();
-program.name("canvas").description("CLI tool for managing Drupal Canvas code components").version(version);
+program.name("canvas").description("CLI tool for managing Drupal Canvas code components").version(version ?? "0.0.0");
 downloadCommand(program);
 scaffoldCommand(program);
 uploadCommand(program);
@@ -19076,5 +19106,3 @@ try {
     process.exit(1);
   }
 }
-//# sourceMappingURL=index.js.map
-//# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@drupal-canvas/cli",
-  "version": "0.5.1",
   "description": "CLI tool for managing Drupal Canvas code components",
+  "version": "0.6.1",
   "license": "GPL-2.0-or-later",
   "repository": {
     "type": "git",
@@ -51,7 +51,7 @@
   "dependencies": {
     "@babel/parser": "^7.26.9",
     "@clack/prompts": "^0.11.0",
-    "@drupal-canvas/eslint-config": "^0.0.1",
+    "@drupal-canvas/eslint-config": "^0.1.0",
     "@swc/wasm": "^1.12.1",
     "axios": "^1.9.0",
     "chalk": "^5.4.1",