@hahnpro/flow-cli 2.9.0 → 2.12.1

package/lib/utils.mjs

@@ -0,0 +1,197 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+const defaultLogger = {
+  /* eslint-disable no-console */
+  log: console.log,
+  error: console.error,
+  ok: console.info,
+  /* eslint-enable no-console */
+};
+
+export function checkTypes(definedTypes, propertiesSchema, jsonPath, logger = defaultLogger) {
+  const knownTypes = new Set([
+    ...definedTypes,
+    'string',
+    'undefined',
+    'number',
+    'boolean',
+    'any',
+    'object',
+    'array',
+    'integer',
+    'Asset',
+    'AssetType',
+    'Flow',
+    'Secret',
+    'TimeSeries',
+  ]);
+
+  // check if all types are known
+  const properties = propertiesSchema.properties || {};
+  for (const property of Object.keys(properties)) {
+    if (properties[property].type && !knownTypes.has(properties[property].type)) {
+      logger.error(
+        `ERROR: unknown type ${properties[property].type}.
+       Please add a schema for this type in ${jsonPath}
+       for more info check the documentation`,
+      );
+      return false;
+    }
+  }
+  return true;
+}
+
+export async function getTypes(filePath) {
+  try {
+    const json = JSON.parse(await fs.readFile(path.join(process.cwd(), filePath)));
+    return json.definitions ? Object.keys(json.definitions) : [];
+  } catch {
+    return [];
+  }
+}
+
+export async function handleConvertedOutput(result, jsonPath, json, logger = defaultLogger) {
+  let schema;
+  try {
+    schema = JSON.parse(result);
+  } catch {
+    logger.error(result);
+    return json;
+  }
+
+  const values = [
+    ['propertiesSchema', 'Properties'],
+    ['inputStreams', 'InputProperties'],
+    ['outputStreams', 'OutputProperties'],
+  ];
+
+  for (const value of values) {
+    const propertiesSchema = schema[value[1]] || {};
+    for (const requestProperty of propertiesSchema.required || []) {
+      propertiesSchema.properties[requestProperty] = { ...propertiesSchema.properties[requestProperty], required: true };
+    }
+    // remove required field
+    delete propertiesSchema.required;
+
+    const types = await getTypes(jsonPath);
+    checkTypes(types, propertiesSchema, jsonPath);
+
+    const completeSchema = {
+      schema: {
+        type: 'object',
+        properties: {
+          ...propertiesSchema.properties,
+        },
+      },
+    };
+
+    if (value[0] === 'propertiesSchema') {
+      if (!json['propertiesSchema']) {
+        json['propertiesSchema'] = completeSchema;
+      }
+    } else {
+      // check if config for default input/output stream exists
+      if (!json[value[0]].some((v) => v.name === 'default') && propertiesSchema) {
+        json[value[0]].push({
+          name: 'default',
+          ...completeSchema,
+        });
+      }
+    }
+  }
+
+  // add definitions
+  if (Object.keys(schema).some((key) => !['Properties', 'InputProperties', 'OutputProperties'].includes(key))) {
+    const typeDefinitions = Object.keys(schema).filter((key) => !['Properties', 'InputProperties', 'OutputProperties'].includes(key));
+    json.definitions = typeDefinitions.reduce((previousValue, currentValue) => {
+      const additionalSchema = schema[currentValue];
+      for (const requestProperty of additionalSchema.required || []) {
+        additionalSchema.properties[requestProperty] = { ...additionalSchema.properties[requestProperty], required: true };
+      }
+      delete additionalSchema.required;
+      previousValue[currentValue] = additionalSchema;
+      return previousValue;
+    }, {});
+  }
+  return json;
+}
+
+export function prepareTsFile(file) {
+  // if a class extends another and does not have its own fields no metadata is generated and so no schema can be generated
+  // in this case replace empty block with the block it inherits from
+  let codeBlocks = getCodeBlocks(file);
+  const emptyExtendsBlock = codeBlocks.find((block) => blockDefinitionIncludes(block, 'extends') && isBlockEmpty(block));
+  if (emptyExtendsBlock) {
+    // replace block and remove extends
+    let replBlock = `${emptyExtendsBlock}`;
+    if (replBlock.replace(/\s\s+/g, ' ').trim().startsWith('class OutputProperties')) {
+      // remove extends
+      replBlock = replBlock.replace('extends InputProperties', '');
+      // replace block with InputProperties block
+      const inputPropertiesBlock = codeBlocks.find(
+        (v) => blockDefinitionIncludes(v, 'InputProperties') && !blockDefinitionIncludes(v, 'OutputProperties'),
+      );
+      replBlock = replBlock.replace(getBlockContent(replBlock), getBlockContent(inputPropertiesBlock));
+
+      file = file.replace(emptyExtendsBlock, replBlock);
+    }
+  }
+  return (
+    `import { validationMetadatasToSchemas as v } from 'class-validator-jsonschema';\n` +
+    `import { defaultMetadataStorage as classTransformerDefaultMetadataStorage } from 'class-transformer/cjs/storage';\n` +
+    `${file}\n` +
+    `const s = v({\n
+      additionalConverters: {\n
+        UnitArgsValidator: (meta) => {\n
+          return {\n
+            measure: meta.constraints[0],\n
+            unit: meta.constraints[1],\n
+            type: 'number',\n
+          };\n
+        },\n
+      },\n
+      classTransformerMetadataStorage\n
+    });\n` +
+    `console.log(JSON.stringify(s));`
+  );
+}
+
+export function getCodeBlocks(string_) {
+  const blocks = [];
+  let counter = 0;
+  let start = 0;
+  let lastNewline = 0;
+  for (const [index, char] of [...string_].entries()) {
+    if (char === '\n') {
+      lastNewline = index;
+    }
+    if (char === '{') {
+      if (counter === 0) {
+        // first bracket of block
+        start = lastNewline;
+      }
+      counter++;
+    } else if (char === '}') {
+      counter--;
+      if (counter === 0) {
+        // last bracket of block
+        blocks.push(string_.slice(start, index + 1));
+      }
+    }
+  }
+  return blocks;
+}
+
+function blockDefinitionIncludes(block, value) {
+  return block.trim().split('\n', 1)[0].includes(value);
+}
+
+function getBlockContent(block) {
+  return block.slice(block.indexOf('{'), block.lastIndexOf('}') + 1);
+}
+
+function isBlockEmpty(block) {
+  const blockContent = block.slice(block.indexOf('{') + 1, block.lastIndexOf('}'));
+  return !blockContent.trim();
+}

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@hahnpro/flow-cli",
-  "version": "2.9.0",
+  "version": "2.12.1",
   "description": "CLI for managing Flow Modules",
   "license": "MIT",
+  "type": "module",
   "author": {
     "name": "Hahn Projects GmbH",
     "url": "https://hahnpro.com"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:hahnpro/flow.git"
+    "url": "git@github.com:hahnprojects/flow.git"
   },
   "bin": {
-    "flow": "lib/cli.js"
+    "flow": "lib/cli.mjs"
   },
   "directories": {
     "lib": "lib",
@@ -24,42 +25,55 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {},
   "dependencies": {
-    "@ihof/https-proxy-agent-timeout": "^5.0.1",
-    "@types/jest": "^26.0.19",
-    "@types/node": "^14.17.3",
-    "@types/supertest": "^2.0.10",
-    "archiver": "^5.1.0",
-    "axios": "^0.21.1",
-    "chalk": "^4.1.0",
-    "class-transformer": "0.3.1",
-    "class-validator": "~0.12.2",
-    "class-validator-jsonschema": "^2.2.0",
-    "commander": "^7.1.0",
+    "archiver": "^5.3.0",
+    "axios": "^0.25.0",
+    "chalk": "^5.0.0",
+    "class-transformer": "0.5.1",
+    "class-validator": "~0.13.2",
+    "class-validator-jsonschema": "^3.1.0",
+    "commander": "^9.0.0",
     "copyfiles": "^2.4.1",
-    "dotenv": "^10.0.0",
-    "execa": "^5.1.1",
+    "dotenv": "^16.0.0",
+    "execa": "^6.0.0",
     "form-data": "^4.0.0",
-    "glob": "^7.1.7",
+    "glob": "^7.2.0",
     "https-proxy-agent": "^5.0.0",
-    "jest": "^26.6.2",
-    "latest-semver": "^3.0.0",
-    "nodemon": "^2.0.7",
-    "ora": "^5.4.1",
-    "prettier": "^2.3.1",
-    "querystring": "^0.2.1",
-    "read-pkg": "^5.2.0",
+    "ora": "^6.0.1",
     "reflect-metadata": "^0.1.13",
-    "supertest": "^6.1.3",
-    "ts-jest": "^26.5.6",
-    "ts-node": "^10.0.0",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^4.3.2",
-    "write-pkg": "^4.0.0"
+    "ts-node": "^10.5.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.0",
+    "@types/node": "^16.11.22",
+    "eslint": "^8.8.0",
+    "eslint-plugin-unicorn": "^40.1.0",
+    "jest": "^27.5.0",
+    "prettier": "^2.5.1",
+    "typescript": "^4.5.5"
   },
   "engines": {
-    "node": ">=14"
-  }
-}
+    "node": "^14.13.1 || >=16.0.0"
+  },
+  "eslintConfig": {
+    "extends": [
+      "eslint:recommended",
+      "prettier",
+      "plugin:prettier/recommended",
+      "plugin:unicorn/all"
+    ],
+    "rules": {
+      "unicorn/no-array-reduce": "off",
+      "unicorn/no-null": "off",
+      "unicorn/prefer-object-from-entries": "off",
+      "no-async-promise-executor": "off",
+      "no-console": "error"
+    }
+  },
+  "scripts": {
+    "format": "prettier --write .",
+    "lint": "eslint '*/**/*.{js,mjs}'",
+    "test": "jest"
+  },
+  "readme": "# `@hahnpro/flow-cli`\n\nhttps://github.com/hahnprojects/flow\n\n# Commands\n\n## `build [projectName]`\n\nBuilds specified Project.\n\n## `install [projectName]`\n\nInstalls the dependencies of the specified Project.\n\n## `format`\n\nFormats all typescript files according to prettier configuration.\n\n## `name [projectName]`\n\nInstalls Dependencies and Builds the specified Project.\n\n## `package [projectName]`\n\nBuilds specified Module and packages it as .zip File for manual upload to the platform.\n\n## `publish-module [projectName]`\n\nPublishes specified Module to Cloud Platform.\n\n- `-f`, `--functions` Publish flow functions.\n- `-u`, `--update` Update existing flow functions.\n\n## `publish-functions [projectName]`\n\nPublishes all Flow Functions inside specified Module to Cloud Platform.\n\n- `-u`, `--update` Update existing flow functions.\n\n## `serve [projectName]`\n\nBuilds and serves your Project. Rebuilding on file changes.\n\n## `start [projectName]`\n\nRuns your project.\n\n## `test [projectName]`\n\nRuns tests for your Project.\n\n## `generate-schemas [projectName]`\n\nGenerates Input, Output and Properties-Schemas for the specified project.\n\n- `--verbose` Output more information about what is being done.\n- `-h`, `--hide` Hide warnings if Input/OutputProperties classes can´t be found.\n  This command generates the schemas and puts them in the `inputStreams` and `outputStreams`\n  fields in the json-files of each Flow-Function. It always assumes the properties defined\n  in the `Input/OutPutProperties` classes are meant for the default input/output streams.\n  If your Function uses different streams you may have to change stream name manually.\n"
+}