@nzz/q-cli 2.1.2 → 2.2.1

package/dist/{createCustomCodeItem.js → commands/createCustomCodeItem.js}

@@ -7,10 +7,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { logSuccess, logError, updateItem, getAccessToken, getQServerUrl } from './utils.js';
+import { logSuccess, logError, updateItem, getAccessToken, getQServerUrl } from '../utils.js';
 import { readFileSync, existsSync, writeFileSync } from 'fs';
 import { resolve } from 'path';
-export default function (command) {
+export function createCreateCustomCodeItemCommand(program) {
+    return program
+        .command('create-custom-code-item')
+        .description('creates a new q custom code item in the db and adds it to the q config file')
+        .option('-c, --config [path]', 'set config path to q.config.json. defaults to ./q.config.json', `${process.cwd()}/q.config.json`)
+        .option('-e, --environment [env]', 'set environment where the new q custom code item should be created in')
+        .option('-t, --title [title]', 'set title of the new q custom code item')
+        .action((command) => __awaiter(this, void 0, void 0, function* () {
+        yield createCustomCodeItem(command);
+    }));
+}
+function createCustomCodeItem(command) {
     return __awaiter(this, void 0, void 0, function* () {
         const qConfigPath = resolve(command.config);
         if (!existsSync(qConfigPath)) {
@@ -35,6 +46,7 @@ export default function (command) {
             files: [],
             options: {
                 previewDisabled: true,
+                qEditorPreviewDisabled: false,
             },
             // @ts-ignore
             publication: 'nzz',

package/dist/{newCustomCode.js → commands/newCustomCode.js}

@@ -1,8 +1,18 @@
-import * as fs from 'fs';
 import * as path from 'path';
+import * as fs from 'fs';
 import { execSync } from 'child_process';
-import { logError, logSuccess } from './utils.js';
-export default function (command) {
+import { logError, logSuccess } from '../utils.js';
+export function createNewCustomCodeCommand(program) {
+    return program
+        .command('new-custom-code')
+        .argument('<path>', 'the base directory to bootstrap the new custom code project in')
+        .description('bootstrap a new custom code project')
+        .action(() => {
+        const dir = program.args[1];
+        newCustomCode({ dir });
+    });
+}
+function newCustomCode(command) {
     const { dir } = command;
     if (!dir) {
         logError('No custom-code project name/directory given');

package/dist/{updateItem.js → commands/updateItem.js}

@@ -12,9 +12,19 @@ import { readFileSync, existsSync, createReadStream } from 'fs';
 import { resolve } from 'path';
 import FormData from 'form-data';
 import fetch from 'node-fetch'; // Use node-fetch instead of native fetch, because native fetch seems to have issues with FormData/uploading files
-import { getAccessToken, getQServerUrl, logError, logSuccess, updateItem } from './utils.js';
-import updateSchemaJson from './assets/updateSchema.json' with { type: 'json' };
-import { Environment } from './enums.js';
+import { getAccessToken, getQServerUrl, logError, logSuccess, updateItem as updateItemUtils } from '../utils.js';
+import updateSchemaJson from '../assets/updateSchema.json' with { type: 'json' };
+import { Environment } from '../enums.js';
+export function createUpdateItemCommand(program) {
+    return program
+        .command('update-item')
+        .description('update q item')
+        .option('-c, --config [path]', 'set config path which defines the q items to be updated. defaults to ./q.config.json', `${process.cwd()}/q.config.json`)
+        .option('-e, --environment [env]', 'set environment which should be updated, defaults to update all items of all environments defined in config')
+        .action((command) => __awaiter(this, void 0, void 0, function* () {
+        yield updateItem(command);
+    }));
+}
 const envCredentials = {
     [Environment.LOCAL]: {
         qServerUrl: '',
@@ -84,6 +94,28 @@ function uploadFile(path, qServerUrl, accessToken) {
                 body: form,
                 headers: Object.assign(Object.assign({}, form.getHeaders()), { 'user-agent': 'Q Command-line Tool', Authorization: `Bearer ${accessToken}` }),
             });
+            // Handle HTTP errors before parsing JSON
+            if (!response.ok) {
+                let errorMessage;
+                switch (response.status) {
+                    case 401:
+                        errorMessage = 'Authentication error: Invalid or expired access token';
+                        break;
+                    case 403:
+                        errorMessage = 'Authorization error: Insufficient permissions to upload files';
+                        break;
+                    case 413:
+                        errorMessage = 'File too large: The file exceeds the maximum allowed size';
+                        break;
+                    case 415:
+                        errorMessage = 'Unsupported file type: The file type is not allowed';
+                        break;
+                    default:
+                        errorMessage = createGenericFileUploadErrorMsg(response);
+                }
+                logError(errorMessage);
+                return undefined;
+            }
             const data = (yield response.json());
             if (!data.apiResponseStatus.success) {
                 logError(`Failed to upload file: ${data.apiResponseStatus.msg}`);
@@ -97,6 +129,9 @@ function uploadFile(path, qServerUrl, accessToken) {
         }
     });
 }
+function createGenericFileUploadErrorMsg(response) {
+    return `HTTP ${response.status}: File upload failed`;
+}
 /**
  * Recursively processes a document structure, looking for 'path' properties
  * and processing them with the processResource function.
@@ -127,7 +162,7 @@ function processPathProperties(item, processResource) {
         return result;
     });
 }
-export default function (command) {
+function updateItem(command) {
     return __awaiter(this, void 0, void 0, function* () {
         const qConfigPath = resolve(command.config);
         if (!existsSync(qConfigPath)) {
@@ -170,7 +205,7 @@ export default function (command) {
                     return yield uploadFile(formattedPath, qServerUrl, accessToken);
                 }));
                 // Update the item on the Q server
-                const result = yield updateItem(qDoc, qServerUrl, accessToken);
+                const result = yield updateItemUtils(qDoc, qServerUrl, accessToken);
                 if (result.success) {
                     logSuccess(`Successfully updated item with id ${environment.id} on ${environmentToUpdate} environment`);
                 }
@@ -182,3 +217,8 @@ export default function (command) {
         }
     });
 }
+// Export for testing only
+export const __test__ = {
+    uploadFile,
+    createGenericFileUploadErrorMsg,
+};

package/dist/index.js

@@ -10,40 +10,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { Command } from 'commander';
 import packageJson from '../package.json' with { type: 'json' };
-import updateItem from './updateItem.js';
-import newCustomCode from './newCustomCode.js';
-import createCustomCodeItem from './createCustomCodeItem.js';
+import { createCreateCustomCodeItemCommand } from './commands/createCustomCodeItem.js';
+import { createUpdateItemCommand } from './commands/updateItem.js';
+import { createNewCustomCodeCommand } from './commands/newCustomCode.js';
 const program = new Command();
-// Get the version from the package.json file
 const version = packageJson.version;
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         program.version(version).description('Q Toolbox cli');
-        program
-            .command('new-custom-code')
-            .argument('<path>', 'the base directory to bootstrap the new custom code project in')
-            .description('bootstrap a new custom code project')
-            .action(() => {
-            const dir = program.args[1];
-            newCustomCode({ dir });
-        });
-        program
-            .command('update-item')
-            .description('update q item')
-            .option('-c, --config [path]', 'set config path which defines the q items to be updated. defaults to ./q.config.json', `${process.cwd()}/q.config.json`)
-            .option('-e, --environment [env]', 'set environment which should be updated, defaults to update all items of all environments defined in config')
-            .action((command) => __awaiter(this, void 0, void 0, function* () {
-            yield updateItem(command);
-        }));
-        program
-            .command('create-custom-code-item')
-            .description('creates a new q custom code item in the db and adds it to the q config file')
-            .option('-c, --config [path]', 'set config path to q.config.json. defaults to ./q.config.json', `${process.cwd()}/q.config.json`)
-            .option('-e, --environment [env]', 'set environment where the new q custom code item should be created in')
-            .option('-t, --title [title]', 'set title of the new q custom code item')
-            .action((command) => __awaiter(this, void 0, void 0, function* () {
-            yield createCustomCodeItem(command);
-        }));
+        createNewCustomCodeCommand(program);
+        createUpdateItemCommand(program);
+        createCreateCustomCodeItemCommand(program);
         yield program.parseAsync(process.argv);
     });
 }

package/dist/utils.js

@@ -37,9 +37,10 @@ export function updateItem(qDoc, qServerUrl, accessToken) {
             msg: '',
             success: false,
         };
+        let response;
         let data;
         try {
-            const response = yield fetch(`${qServerUrl}/item`, {
+            response = yield fetch(`${qServerUrl}/item`, {
                 method: 'POST',
                 body: JSON.stringify(qDoc),
                 headers: {
@@ -60,6 +61,30 @@ export function updateItem(qDoc, qServerUrl, accessToken) {
             }
             return retVal;
         }
+        // Handle different HTTP status codes
+        if (!response.ok) {
+            switch (response.status) {
+                case 400:
+                    retVal.msg = `Bad Request: ${isAuthError(data) ? data.error : 'Invalid request data'}`;
+                    break;
+                case 401:
+                    retVal.msg = 'Authentication error: Invalid or expired access token';
+                    break;
+                case 403:
+                    retVal.msg = 'Authorization error: Insufficient permissions';
+                    break;
+                case 413:
+                    retVal.msg =
+                        'Request too large: The item data is too large. Please reduce the size of your content or contact support to increase the limit.';
+                    break;
+                case 500:
+                    retVal.msg = 'Server error: Internal server error occurred';
+                    break;
+                default:
+                    retVal.msg = createUnknownErrorMsg(response, data);
+            }
+            return retVal;
+        }
         if (isAuthError(data)) {
             retVal.msg = `Authentication error: ${data.error}`;
             return retVal;
@@ -73,9 +98,12 @@ export function updateItem(qDoc, qServerUrl, accessToken) {
         return retVal;
     });
 }
+function createUnknownErrorMsg(response, data) {
+    return `HTTP ${response.status}: ${isAuthError(data) ? data.error : 'Unknown error occurred'}`;
+}
 // Use type predicate to check response type
 function isAuthError(data) {
-    return 'error' in data;
+    return data !== null && typeof data === 'object' && 'error' in data && typeof data.error === 'string';
 }
 function readSecret(reference) {
     try {
@@ -86,3 +114,7 @@ function readSecret(reference) {
         process.exit(1);
     }
 }
+// Export for testing only
+export const __test__ = {
+    createUnknownErrorMsg,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nzz/q-cli",
-  "version": "2.1.2",
+  "version": "2.2.1",
   "description": "",
   "type": "module",
   "main": "./src/index.ts",
@@ -16,6 +16,9 @@
     "create-custom-code-item": "tsx ./src/index.ts create-custom-code-item -e local -c ./tests/q.config.json -t 'TEST CUSTOM CODE ITEM'",
     "update-item": "tsx ./src/index.ts update-item -e local -c ./tests/q.config.json",
     "new-custom-code": "tsx ./src/index.ts new-custom-code -d my-custom-code-project",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "eslint": "TIMING=1 eslint --ext .svelte,.ts --config .eslintrc.cjs .",
     "lint:all": "run-s -c tscheck lint svelte-check",
     "tscheck": "tsc --noEmit"
@@ -33,6 +36,7 @@
     "@repo/types-custom-code": "workspace:^",
     "@repo/types-db": "workspace:^",
     "@repo/types-files": "workspace:^",
+    "@vitest/coverage-v8": "^3.0.8",
     "delivery-server": "workspace:*",
     "typescript": "^5.2.2",
     "vitest": "^0.34.6"