@nzz/q-cli 1.10.3 → 2.0.0-beta.7

package/dist/index.js

@@ -0,0 +1,79 @@
+#!/usr/bin/env node
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Command } from 'commander';
+import updateItem from './updateItem.js';
+import newCustomCode from './newCustomCode.js';
+import packageJson from '../package.json' with { type: 'json' };
+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')
+            .option('-d, --dir [path]', 'the base directory to bootstrap the new custom code project in')
+            .description('bootstrap a new custom code project')
+            .action((command) => {
+            newCustomCode(command.dir);
+        });
+        program
+            .command('new-et-utils-package')
+            .option('-d, --dir [path]', 'the base directory to bootstrap the new tool in, defaults to the tools name')
+            .description('bootstrap a new ed-tech utility package')
+            .action(() => __awaiter(this, void 0, void 0, function* () {
+            //   const name = program.args[1];
+            //   const author = program.args[2] || 'TODO: Set package author name';
+            //   const description = program.args[3] || 'TODO: Write a package description';
+            //   if (!name) {
+            //     console.error(errorColor('no package name given'));
+            //     process.exit(1);
+            //   }
+            //   const baseDir = program.dir || name;
+            //   const textReplacements = [
+            //     { regex: new RegExp('<package-name>', 'g'), replaceWith: name },
+            //     { regex: new RegExp('<author-name>', 'g'), replaceWith: author },
+            //     {
+            //       regex: new RegExp('<package-description>', 'g'),
+            //       replaceWith: description,
+            //     },
+            //   ];
+            //   await bootstrap('et-utils-package', baseDir, textReplacements);
+        }));
+        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('copy-item')
+            .description('copies an existing q item')
+            .option('-c, --config [path]', 'set config path which defines the q items to be copied. defaults to ./q.config.json', `${process.cwd()}/q.config.json`)
+            .option('-e, --environment [env]', 'set environment where the existing q item is found, defaults to copy all items of all environments defined in config')
+            .action((command) => __awaiter(this, void 0, void 0, function* () {
+            // await copyItem(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* () {
+            // await createCustomCodeItem(command);
+        }));
+        yield program.parseAsync(process.argv);
+    });
+}
+main();

package/dist/interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/newCustomCode.js

@@ -0,0 +1,106 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import { execSync } from 'child_process';
+import { logError, logSuccess } from './utils.js';
+export default function newCustomCode(dir) {
+    if (!dir) {
+        logError('No custom-code project name/directory given');
+        process.exit(1);
+    }
+    if (fs.existsSync(dir)) {
+        logError(`Directory ${dir} already exists`);
+        process.exit(1);
+    }
+    const skeletonDir = 'skeletons';
+    const skeletonCustomCodeDir = path.join(skeletonDir, 'custom-code-project');
+    try {
+        // Create the target directory
+        fs.mkdirSync(dir);
+        // Change to the target directory
+        process.chdir(dir);
+        // Initialize git repository to pull the skeletons/custom-code-project content into a separate directory
+        console.log('Initializing git repository...');
+        execSync('git init');
+        execSync('git remote add origin https://github.com/nzzdev/Q.git');
+        // Enable sparse checkout and pull the content from remote
+        console.log(`Sparse checkout ${skeletonCustomCodeDir}...`);
+        execSync('git sparse-checkout init --cone');
+        execSync(`git sparse-checkout set ${skeletonCustomCodeDir}`);
+        console.log('Pulling content from remote...');
+        execSync('git pull origin edtech-965-cli-porting');
+        // Remove all files, except the skeletons directory
+        console.log('Cleaning up...');
+        const cwdFiles = fs.readdirSync(process.cwd());
+        for (const file of cwdFiles) {
+            if (file === skeletonDir)
+                continue; // Skip the skeletons directory
+            const filePath = path.join(process.cwd(), file);
+            if (fs.statSync(filePath).isDirectory()) {
+                fs.rmSync(filePath, { recursive: true, force: true });
+            }
+            else {
+                fs.unlinkSync(filePath);
+            }
+        }
+        // Copy the skeletons/custom-code-project content to the root
+        const cwdSkeletonCustomCodeDir = path.join(process.cwd(), skeletonCustomCodeDir);
+        const skeletonFiles = fs.readdirSync(cwdSkeletonCustomCodeDir);
+        for (const file of skeletonFiles) {
+            const srcFilePath = path.join(cwdSkeletonCustomCodeDir, file);
+            const targetFilePath = path.join(process.cwd(), file);
+            if (fs.statSync(srcFilePath).isDirectory()) {
+                fs.cpSync(srcFilePath, targetFilePath, { recursive: true });
+            }
+            else {
+                fs.copyFileSync(srcFilePath, targetFilePath);
+            }
+        }
+        // Remove the now empty skeletons directory
+        fs.rmSync(path.join(process.cwd(), skeletonDir), { recursive: true, force: true });
+        // Update the package.json and q.config.json files with the custom code project name
+        const customCodeProjectName = path.basename(dir);
+        updateJsonValue(path.join(process.cwd(), 'package.json'), 'name', customCodeProjectName);
+        updateJsonValue(path.join(process.cwd(), 'q.config.json'), 'items.0.item.trackingComponent.componentInfo.componentName', customCodeProjectName);
+        logSuccess(`Successfully created new custom code project '${dir}'`);
+    }
+    catch (error) {
+        logError(error.message);
+        process.exit(1);
+    }
+}
+/**
+ * Reads a JSON file, updates a specific value, and writes the changes back to the file
+ * @param filePath - Path to the JSON file
+ * @param keyPath - Path to the key to update (use dot notation for nested objects, e.g., 'parent.child')
+ * @param newValue - New value to set
+ * @returns boolean indicating success
+ */
+function updateJsonValue(filePath, keyPath, newValue) {
+    try {
+        // Read the JSON file
+        const jsonContent = JSON.parse(fs.readFileSync(filePath, 'utf8'));
+        // Split the key path into parts for nested objects
+        const keys = keyPath.split('.');
+        let current = jsonContent;
+        // Navigate to the parent of the target property
+        for (let i = 0; i < keys.length - 1; i++) {
+            if (!(keys[i] in current)) {
+                throw new Error(`Key path ${keyPath} not found in JSON file`);
+            }
+            current = current[keys[i]];
+        }
+        // Update the value
+        const lastKey = keys[keys.length - 1];
+        if (!(lastKey in current)) {
+            throw new Error(`Key ${lastKey} not found in JSON file`);
+        }
+        current[lastKey] = newValue;
+        // Write the updated JSON back to the file
+        fs.writeFileSync(filePath, JSON.stringify(jsonContent, null, 2));
+        return true;
+    }
+    catch (error) {
+        logError('Error updating JSON file:' + error.message);
+        return false;
+    }
+}

package/dist/updateItem.js

@@ -0,0 +1,191 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Ajv from 'ajv';
+import { readFileSync, existsSync, createReadStream } from 'fs';
+import { resolve } from 'path';
+import { read } from '@1password/op-js';
+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 { logError, logSuccess } from './utils.js';
+import updateSchemaJson from './assets/updateSchema.json' with { type: 'json' };
+function readSecret(reference) {
+    try {
+        return read.parse(reference);
+    }
+    catch (error) {
+        logError(`Error occurred while reading the secret: ${error.message}`);
+        process.exit(1);
+    }
+}
+function validateConfig(metaSchema, qConfig) {
+    const ajv = new Ajv({ allErrors: true });
+    let isValid = true;
+    let errorsText = '';
+    try {
+        isValid = ajv.validate(metaSchema, qConfig);
+        errorsText = ajv.errorsText();
+    }
+    catch (error) {
+        isValid = false;
+        errorsText = `Error occurred while validating the config file: ${error.message}`;
+    }
+    return {
+        isValid,
+        errorsText,
+    };
+}
+// Use type predicate to check response type
+function isAuthError(data) {
+    return 'error' in data;
+}
+function updateItem(qDoc, qServerUrl, accessToken) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let data;
+        try {
+            const response = yield fetch(`${qServerUrl}/item`, {
+                method: 'POST',
+                body: JSON.stringify(qDoc),
+                headers: {
+                    'user-agent': 'Q Command-line Tool',
+                    Authorization: `Bearer ${accessToken}`,
+                    'Content-Type': 'application/json',
+                },
+            });
+            data = (yield response.json());
+        }
+        catch (error) {
+            if (error instanceof TypeError && error.message.includes('fetch failed')) {
+                logError('Network request failed: Unable to connect to the server. Please check your internet connection and server status.');
+            }
+            else {
+                logError(`Failed to update item: ${error instanceof Error ? error.message : String(error)}`);
+            }
+            return false;
+        }
+        if (isAuthError(data)) {
+            logError(`Authentication error: ${data.error}`);
+            return false;
+        }
+        if (!data.success) {
+            logError(`Error occurred while updating item: ${data.msg}`);
+            return false;
+        }
+        return true;
+    });
+}
+function uploadFile(path, qServerUrl, accessToken) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const localFilePath = resolve(path);
+        // Check if the file exists
+        if (!existsSync(localFilePath)) {
+            logError(`File not found: ${localFilePath}`);
+            return undefined;
+        }
+        try {
+            const form = new FormData();
+            // Read the file
+            const fileStream = createReadStream(localFilePath);
+            // Append the file to the form
+            form.append('file', fileStream);
+            // Upload the file to the server
+            const response = yield fetch(`${qServerUrl}/file`, {
+                method: 'POST',
+                body: form,
+                headers: Object.assign(Object.assign({}, form.getHeaders()), { 'user-agent': 'Q Command-line Tool', Authorization: `Bearer ${accessToken}` }),
+            });
+            const data = (yield response.json());
+            if (!data.apiResponseStatus.success) {
+                logError(`Failed to upload file: ${data.apiResponseStatus.msg}`);
+                return undefined;
+            }
+            logSuccess(`Successfully uploaded file: ${localFilePath}`);
+            return data.fileInfo;
+        }
+        catch (error) {
+            logError(`Error uploading file: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    });
+}
+/**
+ * Recursively processes a document structure, looking for 'path' properties
+ * and processing them with the processResource function.
+ *
+ * @param item The object or value to process
+ * @param processResource Function to handle path properties
+ * @returns The processed item
+ */
+function processPathProperties(item, processResource) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Base case: if item is null or not an object, return it unchanged
+        if (item === null || typeof item !== 'object') {
+            return item;
+        }
+        // Handle arrays
+        if (Array.isArray(item)) {
+            return yield Promise.all(item.map((element) => __awaiter(this, void 0, void 0, function* () { return yield processPathProperties(element, processResource); })));
+        }
+        // Check if this object has a 'path' property (using Object.prototype.hasOwnProperty.call to avoid prototype pollution)
+        if (Object.prototype.hasOwnProperty.call(item, 'path') && typeof item.path === 'string') {
+            return yield processResource(item.path);
+        }
+        // Process each property recursively
+        const result = Object.assign({}, item);
+        for (const key of Object.keys(item)) {
+            result[key] = yield processPathProperties(item[key], processResource);
+        }
+        return result;
+    });
+}
+export default function (command) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const qConfigPath = resolve(command.config);
+        if (!existsSync(qConfigPath)) {
+            logError(`Couldn't find config file: '${qConfigPath}'.\nCreate a config file in the current directory or pass the path to the config file with the option -c <path>`);
+            return;
+        }
+        const qConfig = JSON.parse(readFileSync(qConfigPath, 'utf-8'));
+        const validationResult = validateConfig(updateSchemaJson, qConfig); // Validate the config file against the schema
+        if (!validationResult.isValid) {
+            logError(`A problem occurred while validating the config file: ${validationResult.errorsText}`);
+            process.exit(1);
+        }
+        // Get the Q server URL and access token from the environment variables or 1Password
+        const envUpperCase = command.environment.toUpperCase();
+        const envLowerCase = command.environment.toLowerCase();
+        const qServerUrl = process.env[`Q_${envUpperCase}_SERVER`]
+            ? process.env[`Q_${envUpperCase}_SERVER`]
+            : readSecret(`op://Q CLI/qv2-${envLowerCase}/Q_SERVER_BASE_URL`);
+        const accessToken = process.env[`Q_${envUpperCase}_ACCESSTOKEN`]
+            ? process.env[`Q_${envUpperCase}_ACCESSTOKEN`]
+            : readSecret(`op://Q CLI/qv2-${envLowerCase}/CLI_AUTH_TOKEN`);
+        console.log(`Updating items on server ${qServerUrl}...`);
+        for (const item of qConfig.items) {
+            for (const environment of item.environments) {
+                // Skip if the environment is not the one we want to update
+                if (command.environment !== environment.name)
+                    continue;
+                console.log(`Updating item ${environment.id} on ${environment.name} environment...`);
+                let qDoc = structuredClone(item.item);
+                qDoc._id = environment.id;
+                // Process the 'path' properties and upload files
+                qDoc = yield processPathProperties(qDoc, (path) => __awaiter(this, void 0, void 0, function* () {
+                    const formattedPath = path.replace('{id}', environment.id);
+                    console.log(`Processing resource at path: ${formattedPath}`);
+                    return yield uploadFile(formattedPath, qServerUrl, accessToken);
+                }));
+                // Update the item on the Q server
+                const result = yield updateItem(qDoc, qServerUrl, accessToken);
+                if (result) {
+                    logSuccess(`Successfully updated item with id ${environment.id} on ${environment.name} environment`);
+                }
+            }
+        }
+    });
+}

package/dist/utils.js

@@ -0,0 +1,11 @@
+const colors = {
+    green: '\x1b[32m',
+    reset: '\x1b[0m',
+    red: '\x1b[31m',
+};
+export function logError(message) {
+    console.error(`${colors.red}${message}${colors.reset}`);
+}
+export function logSuccess(message) {
+    console.log(`${colors.green}${message}${colors.reset}`);
+}

package/package.json

@@ -1,47 +1,38 @@
 {
   "name": "@nzz/q-cli",
-  "version": "1.10.3",
-  "prettier": "@nzz/et-utils-config-prettier",
-  "description": "Cli tool to setup new Q tools, new Q server implementations and start Q dev server to test developing Q tools",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/nzzdev/Q-cli.git"
-  },
+  "version": "2.0.0-beta.7",
+  "description": "",
+  "main": "./src/index.ts",
+  "type": "module",
   "bin": {
-    "Q": "bin/q.js"
+    "q": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && npm run copy-assets",
+    "copy-assets": "cp -R src/assets dist/",
+    "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",
+    "eslint": "TIMING=1 eslint --ext .svelte,.ts --config .eslintrc.cjs .",
+    "lint:all": "run-s -c tscheck lint svelte-check",
+    "tscheck": "tsc --noEmit"
   },
   "author": "",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/nzzdev/Q-cli/issues"
-  },
-  "homepage": "https://github.com/nzzdev/Q-cli#readme",
   "dependencies": {
-    "@hapi/boom": "^9.1.1",
-    "@hapi/hapi": "^20.3.0",
-    "@hapi/inert": "^6.0.3",
-    "@hapi/mimos": "^5.0.0",
-    "@hapi/vision": "^6.1.0",
-    "@hapi/wreck": "^17.1.0",
-    "ajv": "^6.12.6",
-    "chalk": "^4.1.1",
-    "commander": "^5.1.0",
-    "configstore": "^5.0.1",
-    "deepmerge": "^4.3.1",
-    "form-data": "^3.0.0",
-    "fs-extra": "^9.0.1",
-    "image-size": "^0.8.3",
-    "joi": "^17.9.1",
-    "node-fetch": "^2.6.9",
-    "nunjucks": "^3.2.2",
-    "promptly": "^3.2.0",
-    "replace-in-file": "^3.4.4"
+    "@1password/op-js": "^0.1.13",
+    "ajv": "^8.17.1",
+    "commander": "^13.1.0",
+    "form-data": "^4.0.2",
+    "node-fetch": "^3.3.2"
   },
   "devDependencies": {
-    "@nzz/et-utils-config-prettier": "^1.0.6"
+    "@repo/types-db": "workspace:^",
+    "@repo/types-files": "workspace:^",
+    "delivery-server": "workspace:*",
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.6"
   }
 }

package/.nvmrc

@@ -1 +0,0 @@
-14

package/.travis.yml

@@ -1,17 +0,0 @@
-dist: trusty
-sudo: true
-language: node_js
-node_js:
-  - "14"
-cache:
-  directories:
-    - node_modules
-install:
-  - cd ./skeletons/tool-skeleton
-  - npm install
-script:
-  - npm run build
-  - npm run test
-notfications:
-  slack:
-    secure: cpd8v7VZ14SE1//jmd6mP+Gndo+htGzleW3E6RdnsEgz1ttAJLvIkx9HxtN2ppwwhQJTv3g4rZUGU2vXyyneRQAMak80tWK8zrhdShg0Yry47M1R24LZsPiwOUCaMLD8O26irSlWgAuwno1LUReiJLnssRDGj0CSW3o+ISp11G9Q338u9PzULhjFnD3lT4pv4u7RAPbTB6MLVjWe7eRxyXATn92HQCtKH5YdVjItbDS/HEZwZOHV+lwrQNu/w/wBqHoEDX4XCJnQdzTdUZdlXmSz/5AS10IlDw05U9P9YEO9toOMWQJunDaslpIhl7kuSkqYrWzb0X+wLVNyLVfA0vf8wQG31WHs5T+Ul2P/O9zm4NzgTCT2khfQaynUpE2Zh9p1asnUSYGN75M+GPYKOkHHdj6KKmZ2APsuggC42vyI7FrsOy0Af9wnaoKxsBfaM/XNxx0hoblRQaQ4RaUaNQ4cF1WwUg6ZOlfewjpFnDLmC+XJS8t6PSlIKgHdTsaJB9wA4xlYPU4JFGMVYGd15tRpGDz9mgQbIkKhAFsFF6PiuemTHSO17Zpij7WKFVZuyAcs6NLZieXNIUwjKrfEzaUV03mPuw2dlxIlzm2TbZrKE97SzNIND2XJ2HTfmIoJ/jL3OKwc3WdE76ypoUl9E5sqg7zRrU+wgZMBM1U4ytY=

package/.vscode/launch.json

@@ -1,36 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Debug server command",
-      "program": "${workspaceFolder}/bin/q.js",
-      "args": ["server"]
-    },
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Debug new-server command",
-      "program": "${workspaceFolder}/bin/q.js",
-      "args": ["new-server", "test-server"]
-    },
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Debug new-tool command",
-      "program": "${workspaceFolder}/bin/q.js",
-      "args": ["new-tool", "test-tool"]
-    },
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Debug update-item command",
-      "program": "${workspaceFolder}/bin/q.js",
-      "args": ["update-item"]
-    }
-  ]
-}

package/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-  "[svelte]": {
-    "editor.defaultFormatter": "svelte.svelte-vscode"
-  }
-}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) NZZ Management AG
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.