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

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

@@ -1,40 +0,0 @@
-{
-  "name": "@nzz/et-utils-<package-name>",
-  "version": "1.0.0",
-  "description": "<package-description>",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/nzzdev/ed-tech-utilities.git",
-    "directory": "<package-name>"
-  },
-  "scripts": {
-    "prepublishOnly": "npm run test && npm run clean && npm run buildMjs && npm run buildCjs && ./scripts/package-fixup.sh",
-    "clean": "rimraf dist",
-    "buildMjs": "tsc -p tsconfig.json",
-    "buildCjs": "tsc -p tsconfig-cjs.json",
-    "start": "npm run buildMjs -- -w",
-    "test": "jest --config jest.config.ts"
-  },
-  "main": "dist/cjs/index.js",
-  "module": "dist/mjs/index.js",
-  "exports": {
-    ".": {
-      "import": "./dist/mjs/index.js",
-      "require": "./dist/cjs/index.js"
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@types/jest": "^27.5.1",
-    "@types/node": "^16.11.36",
-    "jest": "^28.1.0",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^28.0.3",
-    "ts-node": "^10.8.0",
-    "typescript": "^4.6.4"
-  },
-  "author": "<author-name>",
-  "license": "MIT"
-}

package/skeletons/et-utils-package-skeleton/scripts/package-fixup.sh

@@ -1,13 +0,0 @@
-#Add external dependencies under 'dependencies'
-cat >dist/cjs/package.json <<!EOF
-{
-    "type": "commonjs"
-}
-!EOF
-
-#Add external dependencies under 'dependencies'
-cat >dist/mjs/package.json <<!EOF
-{
-    "type": "module"
-}
-!EOF

package/skeletons/et-utils-package-skeleton/src/Service.ts

@@ -1,8 +0,0 @@
-// Note: This is an example file
-function someFunction() {
-  const value = "Up, Up, Down, Down, Left, Right, Left, Right, B, A";
-
-  return value;
-}
-
-export { someFunction };

package/skeletons/et-utils-package-skeleton/src/index.ts

@@ -1,4 +0,0 @@
-// Note: Export all your code in here, that should be exposed to the consumer
-
-// e.g. Exports all exports of the Service.ts file
-export * from "./Service";

package/skeletons/et-utils-package-skeleton/test/Service.spec.ts

@@ -1,10 +0,0 @@
-import { someFunction } from "../src";
-
-describe("Service", () => {
-  it("should return the konami cheatcode", () => {
-    const result = someFunction();
-    const expectedResult = "Up, Up, Down, Down, Left, Right, Left, Right, B, A";
-
-    expect(result).toEqual(expectedResult);
-  });
-});

package/skeletons/et-utils-package-skeleton/test/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "compilerOptions": {
-    "moduleResolution": "node",
-    "types": ["jest", "node"],
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true
-  }
-}

package/skeletons/et-utils-package-skeleton/tsconfig-base.json

@@ -1,10 +0,0 @@
-{
-  "include": ["src/**/*"],
-  "exclude": ["test/**/*"],
-  "compilerOptions": {
-    "declaration": true,
-    "moduleResolution": "node"
-    // "esModuleInterop": true,
-    // "allowSyntheticDefaultImports": true,
-  }
-}

package/skeletons/et-utils-package-skeleton/tsconfig-cjs.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig-base.json",
-  "compilerOptions": {
-    "module": "commonjs",
-    "outDir": "dist/cjs",
-    "target": "es2015"
-  }
-}

package/skeletons/et-utils-package-skeleton/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig-base.json",
-  "compilerOptions": {
-    "module": "esnext",
-    "outDir": "dist/mjs",
-    "target": "es6"
-  }
-}

package/skeletons/server-skeleton/.nvmrc

@@ -1 +0,0 @@
-14

package/skeletons/server-skeleton/Dockerfile

@@ -1,19 +0,0 @@
-# Use following version of node alpine as the base image
-FROM node:14-alpine
-
-# Set work directory for run/cmd
-WORKDIR /app
-
-# Copy package.json and package-lock.json into work directory and install dependencies
-COPY package.json /app/package.json
-COPY package-lock.json /app/package-lock.json
-RUN npm install --production
-
-# Copy everthing else in work directory
-COPY . /app
-
-# Expose server port
-EXPOSE 3001
-
-# Run node
-CMD node index.js

package/skeletons/server-skeleton/auth/routes.js

@@ -1,85 +0,0 @@
-const Joi = require("joi");
-const Boom = require("@hapi/boom");
-
-module.exports = [
-  {
-    path: "/authenticate",
-    method: "POST",
-    options: {
-      validate: {
-        payload: {
-          username: Joi.string().required(),
-          password: Joi.string().required(),
-        },
-      },
-    },
-    handler: async (request, h) => {
-      if (
-        request.payload.username === "demo-user" ||
-        request.payload.username === "demo-expert" ||
-        request.payload.username === "demo-poweruser"
-      ) {
-        return {
-          access_token: request.payload.username,
-        };
-      }
-    },
-  },
-  {
-    path: "/user",
-    method: "GET",
-    config: {
-      auth: "q-auth",
-    },
-    handler: (request, h) => {
-      if (!request.auth.isAuthenticated) {
-        throw Boom.unauthorized();
-      }
-
-      const user = {
-        username: request.auth.credentials.name,
-        department: "Politics",
-        publication: "pub1",
-        initials: "🤖",
-      };
-
-      if (
-        user.username === "demo-expert" ||
-        user.username === "demo-poweruser"
-      ) {
-        user.roles = [
-          "expert-election-executive",
-          "expert-election-votes",
-          "expert-election-seats",
-          "expert-map",
-          "expert-chart",
-          "expert-coalition-calculation",
-        ];
-      }
-
-      if (user.username === "demo-poweruser") {
-        user.roles.push("poweruser");
-      }
-
-      return user;
-    },
-  },
-  {
-    path: "/user",
-    method: "PUT",
-    config: {
-      auth: "q-auth",
-      validate: {
-        payload: {
-          username: Joi.string().required(),
-        },
-        options: {
-          allowUnknown: true,
-        },
-      },
-    },
-    handler: async (request, h) => {
-      return "ok";
-    },
-  },
-];

package/skeletons/server-skeleton/auth/strategyOptions.js

@@ -1,28 +0,0 @@
-module.exports = {
-  allowQueryToken: false, // optional, true by default
-  allowMultipleHeaders: false, // optional, false by default
-  accessTokenName: "access_token", // optional, 'access_token' by default
-  validate: async function (request, token, h) {
-    const user = {};
-
-    if (token.includes("demo-user")) {
-      user.name = "demo-user";
-    } else if (token.includes("demo-expert")) {
-      user.name = "demo-expert";
-    } else if (token.includes("demo-poweruser")) {
-      user.name = "demo-poweruser";
-    } else {
-      return {
-        isValid: false,
-      };
-    }
-
-    user.token = token;
-    user.email = user.name + "@q.tools";
-
-    return {
-      isValid: true,
-      credentials: user,
-    };
-  },
-};

package/skeletons/server-skeleton/config/base.js

@@ -1,45 +0,0 @@
-const Confidence = require("confidence");
-
-const base = {
-  cache: {
-    cacheControl: {
-      // these are the default cache-control headers used for the tool-default route in case a tool is not responding with it's own directives.
-      public: true,
-      maxAge: {
-        $filter: "env",
-        local: 1,
-        $default: 60
-      },
-      sMaxAge: {
-        $filter: "env",
-        local: 1,
-        $default: 60
-      },
-      staleWhileRevalidate: {
-        // this is just for the CDN, it will serve maximum 24 hours old content while revalidating in the background
-        $filter: "env",
-        local: 1,
-        $default: 60 * 60 * 24
-      },
-      staleIfError: {
-        // this is just for the CDN, it will serve maximum 7 days old content if the backend is not running
-        $filter: "env",
-        local: 1,
-        $default: 60 * 60 * 24 * 7
-      }
-    }
-  }
-};
-
-const env = process.env.APP_ENV || "local";
-const store = new Confidence.Store(base);
-
-module.exports.get = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.get(key, criteria);
-};
-
-module.exports.meta = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.meta(key, criteria);
-};

package/skeletons/server-skeleton/config/db.js

@@ -1,6 +0,0 @@
-module.exports = {
-  host: process.env.COUCH_HOST,
-  database: process.env.COUCH_DB,
-  user: process.env.COUCH_USER,
-  pass: process.env.COUCH_PASS
-};

package/skeletons/server-skeleton/config/editor.js

@@ -1,105 +0,0 @@
-const Confidence = require("confidence");
-
-const editorConfig = {
-  auth: {
-    type: "token"
-  },
-  languages: [
-    {
-      key: "en",
-      label: "en"
-    },
-    {
-      key: "de",
-      label: "de"
-    },
-    {
-      key: "fr",
-      label: "fr"
-    }
-  ],
-  departments: ["Economics", "Politics"],
-  publications: [
-    {
-      key: "pub1",
-      label: "Publication 1",
-      previewTarget: "target1"
-    }
-  ],
-  lowNewItems: {
-    threshold: 1,
-    days: 365
-  },
-  itemList: {
-    itemsPerLoad: 18
-  },
-  help: {
-    intro: "This is the Q editor. Just click around to learn how it works.",
-    faq: [
-      {
-        question: "What is Q?",
-        answer:
-          "Q is a browser-based toolbox that allows reporters and editors to create simple graphics and interactive elements for their stories."
-      }
-    ]
-  },
-  stylesheets: [
-    {
-      // Roboto is used in Q editor
-      url: "https://fonts.googleapis.com/css?family=Roboto:400,700&subset=latin"
-    }
-    // if needed add some stylesheets here for preview, e.g. font-faces which do not work in ShadowRoot
-  ],
-  uiBehavior: {
-    useItemDialogToActivate: false
-  },
-  eastereggs: {
-    sounds: {
-      m: "",
-      q: "",
-      bondTheme: ""
-    }
-  },
-  previewSizes: {
-    small: {
-      value: 290,
-      min_height: 568,
-      label_locales: {
-        de: "Mobile",
-        en: "Mobile",
-        fr: "Mobile"
-      }
-    },
-    medium: {
-      value: 560,
-      min_height: 768,
-      label_locales: {
-        de: "Artikelbreite",
-        en: "Content",
-        fr: "Content"
-      }
-    },
-    large: {
-      value: 800,
-      min_height: 768,
-      label_locales: {
-        de: "Volle Breite",
-        en: "Full",
-        fr: "Complet"
-      }
-    }
-  }
-};
-
-const env = process.env.APP_ENV || "local";
-const store = new Confidence.Store(editorConfig);
-
-module.exports.get = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.get(key, criteria);
-};
-
-module.exports.meta = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.meta(key, criteria);
-};

package/skeletons/server-skeleton/config/rendering-info.js

@@ -1,70 +0,0 @@
-const Confidence = require("confidence");
-
-const renderingInfoConfig = {
-  cache: {
-    cacheControl: {
-      // these are the default cache-control headers in case a tool is not responding with it's own directives.
-      maxAge: {
-        $filter: "env",
-        local: 1,
-        $default: 60
-      },
-      sMaxAge: {
-        $filter: "env",
-        local: 1,
-        $default: 60
-      },
-      staleWhileRevalidate: {
-        // this is just for the CDN, it will serve maximum 24 hours old content while revalidating in the background
-        $filter: "env",
-        local: 1,
-        $default: 60 * 60 * 24
-      },
-      staleIfError: {
-        // this is just for the CDN, it will serve maximum 7 days old content if the backend is not running
-        $filter: "env",
-        local: 1,
-        $default: 60 * 60 * 24 * 7
-      }
-    }
-  },
-  toolRuntimeConfig: {
-    toolBaseUrl: {
-      $filter: "env",
-      local: {
-        protocol: "http",
-        host: "localhost:3001",
-        path: {
-          $filter: "tool",
-          default: undefined,
-          chart: "/tools/chart"
-        }
-      },
-      staging: {
-        protocol: "https",
-        host: "q-staging.example.com"
-      },
-      production: {
-        protocol: "https",
-        host: "q.example.com"
-      },
-      playground: {
-        protocol: "https",
-        host: "q-playground.example.com"
-      }
-    }
-  }
-};
-
-const env = process.env.APP_ENV || "local";
-const store = new Confidence.Store(renderingInfoConfig);
-
-module.exports.get = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.get(key, criteria);
-};
-
-module.exports.meta = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.meta(key, criteria);
-};

package/skeletons/server-skeleton/config/screenshot.js

@@ -1,80 +0,0 @@
-const Confidence = require("confidence");
-
-// used in screenshot plugin
-function resolvePath(resource, env) {
-  if (!resource.url && resource.path) {
-    resource.url = `${process.env.Q_SERVER_BASE_URL}${resource.path}`;
-  }
-  delete resource.path;
-  return resource;
-}
-
-const screenshot = {
-  getScripts: function(renderingInfo) {
-    const scripts = [];
-    if (
-      renderingInfo.loaderConfig &&
-      renderingInfo.loaderConfig.loadSystemJs === "full"
-    ) {
-      scripts.push({ url: `${process.env.Q_SERVER_BASE_URL}/files/system.js` });
-    }
-    if (renderingInfo.scripts && Array.isArray(renderingInfo.scripts)) {
-      for (let script of renderingInfo.scripts) {
-        script = resolvePath(script);
-        scripts.push(script);
-      }
-    }
-    return scripts;
-  },
-  getStylesheets: function(renderingInfo) {
-    const stylesheets = [];
-    if (renderingInfo.stylesheets && Array.isArray(renderingInfo.stylesheets)) {
-      for (let stylesheet of renderingInfo.stylesheets) {
-        stylesheet = resolvePath(stylesheet);
-        stylesheets.push(stylesheet);
-      }
-    }
-    return stylesheets;
-  },
-  cache: {
-    cacheControl: {
-      // these cache control directives are sent in the cache-control header of the response to screenshot api
-      maxAge: {
-        $filter: "env",
-        local: 1,
-        $default: 60
-      },
-      sMaxAge: {
-        // this is just for the CDN, it will mark screenshots as stale after 24 hours. we use keycdn plugin to purge it on item.update
-        $filter: "env",
-        local: 1,
-        $default: 60 * 60 * 24
-      },
-      staleWhileRevalidate: {
-        // this is just for the CDN, it will serve maximum 7 days old content while revalidating in the background
-        $filter: "env",
-        local: 1,
-        $default: 60 * 60 * 24 * 7
-      },
-      staleIfError: {
-        // this is just for the CDN, it will serve maximum 7 days old content if the backend is responding with an error
-        $filter: "env",
-        local: 1,
-        $default: 60 * 60 * 24 * 7
-      }
-    }
-  }
-};
-
-const env = process.env.APP_ENV || "local";
-const store = new Confidence.Store(screenshot);
-
-module.exports.get = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.get(key, criteria);
-};
-
-module.exports.meta = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.meta(key, criteria);
-};

package/skeletons/server-skeleton/config/targets.js

@@ -1,31 +0,0 @@
-const Confidence = require("confidence");
-
-const targets = {
-  target1: {
-    label: "Target 1",
-    type: "web",
-    context: {
-      stylesheets: [
-        {
-          url: "https://example.com/stylesheet-for-preview.css"
-        }
-      ],
-      background: {
-        color: "white"
-      }
-    }
-  }
-};
-
-const env = process.env.APP_ENV || "local";
-const store = new Confidence.Store(targets);
-
-module.exports.get = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.get(key, criteria);
-};
-
-module.exports.meta = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.meta(key, criteria);
-};

package/skeletons/server-skeleton/config/tools.js

@@ -1,65 +0,0 @@
-const Confidence = require("confidence");
-
-const tool1_editor_config = {
-  label_locales: {
-    de: "Beispiel-Tool",
-    en: "example tool"
-  },
-  icon:
-    '<svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><g fill="#000" fill-rule="evenodd"><path d="M5.706 30.294a.996.996 0 0 1-1.412 0l-2.588-2.588a.995.995 0 0 1 0-1.412L19 9l4 4L5.706 30.294zM11 7l4 4-4 4-4-4H5c-1.112 0-2.632-.632-3.41-1.41L1 9 0 6l1-1 3 3 4-4-3-3 1-1 3 1 .59.59C10.366 2.366 11 3.894 11 5v2zM21 25l-4-4 4-4 4 4h2c1.112 0 2.632.632 3.41 1.41L31 23l1 3-1 1-3-3-4 4 3 3-1 1-3-1-.59-.59C21.634 29.634 21 28.106 21 27v-2zM19 1h4l9 9-5 5L16 4z"/></g></svg>'
-};
-
-const tools = {
-  $filter: "env",
-  local: {
-    tool1: {
-      // tool name
-      baseUrl: "http://localhost:3000",
-      editor: tool1_editor_config,
-      endpoint: {
-        $filter: "target",
-        $default: false,
-        target1: {
-          // target name
-          path: "/rendering-info/web",
-          additionalRenderingInfo: {
-            // if needed you can add tool specific stylesheets here, delete otherwise
-            // further scripts can be added in a similar manner too
-            stylesheets: [
-              {
-                url: "https://example.com/tool-specific-stylesheet.css" // add some url to a stylesheet here
-              },
-              {
-                content: "h2, p {color: darkgray}" // add some css here
-              }
-            ]
-          },
-          toolRuntimeConfig: {
-            // if needed add further properties here which the tool needs at runtime
-          }
-        },
-        target2: {
-          url: "https://some-other-service.example.com/rendering-info" // you can use a url to use an external service providing the rendering information
-        }
-      }
-    }
-  }
-};
-
-const env = process.env.APP_ENV || "local";
-const store = new Confidence.Store(tools);
-
-module.exports.get = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.get(key, criteria);
-};
-
-module.exports.load = async function() {
-  // if needed you could add further async loaded configs here
-  store.load(tools);
-};
-
-module.exports.meta = (key, criteria = {}) => {
-  criteria = Object.assign({ env: env }, criteria);
-  return store.meta(key, criteria);
-};