@scifeon/sdk 0.91.0 → 0.92.0

package/dist/cli/commands/app/e2e-test.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.E2ETestCommand = void 0;
+const path = require("path");
 const resolve = require("resolve");
 const logger_1 = require("../../../logger");
 class E2ETestCommand {
     execute(options) {
-        resolve("@scifeon/e2e-test", { basedir: process.cwd() }, function (err, res) {
+        if (__dirname.includes(`${path.sep}packages${path.sep}sdk${path.sep}`)) {
+            require("../../../../../e2e-test/dist").e2eTestRunner(options);
+            return;
+        }
+        resolve("@scifeon/e2e-test", { basedir: process.cwd() }, (err, res) => {
             if (err) {
                 logger_1.LOGGER.error(`You must install the @scifeon/e2e-test package to use this command: 'npm install @scifeon/e2e-test --save-dev'`);
             }

package/dist/cli/commands/app/post-process.d.ts

@@ -0,0 +1,8 @@
+import { OptionValues } from "commander";
+export declare class PostProcessCommand {
+    private updateTestFile;
+    private postProcessFiles;
+    private parseFile;
+    private findBlocks;
+    execute(options: OptionValues): Promise<void>;
+}

package/dist/cli/commands/app/post-process.js

@@ -0,0 +1,122 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostProcessCommand = void 0;
+const fs = require("fs");
+const readline = require("readline");
+const logger_1 = require("../../../logger");
+class PostProcessCommand {
+    updateTestFile(testFile, recordingFile) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const lines = yield this.parseFile(testFile);
+            const newLines = [];
+            for (const line of lines) {
+                if (line.includes(`import { runChromeRecording } from`)) {
+                    newLines.push(`import { runChromeRecording } from "./${recordingFile.replace(/\.js/, "")}";`);
+                }
+                else {
+                    newLines.push(line);
+                }
+            }
+            fs.writeFileSync(testFile, newLines.join("\n"), { flag: "w" });
+            logger_1.LOGGER.msg(`Updating test file: "${testFile}".`);
+        });
+    }
+    postProcessFiles(recordingFile) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const recordingLines = yield this.parseFile(recordingFile);
+            const functionBlocks = this.findBlocks(recordingLines, "    async function", "    }");
+            const blocks = this.findBlocks(recordingLines, "    {", "    }");
+            blocks.splice(1, 1);
+            const functionLines = functionBlocks.reduce((ary, block) => ary.concat(block), []);
+            functionLines.unshift(`import { e2eConfig } from "@scifeon/e2e-test";`);
+            const blockLines = blocks.reduce((ary, block) => ary.concat(block), []);
+            blockLines.unshift("");
+            blockLines.unshift("    const timeout = e2eConfig.puppeteer.timeout;");
+            blockLines.unshift("async function runChromeRecording(page) {");
+            blockLines.push("};");
+            blockLines.push("");
+            blockLines.push("export { runChromeRecording };");
+            return [...functionLines, ...blockLines];
+        });
+    }
+    parseFile(filePath) {
+        var e_1, _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const lines = [];
+            const fileInterface = readline.createInterface({
+                input: fs.createReadStream(filePath),
+                output: process.stdout,
+                terminal: false,
+            });
+            try {
+                for (var fileInterface_1 = __asyncValues(fileInterface), fileInterface_1_1; fileInterface_1_1 = yield fileInterface_1.next(), !fileInterface_1_1.done;) {
+                    const line = fileInterface_1_1.value;
+                    lines.push(line);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (fileInterface_1_1 && !fileInterface_1_1.done && (_a = fileInterface_1.return)) yield _a.call(fileInterface_1);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            return lines;
+        });
+    }
+    findBlocks(lines, startPattern, endPattern) {
+        const blocks = [];
+        let gotStart = false;
+        let gotEnd = false;
+        let block = [];
+        for (const line of lines) {
+            if (line.startsWith(startPattern)) {
+                gotStart = true;
+                gotEnd = false;
+            }
+            if (line.startsWith(endPattern)) {
+                gotEnd = true;
+            }
+            if (gotStart) {
+                block.push(line);
+            }
+            if (gotStart && gotEnd) {
+                blocks.push(block);
+                block = [];
+                gotStart = false;
+                gotEnd = false;
+            }
+        }
+        return blocks;
+    }
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (options.test && options.recording) {
+                const testFile = options.test;
+                const recordingFile = options.recording;
+                const outputFile = recordingFile.replace(/\.js$/, ".post-processed.js");
+                yield this.updateTestFile(testFile, outputFile);
+                const outputLines = yield this.postProcessFiles(recordingFile);
+                fs.writeFileSync(outputFile, outputLines.join("\n"));
+                logger_1.LOGGER.msg(`Writing post-processed file: "${outputFile}".`);
+            }
+        });
+    }
+}
+exports.PostProcessCommand = PostProcessCommand;

package/dist/cli/commands/app/scaffold.d.ts

@@ -0,0 +1,4 @@
+import { OptionValues } from "commander";
+export declare class ScaffoldCommand {
+    execute(options: OptionValues): void;
+}

package/dist/cli/commands/app/scaffold.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScaffoldCommand = void 0;
+const fs = require("fs");
+const path = require("path");
+const logger_1 = require("../../../logger");
+class ScaffoldCommand {
+    execute(options) {
+        const basePath = path.resolve(__dirname, "..", "..", "..", "..", "resources", "scaffold-templates");
+        if (options.e2eTest) {
+            const fileName = options.e2eTest;
+            const template = path.resolve(basePath, "scaffold-e2e-test.ts");
+            const scaffold = fs.readFileSync(template);
+            fs.writeFileSync(fileName, scaffold);
+            logger_1.LOGGER.msg(`Writing scaffold file: "${fileName}".`);
+        }
+    }
+}
+exports.ScaffoldCommand = ScaffoldCommand;

package/dist/cli/index.js

@@ -25,7 +25,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScifeonCLI = void 0;
 const chalk_1 = require("chalk");
-const commander = require("commander");
+const commander_1 = require("commander");
 const logger_1 = require("../logger");
 const build_1 = require("./commands/app/build");
 const clean_1 = require("./commands/app/clean");
@@ -33,6 +33,8 @@ const debug_1 = require("./commands/app/debug");
 const e2e_test_1 = require("./commands/app/e2e-test");
 const new_1 = require("./commands/app/new");
 const package_1 = require("./commands/app/package");
+const post_process_1 = require("./commands/app/post-process");
+const scaffold_1 = require("./commands/app/scaffold");
 const unit_test_1 = require("./commands/app/unit-test");
 const validate_1 = require("./commands/app/validate");
 const version_1 = require("./commands/app/version");
@@ -41,32 +43,33 @@ const download_1 = require("./commands/scifeon/download");
 __exportStar(require("../utils/test-helper"), exports);
 class ScifeonCLI {
     constructor() {
-        this.program = commander;
+        this.program = commander_1.program;
         this.package = require("../../package.json");
         this.initialize();
         this.setup();
+        const padding = new Array(20).join(" ");
+        const header = `${padding}Scifeon CLI | Version: ${this.package.version}${padding}`;
+        console.log(chalk_1.default.bgBlue.white(" ".repeat(header.length)));
+        console.log(chalk_1.default.bgBlue.white(header));
+        console.log(chalk_1.default.bgBlue.white("-".repeat(header.length)));
+        const options = this.program.opts();
+        new logger_1.LOGGER(options.quiet, options.verbose);
+        logger_1.LOGGER.warn("Verbose logging enabled.");
     }
     initialize() {
         this.program
             .version(this.package.version)
             .description(this.package.description)
             .option("-v, --verbose", "Verbose logging.")
-            .option("-q, --quiet", "No logging.")
-            .parse(process.argv);
-        const header = "                      Scifeon CLI | Version: " + this.package.version + "                      ";
-        console.log(chalk_1.default.bgBlue.white(" ".repeat(header.length)));
-        console.log(chalk_1.default.bgBlue.white(header));
-        console.log(chalk_1.default.bgBlue.white("-".repeat(header.length)));
-        new logger_1.LOGGER(this.program.quiet, this.program.verbose);
-        logger_1.LOGGER.warn("Verbose logging enabled.");
+            .option("-q, --quiet", "No logging.");
     }
     setup() {
         this.program
             .command("build")
-            .option("--branch [branch]", "Platform branch to use for SDK types")
+            .option("--branch <branch>", "Platform branch to use for SDK types.")
             .allowUnknownOption()
             .description("Build the App into the folder /build.\n")
-            .action((options) => __awaiter(this, void 0, void 0, function* () { return yield new build_1.BuildCommand().execute(options); }));
+            .action((filename, options, command) => __awaiter(this, void 0, void 0, function* () { return new build_1.BuildCommand().execute(options); }));
         this.program
             .command("clean")
             .description("Remove the /build-folder.\n")
@@ -76,8 +79,8 @@ class ScifeonCLI {
             .allowUnknownOption()
             .option("--disable-browser-launch", "Don't launch http://localhost:5000 in the default browser.")
             .description("Starts Scifeon development version and builds App with watch-mode.\n")
-            .action((options) => __awaiter(this, void 0, void 0, function* () {
-            return yield new debug_1.DebugCommand()
+            .action((filename, options, command) => __awaiter(this, void 0, void 0, function* () {
+            return new debug_1.DebugCommand()
                 .execute(options.disableBrowserLaunch !== undefined && options.disableBrowserLaunch);
         }));
         this.program
@@ -101,45 +104,52 @@ class ScifeonCLI {
             .option("--cli", "Run tests on the command-line, i.e. not in the browser.")
             .option("--junit-report")
             .option("--html-report")
-            .option("--dir [dir]")
+            .option("--dir <dir>")
             .description("Run all unit-tests located in the /test/unit-folder.\n")
-            .action(options => new unit_test_1.TestCommand().execute(options));
+            .action((filename, options, command) => new unit_test_1.TestCommand().execute(options));
         this.program
             .command("e2e-test")
-            .option("--url [url]", "URL for the scifeon instance to test (Default: http://localhost:5000)")
-            .option("--key [key]", "Optionally add a /test/e2e/key.config-file with this content (make sure the file is ignored by .git).")
-            .option("--pdf-report", "Generate a PDF report with the result")
-            .option("--junit-report", "Generate a JUnit formatted XML-file with the result")
-            .option("--trx-report", "Generate a TRX formatted XML-file with the result")
-            .option("--headless", "Run Chrome in headless mode")
-            .option("--tag [tag]", "Run only tests with tag")
-            .option("--file-pattern [filePattern]", "Run only tests in files matching file pattern")
-            .option("--dir [dir]", "Run only tests in provided directory")
-            .option("--test [test]", "Run only specific test file")
-            .option("--timeout [timeout]", "Set the timeout for when to fail a test (Default: 30s)")
-            .option("--chrome [chrome]", "Optionally specify the full path to the Chrome-installation to use.")
+            .option("--url <url>", "URL for the scifeon instance to test", "http://localhost:5000")
+            .option("--key <key>", "Optionally add a /test/e2e/key.config-file with this content (make sure the file is ignored by .git).")
+            .option("--pdf-report", "Generate a PDF report with the result.")
+            .option("--junit-report", "Generate a JUnit formatted XML-file with the result.")
+            .option("--trx-report", "Generate a TRX formatted XML-file with the result.")
+            .option("--headless", "Run Chrome in headless mode.")
+            .option("--tag <tag>", "Run only tests with tag.")
+            .option("--file-pattern <filePattern>", "Run only tests in files matching file pattern.")
+            .option("--dir <dir>", "Run only tests in provided directory.")
+            .option("--test <file>", "Run only specific test file.")
+            .option("--timeout <timeout>", "Set the timeout for when to fail a test", "30")
+            .option("--chrome <path>", "Optionally specify the full path to the Chrome-installation to use.")
             .description("Run all end-to-end-tests located in the /test/e2e-folder. All options above can be added to the /test/e2e/config.ts-file.\n")
             .action(options => new e2e_test_1.E2ETestCommand().execute(options));
+        this.program
+            .command("scaffold")
+            .option("--e2e-test <filename>", "Create an e2e test file with the specified filename.")
+            .description("Create a scaffold file with boilerplate code.\n")
+            .action(options => new scaffold_1.ScaffoldCommand().execute(options));
+        this.program
+            .command("post-process")
+            .option("--test <file>", "Test file created with 'scifeon-cli scaffold --e2e-test'.")
+            .option("--recording <file>", "Puppeteer file exported from Chrome Recorder.")
+            .description("Post-process the content of a Chrome recording for use with the test file.")
+            .action(options => new post_process_1.PostProcessCommand().execute(options));
         this.program
             .command("watch")
             .allowUnknownOption()
             .description("Build the App and watch for changes.\n")
-            .action(() => __awaiter(this, void 0, void 0, function* () { return yield new watch_1.WatchCommand().execute(); }));
+            .action(() => __awaiter(this, void 0, void 0, function* () { return new watch_1.WatchCommand().execute(); }));
         this.program
             .command("download")
             .description("Download the latest version of the Scifeon runtime.\n")
-            .action(() => __awaiter(this, void 0, void 0, function* () { return yield new download_1.DownloadCommand().execute(); }));
+            .action(() => __awaiter(this, void 0, void 0, function* () { return new download_1.DownloadCommand().execute(); }));
+        this.program.configureHelp({
+            sortSubcommands: true,
+        });
     }
     start() {
         try {
-            this.program.parse(process.argv);
-            if (this.program.args.length) {
-                const command = this.program.args[this.program.args.length - 1];
-                if (typeof command === "string") {
-                    logger_1.LOGGER.error(`The command ${command} was not recognized.`);
-                    this.program.help();
-                }
-            }
+            const command = this.program.parse(process.argv);
         }
         catch (err) {
             logger_1.LOGGER.error(err.toString());

package/dist/index.js

@@ -1,12 +1,17 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
 const resolve = require("resolve");
 const cli_1 = require("./cli");
 process.title = "scifeon";
 resolve("@scifeon/sdk", { basedir: process.cwd() }, function (err, res) {
     let cli;
-    if (err) {
+    if (__dirname.includes(`client${path.sep}packages${path.sep}sdk${path.sep}dist`)) {
+        console.log("Using development version...");
+        cli = cli_1.ScifeonCLI;
+    }
+    else if (err) {
         console.log("Using global NPM package...");
         cli = cli_1.ScifeonCLI;
     }

package/dist/plugin-types.d.ts

@@ -32,6 +32,9 @@ export declare enum PLUGIN_TYPE {
     ELN_EXPERIMENT_COMPLETE = "eln.experiment.complete",
     ELN_EXPERIMENT_LOCK = "eln.experiment.lock",
     ELN_STEP_FORM_MODE = "eln.step.form.mode",
+    ELN_STEP_CONTROL = "eln.step.control",
     PRE_PROCESS_SAVE_ENTITY = "pre_process_save_entity",
+    ADMINISTRATION_SETTINGS = "administration.settings",
+    ADMINISTRATION_SETTINGS_SECURITY = "administration.settings.security",
     ADMINISTRATION_SETTINGS_ELN = "administration.settings.eln"
 }

package/dist/plugin-types.js

@@ -36,6 +36,9 @@ var PLUGIN_TYPE;
     PLUGIN_TYPE["ELN_EXPERIMENT_COMPLETE"] = "eln.experiment.complete";
     PLUGIN_TYPE["ELN_EXPERIMENT_LOCK"] = "eln.experiment.lock";
     PLUGIN_TYPE["ELN_STEP_FORM_MODE"] = "eln.step.form.mode";
+    PLUGIN_TYPE["ELN_STEP_CONTROL"] = "eln.step.control";
     PLUGIN_TYPE["PRE_PROCESS_SAVE_ENTITY"] = "pre_process_save_entity";
+    PLUGIN_TYPE["ADMINISTRATION_SETTINGS"] = "administration.settings";
+    PLUGIN_TYPE["ADMINISTRATION_SETTINGS_SECURITY"] = "administration.settings.security";
     PLUGIN_TYPE["ADMINISTRATION_SETTINGS_ELN"] = "administration.settings.eln";
 })(PLUGIN_TYPE = exports.PLUGIN_TYPE || (exports.PLUGIN_TYPE = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scifeon/sdk",
-  "version": "0.91.0",
+  "version": "0.92.0",
   "description": "A tool for developing Apps for Scifeon.",
   "author": {
     "name": "Scifeon",
@@ -31,8 +31,8 @@
     "aurelia-webpack-plugin": "4.0.0",
     "chai": "4.3.6",
     "chalk": "2.4.2",
-    "commander": "4.0.0",
     "chokidar": "3.5.3",
+    "commander": "9.3.0",
     "copy-webpack-plugin": "5.1.1",
     "css-loader": "3.5.3",
     "file-loader": "6.0.0",
@@ -69,4 +69,4 @@
     "@types/node": "17.0.41",
     "rimraf": "3.0.2"
   }
-}
+}

package/resources/scaffold-templates/scaffold-e2e-test.ts

@@ -0,0 +1,19 @@
+import { runChromeRecording } from "";
+import { E2EUtils, ScifeonPage } from "@scifeon/e2e-test";
+
+describe("Scaffold", () => {
+    let page: ScifeonPage;
+
+    before(async () => {
+        page = await E2EUtils.newPage();
+        await page.login("USER");
+    });
+
+    it("should execute Chrome Recording and assert ...", async () => {
+        await runChromeRecording(page);
+
+        const selector = "My selector";
+        const value = "My value";
+        await page.assert.textContains(selector, value);
+    });
+});