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

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,
-};

package/bin/commands/qItem/schemaService.js

@@ -1,65 +0,0 @@
-const Ajv = require("ajv");
-// Remove additional properties which are not defined by the json schema
-// See https://ajv.js.org/options.html#removeadditional for details
-const ajv = new Ajv({ schemaId: "auto", removeAdditional: true });
-ajv.addMetaSchema(require("ajv/lib/refs/json-schema-draft-04.json"));
-const fetch = require("node-fetch");
-const chalk = require("chalk");
-const errorColor = chalk.red;
-
-async function getToolSchema(qServer, tool) {
-  try {
-    const response = await fetch(`${qServer}tools/${tool}/schema.json`);
-    if (response.ok) {
-      return await response.json();
-    } else {
-      throw new Error(
-        `A problem occured while getting the schema of the ${tool} tool. Please check your connection and try again.`
-      );
-    }
-  } catch (error) {
-    console.error(errorColor(error.message));
-    process.exit(1);
-  }
-}
-
-function getSchemaPathFor(commandName) {
-  const pathFor = {
-    createCustomCodeItem: "./createCustomCodeItem/schema.json",
-    copyItem: "./copyItem/copySchema.json",
-    updateItem: "./updateItem/updateSchema.json",
-  };
-
-  if (pathFor[commandName]) {
-    return pathFor[commandName];
-  } else {
-    throw new Error(`Unhandled schema path for commandName: '${commandName}'`);
-  }
-}
-
-function validateConfig(config, commandName = "updateItem") {
-  const isValid = ajv.validate(require(getSchemaPathFor(commandName)), config);
-  return {
-    isValid: isValid,
-    errorsText: ajv.errorsText(),
-  };
-}
-
-function getNormalizedItem(schema, item, environment) {
-  const isValid = ajv.validate(schema, item);
-  if (!isValid) {
-    throw new Error(
-      `A problem occured while validating item with id ${environment.id} on ${
-        environment.name
-      } environment: ${ajv.errorsText()}`
-    );
-  }
-
-  return item;
-}
-
-module.exports = {
-  getToolSchema: getToolSchema,
-  validateConfig: validateConfig,
-  getNormalizedItem: getNormalizedItem,
-};

package/bin/commands/qItem/updateItem/updateItem.js

@@ -1,64 +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)) {
-      const qConfig = JSON.parse(fs.readFileSync(qConfigPath));
-      const validationResult = schemaService.validateConfig(qConfig);
-
-      if (validationResult.isValid) {
-        const config = await configStore.setupStore(
-          qConfig,
-          command.environment,
-          command.reset
-        );
-
-        for (const item of itemService.getItems(qConfig, command.environment)) {
-          for (const environment of item.environments) {
-            const result = await itemService.updateItem(
-              item.item,
-              environment,
-              config,
-              qConfigPath
-            );
-
-            if (result) {
-              console.log(
-                successColor(
-                  `Successfully updated item with id ${environment.id} on ${environment.name} environment`
-                )
-              );
-            }
-          }
-        }
-      } else {
-        console.error(
-          errorColor(
-            `A problem occured while validating the config file: ${validationResult.errorsText}`
-          )
-        );
-        process.exit(1);
-      }
-    } else {
-      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>"
-        )
-      );
-    }
-  } catch (error) {
-    console.error(
-      errorColor(
-        `A problem occured while parsing the config file at ${command.config}. Please make sure it is valid JSON.`
-      )
-    );
-  }
-};

package/bin/commands/server.js

@@ -1,80 +0,0 @@
-const path = require("path");
-const Nunjucks = require("nunjucks");
-
-async function startServer() {
-  const server = require(path.join(__dirname, "../../dev-server/server.js"));
-  const plugins = require(path.join(
-    __dirname,
-    "../../dev-server/server-plugins.js"
-  ));
-  const routes = require(path.join(
-    __dirname,
-    "../../dev-server/routes/routes.js"
-  ));
-  await server.register(plugins);
-  server.views({
-    engines: {
-      html: {
-        compile: (src, options) => {
-          const template = Nunjucks.compile(src, options.environment);
-          return (context) => {
-            return template.render(context);
-          };
-        },
-
-        prepare: (options, next) => {
-          options.compileOptions.environment = Nunjucks.configure(
-            options.path,
-            { watch: false }
-          );
-          return next();
-        },
-      },
-    },
-    path: `${path.join(__dirname, "../../dev-server/views")}`,
-  });
-
-  server.route(routes);
-
-  await server.start();
-
-  console.log("Server running at: ", server.info.uri);
-  console.log(`Target being used: ${process.env.TARGET || "nzz_ch"}`);
-  console.log(
-    `Tool base url being used: ${
-      process.env.TOOL_BASE_URL || "http://localhost:3000"
-    }`
-  );
-  if (process.env.CONFIG) {
-    console.log(`Config module will be loaded from: ${process.env.CONFIG}`);
-  }
-}
-
-module.exports = async function (command) {
-  if (command.port) {
-    process.env.PORT = command.port;
-  }
-
-  if (command.target) {
-    process.env.TARGET = command.target;
-  }
-
-  if (command.toolBaseUrl) {
-    process.env.TOOL_BASE_URL = command.toolBaseUrl;
-  }
-
-  if (command.config) {
-    if (path.isAbsolute(command.config)) {
-      process.env.CONFIG = command.config;
-    } else {
-      process.env.CONFIG = path.join(process.cwd(), command.config);
-    }
-  } else {
-    process.env.CONFIG = path.join(
-      __dirname,
-      "../../dev-server/config/default.js"
-    );
-  }
-
-  await startServer();
-};

package/bin/q.js

@@ -1,213 +0,0 @@
-#!/usr/bin/env node
-
-const { program } = require("commander");
-const chalk = require("chalk");
-const errorColor = chalk.red;
-const version = require("../package.json").version;
-const runServer = require("./commands/server.js");
-const bootstrap = require("./commands/bootstrap.js");
-const updateItem = require("./commands/qItem/updateItem/updateItem.js");
-const copyItem = require("./commands/qItem/copyItem/copyItem.js");
-const createCustomCodeItem = require("./commands/qItem/createCustomCodeItem/createCustomCodeItem.js");
-
-async function main() {
-  program.version(version).description("Q Toolbox cli");
-
-  program
-    .command("server")
-    .option("-p, --port [port]", "the port to start the server on")
-    .option(
-      "-t, --target [target]",
-      "the target being used for rendering info route"
-    )
-    .option(
-      "-b, --tool-base-url [url]",
-      "the tool base url being set in rendering info route"
-    )
-    .option(
-      "-c, --config [config]",
-      "the config file name in which additional rendering info and tool runtime config is specified"
-    )
-    .description("start a simple server mocking a Q server for development")
-    .action(async (command) => {
-      await runServer(command);
-    });
-
-  program
-    .command("new-server")
-    .option(
-      "-d, --dir [path]",
-      "the base directory to bootstrap the new Q server implementation in, defaults to the name of Q server implementation"
-    )
-    .description("bootstrap a new Q server implementation")
-    .action(async (command) => {
-      const name = command.args[0];
-      if (!name) {
-        console.error(errorColor("no servername given"));
-        process.exit(1);
-      }
-      const baseDir = program.dir || name;
-      const textReplacements = [
-        { regex: new RegExp(`server-skeleton`, "g"), replaceWith: name },
-      ];
-
-      await bootstrap("server", baseDir, textReplacements);
-    });
-
-  program
-    .command("new-tool")
-    .option(
-      "-d, --dir <path>",
-      "the base directory to bootstrap the new tool in, defaults to the tools name"
-    )
-    .description("bootstrap a new tool")
-    .action(async (command) => {
-      let name = command.args[0];
-
-      if (!name) {
-        console.error(errorColor("no toolname given"));
-        process.exit(1);
-      }
-
-      // Make sure the name matches the spec.
-      if (!name.match(/^(Q-|q-)\w+/g)) {
-        console.error(errorColor("Tool must be named according to this format: Q-[a-z+]"));
-        process.exit(1);
-      }
-
-      // Capitalize first letter.
-      name = name[0].toUpperCase() + name.substring(1).toLowerCase();
-
-      let nameNodashes = name.replace(/\-/g, '');
-      toolnameCamelCase = nameNodashes[0].toUpperCase() + nameNodashes[1].toUpperCase() + nameNodashes.substring(2);
-
-      const baseDir = program.dir || name;
-      const textReplacements = [
-        // deprecated.
-        { regex: /tool-skeleton/g, replaceWith: name },
-
-        // Replace all instance of tool name with underscore.
-        { regex: /\[tool_name\]/g, replaceWith: name.toLowerCase().replace(/\-/g, '_') },
-
-        // Replace all instances with minuses.
-        { regex: /\[Tool-name\]/g, replaceWith: name },
-        { regex: /\[tool-name\]/g, replaceWith: name.toLowerCase() },
-
-        // Replace all CamelCase instances.
-        { regex: /\[ToolName\]/g, replaceWith: toolnameCamelCase},
-      ];
-
-      await bootstrap("toolv2", baseDir, textReplacements);
-    });
-
-  program
-    .command("new-custom-code")
-    .option(
-      "-d, --dir <path>",
-      "the base directory to bootstrap the new tool in, defaults to the tools name"
-    )
-    .description("bootstrap a new custom code project")
-    .action(async () => {
-      const name = program.args[1];
-      if (!name) {
-        console.error(errorColor("no custom-code projectname given"));
-        process.exit(1);
-      }
-      const baseDir = program.dir || name;
-      const textReplacements = [
-        { regex: new RegExp(`custom-code-skeleton`, "g"), replaceWith: name },
-      ];
-
-      await bootstrap("custom-code", baseDir, textReplacements);
-    });
-
-  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(async () => {
-      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"
-    )
-    .option("-r, --reset", "reset stored configuration properties")
-    .action(async (command) => {
-      await 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"
-    )
-    .option("-r, --reset", "reset stored configuration properties")
-    .action(async (command) => {
-      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"
-    )
-    .option("-r, --reset", "reset stored configuration properties")
-    .action(async (command) => {
-      await createCustomCodeItem(command);
-    });
-
-  await program.parseAsync(process.argv);
-}
-
-main();

package/dev-server/config/default.js

@@ -1,51 +0,0 @@
-async function getConfig() {
-  return {
-    nzz_ch: {
-      additionalRenderingInfo: {
-        // additionalRenderingInfo is tool based
-        stylesheets: [
-          {
-            url:
-              "https://service.sophie.nzz.ch/bundle/sophie-q@1,sophie-font@1,sophie-color@1,sophie-viz-color@1,sophie-legend@1,sophie-input@1.css"
-          }
-        ]
-      },
-      context: {
-        // context is target based
-        stylesheets: [
-          {
-            url: "https://context-service.st.nzz.ch/stylesheet/all/nzz.ch.css"
-          }
-        ],
-        background: {
-          color: "#fff"
-        }
-      },
-      toolRuntimeConfig: {}
-    },
-    nzzas: {
-      additionalRenderingInfo: {
-        stylesheets: [
-          {
-            url:
-              "https://service.sophie.nzz.ch/bundle/sophie-nzzas-q@1,sophie-nzzas-font@1,sophie-nzzas-color@1,sophie-nzzas-viz-color@1,sophie-nzzas-input@1.css"
-          }
-        ]
-      },
-      context: {
-        stylesheets: [
-          {
-            url:
-              "https://context-service.st.nzz.ch/stylesheet/all/nzzas.nzz.ch.css"
-          }
-        ],
-        background: {
-          color: "#fff"
-        }
-      },
-      toolRuntimeConfig: {}
-    }
-  };
-}
-
-module.exports = getConfig;

package/dev-server/public/style.css

@@ -1,64 +0,0 @@
-body {
-  margin: 0;
-  padding: 0;
-  margin-top: 30px;
-}
-@media (min-width: 768px) {
-  body {
-    min-width: 100% !important;
-  }
-  .l--holder {
-    padding: 0;
-    margin: 0;
-    width: 100%;
-  }
-}
-.fixtures__container {
-  display: flex;
-  position: fixed;
-  height: 30px;
-  width: 100%;
-  top: 0;
-  z-index: 1000;
-}
-.fixtures__select {
-  font-family: nzz-sans-serif, Helvetica, Arial;
-  font-size: 13px;
-  font-weight: 500;
-  height: 100%;
-  line-height: 30px;
-  width: 100%;
-  padding: 0px 10px;
-  outline: none;
-  border-radius: 0;
-  border: 1px solid transparent;
-  color: #fff;
-  cursor: pointer;
-  appearance: none;
-  -webkit-appearance: none;
-  -moz-appearance: none;
-  background-color: #13175f;
-  background-position: calc(100% - 10px) 11px;
-  background-repeat: no-repeat;
-  background-image: url("data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTFweCIgaGVpZ2h0PSI3cHgiIHZpZXdCb3g9IjAgMCAxMSA3IiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPg0KICAgIDxnIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPg0KICAgICAgICA8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgtNjAyLCAtMTIyNikiIGZpbGw9IiNGRkYiPg0KICAgICAgICAgICAgPGcgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoNDY4LCAxMjA3KSI+DQogICAgICAgICAgICAgICAgPHBvbHlnb24gcG9pbnRzPSIxMzUuMDU5IDE5IDEzNCAyMC4wNjQgMTM5LjA3NCAyNS4xMjEgMTQ0LjEyMSAyMC4wOTEgMTQzLjA2MyAxOS4wMjggMTM5LjA3NCAyMy4wMDQiPjwvcG9seWdvbj4NCiAgICAgICAgICAgIDwvZz4NCiAgICAgICAgPC9nPg0KICAgIDwvZz4NCjwvc3ZnPg==");
-}
-.fixtures__reload-button {
-  font-size: 13px;
-  font-family: nzz-sans-serif, Helvetica, Arial;
-  font-weight: 500;
-  display: flex;
-  flex-flow: row nowrap;
-  justify-content: center;
-  align-items: center;
-  box-sizing: border-box;
-  height: 30px;
-  padding: 0 10px;
-  color: #fff;
-  background-color: #13175f;
-  border-width: 0px;
-  border-radius: 0px;
-}
-.fixtures__select:hover,
-.fixtures__reload-button:hover {
-  background-color: #2c32bd;
-}