@contentstack/cli-utilities 1.6.2 → 1.7.0

package/lib/contentstack-management-sdk.js

@@ -30,7 +30,7 @@ class ManagementSDKInitiator {
             retryDelay: Math.floor(Math.random() * (8000 - 3000 + 1) + 3000),
             logHandler: (level, data) => { },
             retryCondition: (error) => {
-                // LINK https://github.com/contentstack/contentstack-javascript/blob/72fee8ad75ba7d1d5bab8489ebbbbbbaefb1c880/src/core/stack.js#L49
+                // LINK ***REMOVED***vascript/blob/72fee8ad75ba7d1d5bab8489ebbbbbbaefb1c880/src/core/stack.js#L49
                 if (error.response && error.response.status) {
                     switch (error.response.status) {
                         case 401:

package/lib/helpers.d.ts

@@ -17,3 +17,4 @@ export declare const sanitizePath: (str: string) => string;
 export declare const validateUids: (uid: any) => boolean;
 export declare const validateFileName: (fileName: any) => boolean;
 export declare const validateRegex: (str: any) => import("recheck").Diagnostics;
+export declare const formatError: (error: any) => any;

package/lib/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateRegex = exports.validateFileName = exports.validateUids = exports.sanitizePath = exports.escapeRegExp = exports.validatePath = exports.createDeveloperHubUrl = exports.isManagementTokenValid = exports.doesBranchExist = exports.isAuthenticated = void 0;
+exports.formatError = exports.validateRegex = exports.validateFileName = exports.validateUids = exports.sanitizePath = exports.escapeRegExp = exports.validatePath = exports.createDeveloperHubUrl = exports.isManagementTokenValid = exports.doesBranchExist = exports.isAuthenticated = void 0;
 const tslib_1 = require("tslib");
 const recheck_1 = require("recheck");
 const auth_handler_1 = tslib_1.__importDefault(require("./auth-handler"));
@@ -28,7 +28,7 @@ const isManagementTokenValid = async (stackAPIKey, managementToken) => {
             return { valid: false, message: response.error_message };
         }
         else {
-            throw typeof response === "string" ? response : "";
+            throw typeof response === 'string' ? response : '';
         }
     }
     catch (error) {
@@ -61,15 +61,64 @@ exports.validatePath = validatePath;
 // To escape special characters in a string
 const escapeRegExp = (str) => str === null || str === void 0 ? void 0 : str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 exports.escapeRegExp = escapeRegExp;
-// To remove the relative path 
+// To remove the relative path
 const sanitizePath = (str) => str === null || str === void 0 ? void 0 : str.replace(/^(\.\.(\/|\\|$))+/, '');
 exports.sanitizePath = sanitizePath;
-// To validate the UIDs of assets 
+// To validate the UIDs of assets
 const validateUids = (uid) => /^[a-zA-Z0-9]+$/.test(uid);
 exports.validateUids = validateUids;
 // Validate File name
 const validateFileName = (fileName) => /^[a-zA-Z0-9-_\.]+$/.test(fileName);
 exports.validateFileName = validateFileName;
 // Validate Regex for ReDDos
-const validateRegex = (str) => (0, recheck_1.checkSync)(str, "");
+const validateRegex = (str) => (0, recheck_1.checkSync)(str, '');
 exports.validateRegex = validateRegex;
+const formatError = function (error) {
+    let parsedError;
+    // Parse the error
+    try {
+        if (typeof error === 'string') {
+            parsedError = JSON.parse(error);
+        }
+        else if (typeof (error === null || error === void 0 ? void 0 : error.message) === 'string') {
+            parsedError = JSON.parse(error.message);
+        }
+        else {
+            parsedError = error;
+        }
+    }
+    catch (e) {
+        parsedError = error;
+    }
+    // Determine the error message
+    let message = parsedError.errorMessage || parsedError.error_message || parsedError.message || parsedError;
+    if (typeof message === 'object') {
+        message = JSON.stringify(message);
+    }
+    // If message is in JSON format, parse it to extract the actual message string
+    try {
+        const parsedMessage = JSON.parse(message);
+        if (typeof parsedMessage === 'object') {
+            message = (parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.message) || message;
+        }
+    }
+    catch (e) {
+        // message is not in JSON format, no need to parse
+    }
+    // Append detailed error information if available
+    if (parsedError.errors && Object.keys(parsedError.errors).length > 0) {
+        const entityNames = {
+            authorization: 'Authentication',
+            api_key: 'Stack API key',
+            uid: 'Content Type',
+            access_token: 'Delivery Token',
+        };
+        message +=
+            ' ' +
+                Object.entries(parsedError.errors)
+                    .map(([key, value]) => `${entityNames[key] || key} ${value}`)
+                    .join(' ');
+    }
+    return message;
+};
+exports.formatError = formatError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.6.2",
+  "version": "1.7.0",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -33,7 +33,7 @@
   "license": "MIT",
   "dependencies": {
     "@contentstack/management": "~1.15.3",
-    "@contentstack/marketplace-sdk": "^1.0.1",
+    "@contentstack/marketplace-sdk": "^1.2.1",
     "@oclif/core": "^3.26.5",
     "axios": "^1.6.4",
     "chalk": "^4.0.0",
@@ -50,13 +50,13 @@
     "mkdirp": "^1.0.4",
     "open": "^8.4.2",
     "ora": "^5.4.0",
+    "recheck": "^4.4.5",
     "rxjs": "^6.6.7",
     "traverse": "^0.6.7",
     "unique-string": "^2.0.0",
-    "uuid": "^9.0.0",
+    "uuid": "^9.0.1",
     "winston": "^3.7.2",
-    "xdg-basedir": "^4.0.0",
-    "recheck": "^4.4.5"
+    "xdg-basedir": "^4.0.0"
   },
   "devDependencies": {
     "@contentstack/cli-dev-dependencies": "^1.2.4",
@@ -84,4 +84,4 @@
     "tslib": "^1.13.0",
     "typescript": "^4.9.3"
   }
-}
+}