@scifeon/sdk 0.112.0 → 0.114.0

package/dist/{plugin-types.d.ts → core/src/types/plugins/common/enums/plugin-types.d.ts}

@@ -15,7 +15,6 @@ export declare enum PLUGIN_TYPE {
     REQUEST_PANEL = "request.panel",
     FIELD_TEMPLATE = "field_template",
     FIELD_GROUP_TEMPLATE = "field_group_template",
-    SPREADSHEET_FUNCTION = "spreadsheet_function",
     POST_UPLOAD_REDIRECT = "PostUploadRedirect",
     ASSAY_DEFINITION = "AssayDefinition",
     LINKS_DETAIL = "DetailLink",
@@ -40,8 +39,14 @@ export declare enum PLUGIN_TYPE {
     ELN_BATCH_RECIPE_COLUMN = "eln.batch_recipe.column",
     APPROVAL_STRATEGY = "approval.strategy",
     FORM_VARIABLE_INJECTION = "form.variable_injection",
+    CUSTOM_FUNCTION = "custom_function",
     PRE_PROCESS_SAVE_ENTITY = "pre_process_save_entity",
     ADMINISTRATION_SETTINGS = "administration.settings",
     ADMINISTRATION_SETTINGS_SECURITY = "administration.settings.security",
-    ADMINISTRATION_SETTINGS_ELN = "administration.settings.eln"
+    ADMINISTRATION_SETTINGS_ELN = "administration.settings.eln",
+    REPORT_DATA = "report.data",
+    REPORT_BLOCK = "report.block",
+    REPORT_BLOCK_CONFIG = "report.block.config",
+    UPDATE_SET = "update_set",
+    DATA_STEP = "data_step"
 }

package/dist/{plugin-types.js → core/src/types/plugins/common/enums/plugin-types.js}

@@ -19,7 +19,6 @@ var PLUGIN_TYPE;
     PLUGIN_TYPE["REQUEST_PANEL"] = "request.panel";
     PLUGIN_TYPE["FIELD_TEMPLATE"] = "field_template";
     PLUGIN_TYPE["FIELD_GROUP_TEMPLATE"] = "field_group_template";
-    PLUGIN_TYPE["SPREADSHEET_FUNCTION"] = "spreadsheet_function";
     PLUGIN_TYPE["POST_UPLOAD_REDIRECT"] = "PostUploadRedirect";
     PLUGIN_TYPE["ASSAY_DEFINITION"] = "AssayDefinition";
     PLUGIN_TYPE["LINKS_DETAIL"] = "DetailLink";
@@ -44,8 +43,14 @@ var PLUGIN_TYPE;
     PLUGIN_TYPE["ELN_BATCH_RECIPE_COLUMN"] = "eln.batch_recipe.column";
     PLUGIN_TYPE["APPROVAL_STRATEGY"] = "approval.strategy";
     PLUGIN_TYPE["FORM_VARIABLE_INJECTION"] = "form.variable_injection";
+    PLUGIN_TYPE["CUSTOM_FUNCTION"] = "custom_function";
     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["REPORT_DATA"] = "report.data";
+    PLUGIN_TYPE["REPORT_BLOCK"] = "report.block";
+    PLUGIN_TYPE["REPORT_BLOCK_CONFIG"] = "report.block.config";
+    PLUGIN_TYPE["UPDATE_SET"] = "update_set";
+    PLUGIN_TYPE["DATA_STEP"] = "data_step";
 })(PLUGIN_TYPE = exports.PLUGIN_TYPE || (exports.PLUGIN_TYPE = {}));

package/dist/{app → sdk/src/app}/app-generator.d.ts

@@ -21,6 +21,7 @@ export declare class AppGenerator {
     private generateScopes;
     private generateGenAppJs;
     private addCustomElementDecorators;
+    private generateChunk;
     private addRouteDecorators;
     private addElnStepSectionDecorators;
     private addActionDecorators;

package/dist/{app → sdk/src/app}/app-generator.js

@@ -4,10 +4,10 @@ exports.AppGenerator = void 0;
 const fs = require("fs");
 const path = require("path");
 const ts = require("typescript");
-const action_target_1 = require("../action-target");
+const action_target_1 = require("../../../core/src/types/plugins/action/action-target");
+const page_types_1 = require("../../../core/src/types/plugins/common/enums/page-types");
+const plugin_types_1 = require("../../../core/src/types/plugins/common/enums/plugin-types");
 const file_utils_1 = require("../file-utils");
-const page_types_1 = require("../page-types");
-const plugin_types_1 = require("../plugin-types");
 const app_persist_1 = require("./app-persist");
 const app_validator_1 = require("./app-validator");
 class AppGenerator {
@@ -209,6 +209,18 @@ class AppGenerator {
             });
         }
     }
+    generateChunk(src) {
+        let chunk = src;
+        const dirs = src.split("/");
+        chunk = dirs[0];
+        if (chunk === "src") {
+            chunk = dirs[1];
+            if (chunk === "pages" || chunk === "plugins") {
+                chunk = dirs[2] || chunk;
+            }
+        }
+        return chunk;
+    }
     addRouteDecorators() {
         const routeRegex = /@scifeonRoute\s*\(\s*(\{[^]*?\})\s*\)/i;
         for (const file of this.tsFiles) {
@@ -221,17 +233,16 @@ class AppGenerator {
                 src: file.src,
                 route: Array.isArray(routeObject.route) ? routeObject.route : [routeObject.route],
                 title: routeObject.title,
-                roles: routeObject.roles,
+                roles: routeObject.roles || [],
+                permissions: routeObject.permissions || [],
                 chunk: routeObject.chunk,
                 type: routeObject.type,
             };
             if (route.type === page_types_1.PAGE_TYPE.DATA_ADMINISTRATION) {
-                route.roles = route.roles || [];
                 route.roles.push("admin");
                 route.roles.push("datamanager");
             }
             else if (route.type === page_types_1.PAGE_TYPE.ADMINISTRATION) {
-                route.roles = route.roles || [];
                 route.roles.push("admin");
             }
             this.contributionsJson.routes.push(route);

package/dist/{app → sdk/src/app}/app-validator.js

@@ -16,6 +16,8 @@ class AppValidator {
             "files",
             "previewFeatures",
             "scheduledNotifications",
+            "permissions",
+            "modules",
         ];
     }
     validatePackageJson(packageJson) {
@@ -117,21 +119,19 @@ class AppValidator {
                 }
             }
         }
-        if (contributionsJson.previewFeatures) {
-            const requiredKeys = ["id", "name", "description", "expireDate"];
-            for (const previewFeature of contributionsJson.previewFeatures) {
-                const keys = Object.keys(previewFeature);
-                if (requiredKeys.some(rk => !keys.includes(rk))) {
-                    throw new Error(`Error in contributions.json: '${requiredKeys.join("' or '")}' missing in previewFeature: ${JSON.stringify(previewFeature)}`);
-                }
-            }
-        }
-        if (contributionsJson.scheduledNotifications) {
-            const requiredKeys = ["schedule", "query", "emailTemplate", "emailSubject"];
-            for (const scheduledNotification of contributionsJson.scheduledNotifications) {
-                const keys = Object.keys(scheduledNotification);
-                if (requiredKeys.some(rk => !keys.includes(rk))) {
-                    throw new Error(`Error in contributions.json: '${requiredKeys.join("' or '")}' missing in scheduledNotifications: ${JSON.stringify(scheduledNotification)}`);
+        const requiredKeysMap = {
+            scheduledNotifications: ["schedule", "query", "emailTemplate", "emailSubject"],
+            permissions: ["id", "title", "group", "description"],
+            modules: ["id", "title", "description"],
+            previewFeatures: ["id", "name", "description", "expireDate"],
+        };
+        for (const [section, requiredKeys] of Object.entries(requiredKeysMap)) {
+            if (contributionsJson[section]) {
+                for (const item of contributionsJson[section]) {
+                    const keys = Object.keys(item);
+                    if (requiredKeys.some(rk => !keys.includes(rk))) {
+                        throw new Error(`Error in contributions.json: '${requiredKeys.join("' or '")}' missing in ${section}: ${JSON.stringify(item)}`);
+                    }
                 }
             }
         }

package/dist/{app → sdk/src/app}/interfaces/contributions/contributions-json.interface.d.ts

@@ -8,6 +8,23 @@ export interface IContributionsJson {
     userRoles?: {
         [roleName: string]: string;
     };
+    permissions?: [
+        {
+            id: string;
+            title: string;
+            group: string;
+            description: string;
+            upsertEClass?: string;
+            upsertType?: string;
+        }
+    ];
+    modules?: [
+        {
+            id: string;
+            title: string;
+            description: string;
+        }
+    ];
     scheduledNotifications?: {
         description?: string;
         schedule: "daily";
@@ -33,6 +50,9 @@ export interface IContributionsJson {
             accessScope: "All" | "Department" | "Project" | "Admin" | "User";
             fields?: string;
             dbms?: ("sqlserver" | "sqlite")[];
+            useRecompileOption?: boolean;
+            isMaterialized?: boolean;
+            dependencies?: string[];
         }[];
         datamodel: string;
         sequences: {

package/dist/{app → sdk/src/app}/interfaces/contributions/page-menu.interface.d.ts

@@ -4,6 +4,7 @@ export interface IPageMenu {
     route: string;
     text: string;
     roles?: string[];
+    permissions?: string[];
     rank?: number;
     items?: IPageMenuItem[];
 }

package/dist/{cli → sdk/src/cli}/config.js

@@ -19,5 +19,5 @@ exports.config = {
         path.resolve(__dirname, "..", "..", "..", "..", "..", "node_modules"),
     ].map(x => path.resolve(x)),
     wwwDir: path.resolve("runtime", "scifeon", "wwwroot", "dist"),
-    manifests: ["vendor", "scifeon-core", "scifeon-plugins", "scifeon-ui", "scifeon-data", "scifeon-approval"].reverse(),
+    manifests: ["vendor", "scifeon-core", "scifeon-ui", "scifeon-eln", "scifeon-insights", "scifeon-approval"].reverse(),
 };

package/dist/{utils → sdk/src/utils}/test-helper.d.ts

@@ -1,4 +1,5 @@
 export declare class TestHelper {
     static XLSX(): Promise<any>;
     static fileToXLSX(filename: string, options?: any): Promise<any>;
+    static csvToXLSX(csv: any[][], options?: any): Promise<any>;
 }

package/dist/{utils → sdk/src/utils}/test-helper.js

@@ -42,5 +42,15 @@ class TestHelper {
             return xlsx.read(fs.readFileSync(filename), options);
         });
     }
+    static csvToXLSX(csv, options = { cellDates: true }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const xlsx = yield TestHelper.XLSX();
+            const wb = xlsx.utils.book_new();
+            wb.SheetNames.push("Sheet1");
+            const ws = xlsx.utils.aoa_to_sheet(csv, Object.assign({}, options));
+            wb.Sheets.Sheet1 = ws;
+            return wb;
+        });
+    }
 }
 exports.TestHelper = TestHelper;

package/dist/{webpack-app-config.js → sdk/src/webpack-app-config.js}

@@ -31,7 +31,7 @@ function webpackAppConfig(env, config, appType = "sdk") {
         let plugins = [];
         if (appType !== "sdk") {
             plugins = config.manifests.reverse().map(p => new webpack.DllReferencePlugin({
-                manifest: require(path.resolve(config.manifestDir, "packages", p + ".bundle.manifest.json")),
+                manifest: require(path.resolve(config.manifestDir, "packages", `${p}.bundle.manifest.json`)),
             }));
             plugins.push(new webpack.DllReferencePlugin({ manifest: require(path.resolve(config.manifestDir, "vendor", "vendor.bundle.manifest.json")) }));
         }
@@ -77,15 +77,15 @@ function webpackAppConfig(env, config, appType = "sdk") {
                 plugins = plugins.concat([
                     new PostCompile(() => {
                         const packageDir = config.packageDir || config.outputDir;
-                        const filename = path.resolve(packageDir, app.namespace + "." + app.name + ".zip");
+                        const filename = path.resolve(packageDir, `${app.namespace}.${app.name}.zip`);
                         logger_1.LOGGER.msg(`Packaging into ${filename}...`);
                         const zip = new AdmZip();
-                        zip.addLocalFolder(path.resolve(config.outputDir, app.namespace, app.name), app.namespace + "/" + app.name);
+                        zip.addLocalFolder(path.resolve(config.outputDir, app.namespace, app.name), `${app.namespace}/${app.name}`);
                         zip.writeZip(filename);
                     }),
                 ]);
             }
-            const publicPath = webpack_utils_1.WebpackUtils.getPublicPath(config.publicPath + app.namespace + "/" + app.name + "/", "apps", app.namespace + "/" + app.name + "/bundles");
+            const publicPath = webpack_utils_1.WebpackUtils.getPublicPath(`${config.publicPath + app.namespace}/${app.name}/`, "apps", `${app.namespace}/${app.name}/bundles`);
             entry = {
                 app: [path.resolve(config.tempDir, "gen-app.js")],
             };
@@ -93,7 +93,7 @@ function webpackAppConfig(env, config, appType = "sdk") {
                 path: path.resolve(config.outputDir, app.namespace, app.name, "bundles"),
                 publicPath,
                 filename: "app.js",
-                library: app.namespace.replace(/\./g, "_") + "_" + app.name,
+                library: `${app.namespace.replace(/\./g, "_")}_${app.name}`,
                 libraryTarget: "jsonp",
                 chunkFilename: WATCH || DEBUG ? "[id].js" : "[id].[contenthash].js",
                 devtoolModuleFilenameTemplate: "webpack:///[resource-path]?[loaders]",
@@ -111,10 +111,13 @@ function webpackAppConfig(env, config, appType = "sdk") {
             optimization: {
                 minimizer: DEBUG || SDK ? [] : [new TerserJSPlugin({
                         terserOptions: {
-                            ecma: 6,
+                            ecma: 8,
                             compress: {
                                 pure_funcs: ["console.info", "console.debug", "console.warn", "console.log"],
                             },
+                            parse: {
+                                ecma: 8,
+                            },
                         },
                         parallel: true,
                         cache: true,
@@ -187,12 +190,12 @@ function webpackAppConfig(env, config, appType = "sdk") {
         };
     }
     catch (err) {
-        logger_1.LOGGER.error("ERROR: " + err.message);
+        logger_1.LOGGER.error(`ERROR: ${err.message}`);
         logger_1.LOGGER.error(err.stack + err.stacktrace);
         logger_1.LOGGER.error("An error occurred when creating Webpack config with this input:");
-        logger_1.LOGGER.error("CONFIG: " + JSON.stringify(config, null, 2));
-        logger_1.LOGGER.error("ENV: " + JSON.stringify(env, null, 2));
-        logger_1.LOGGER.error("APP_TYPE: " + appType);
+        logger_1.LOGGER.error(`CONFIG: ${JSON.stringify(config, null, 2)}`);
+        logger_1.LOGGER.error(`ENV: ${JSON.stringify(env, null, 2)}`);
+        logger_1.LOGGER.error(`APP_TYPE: ${appType}`);
         return null;
     }
 }
@@ -208,7 +211,7 @@ function getReplaceModulesPlugins(dist, libs) {
             scope: lib.replace("-", "_"),
             name: `@${lib.replace("-", "/")}`,
             path: `${lib.replace("-", "_")}/packages/${lib.replace("scifeon-", "")}/index.ts`,
-            manifest: JSON.parse(fs.readFileSync(path.resolve(dist, "packages", lib + ".bundle.manifest.json")).toString()),
+            manifest: JSON.parse(fs.readFileSync(path.resolve(dist, "packages", `${lib}.bundle.manifest.json`)).toString()),
         });
     }
     let plugins = [new webpack.NormalModuleReplacementPlugin(/.*/, function (resource) {
@@ -226,7 +229,7 @@ function getReplaceModulesPlugins(dist, libs) {
                             const match = Object.keys(manifestContent).find(m => m.includes(`/${request}/`)
                                 || m.includes(`${request}.js`)
                                 || m.includes(`${request}.ts`));
-                            return match ? match.replace("./", prefix + "/") : null;
+                            return match ? match.replace("./", `${prefix}/`) : null;
                         };
                         const match = replaceMatch(vendor.manifest.content, dep.request, vendor.scope);
                         if (match) {

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@scifeon/sdk",
-  "version": "0.112.0",
+  "version": "0.114.0",
   "description": "A tool for developing Apps for Scifeon.",
   "author": {
     "name": "Scifeon",
     "email": "support@scifeon.com"
   },
-  "main": "dist/cli/index.js",
+  "main": "dist/sdk/src/cli/index.js",
   "bin": {
-    "scifeon-cli": "dist/index.js"
+    "scifeon-cli": "dist/sdk/src/index.js"
   },
   "files": [
     "bin",

package/resources/new-app/typescript/src/index.ts

@@ -1,5 +1,4 @@
-import { ConsoleLogger, ServerAPI } from "@scifeon/core";
-import { scifeonRoute } from "@scifeon/plugins";
+import { ConsoleLogger, ServerAPI, scifeonRoute } from "@scifeon/core";
 import { autoinject } from "aurelia-framework";
 
 @autoinject
@@ -19,9 +18,10 @@ export class Index {
 
     public async button() {
         const response = await this.server.get("/api/user");
+
         if (response.ok) {
             const user = await response.json();
-            alert("Current user: " + user.id);
+            alert(`Current user: ${user.id}`);
         } else {
             alert("Button clicked!");
         }