@nzz/q-cli 1.9.2 → 1.9.4

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@nzz/q-cli",
-  "version": "1.9.2",
+  "version": "1.9.4",
+  "prettier": "@nzz/et-utils-config-prettier",
   "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": {
@@ -21,7 +22,7 @@
   "homepage": "https://github.com/nzzdev/Q-cli#readme",
   "dependencies": {
     "@hapi/boom": "^9.1.1",
-    "@hapi/hapi": "^20.1.3",
+    "@hapi/hapi": "^20.3.0",
     "@hapi/inert": "^6.0.3",
     "@hapi/mimos": "^5.0.0",
     "@hapi/vision": "^6.1.0",
@@ -30,14 +31,17 @@
     "chalk": "^4.1.1",
     "commander": "^5.1.0",
     "configstore": "^5.0.1",
-    "deepmerge": "^4.2.2",
+    "deepmerge": "^4.3.1",
     "form-data": "^3.0.0",
     "fs-extra": "^9.0.1",
     "image-size": "^0.8.3",
-    "joi": "^17.4.0",
-    "node-fetch": "^2.6.1",
+    "joi": "^17.9.1",
+    "node-fetch": "^2.6.9",
     "nunjucks": "^3.2.2",
     "promptly": "^3.2.0",
     "replace-in-file": "^3.4.4"
+  },
+  "devDependencies": {
+    "@nzz/et-utils-config-prettier": "^1.0.6"
   }
 }

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

@@ -1,8 +1,10 @@
 {
   "name": "custom-code-skeleton",
   "version": "1.0.0",
+  "prettier": "@nzz/et-utils-config-prettier",
   "devDependencies": {
-    "@nzz/nzz.ch-static": "github:nzzdev/ed-tech-nzz.ch-static#v1.0.0",
+    "@nzz/et-utils-config-prettier": "^1.0.6",
+    "@nzz/nzz.ch-static": "github:nzzdev/ed-tech-nzz.ch-static#v1.2.0",
     "@nzz/q-cli": "^1.4.11",
     "@rollup/plugin-alias": "^3.1.9",
     "@rollup/plugin-commonjs": "^21.0.0",
@@ -23,7 +25,7 @@
     "rollup-plugin-terser": "^7.0.2",
     "sass": "^1.43.4",
     "sirv-cli": "^1.0.12",
-    "svelte": "^3.43.1",
+    "svelte": "^3.57.0",
     "svelte-preprocess": "^4.10.7",
     "typescript": "^4.6.4"
   },
@@ -37,7 +39,8 @@
     "start-regular": "LAYOUT=regular run-p serve rollup",
     "start-ls": "LAYOUT=longform-standard run-p serve rollup",
     "start-lv": "LAYOUT=longform-visual run-p serve rollup",
+    "start-hlv": "LAYOUT=headless-longform-visual run-p serve rollup",
     "rollup": "rollup -c -w",
     "serve": "sirv public --dev --port 5555 --host 0.0.0.0"
   }
-}
+}

package/skeletons/custom-code-skeleton/rollup.config.js

@@ -1,22 +1,28 @@
-import * as fs from "fs";
-import * as path from "path";
-import nodeResolve from "@rollup/plugin-node-resolve";
-import commonjs from "@rollup/plugin-commonjs";
-import json from "@rollup/plugin-json";
-import html from "@rollup/plugin-html";
-import svelte from "rollup-plugin-svelte";
-import { terser } from "rollup-plugin-terser";
-import livereload from "rollup-plugin-livereload";
-import scss from "rollup-plugin-scss";
-import postcss from "postcss";
-import cssnano from "cssnano";
-import autoprefixer from "autoprefixer";
-import qConfig from "./q.config.json";
+import * as fs from 'fs';
+import * as path from 'path';
+import nodeResolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+import html from '@rollup/plugin-html';
+import svelte from 'rollup-plugin-svelte';
+import { terser } from 'rollup-plugin-terser';
+import livereload from 'rollup-plugin-livereload';
+import scss from 'rollup-plugin-scss';
+import postcss from 'postcss';
+import cssnano from 'cssnano';
+import autoprefixer from 'autoprefixer';
+import qConfig from './q.config.json';
 import typescript from '@rollup/plugin-typescript';
 import image from '@rollup/plugin-image';
 import alias from '@rollup/plugin-alias';
 import sveltePreprocess from 'svelte-preprocess';
-import { createContentWidthQElement, createFullwidthQElement, getHtml, createSubtitle, createParagraph  } from '@nzz/nzz.ch-static';
+import {
+  createContentWidthQElement,
+  createFullwidthQElement,
+  getHtml,
+  createSubtitle,
+  createParagraph,
+} from '@nzz/nzz.ch-static';
 
 // Which nzz layout to use?
 const LAYOUT = process.env.LAYOUT;
@@ -29,10 +35,10 @@ function getOutputConfigs() {
   const outputConfigs = [];
   for (let item of qConfig.items) {
     for (let environment of item.environments) {
-      if (environment.id !== "") {
+      if (environment.id !== '') {
         outputConfigs.push({
           sourcemap: production ? false : true,
-          format: "iife",
+          format: 'iife',
           name: `window._q_custom_code_${environment.id}.App`,
           file: `public/bundle-${environment.id}.js`,
         });
@@ -45,40 +51,40 @@ function getOutputConfigs() {
 
 function getHtmlOptions() {
   return {
-      fileName: 'index.html',
-      template: function (options) {
-          return getHtml({
-              // These 3 options are the most important. Without them the static website will not function.
-              layout: LAYOUT, // Type of layout.
-              builtCssFilename, // Will be appended at the end of <head>.
-              builtJsFilename: options.files.js[0].fileName, // Will appended to the end of <body>.
-
-              // Create mock elements to simulate your article.
-              content: `
+    fileName: 'index.html',
+    template: function (options) {
+      return getHtml({
+        // These 3 options are the most important. Without them the static website will not function.
+        layout: LAYOUT, // Type of layout.
+        builtCssFilename, // Will be appended at the end of <head>.
+        builtJsFilename: options.files.js[0].fileName, // Will appended to the end of <body>.
+
+        // Create mock elements to simulate your article.
+        content: `
                   ${createSubtitle('Test Subtitle')}
                   ${createParagraph('Test paragraph')}
                   ${createFullwidthQElement('custom-code-fw')}
                   ${createContentWidthQElement('custom-code-cw')}
               `,
 
-              // Other options.
-              author: 'Max Musterman',
-              lead: 'Test lead.',
-              title: 'Test title',
-
-              // Links to other css files that need to be loaded.
-              // Will be appended to <head> but before the bundled css file of your app.
-              customCssLinks: [
-                  'https://service.sophie.nzz.ch/bundle/sophie-q@^1,sophie-input@^1,sophie-font@^1,sophie-color@^1,sophie-viz-color@^1,sophie-legend@^1.css',
-              ],
-
-              // Links to other js filed that need to be loaded.
-              // Will be appended at the end of the body, but before the built js file for the app.
-              customJsLinks: [
-                  'https://cdn.polyfill.io/v2/polyfill.min.js?features=Map,URL,Promise,fetch,URLSearchParams,Array.prototype.find,Array.prototype.findIndex,Object.entries,Array.prototype.includes,CustomEvent,Array.from,String.prototype.startsWith&flags=gated&unknown=polyfill'
-              ],
-          });
-      },
+        // Other options.
+        author: 'Max Musterman',
+        lead: 'Test lead.',
+        title: 'Test title',
+
+        // Links to other css files that need to be loaded.
+        // Will be appended to <head> but before the bundled css file of your app.
+        customCssLinks: [
+          'https://service.sophie.nzz.ch/bundle/sophie-q@^1,sophie-input@^1,sophie-font@^1,sophie-color@^1,sophie-viz-color@^1,sophie-legend@^1.css',
+        ],
+
+        // Links to other js filed that need to be loaded.
+        // Will be appended at the end of the body, but before the built js file for the app.
+        customJsLinks: [
+          'https://cdn.polyfill.io/v2/polyfill.min.js?features=Map,URL,Promise,fetch,URLSearchParams,Array.prototype.find,Array.prototype.findIndex,Object.entries,Array.prototype.includes,CustomEvent,Array.from,String.prototype.startsWith&flags=gated&unknown=polyfill',
+        ],
+      });
+    },
   };
 }
 
@@ -94,7 +100,7 @@ function getPostcssPlugins(isProduction) {
 
 function createOutputCssFunction() {
   const outputCssFunction = (styles, styleNodes) => {
-    const publicDir = "public";
+    const publicDir = 'public';
 
     if (!fs.existsSync(publicDir)) {
       fs.mkdirSync(publicDir);
@@ -108,14 +114,14 @@ function createOutputCssFunction() {
 
 function getSassConfig(isProduction) {
   const config = {
-    outputStyle: isProduction ? "compressed" : "expanded",
+    outputStyle: isProduction ? 'compressed' : 'expanded',
     // Sourcemap generation (specifically writing the file to system) is currently not supported by rollup-plugin-sass (but soon!)
     // See: https://github.com/thgh/rollup-plugin-scss/issues/7
     // outFile: path.join(__dirname, "/public/default.css"), // <- Uncomment after: https://github.com/thgh/rollup-plugin-scss/issues/7
     sourceMap: !isProduction,
     sourceMapEmbed: !isProduction, // Remove after: https://github.com/thgh/rollup-plugin-scss/issues/7
     failOnError: !isProduction,
-    watch: [path.join(__dirname, "/src")],
+    watch: [path.join(__dirname, '/src')],
     processor: (css) =>
       postcss(getPostcssPlugins(isProduction))
         .process(css, {
@@ -131,14 +137,15 @@ function getSassConfig(isProduction) {
 }
 
 export default {
-  input: production ? "src/main-prod.ts" : "src/main.ts",
+  input: production ? 'src/main-prod.ts' : 'src/main.ts',
   output: getOutputConfigs(),
   plugins: [
     alias({
       entries: [
         { find: '@src', replacement: path.resolve(projectRootDir, 'src') },
         { find: '@interfaces', replacement: path.resolve(projectRootDir, 'src/interfaces.ts') },
-      ]
+        { find: '@enums', replacement: path.resolve(projectRootDir, 'src/enums.ts') },
+      ],
     }),
 
     typescript({ sourceMap: !production }),
@@ -171,14 +178,14 @@ export default {
 
     // Watch the `public` directory and refresh the
     // browser on changes when not in production
-    !production && livereload({ watch: ["public"], delay: 800 }),
+    !production && livereload({ watch: ['public'], delay: 800 }),
     production && terser(),
   ],
   watch: {
     clearScreen: false,
   },
   onwarn: function (warning, warn) {
-    if (warning.code === "CIRCULAR_DEPENDENCY") return;
+    if (warning.code === 'CIRCULAR_DEPENDENCY') return;
     warn(warning);
   },
 };

package/skeletons/custom-code-skeleton/src/main-prod.ts

@@ -1,4 +1,4 @@
 // file is used for the production since the initializing of the app will happen in Q
-import App from "./App.svelte";
-import "./main.scss";
+import App from './App.svelte';
+import './main.scss';
 export default App;

package/skeletons/custom-code-skeleton/src/main.scss

@@ -1 +1 @@
-@use "App.scss";
+@use 'App.scss';

package/skeletons/custom-code-skeleton/src/main.ts

@@ -1,17 +1,17 @@
-import App from "./App.svelte";
-import "./main.scss";
+import App from './App.svelte';
+import './main.scss';
 
 const app = new App({
-  target: document.querySelector("#custom-code-fw"),
+  target: document.querySelector('#custom-code-fw'),
   props: {
-    name: "custom-code-skeleton - Fullwidth",
+    name: 'custom-code-skeleton - Fullwidth',
   },
 });
 
 new App({
-  target: document.querySelector("#custom-code-cw"),
+  target: document.querySelector('#custom-code-cw'),
   props: {
-    name: "custom-code-skeleton - Content Width",
+    name: 'custom-code-skeleton - Content Width',
   },
 });
 

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

@@ -9,7 +9,8 @@
     "declaration": false,
     "paths": {
       "@src": ["./src/"],
-      "@interfaces": ["./src/interfaces.ts"]
+      "@interfaces": ["./src/interfaces.ts"],
+      "@enums": ["./src/enums.ts"]
     }
   }
 }

package/.history/bin/commands/qItem/itemService_20220627113036.js

@@ -1,302 +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 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,
-};