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

package/bin/commands/qItem/createCustomCodeItem/createCustomCodeItem.js

@@ -1,70 +0,0 @@
-const schemaService = require('../schemaService.js');
-const configStore = require('../configStore.js');
-const itemService = require('../itemService.js');
-const fs = require('fs');
-const path = require('path');
-const chalk = require('chalk');
-const errorColor = chalk.red;
-const successColor = chalk.green;
-
-module.exports = async function (command) {
-  try {
-    const qConfigPath = path.resolve(command.config);
-
-    if (!fs.existsSync(qConfigPath)) {
-      console.error(
-        errorColor(
-          "Couldn't find config file named q.config.json in the current directory. Create a config file in the current directory or pass the path to the config file with the option -c <path>"
-        )
-      );
-      process.exit(1);
-    }
-
-    const qConfig = JSON.parse(fs.readFileSync(qConfigPath));
-    const validationResult = schemaService.validateConfig(qConfig, 'createCustomCodeItem');
-
-    if (!validationResult.isValid) {
-      console.error(errorColor(`A problem occured while validating the config file: ${validationResult.errorsText}`));
-      process.exit(1);
-    }
-
-    const environmentName = command.environment;
-    const config = await configStore.setupStore(qConfig, environmentName, command.reset);
-    const items = itemService.getItems(qConfig);
-    const firstItem = items?.[0];
-
-    if (!firstItem) {
-      console.error(errorColor('No items found in the config file.'));
-      process.exit(1);
-    }
-
-    // Create a new custom code item
-    const title = command.title || 'Custom Code item created by Q-cli';
-    const newItem = await itemService.createItem(
-      { assetGroups: [], data: [], files: [], title: title, tool: 'custom_code' },
-      { name: environmentName },
-      config
-    );
-
-    if (!newItem) {
-      console.error(errorColor('Failed to create a new custom code item.'));
-      process.exit(1);
-    }
-
-    // Add the new custom code item to the config file
-    qConfig.items[0].environments.push({
-      id: newItem._id,
-      name: environmentName,
-    });
-
-    // Write the updated config file
-    fs.writeFileSync(qConfigPath, JSON.stringify(qConfig, null, 2));
-
-    console.log(
-      successColor(`Successfully added new custom code item with id ${newItem._id} on ${environmentName} environment.`)
-    );
-  } catch (error) {
-    console.error(errorColor(`A problem occured while parsing the config file at ${command.config}.`));
-    console.error(error);
-  }
-};

package/bin/commands/qItem/createCustomCodeItem/schema.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/bin/commands/qItem/helpers.js

@@ -1,102 +0,0 @@
-const fetch = require("node-fetch");
-const chalk = require("chalk");
-const errorColor = chalk.red;
-
-function getEnvironments(qConfig, environmentFilter) {
-  try {
-    const environments = new Set();
-    for (const item of qConfig.items) {
-      for (const environment of item.environments) {
-        if (environmentFilter) {
-          if (environmentFilter === environment.name) {
-            environments.add(environment.name);
-          }
-        } else {
-          environments.add(environment.name);
-        }
-      }
-    }
-
-    if (environments.size > 0) {
-      return Array.from(environments);
-    } else {
-      throw new Error(
-        `No items with environment ${environmentFilter} found. Please check your configuration and try again.`
-      );
-    }
-  } catch (error) {
-    console.error(errorColor(error.message));
-    process.exit(1);
-  }
-}
-
-async function getAccessToken(
-  environment,
-  qServer,
-  username,
-  password,
-  cookie
-) {
-  try {
-    const response = await fetch(`${qServer}authenticate`, {
-      method: "POST",
-      headers: {
-        "user-agent": "Q Command-line Tool",
-        origin: qServer,
-        Cookie: cookie ? cookie : "",
-      },
-      body: JSON.stringify({
-        username: username,
-        password: password,
-      }),
-    });
-
-    if (response.ok) {
-      const body = await response.json();
-      return {
-        accessToken: body.access_token,
-        cookie: response.headers.get("set-cookie"),
-      };
-    }
-
-    return false;
-  } catch (error) {
-    console.error(
-      errorColor(
-        `A problem occured while authenticating on ${environment} environment. Please check your connection and try again.`
-      )
-    );
-    process.exit(1);
-  }
-}
-
-async function checkValidityOfAccessToken(
-  environment,
-  qServer,
-  accessToken,
-  cookie
-) {
-  try {
-    const response = await fetch(`${qServer}user`, {
-      headers: {
-        "user-agent": "Q Command-line Tool",
-        Authorization: `Bearer ${accessToken}`,
-        Cookie: cookie ? cookie : "",
-      },
-    });
-    return response.ok;
-  } catch (error) {
-    console.error(
-      errorColor(
-        `A problem occured while checking the validity of your access token on ${environment} environment. Please check your connection and try again.`
-      )
-    );
-    process.exit(1);
-  }
-}
-
-module.exports = {
-  getEnvironments: getEnvironments,
-  getAccessToken,
-  checkValidityOfAccessToken,
-};

package/bin/commands/qItem/itemService.js

@@ -1,310 +0,0 @@
-const resourcesService = require("./resourcesService.js");
-const schemaService = require("./schemaService.js");
-const deepmerge = require("deepmerge");
-const fetch = require("node-fetch");
-const chalk = require("chalk");
-const errorColor = chalk.red;
-
-async function createItem(item, environment, config) {
-  const qServer = config.get(`${environment.name}.qServer`);
-  const accessToken = config.get(`${environment.name}.accessToken`);
-  const cookie = config.get(`${environment.name}.cookie`);
-
-  try {
-    const response = await fetch(`${qServer}item`, {
-      method: "POST",
-      body: JSON.stringify(item),
-      headers: {
-        "user-agent": "Q Command-line Tool",
-        Authorization: `Bearer ${accessToken}`,
-        "Content-Type": "application/json",
-        Cookie: cookie ? cookie : "",
-      },
-    });
-    if (response.ok) {
-      return await response.json();
-    } else {
-      throw new Error(
-        `A problem occured while creating item on ${environment.name} environment. Please check your connection and try again.`
-      );
-    }
-  } catch (error) {
-    console.error(errorColor(error.message));
-    process.exit(1);
-  }
-}
-
-async function getItem(qServer, environment, accessToken, cookie) {
-  try {
-    const response = await fetch(`${qServer}item/${environment.id}`, {
-      headers: {
-        "user-agent": "Q Command-line Tool",
-        Authorization: `Bearer ${accessToken}`,
-        Cookie: cookie ? cookie : "",
-      },
-    });
-    if (response.ok) {
-      return await response.json();
-    } else {
-      throw new Error(
-        `A problem occured while getting item with id ${environment.id} on ${environment.name} environment. Please make sure that the id is correct, you have an internet connection and try again.`
-      );
-    }
-  } catch (error) {
-    console.error(errorColor(error.message));
-    process.exit(1);
-  }
-}
-
-function getItems(qConfig, environmentFilter) {
-  const items = qConfig.items
-    .filter((item) => {
-      if (environmentFilter) {
-        return item.environments.some(
-          (environment) => environment.name === environmentFilter
-        );
-      }
-
-      return true;
-    })
-    .map((item) => {
-      if (environmentFilter) {
-        item.environments = item.environments.filter(
-          (environment) => environment.name === environmentFilter
-        );
-      }
-
-      return item;
-    });
-
-  return items;
-}
-
-function getDefaultOrNull(schema) {
-  if (schema.hasOwnProperty("default")) {
-    if (typeof schema.default === "object") {
-      return JSON.parse(JSON.stringify(schema.default));
-    }
-    return schema.default;
-  }
-  return null;
-}
-
-// Returns a default item based on the tool schema
-// The default item is used to derive the file properties of a certain file type
-// These file properties are specified by the tool and are specific to the file type
-// For example an image file has height/width file properties
-function getDefaultItem(schema) {
-  schema = JSON.parse(JSON.stringify(schema));
-  if (schema.type === "array") {
-    let array = [];
-    schema.minItems = 1;
-    for (let i = 0; i < schema.minItems; i++) {
-      let value = getDefaultItem(schema.items);
-      if (value) {
-        if (
-          schema["Q:type"] &&
-          schema["Q:type"] === "files" &&
-          schema["Q:options"] &&
-          schema["Q:options"].fileProperties
-        ) {
-          array.push(Object.assign(value, schema["Q:options"].fileProperties));
-        } else {
-          array.push(value);
-        }
-      }
-    }
-
-    const defaultValue = getDefaultOrNull(schema);
-    if (array === null && defaultValue !== null) {
-      array = defaultValue;
-    }
-    return array;
-  } else if (schema.type === "object") {
-    const defaultValue = getDefaultOrNull(schema);
-    if (defaultValue !== null) {
-      return defaultValue;
-    }
-
-    if (
-      schema["Q:type"] &&
-      schema["Q:type"] === "files" &&
-      schema["Q:options"] &&
-      schema["Q:options"].fileProperties
-    ) {
-      return schema["Q:options"].fileProperties;
-    }
-
-    if (!schema.hasOwnProperty("properties")) {
-      return undefined;
-    }
-    let object = {};
-    Object.keys(schema.properties).forEach((propertyName) => {
-      const property = schema.properties[propertyName];
-      let value = getDefaultItem(property);
-      if (value !== undefined) {
-        object[propertyName] = value;
-      } else if (
-        property["Q:type"] &&
-        property["Q:type"] === "files" &&
-        property["Q:options"] &&
-        property["Q:options"].fileProperties
-      ) {
-        object[propertyName] = property["Q:options"].fileProperties;
-      }
-    });
-    return object;
-  }
-
-  // if this is not an array or object, we just get the default if any
-  const defaultValue = getDefaultOrNull(schema);
-  if (defaultValue !== null) {
-    return defaultValue;
-  }
-  return undefined;
-}
-
-async function updateItem(item, environment, config, qConfigPath) {
-  const qServer = config.get(`${environment.name}.qServer`);
-  const accessToken = config.get(`${environment.name}.accessToken`);
-  const cookie = config.get(`${environment.name}.cookie`);
-  const existingItem = await getItem(qServer, environment, accessToken, cookie);
-  const updatedItem = await getUpdatedItem(
-    qServer,
-    accessToken,
-    cookie,
-    existingItem,
-    item,
-    environment,
-    qConfigPath
-  );
-  return await saveItem(qServer, environment, accessToken, cookie, updatedItem);
-}
-
-async function getUpdatedItem(
-  qServer,
-  accessToken,
-  cookie,
-  existingItem,
-  item,
-  environment,
-  qConfigPath
-) {
-  try {
-    const toolSchema = await schemaService.getToolSchema(
-      qServer,
-      existingItem.tool
-      );
-      // Removes additional properties not defined in the schema on the top level object of the item
-      toolSchema.additionalProperties = false;
-
-      if(existingItem.customSchema) {
-        toolSchema.properties = {...toolSchema.properties, ...existingItem.customSchema}
-      }
-
-      if(existingItem.customSchemaDefinitions) {
-        toolSchema.definitions = {...toolSchema.definitions, ...existingItem.customSchemaDefinitions}
-      }
-      // If options object is available additional properties not defined in the schema are removed
-    if (toolSchema.properties && toolSchema.properties.options) {
-      toolSchema.properties.options.additionalProperties = false;
-    }
-    const defaultItem = getDefaultItem(toolSchema);
-    item = JSON.parse(JSON.stringify(item));
-    item = await resourcesService.handleResources(
-      qServer,
-      accessToken,
-      cookie,
-      item,
-      defaultItem,
-      qConfigPath,
-      environment
-    );
-
-    // Merge options:
-    // File of files property will be updated (if file exists on destination)
-    // If it doesn't exist it is appended to the files array
-    // All other properties are overwritten from source config
-    const options = {
-      arrayMerge: (destArr, srcArr) => srcArr,
-      customMerge: (key) => {
-        if (key === "files") {
-          return (destArr, srcArr) => {
-            if (destArr.length <= 0) {
-              return srcArr;
-            }
-
-            srcArr.forEach((fileObj) => {
-              let destIndex = destArr.findIndex(
-                (destFileObj) =>
-                  destFileObj.file.originalName === fileObj.file.originalName
-              );
-
-              if (destIndex !== -1) {
-                destArr[destIndex] = fileObj;
-              } else {
-                destArr.push(fileObj);
-              }
-            });
-            return destArr;
-          };
-        }
-      },
-    };
-
-    // merges existing item with the item defined in q.config.json
-    const updatedItem = deepmerge(existingItem, item, options);
-    // normalizes the item which removes additional properties not defined in the schema
-    // and validates the item against the schema
-    const normalizedItem = schemaService.getNormalizedItem(
-      toolSchema,
-      updatedItem,
-      environment
-    );
-    // the normalized item is merged with the existing item. This is done because properties such as _id and _rev
-    // defined in the existing item are removed during normalization, because they are not defined in the schema
-    return deepmerge(existingItem, normalizedItem, options);
-  } catch (error) {
-    console.error(errorColor(error.message));
-    process.exit(1);
-  }
-}
-
-async function saveItem(
-  qServer,
-  environment,
-  accessToken,
-  cookie,
-  updatedItem
-) {
-  try {
-    delete updatedItem.updatedDate;
-    const response = await fetch(`${qServer}item`, {
-      method: "PUT",
-      body: JSON.stringify(updatedItem),
-      headers: {
-        "user-agent": "Q Command-line Tool",
-        Authorization: `Bearer ${accessToken}`,
-        "Content-Type": "application/json",
-        Cookie: cookie ? cookie : "",
-      },
-    });
-    if (response.ok) {
-      return await response.json();
-    } else {
-      throw new Error(
-        `A problem occured while saving item with id ${environment.id} on ${environment.name} environment. Please check your connection and try again.`
-      );
-    }
-  } catch (error) {
-    console.error(errorColor(error.message));
-    process.exit(1);
-  }
-}
-
-module.exports = {
-  createItem: createItem,
-  getItem: getItem,
-  getItems: getItems,
-  updateItem: updateItem,
-};

package/bin/commands/qItem/resourcesService.js

@@ -1,148 +0,0 @@
-const fetch = require("node-fetch");
-const FormData = require("form-data");
-const fs = require("fs");
-const util = require("util");
-const stat = util.promisify(fs.stat);
-const Mimos = require("@hapi/mimos");
-const mimos = new Mimos({
-  override: {
-    "application/javascript": {
-      source: "iana",
-      charset: "UTF-8",
-      compressible: true,
-      extensions: ["js", "javascript"],
-      type: "text/javascript",
-    },
-  },
-});
-const imageSize = require("image-size");
-const path = require("path");
-const chalk = require("chalk");
-const errorColor = chalk.red;
-
-// Recursively traverses the item object
-// If a property called "path" is found, the resource is uploaded
-// and the metadata of that resource is inserted at that place in the item object
-async function handleResources(
-  qServer,
-  accessToken,
-  cookie,
-  item,
-  defaultItem,
-  qConfigPath,
-  environment
-) {
-  try {
-    if (item) {
-      for (let key of Object.keys(item)) {
-        if (typeof item[key] === "object") {
-          let defaultItemSubtree;
-          if (defaultItem && Number.isInteger(parseInt(key)) && key > 0) {
-            defaultItemSubtree = defaultItem[0];
-          } else if (defaultItem && defaultItem[key]) {
-            defaultItemSubtree = defaultItem[key];
-          }
-          item[key] = await handleResources(
-            qServer,
-            accessToken,
-            cookie,
-            item[key],
-            defaultItemSubtree,
-            qConfigPath,
-            environment
-          );
-        } else if (key === "path") {
-          const resourcePath = item[key];
-          if (defaultItem) {
-            item = await getResourceMetadata(
-              qServer,
-              accessToken,
-              cookie,
-              resourcePath,
-              defaultItem,
-              qConfigPath,
-              environment
-            );
-          } else {
-            throw new Error(
-              `Error occured while uploading the resource at ${resourcePath}. Please make sure the config structure matches the schema of the tool and try again. `
-            );
-          }
-        }
-      }
-    }
-    return item;
-  } catch (error) {
-    console.error(errorColor(error.message));
-    process.exit(1);
-  }
-}
-
-// Uploads the resource and returns the metadata based on the file properties
-async function getResourceMetadata(
-  qServer,
-  accessToken,
-  cookie,
-  resource,
-  fileProperties,
-  qConfigPath,
-  environment
-) {
-  const resourcePath = path
-    .resolve(path.dirname(qConfigPath), resource)
-    .replace(/{id}/g, environment.id);
-  resource = await uploadResource(qServer, accessToken, cookie, resourcePath);
-  const statistic = await stat(resourcePath);
-  resource.size = statistic.size;
-  resource.type = mimos.path(resourcePath).type;
-
-  if (fileProperties.name) {
-    resource[fileProperties.name] = path.basename(resourcePath);
-  }
-  if (fileProperties.width && fileProperties.height) {
-    const dimensions = imageSize(resourcePath);
-    resource[fileProperties.width] = dimensions.width;
-    resource[fileProperties.height] = dimensions.height;
-  }
-
-  return resource;
-}
-
-async function uploadResource(qServer, accessToken, cookie, resourcePath) {
-  try {
-    if (fs.existsSync(resourcePath)) {
-      const form = new FormData();
-      const stream = fs.createReadStream(resourcePath);
-      form.append("file", stream);
-      const headers = form.getHeaders();
-      headers.Authorization = `Bearer ${accessToken}`;
-      headers.Cookie = cookie;
-
-      const response = await fetch(`${qServer}file`, {
-        method: "POST",
-        headers: headers,
-        body: form,
-      });
-      const body = await response.json();
-
-      if (response.ok) {
-        return body;
-      } else {
-        throw new Error(
-          `Error occured while uploading the resource at ${resourcePath}. Please check your connection and try again.\nResponse: ${body.statusCode} ${body.error} - ${body.message}`
-        );
-      }
-    } else {
-      throw new Error(
-        `Error occured while reading the resource at ${resourcePath}. Please make sure that the resource exists and try again.`
-      );
-    }
-  } catch (error) {
-    console.error(errorColor(error.message));
-    process.exit(1);
-  }
-}
-
-module.exports = {
-  handleResources: handleResources,
-};