@nzz/q-cli 2.0.6 → 2.1.0

package/README.md

@@ -41,7 +41,7 @@ Example:
 Creates a new custom code project.
 
 ```bash
-Q new-custom-code -d my-custom-code-project
+Q new-custom-code my-custom-code-project
 ```
 
 ### Creating a new custom code item

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nzz/q-cli",
-  "version": "2.0.6",
+  "version": "2.1.0",
   "description": "",
   "type": "module",
   "main": "./src/index.ts",

package/dist/assets/updateSchema.json

@@ -1,41 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Q Config",
-  "description": "Config used by the Q CLI to update items",
-  "type": "object",
-  "properties": {
-    "items": {
-      "description": "Array of Q items",
-      "type": "array",
-      "minItems": 1,
-      "items": {
-        "type": "object",
-        "properties": {
-          "environments": {
-            "type": "array",
-            "minItems": 1,
-            "items": {
-              "type": "object",
-              "properties": {
-                "name": {
-                  "type": "string",
-                  "description": "Environment name of Q item"
-                },
-                "id": {
-                  "type": "string",
-                  "description": "Id of Q item"
-                }
-              },
-              "required": ["name", "id"]
-            }
-          },
-          "item": {
-            "type": "object"
-          }
-        },
-        "required": ["environments", "item"]
-      }
-    }
-  },
-  "required": ["items"]
-}

package/dist/createCustomCodeItem.js

@@ -1,74 +0,0 @@
-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

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

package/dist/index.js

@@ -1,50 +0,0 @@
-#!/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 packageJson from '../package.json' with { type: 'json' };
-import updateItem from './updateItem.js';
-import newCustomCode from './newCustomCode.js';
-import createCustomCodeItem from './createCustomCodeItem.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);
-        }));
-        yield program.parseAsync(process.argv);
-    });
-}
-main();

package/dist/interfaces.js

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

package/dist/newCustomCode.js

@@ -1,107 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { execSync } from 'child_process';
-import { logError, logSuccess } from './utils.js';
-export default function (command) {
-    const { dir } = command;
-    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 main');
-        // 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

@@ -1,184 +0,0 @@
-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 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';
-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 });
-    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,
-    };
-}
-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);
-        }
-        let qServerUrl;
-        let accessToken;
-        let environmentToUpdate;
-        for (const item of qConfig.items) {
-            for (const environment of item.environments) {
-                // 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
-                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.success) {
-                    logSuccess(`Successfully updated item with id ${environment.id} on ${environmentToUpdate} environment`);
-                }
-                else {
-                    logError(result.msg);
-                    process.exit(1);
-                }
-            }
-        }
-    });
-}

package/dist/utils.js

@@ -1,88 +0,0 @@
-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);
-    }
-}