@scifeon/sdk 0.103.0 → 0.105.0

package/dist/app/app-validator.js

@@ -1,145 +1,145 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppValidator = void 0;
-const fs = require("fs");
-const path = require("path");
-class AppValidator {
-    constructor() {
-        this.validScopeKeys = [
-            "menu",
-            "plugins",
-            "routes",
-            "userRoles",
-            "entities",
-            "dashboards",
-            "database",
-            "files",
-            "previewFeatures",
-            "scheduledNotifications",
-        ];
-    }
-    validatePackageJson(packageJson) {
-        if (!packageJson) {
-            throw new Error("No package.json file could be found.");
-        }
-        if (!packageJson.name) {
-            throw new Error(`Error in package.json: 'name' missing.`);
-        }
-        if (!packageJson.namespace) {
-            throw new Error(`Error in package.json: 'namespace' missing.`);
-        }
-        if (!packageJson.version) {
-            throw new Error(`Error in package.json: 'version' missing.`);
-        }
-        if (!packageJson.author) {
-            throw new Error(`Error in package.json: 'author' missing.`);
-        }
-        if (!packageJson.description) {
-            throw new Error(`Error in package.json: 'description' missing.`);
-        }
-        if (!/^([a-zA-Z]\d*(\.[a-zA-Z])?)+$/i.test(packageJson.namespace)) {
-            throw new Error("Error in package.json: The namespace must be characters (a-z), numbers and dots.");
-        }
-        if (!/^([a-z]+(\_[a-z])?)+$/.test(packageJson.name)) {
-            throw new Error("Error in package.json: The id must be letters, numbers, dot, dashes and underscores (_).");
-        }
-        if (packageJson.scifeon.scopes) {
-            const notValidScopes = packageJson.scifeon.scopes.filter(s => !this.validScopeKeys.some(vs => vs === s) && !s.startsWith("plugins.") && !s.startsWith("menu."));
-            if (notValidScopes.length) {
-                throw new Error(`Error in contributions.json: The following keys are not recognized: ${notValidScopes}`);
-            }
-        }
-    }
-    validateContributionsJson(contributionsJson, appPath = "./") {
-        if (contributionsJson.plugins) {
-            for (const plugin of contributionsJson.plugins) {
-                if (plugin.types && plugin.types.includes("page") && !plugin.id) {
-                    throw new Error(`Error in contributions.json: 'id' missing in plugin: ${JSON.stringify(plugin)}`);
-                }
-                if (!plugin.src) {
-                    throw new Error(`Error in contributions.json: 'src' missing in plugin: ${JSON.stringify(plugin)}`);
-                }
-                if (!plugin.types || !plugin.types.length) {
-                    throw new Error(`Error in contributions.json: 'types' missing in plugin: ${JSON.stringify(plugin)}`);
-                }
-            }
-        }
-        if (contributionsJson.database) {
-            if (contributionsJson.database.sequences) {
-                for (const seq of contributionsJson.database.sequences) {
-                    if (!seq.id || !seq.minDigits || !seq.prefix) {
-                        throw new Error(`Error in contributions.json: 'id', 'prefix' and 'minDigits' required in database sequence: ${JSON.stringify(seq)}`);
-                    }
-                    if (typeof seq.id !== "string"
-                        || typeof seq.minDigits !== "number"
-                        || typeof seq.prefix !== "string"
-                        || (seq.type && typeof seq.type !== "string")) {
-                        throw new Error(`Error in contributions.json: 'id', 'prefix', 'minDigits' or 'type' are not correct type in database sequence: ${JSON.stringify(seq)}`);
-                    }
-                    if (seq.env && !Array.isArray(seq.env)) {
-                        throw new Error(`Error in contributions.json: 'env' are not correct type in database sequence (should be array of strings): ${JSON.stringify(seq)}`);
-                    }
-                }
-            }
-            if (contributionsJson.database.datamodel && !contributionsJson.database.prefix) {
-                throw new Error(`Error in contributions.json: 'prefix' required in database when datamodel is included: ${JSON.stringify(contributionsJson.database)}`);
-            }
-            if (contributionsJson.database.views) {
-                for (const view of contributionsJson.database.views) {
-                    if (!view.prefix && !contributionsJson.database.prefix) {
-                        throw new Error(`Error in contributions.json: 'prefix' required in database when view is included: ${JSON.stringify(view)}`);
-                    }
-                    if (!view.name || !view.sql) {
-                        throw new Error(`Error in contributions.json: 'name' and 'sql' required in database view: ${JSON.stringify(view)}`);
-                    }
-                }
-            }
-        }
-        if (contributionsJson.files) {
-            for (const file of contributionsJson.files) {
-                const fileSrc = path.resolve(appPath, file);
-                if (!fs.existsSync(fileSrc)) {
-                    throw new Error(`Error in contributions.json: file '${fileSrc}' does not exist`);
-                }
-            }
-        }
-        if (contributionsJson.menu) {
-            for (const menuKey of Object.keys(contributionsJson.menu)) {
-                if (menuKey === "main" && !Array.isArray(contributionsJson.menu[menuKey])) {
-                    throw new Error(`Error in contributions.json: menu 'main' must be array of items`);
-                }
-                if (!AppValidator.reservedMenus.some(m => m === menuKey)) {
-                    if (Array.isArray(contributionsJson.menu[menuKey])
-                        || !contributionsJson.menu[menuKey].url
-                        || !contributionsJson.menu[menuKey].items) {
-                        throw new Error(`Error in contributions.json: menu '${menuKey}' must be object with key 'url' and 'items' array`);
-                    }
-                }
-            }
-        }
-        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)}`);
-                }
-            }
-        }
-    }
-}
-exports.AppValidator = AppValidator;
-AppValidator.reservedMenus = [
-    "main",
-    "admin",
-    "data",
-];
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppValidator = void 0;
+const fs = require("fs");
+const path = require("path");
+class AppValidator {
+    constructor() {
+        this.validScopeKeys = [
+            "menu",
+            "plugins",
+            "routes",
+            "userRoles",
+            "entities",
+            "dashboards",
+            "database",
+            "files",
+            "previewFeatures",
+            "scheduledNotifications",
+        ];
+    }
+    validatePackageJson(packageJson) {
+        if (!packageJson) {
+            throw new Error("No package.json file could be found.");
+        }
+        if (!packageJson.name) {
+            throw new Error(`Error in package.json: 'name' missing.`);
+        }
+        if (!packageJson.namespace) {
+            throw new Error(`Error in package.json: 'namespace' missing.`);
+        }
+        if (!packageJson.version) {
+            throw new Error(`Error in package.json: 'version' missing.`);
+        }
+        if (!packageJson.author) {
+            throw new Error(`Error in package.json: 'author' missing.`);
+        }
+        if (!packageJson.description) {
+            throw new Error(`Error in package.json: 'description' missing.`);
+        }
+        if (!/^([a-zA-Z]\d*(\.[a-zA-Z])?)+$/i.test(packageJson.namespace)) {
+            throw new Error("Error in package.json: The namespace must be characters (a-z), numbers and dots.");
+        }
+        if (!/^([a-z]+(\_[a-z])?)+$/.test(packageJson.name)) {
+            throw new Error("Error in package.json: The id must be letters, numbers, dot, dashes and underscores (_).");
+        }
+        if (packageJson.scifeon.scopes) {
+            const notValidScopes = packageJson.scifeon.scopes.filter(s => !this.validScopeKeys.some(vs => vs === s) && !s.startsWith("plugins.") && !s.startsWith("menu."));
+            if (notValidScopes.length) {
+                throw new Error(`Error in contributions.json: The following keys are not recognized: ${notValidScopes}`);
+            }
+        }
+    }
+    validateContributionsJson(contributionsJson, appPath = "./") {
+        if (contributionsJson.plugins) {
+            for (const plugin of contributionsJson.plugins) {
+                if (plugin.types && plugin.types.includes("page") && !plugin.id) {
+                    throw new Error(`Error in contributions.json: 'id' missing in plugin: ${JSON.stringify(plugin)}`);
+                }
+                if (!plugin.src) {
+                    throw new Error(`Error in contributions.json: 'src' missing in plugin: ${JSON.stringify(plugin)}`);
+                }
+                if (!plugin.types || !plugin.types.length) {
+                    throw new Error(`Error in contributions.json: 'types' missing in plugin: ${JSON.stringify(plugin)}`);
+                }
+            }
+        }
+        if (contributionsJson.database) {
+            if (contributionsJson.database.sequences) {
+                for (const seq of contributionsJson.database.sequences) {
+                    if (!seq.id || !seq.minDigits || !seq.prefix) {
+                        throw new Error(`Error in contributions.json: 'id', 'prefix' and 'minDigits' required in database sequence: ${JSON.stringify(seq)}`);
+                    }
+                    if (typeof seq.id !== "string"
+                        || typeof seq.minDigits !== "number"
+                        || typeof seq.prefix !== "string"
+                        || (seq.type && typeof seq.type !== "string")) {
+                        throw new Error(`Error in contributions.json: 'id', 'prefix', 'minDigits' or 'type' are not correct type in database sequence: ${JSON.stringify(seq)}`);
+                    }
+                    if (seq.env && !Array.isArray(seq.env)) {
+                        throw new Error(`Error in contributions.json: 'env' are not correct type in database sequence (should be array of strings): ${JSON.stringify(seq)}`);
+                    }
+                }
+            }
+            if (contributionsJson.database.datamodel && !contributionsJson.database.prefix) {
+                throw new Error(`Error in contributions.json: 'prefix' required in database when datamodel is included: ${JSON.stringify(contributionsJson.database)}`);
+            }
+            if (contributionsJson.database.views) {
+                for (const view of contributionsJson.database.views) {
+                    if (!view.prefix && !contributionsJson.database.prefix) {
+                        throw new Error(`Error in contributions.json: 'prefix' required in database when view is included: ${JSON.stringify(view)}`);
+                    }
+                    if (!view.name || !view.sql) {
+                        throw new Error(`Error in contributions.json: 'name' and 'sql' required in database view: ${JSON.stringify(view)}`);
+                    }
+                }
+            }
+        }
+        if (contributionsJson.files) {
+            for (const file of contributionsJson.files) {
+                const fileSrc = path.resolve(appPath, file);
+                if (!fs.existsSync(fileSrc)) {
+                    throw new Error(`Error in contributions.json: file '${fileSrc}' does not exist`);
+                }
+            }
+        }
+        if (contributionsJson.menu) {
+            for (const menuKey of Object.keys(contributionsJson.menu)) {
+                if (menuKey === "main" && !Array.isArray(contributionsJson.menu[menuKey])) {
+                    throw new Error(`Error in contributions.json: menu 'main' must be array of items`);
+                }
+                if (!AppValidator.reservedMenus.some(m => m === menuKey)) {
+                    if (Array.isArray(contributionsJson.menu[menuKey])
+                        || !contributionsJson.menu[menuKey].url
+                        || !contributionsJson.menu[menuKey].items) {
+                        throw new Error(`Error in contributions.json: menu '${menuKey}' must be object with key 'url' and 'items' array`);
+                    }
+                }
+            }
+        }
+        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)}`);
+                }
+            }
+        }
+    }
+}
+exports.AppValidator = AppValidator;
+AppValidator.reservedMenus = [
+    "main",
+    "admin",
+    "data",
+];

package/dist/app/interfaces/app-json.interface.d.ts

@@ -1,4 +1,4 @@
-import { IPackageJson } from "./package-json.interface";
-export interface IAppJson extends IPackageJson {
-    type?: string;
-}
+import { IPackageJson } from "./package-json.interface";
+export interface IAppJson extends IPackageJson {
+    type?: string;
+}

package/dist/app/interfaces/app-json.interface.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/app/interfaces/app-type.enum.d.ts

@@ -1,5 +1,5 @@
-export declare enum AppType {
-    CORE = "core",
-    MODULE = "core",
-    DEMO = "demo"
-}
+export declare enum AppType {
+    CORE = "core",
+    MODULE = "core",
+    DEMO = "demo"
+}

package/dist/app/interfaces/app-type.enum.js

@@ -1,9 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppType = void 0;
-var AppType;
-(function (AppType) {
-    AppType["CORE"] = "core";
-    AppType["MODULE"] = "core";
-    AppType["DEMO"] = "demo";
-})(AppType = exports.AppType || (exports.AppType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppType = void 0;
+var AppType;
+(function (AppType) {
+    AppType["CORE"] = "core";
+    AppType["MODULE"] = "core";
+    AppType["DEMO"] = "demo";
+})(AppType = exports.AppType || (exports.AppType = {}));

package/dist/app/interfaces/contributions/contributions-json.interface.d.ts

@@ -1,55 +1,55 @@
-import { IMainMenu } from "./main-menu.interface";
-import { IPageMenuItem } from "./page-menu-item.interface";
-import { IPageMenu } from "./page-menu.interface";
-export interface IContributionsJson {
-    files?: string[];
-    entities?: string[];
-    dashboards?: string[];
-    userRoles?: {
-        [roleName: string]: string;
-    };
-    scheduledNotifications?: {
-        description?: string;
-        schedule: "daily";
-        hourOfDay?: number;
-        query: string;
-        emailTemplate: string;
-        emailSubject?: string;
-    }[];
-    previewFeatures?: {
-        id: string;
-        name: string;
-        description: string;
-        expireDate: string;
-        default?: boolean;
-    }[];
-    database?: {
-        prefix?: string;
-        views: {
-            prefix?: string;
-            name: string;
-            sql: string;
-            accessScope: "All" | "Department" | "Project" | "Admin" | "User";
-            fields?: string;
-            dbms?: ("sqlserver" | "sqlite")[];
-        }[];
-        datamodel: string;
-        sequences: {
-            id: string;
-            prefix: string;
-            minDigits: number;
-            type: string;
-            nextValue?: number;
-            env?: ("dev")[];
-        }[];
-        seed?: string[];
-    };
-    menu?: {
-        main?: IMainMenu[];
-        dev?: IPageMenu;
-        admin?: IPageMenuItem[];
-        data?: IPageMenuItem[];
-    };
-    routes: any[];
-    plugins: any[];
-}
+import { IMainMenu } from "./main-menu.interface";
+import { IPageMenuItem } from "./page-menu-item.interface";
+import { IPageMenu } from "./page-menu.interface";
+export interface IContributionsJson {
+    files?: string[];
+    entities?: string[];
+    dashboards?: string[];
+    userRoles?: {
+        [roleName: string]: string;
+    };
+    scheduledNotifications?: {
+        description?: string;
+        schedule: "daily";
+        hourOfDay?: number;
+        query: string;
+        emailTemplate: string;
+        emailSubject?: string;
+    }[];
+    previewFeatures?: {
+        id: string;
+        name: string;
+        description: string;
+        expireDate: string;
+        default?: boolean;
+    }[];
+    database?: {
+        prefix?: string;
+        views: {
+            prefix?: string;
+            name: string;
+            sql: string;
+            accessScope: "All" | "Department" | "Project" | "Admin" | "User";
+            fields?: string;
+            dbms?: ("sqlserver" | "sqlite")[];
+        }[];
+        datamodel: string;
+        sequences: {
+            id: string;
+            prefix: string;
+            minDigits: number;
+            type: string;
+            nextValue?: number;
+            env?: ("dev")[];
+        }[];
+        seed?: string[];
+    };
+    menu?: {
+        main?: IMainMenu[];
+        dev?: IPageMenu;
+        admin?: IPageMenuItem[];
+        data?: IPageMenuItem[];
+    };
+    routes: any[];
+    plugins: any[];
+}

package/dist/app/interfaces/contributions/contributions-json.interface.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/app/interfaces/contributions/main-menu.interface.d.ts

@@ -1,12 +1,12 @@
-export interface IMainMenu {
-    text: string;
-    url?: string;
-    iconFA?: string;
-    iconSrc?: string;
-    rank?: number;
-    favorite?: boolean;
-    items?: {
-        text: string;
-        url: string;
-    }[];
-}
+export interface IMainMenu {
+    text: string;
+    url?: string;
+    iconFA?: string;
+    iconSrc?: string;
+    rank?: number;
+    favorite?: boolean;
+    items?: {
+        text: string;
+        url: string;
+    }[];
+}

package/dist/app/interfaces/contributions/main-menu.interface.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/app/interfaces/contributions/menu-item.interface.d.ts

@@ -1,5 +1,5 @@
-export interface IMenuItem {
-    src?: string;
-    section?: string;
-    items?: IMenuItem[];
-}
+export interface IMenuItem {
+    src?: string;
+    section?: string;
+    items?: IMenuItem[];
+}

package/dist/app/interfaces/contributions/menu-item.interface.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/app/interfaces/contributions/page-menu-item.interface.d.ts

@@ -1,10 +1,10 @@
-export interface IPageMenuItem {
-    id?: string;
-    section?: string;
-    src?: string;
-    text?: string;
-    url?: string[];
-    rank?: number;
-    iconFA?: string;
-    items?: IPageMenuItem[];
-}
+export interface IPageMenuItem {
+    id?: string;
+    section?: string;
+    src?: string;
+    text?: string;
+    url?: string[];
+    rank?: number;
+    iconFA?: string;
+    items?: IPageMenuItem[];
+}

package/dist/app/interfaces/contributions/page-menu-item.interface.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/app/interfaces/contributions/page-menu.interface.d.ts

@@ -1,9 +1,9 @@
-import { IPageMenuItem } from "./page-menu-item.interface";
-export interface IPageMenu {
-    section?: string;
-    route: string;
-    text: string;
-    roles?: string[];
-    rank?: number;
-    items?: IPageMenuItem[];
-}
+import { IPageMenuItem } from "./page-menu-item.interface";
+export interface IPageMenu {
+    section?: string;
+    route: string;
+    text: string;
+    roles?: string[];
+    rank?: number;
+    items?: IPageMenuItem[];
+}

package/dist/app/interfaces/contributions/page-menu.interface.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/app/interfaces/package-json.interface.d.ts

@@ -1,14 +1,14 @@
-import { IContributionsJson } from "./contributions/contributions-json.interface";
-export interface IPackageJson {
-    name: string;
-    namespace: string;
-    description: string;
-    author: string;
-    version: string;
-    scifeon: {
-        cliVersion?: string;
-        runtimeVersion?: string;
-        scopes?: string[];
-        contributions: IContributionsJson;
-    };
-}
+import { IContributionsJson } from "./contributions/contributions-json.interface";
+export interface IPackageJson {
+    name: string;
+    namespace: string;
+    description: string;
+    author: string;
+    version: string;
+    scifeon: {
+        cliVersion?: string;
+        runtimeVersion?: string;
+        scopes?: string[];
+        contributions: IContributionsJson;
+    };
+}

package/dist/app/interfaces/package-json.interface.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/app/interfaces/webpack-config.interface.d.ts

@@ -1,5 +1,5 @@
-export interface IWebpackConfig {
-    jsonDir: string;
-    tempDir: string;
-    appPath: string;
-}
+export interface IWebpackConfig {
+    jsonDir: string;
+    tempDir: string;
+    appPath: string;
+}

package/dist/app/interfaces/webpack-config.interface.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,4 +1,4 @@
-export declare class BuildCommand {
-    execute(options: any): Promise<void>;
-    private downloadTypes;
-}
+export declare class BuildCommand {
+    execute(options: any): Promise<void>;
+    private downloadTypes;
+}