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

package/README.md

@@ -0,0 +1,69 @@
+# Q cli
+
+## Installation
+
+```bash
+npm install -g @nzz/q-cli
+```
+
+Some commands require certain environment variables. If you do not provide them, q cli tries to get them from your local 1Password installation. Make sure, that you have [1Password](https://1password.com/downloads/mac) installed.
+
+## Development
+
+```bash
+pnpm i
+```
+
+There is a test script for each command in the `package.json`.
+
+## GitHub Actions
+
+To use the q cli in GitHub Actions there are special access tokens provided. You can find them in 1Password (vault: Q CLI). Editorial Tech manages those access tokens.
+
+You will need to set the secrets in your GitHub repository under: `Settings > Secrets & variables > Actions > New repository secret`
+
+Example:
+
+```
+- name: Run Q cli
+  run: Q update-item
+  env:
+    Q_STAGING_SERVER: ${{ secrets.Q_STAGING_SERVER }}
+    Q_STAGING_ACCESSTOKEN: ${{ secrets.Q_STAGING_ACCESSTOKEN }}
+    Q_PRODUCTION_SERVER: ${{ secrets.Q_PRODUCTION_SERVER }}
+    Q_PRODUCTION_ACCESSTOKEN: ${{ secrets.Q_PRODUCTION_ACCESSTOKEN }}
+```
+
+## Functionality
+
+### Creating a new custom code project
+
+Creates a new custom code project.
+
+```bash
+Q new-custom-code -d my-custom-code-project
+```
+
+### Creating a new custom code item
+
+Creates a new custom code item on the specified environment and adds the id of the newly created item to the specified `q.config.json`.
+
+`q.config.json`: By default q cli will look for the config file in the current directory, if no path is specified.
+
+This command requires the environment variables `Q_[ENVIRONMENT]_SERVER` and `Q_[ENVIRONMENT]_ACCESSTOKEN`.
+
+```bash
+Q create-custom-code-item -e local -c ./tests/q.config.json -t 'TEST CUSTOM CODE ITEM'
+```
+
+### Updating existing Q items
+
+Reads the specified `q.config.json` and updates all q items there.
+
+`q.config.json`: By default q cli will look for the config file in the current directory, if no path is specified.
+
+This command requires the environment variables `Q_[ENVIRONMENT]_SERVER` and `Q_[ENVIRONMENT]_ACCESSTOKEN`.
+
+```bash
+Q update-item -e local -c ./tests/q.config.json
+```

package/dist/createCustomCodeItem.js

@@ -0,0 +1,74 @@
+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 { logSuccess, logError, updateItem, getAccessToken, getQServerUrl } from './utils.js';
+import { readFileSync, existsSync, writeFileSync } from 'fs';
+import { resolve } from 'path';
+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>`);
+            process.exit(1);
+        }
+        if (!command.environment) {
+            logError('Environment is required');
+            process.exit(1);
+        }
+        // Get the Q server URL and access token from the environment variables or 1Password
+        const qServerUrl = getQServerUrl(command.environment);
+        const accessToken = getAccessToken(command.environment);
+        const newCustomCodeDoc = {
+            acronym: 'Visuals',
+            assetGroups: [],
+            createdDate: '', // Will be set when saved
+            createdBy: 'editorial-tech@nzz.ch',
+            data: [],
+            // @ts-ignore
+            department: 'Visuals',
+            files: [],
+            options: {
+                previewDisabled: true,
+            },
+            // @ts-ignore
+            publication: 'nzz',
+            sophieModules: [],
+            title: command.title,
+            // @ts-ignore
+            tool: 'custom_code',
+            updatedDate: '', // Will be set when saved
+            updatedBy: 'editorial-tech@nzz.ch',
+        };
+        // Create the item on the Q server
+        const result = yield updateItem(newCustomCodeDoc, qServerUrl, accessToken);
+        if (!result.success) {
+            logError(result.msg);
+            process.exit(1);
+        }
+        const newCustomCodeDocId = result.id;
+        // Update the config file with the new item
+        const qConfig = JSON.parse(readFileSync(qConfigPath, 'utf-8'));
+        if (!qConfig.items) {
+            qConfig.items = [];
+        }
+        if (qConfig.items.length === 0) {
+            qConfig.items.push({
+                environments: [],
+                item: {}, // User needs to add the item later
+            });
+        }
+        const firstItem = qConfig.items[0];
+        firstItem.environments.push({
+            id: newCustomCodeDocId,
+            name: command.environment,
+        });
+        writeFileSync(qConfigPath, JSON.stringify(qConfig, null, 2));
+        logSuccess(`Successfully created item with id ${newCustomCodeDocId} on ${command.environment} environment`);
+    });
+}

package/dist/enums.js

@@ -0,0 +1,7 @@
+export var Environment;
+(function (Environment) {
+    Environment["PRODUCTION"] = "production";
+    Environment["STAGING"] = "staging";
+    Environment["TEST"] = "test";
+    Environment["LOCAL"] = "local";
+})(Environment || (Environment = {}));

package/dist/index.js

@@ -9,9 +9,10 @@ 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 packageJson from '../package.json' with { type: 'json' };
+import createCustomCodeItem from './createCustomCodeItem.js';
 const program = new Command();
 // Get the version from the package.json file
 const version = packageJson.version;
@@ -20,34 +21,12 @@ function main() {
         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')
+            .argument('<path>', 'the base directory to bootstrap the new custom code project in')
             .description('bootstrap a new custom code project')
-            .action((command) => {
-            newCustomCode(command.dir);
+            .action(() => {
+            const dir = program.args[1];
+            newCustomCode({ 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')
@@ -56,14 +35,6 @@ function main() {
             .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')
@@ -71,7 +42,7 @@ function main() {
             .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 createCustomCodeItem(command);
         }));
         yield program.parseAsync(process.argv);
     });

package/dist/newCustomCode.js

@@ -2,7 +2,8 @@ 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) {
+export default function (command) {
+    const { dir } = command;
     if (!dir) {
         logError('No custom-code project name/directory given');
         process.exit(1);
@@ -27,7 +28,7 @@ export default function newCustomCode(dir) {
         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');
+        execSync('git pull origin main');
         // Remove all files, except the skeletons directory
         console.log('Cleaning up...');
         const cwdFiles = fs.readdirSync(process.cwd());

package/dist/updateItem.js

@@ -10,19 +10,42 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 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 { getAccessToken, getQServerUrl, logError, logSuccess, updateItem } 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);
+import { Environment } from './enums.js';
+const envCredentials = {
+    [Environment.LOCAL]: {
+        qServerUrl: '',
+        accessToken: '',
+    },
+    [Environment.TEST]: {
+        qServerUrl: '',
+        accessToken: '',
+    },
+    [Environment.STAGING]: {
+        qServerUrl: '',
+        accessToken: '',
+    },
+    [Environment.PRODUCTION]: {
+        qServerUrl: '',
+        accessToken: '',
+    },
+};
+/**
+ * Get the Q server URL and access token from the environment variables or 1Password
+ * @param environment The environment to get the credentials for
+ * @returns The Q server URL and access token
+ */
+function getEnvCredentials(environment) {
+    if (envCredentials[environment].qServerUrl === '' || envCredentials[environment].accessToken === '') {
+        envCredentials[environment] = {
+            qServerUrl: getQServerUrl(environment),
+            accessToken: getAccessToken(environment),
+        };
     }
+    return envCredentials[environment];
 }
 function validateConfig(metaSchema, qConfig) {
     const ajv = new Ajv({ allErrors: true });
@@ -41,45 +64,6 @@ function validateConfig(metaSchema, qConfig) {
         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);
@@ -156,22 +140,27 @@ export default function (command) {
             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}...`);
+        let qServerUrl;
+        let accessToken;
+        let environmentToUpdate;
         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...`);
+                // If the environment is specified, use that environment
+                if (command.environment) {
+                    // Skip if the environment is not the one we want to update
+                    if (command.environment !== environment.name)
+                        continue;
+                    environmentToUpdate = command.environment;
+                }
+                else {
+                    // Otherwise, use the environment from the config
+                    environmentToUpdate = environment.name;
+                }
+                // Get the credentials for the current environment
+                const credentials = getEnvCredentials(environmentToUpdate);
+                qServerUrl = credentials.qServerUrl;
+                accessToken = credentials.accessToken;
+                console.log(`Updating item ${environment.id} on ${environmentToUpdate} environment (${qServerUrl})...`);
                 let qDoc = structuredClone(item.item);
                 qDoc._id = environment.id;
                 // Process the 'path' properties and upload files
@@ -182,8 +171,12 @@ export default function (command) {
                 }));
                 // 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`);
+                if (result.success) {
+                    logSuccess(`Successfully updated item with id ${environment.id} on ${environmentToUpdate} environment`);
+                }
+                else {
+                    logError(result.msg);
+                    process.exit(1);
                 }
             }
         }

package/dist/utils.js

@@ -1,11 +1,88 @@
+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 { read } from '@1password/op-js';
+import fetch from 'node-fetch';
 const colors = {
     green: '\x1b[32m',
     reset: '\x1b[0m',
     red: '\x1b[31m',
 };
+export function getAccessToken(env) {
+    return process.env[`Q_${env.toUpperCase()}_ACCESSTOKEN`]
+        ? process.env[`Q_${env.toUpperCase()}_ACCESSTOKEN`]
+        : readSecret(`op://Q CLI/qv2-${env.toLowerCase()}/CLI_AUTH_TOKEN`);
+}
+export function getQServerUrl(env) {
+    return process.env[`Q_${env.toUpperCase()}_SERVER`]
+        ? process.env[`Q_${env.toUpperCase()}_SERVER`]
+        : readSecret(`op://Q CLI/qv2-${env.toLowerCase()}/Q_SERVER_BASE_URL`);
+}
 export function logError(message) {
     console.error(`${colors.red}${message}${colors.reset}`);
 }
 export function logSuccess(message) {
     console.log(`${colors.green}${message}${colors.reset}`);
 }
+export function updateItem(qDoc, qServerUrl, accessToken) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const retVal = {
+            id: undefined,
+            msg: '',
+            success: false,
+        };
+        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')) {
+                retVal.msg =
+                    'Network request failed: Unable to connect to the server. Please check your internet connection and server status.';
+            }
+            else {
+                retVal.msg = `Failed to update item: ${error instanceof Error ? error.message : String(error)}`;
+            }
+            return retVal;
+        }
+        if (isAuthError(data)) {
+            retVal.msg = `Authentication error: ${data.error}`;
+            return retVal;
+        }
+        if (!data.success) {
+            retVal.msg = `Error occurred while updating item: ${data.msg}`;
+            return retVal;
+        }
+        retVal.success = true;
+        retVal.id = data.id; // If the item was created, we get the id from the response
+        return retVal;
+    });
+}
+// Use type predicate to check response type
+function isAuthError(data) {
+    return 'error' in data;
+}
+function readSecret(reference) {
+    try {
+        return read.parse(reference);
+    }
+    catch (error) {
+        logError(`Error occurred while reading the secret: ${error.message}`);
+        process.exit(1);
+    }
+}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@nzz/q-cli",
-  "version": "2.0.0-beta.7",
+  "version": "2.0.6",
   "description": "",
-  "main": "./src/index.ts",
   "type": "module",
+  "main": "./src/index.ts",
   "bin": {
-    "q": "./dist/index.js"
+    "Q": "./dist/index.js"
   },
   "files": [
     "dist"
@@ -13,6 +13,7 @@
   "scripts": {
     "build": "tsc && npm run copy-assets",
     "copy-assets": "cp -R src/assets dist/",
+    "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",
     "eslint": "TIMING=1 eslint --ext .svelte,.ts --config .eslintrc.cjs .",
@@ -29,6 +30,7 @@
     "node-fetch": "^3.3.2"
   },
   "devDependencies": {
+    "@repo/types-custom-code": "workspace:^",
     "@repo/types-db": "workspace:^",
     "@repo/types-files": "workspace:^",
     "delivery-server": "workspace:*",