@nzz/q-cli 1.6.0 → 1.8.0

package/bin/commands/qItem/itemService.js

@@ -0,0 +1,302 @@
+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 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/{updateItem/resourcesHelpers.js → qItem/resourcesService.js}

@@ -20,106 +20,6 @@ const path = require("path");
 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 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;
-}
-
 // 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
@@ -245,6 +145,4 @@ async function uploadResource(qServer, accessToken, cookie, resourcePath) {
 
 module.exports = {
   handleResources: handleResources,
-  getDefaultItem: getDefaultItem,
-  getToolSchema: getToolSchema,
 };

package/bin/commands/qItem/schemaService.js

@@ -0,0 +1,64 @@
+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 = {
+    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/{updateItem → qItem/updateItem}/updateItem.js

@@ -1,4 +1,6 @@
-const helpers = require("./helpers.js");
+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");
@@ -10,21 +12,24 @@ module.exports = async function (command) {
     const qConfigPath = path.resolve(command.config);
     if (fs.existsSync(qConfigPath)) {
       const qConfig = JSON.parse(fs.readFileSync(qConfigPath));
-      const validationResult = helpers.validateConfig(qConfig);
+      const validationResult = schemaService.validateConfig(qConfig);
+
       if (validationResult.isValid) {
-        const config = await helpers.setupConfig(
+        const config = await configStore.setupStore(
           qConfig,
           command.environment,
           command.reset
         );
-        for (const item of helpers.getItems(qConfig, command.environment)) {
+
+        for (const item of itemService.getItems(qConfig, command.environment)) {
           for (const environment of item.environments) {
-            const result = await helpers.updateItem(
+            const result = await itemService.updateItem(
               item.item,
               environment,
               config,
               qConfigPath
             );
+
             if (result) {
               console.log(
                 successColor(

package/bin/q.js

@@ -6,7 +6,8 @@ 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/updateItem/updateItem.js");
+const updateItem = require("./commands/qItem/updateItem/updateItem.js");
+const copyItem = require("./commands/qItem/copyItem/copyItem.js");
 
 async function main() {
   program.version(version).description("Q Toolbox cli");
@@ -45,7 +46,11 @@ async function main() {
         process.exit(1);
       }
       const baseDir = program.dir || name;
-      await bootstrap("server", name, baseDir);
+      const textReplacements = [
+        { regex: new RegExp(`${type}-skeleton`, "g"), replaceWith: name },
+      ];
+
+      await bootstrap("server", baseDir, textReplacements);
     });
 
   program
@@ -62,7 +67,11 @@ async function main() {
         process.exit(1);
       }
       const baseDir = program.dir || name;
-      await bootstrap("tool", name, baseDir);
+      const textReplacements = [
+        { regex: new RegExp(`${type}-skeleton`, "g"), replaceWith: name },
+      ];
+
+      await bootstrap("tool", baseDir, textReplacements);
     });
 
   program
@@ -79,7 +88,42 @@ async function main() {
         process.exit(1);
       }
       const baseDir = program.dir || name;
-      await bootstrap("custom-code", name, baseDir);
+      const textReplacements = [
+        { regex: new RegExp(`${type}-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
@@ -99,6 +143,23 @@ async function main() {
       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);
+    });
+
   await program.parseAsync(process.argv);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nzz/q-cli",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "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": {

package/skeletons/custom-code-skeleton/package.json

@@ -2,7 +2,7 @@
   "name": "custom-code-skeleton",
   "version": "1.0.0",
   "devDependencies": {
-    "@nzz/nzz.ch-static": "github:nzzdev/nzz.ch-static#v1.0.0",
+    "@nzz/nzz.ch-static": "github:nzzdev/ed-tech-nzz.ch-static#v1.0.0",
     "@nzz/q-cli": "^1.4.11",
     "@rollup/plugin-alias": "^3.1.9",
     "@rollup/plugin-commonjs": "^21.0.0",

package/skeletons/custom-code-skeleton/tsconfig.json

@@ -1,15 +1,15 @@
 {
-    "extends": "@tsconfig/svelte/tsconfig.json",
-    "include": ["src/**/*"],
-    "exclude": ["node_modules/*", "__sapper__/*", "public/*"],
-    "compilerOptions": {
-        "lib": ["es2015", "DOM"],
-        "types": ["svelte"],
-        "outDir": "public",
-        "declaration": false,
-        "paths": {
-            "@src": ["./src/"],
-            "@interfaces": ["./src/interfaces.ts"]
-        }
+  "extends": "@tsconfig/svelte/tsconfig.json",
+  "include": ["src/**/*"],
+  "exclude": ["node_modules/*", "__sapper__/*", "public/*"],
+  "compilerOptions": {
+    "lib": ["es2015", "DOM"],
+    "types": ["svelte"],
+    "outDir": "public",
+    "declaration": false,
+    "paths": {
+      "@src": ["./src/"],
+      "@interfaces": ["./src/interfaces.ts"]
     }
+  }
 }

package/skeletons/et-utils-package-skeleton/.nvmrc

@@ -0,0 +1 @@
+16

package/skeletons/et-utils-package-skeleton/README.md

@@ -0,0 +1,7 @@
+# @nzz/et-utils-<package-name>
+
+<package-description>
+
+## Content
+
+TODO: Package documentation