verteilen-core 1.0.13 → 1.0.15

package/dist/src/interface/enum.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParameterTemplateText = exports.ProjectTemplateText = exports.JobType2Text = exports.JobTypeText = exports.JobResultText = exports.ConnectionText = exports.JobCategoryText = exports.ExecuteStateText = exports.DataTypeText = exports.JavascriptLib = exports.RenderUpdateType = exports.ExecuteState = exports.ParameterTemplate = exports.ProjectTemplate = exports.JobType2 = exports.JobType = exports.ConditionResult = exports.JobCategory = exports.FrontendUpdate = exports.ResourceType = exports.DataTypeBase = exports.DataType = exports.SocketState = void 0;
+exports.ParameterTemplateText = exports.ProjectTemplateText = exports.JobType2Text = exports.JobTypeText = exports.JobResultText = exports.ConnectionText = exports.JobCategoryText = exports.ExecuteStateText = exports.DataTypeText = exports.ServiceMode = exports.JavascriptLib = exports.RenderUpdateType = exports.ExecuteState = exports.ParameterTemplate = exports.ProjectTemplate = exports.JobType2 = exports.JobType = exports.ConditionResult = exports.JobCategory = exports.FrontendUpdate = exports.ResourceType = exports.DataTypeBase = exports.DataType = exports.SocketState = void 0;
 var SocketState;
 (function (SocketState) {
     SocketState[SocketState["CONNECTING"] = 0] = "CONNECTING";
@@ -112,6 +112,12 @@ var JavascriptLib;
     JavascriptLib[JavascriptLib["HTTP"] = 8] = "HTTP";
     JavascriptLib[JavascriptLib["PATH"] = 16] = "PATH";
 })(JavascriptLib || (exports.JavascriptLib = JavascriptLib = {}));
+var ServiceMode;
+(function (ServiceMode) {
+    ServiceMode[ServiceMode["ONCE"] = 0] = "ONCE";
+    ServiceMode[ServiceMode["CYCLE"] = 1] = "CYCLE";
+    ServiceMode[ServiceMode["EVENT"] = 2] = "EVENT";
+})(ServiceMode || (exports.ServiceMode = ServiceMode = {}));
 exports.DataTypeText = {
     0: 'types.boolean',
     1: 'types.number',

package/dist/src/interface/server.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PermissionType = exports.UserType = exports.ACLType = void 0;
+exports.CreateRootUser = exports.CreateRootPermission = exports.PermissionType = exports.UserType = exports.ACLType = void 0;
+const uuid_1 = require("uuid");
 var ACLType;
 (function (ACLType) {
     ACLType[ACLType["PUBLIC"] = 0] = "PUBLIC";
@@ -26,3 +27,43 @@ var PermissionType;
     PermissionType[PermissionType["LIB"] = 7] = "LIB";
     PermissionType[PermissionType["LOG"] = 8] = "LOG";
 })(PermissionType || (exports.PermissionType = PermissionType = {}));
+const CreateRootPermission = () => {
+    const perl = {
+        view: true,
+        create: true,
+        edit: true,
+        delete: true,
+    };
+    const per = {
+        project: perl,
+        task: perl,
+        job: perl,
+        plugin: perl,
+        node: perl,
+        parameter: perl,
+        lib: perl,
+        log: perl,
+        execute_job: true
+    };
+    return per;
+};
+exports.CreateRootPermission = CreateRootPermission;
+const CreateRootUser = () => {
+    return {
+        token: (0, uuid_1.v6)(),
+        type: UserType.ROOT,
+        preference: {
+            lan: 'en',
+            log: true,
+            font: 18,
+            theme: "dark",
+            notification: false,
+            plugin_token: [],
+            animation: true,
+        },
+        name: "root",
+        description: "Root User",
+        permission: (0, exports.CreateRootPermission)()
+    };
+};
+exports.CreateRootUser = CreateRootUser;

package/dist/src/lan/en.json

@@ -44,7 +44,8 @@
     "settings": {
         "system": "System",
         "appearance": "Appearance",
-        "workflow": "Workflow"
+        "workflow": "Workflow",
+        "token_remove": "Are you sure you want to remove the token"
     },
     "toast": {
         "server": "Server Mode",
@@ -338,6 +339,7 @@
             "messager_log": "messager_log(message:string)"
         }
     },
+    "token": "Token",
     "info": "Information",
     "search": "Search",
     "selectall": "Select All",

package/dist/src/lan/zh_TW.json

@@ -44,7 +44,8 @@
     "settings": {
         "system": "系統",
         "appearance": "外觀",
-        "workflow": "流程"
+        "workflow": "流程",
+        "token_remove": "確定刪除密鑰嗎"
     },
     "toast": {
         "server": "伺服器模式",
@@ -338,6 +339,7 @@
             "messager_log": "messager_log(message:string)"
         }
     },
+    "token": "密鑰",
     "info": "資訊",
     "search": "搜尋",
     "selectall": "全選",

package/dist/src/plugins/i18n.js

@@ -10,6 +10,7 @@ const i18n_js_1 = require("i18n-js");
 const en_json_1 = __importDefault(require("./../lan/en.json"));
 const zh_TW_json_1 = __importDefault(require("./../lan/zh_TW.json"));
 exports.i18nDefaultData = {
+    legacy: true,
     locale: 'en',
     globalInjection: true,
     fallbackFormat: 'en',

package/index.ts

@@ -1,2 +1,4 @@
+// ? Cannot be import in browser
 export * from './src/computed'
+// ? Can be import in browser
 export * from './src/interface'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "verteilen-core",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "license": "MIT",
   "homepage": "https://verteilen.github.io/wiki/",
   "author": "Elly",

package/src/client/client.ts

@@ -15,6 +15,7 @@ import * as pem from 'pem'
 import * as https from 'https'
 
 /**
+ * **Compute Client**\
  * The calculation node worker
  */
 export class Client {

package/src/interface/base.ts

@@ -3,13 +3,18 @@
 //      Share Codebase     
 //                           
 // ========================
-import { DataType, DataTypeBase } from "./enum"
-import { ACLType, LocalPermiision } from "./server"
+/**
+ * Defined the basic compute use data structure
+ */
+import { DataType, DataTypeBase, JobType, JobType2 } from "./enum"
+import { ACLType, LocalPermission as LocalPermission } from "./server"
 
 export interface ParameterConfigTrigger {
     types: Array<DataTypeBase>
 }
-
+/**
+ * **Parameter Context**\
+ */
 export interface ParameterContainer {
     s?: boolean
     name: string
@@ -20,10 +25,28 @@ export interface ParameterContainer {
     runtimeOnly: boolean
     value: any
 }
-
+/**
+ * **Task Property**\
+ * Use to in local task region field\
+ * Reference in the job execute context
+ */
 export interface Property {
+    /**
+     * **Property Name**\
+     * The name of the property, use this string reference in other
+     * property or job
+     */
     name: string
+    /**
+     * **Property Expression**\
+     * The expression library use custom language {@link https://www.npmjs.com/package/expressionparser}\
+     * Follow the
+     */
     expression: string
+    /**
+     * **Depth Level**\
+     * 
+     */
     deep?: number
 }
 
@@ -32,51 +55,237 @@ export interface Parameter {
     title: string
     canWrite: boolean
     containers: Array<ParameterContainer>
+    /**
+     * **Local Permission**\
+     * Client-side only permission field\
+     * Server will check user token and defined its permission level\
+     * And modify this field and send back to user
+     */
+    permission?: LocalPermission
 }
-
+/**
+ * **Compute Instruction Container**\
+ * Specifed the command, which show how does user want these compute to do\
+ * Contains different arguments list, which could reference to parameter value
+ */
 export interface Job {
-    s?: boolean
-    permission?: LocalPermiision
+    /**
+     * **Order**\
+     * Define the order in the list\
+     * This value is use in the client-side only\
+     * Database will store in the array.
+     */
     index?:number
+    /**
+     * **Job ID**\
+     * Contains 36 characters
+     */
     uuid: string
+    /**
+     * **Execute Runtime ID**\
+     * This getting generate during the execute stage\
+     * Because their can be multiple node run in a same job\
+     * Or two execute project at the same time\
+     * In order to know which one feedback which execute thread\
+     * This value is needs to distinguish
+     */
     runtime_uuid?: string
+    /**
+     * **ENUM: The Job Category Type**\
+     * Could be "Condition" or "Execution"\
+     * Condition is the checker job, After finish it will feedback a result back to server-side\
+     * Execution will not feedback anything other then success or failed
+     */
     category: number
+    /**
+     * **ENUM: The Job SubType**\
+     * Base on the {@link Job.category} value\
+     * This could be {@link JobType} or {@link JobType2}
+     */
     type: number
+    /**
+     * **Javascript String**\
+     * Code context when {@link Job.type} is Javascript\
+     * The client-side will create a javascript vm and execute it
+     */
     script: string
+    /**
+     * **String Arguments**\
+     * In order to execute job, some type of job will require arguments
+     */
     string_args: Array<string>
+    /**
+     * **Number Arguments**\
+     * In order to execute job, some type of job will require arguments
+     */
     number_args: Array<number>
+    /**
+     * **Boolean Arguments**\
+     * In order to execute job, some type of job will require arguments
+     */
     boolean_args: Array<boolean>
+    /**
+     * **Local Permission**\
+     * Client-side only permission field\
+     * Server will check user token and defined its permission level\
+     * And modify this field and send back to user\
+     */
+    permission?: LocalPermission
 }
-
+/**
+ * **Task Container**\
+ * Specified different stage of the compute process
+ */
 export interface Task {
-    permission?: LocalPermiision
+    /**
+     * **Task ID**\
+     * Contains 36 characters
+     */
     uuid: string
+    /**
+     * **Task Name**\
+     * The name of the task
+     */
     title: string
+    /**
+     * **Task Description**\
+     * The description of the task
+     */
     description: string
+    /**
+     * **FLAG: SetupJob**\
+     * Every node will run through all jobs once
+     */
     setupjob: boolean
+    /**
+     * **FLAG: CronJob**\
+     * Generate X amounts of subtask\
+     * Then tells nodes to run through all of them\
+     * Who finish subtask first will get next subtask\
+     * Untill all subtasks finish
+     */
     cronjob: boolean
+    /**
+     * **Cron Reference Key**\
+     * Reference a parameter number in database
+     */
     cronjobKey: string
+    /**
+     * **FLAG: MultiJob**\
+     * Define how many thread can be generate in one node\
+     * If this is false, default will be 1
+     */
     multi: boolean
+    /**
+     * **Multi Reference Key**\
+     * Reference a parameter number in database
+     */
     multiKey: string
+    /**
+     * **Task Properties**\
+     * You could use properties to defined local region field
+     * And reference in the job execute context\
+     * **NOTICE: Order Matter**\
+     * The properties will generate base on the order in the list
+     */
     properties: Array<Property>
+    /**
+     * **Jobs Context**\
+     * A list of jobs, define the context of the task\
+     * Base on the flags, task can run it in a different way
+     */
     jobs: Array<Job>
+    /**
+     * **Local Permission**\
+     * Client-side only permission field\
+     * Server will check user token and defined its permission level\
+     * And modify this field and send back to user
+     */
+    permission?: LocalPermission
 }
-
+/**
+ * **Compute Structure Container**\
+ * It has reference to parameter And contains multiple task\
+ * We grab this container structure to execute queue to execute one by one
+ */
 export interface Project {
-    permission?: LocalPermiision
-    acl?: ACLType
+    /**
+     * **User ID**\
+     * Who own this project\
+     * It will specified public if this field is undefined\
+     * This will getting detect before {@link Project.acl}
+     */
     owner?: string
+    /**
+     * **Project ID**\
+     * Contains 36 characters
+     */
     uuid: string
+    /**
+     * **Project Name**\
+     * The name of the project
+     */
     title: string
-    description: string
-    parameter_uuid: string
+    /**
+     * **Project Description**\
+     * The description of the project
+     */
+    description?: string
+    /**
+     * **Parameter ID**\
+     * In order reference to parameter database
+     */
+    store_uuid: string
+    /**
+     * **Parameter instance**\
+     * The data field of parameter
+     */
     parameter?: Parameter
+    /**
+     * **Tasks**\
+     * The context of this project\
+     * Store all the tasks and jobs in here
+     */
     task: Array<Task>
+    /**
+     * **Local Permission**\
+     * Client-side only permission field\
+     * Server will check user token and defined its permission level\
+     * And modify this field and send back to user
+     */
+    permission?: LocalPermission
+    /**
+     * **Accessibility**\
+     * Could be public, protected, private
+     */
+    acl?: ACLType
 }
-
+/**
+ * **Compute Node Structure Container**\
+ * In the execute stage, it will needs nodes to compute the task\
+ * Which specified in this type of structure
+ */
 export interface Node {
-    permission?: LocalPermiision
-    acl?: ACLType
+    /**
+     * **ID**\
+     * The UUID of the compute node
+     */
     ID: string
+    /**
+     * **URL**\
+     * The address to the compute node
+     */
     url: string
+    /**
+     * **Local Permission**\
+     * Client-side only permission field\
+     * Server will check user token and defined its permission level\
+     * And modify this field and send back to user
+     */
+    permission?: LocalPermission
+    /**
+     * **Accessibility**\
+     * Could be public, protected, private
+     */
+    acl?: ACLType
 }

package/src/interface/bus.ts

@@ -3,6 +3,9 @@
 //      Share Codebase     
 //                           
 // ========================
+/**
+ * Event bus related type and interface
+ */
 import { Job, Parameter, Project, Task } from "./base"
 import { ExecuteState } from "./enum"
 import { ExecutionLog, Log, Preference } from "./record"
@@ -43,6 +46,7 @@ export interface EmitterProxy<T> {
 }
 
 /**
+ * **Execute Event Proxy**\
  * The middleware for task scheduler worker with singal sender
  */
 export interface ExecuteProxy {
@@ -90,6 +94,7 @@ export interface NodeProxy {
 }
 
 /**
+ * **Vue Event Bus Type**\
  * Emitter events container for Primary use
  */
 export type BusType = {

package/src/interface/enum.ts

@@ -3,13 +3,25 @@
 //      Share Codebase     
 //                           
 // ========================
+/**
+ * Enum library, including translation which will be use in Vue
+ */
+
+/**
+ * **Socket Type**\
+ * This exists because reference to ws or buildin socket will sometime cause error\
+ * So we will need to create one for ourselves
+ */
 export enum SocketState {
     CONNECTING = 0,
     OPEN = 1,
     CLOSING = 2,
     CLOSED = 3
 }
-
+/**
+ * **Data Type**\
+ * The support data type for parameter
+ */
 export enum DataType {
     Boolean, 
     Number, 
@@ -20,13 +32,21 @@ export enum DataType {
     Select,
     List,
 }
-
+/**
+ * **Data Type Base**\
+ * The support data type for calculation\
+ * Proerty or expression calculation will use this
+ */
 export enum DataTypeBase {
     Boolean, 
     Number, 
     String,
 }
-
+/**
+ * **Resource Query Type**\
+ * Client resource type\
+ * Use in when server query system information from node
+ */
 export enum ResourceType {
     ALL = ~(~0 << 10),
     SYSTEM = 1 << 0,
@@ -110,6 +130,10 @@ export enum JavascriptLib {
     PATH = 1 << 4,
 }
 
+export enum ServiceMode {
+    ONCE, CYCLE, EVENT
+}
+
 export const DataTypeText: { [key:number]:string } = {
     0: 'types.boolean',
     1: 'types.number',

package/src/interface/execute.ts

@@ -3,6 +3,9 @@
 //      Share Codebase     
 //                           
 // ========================
+/**
+ * The data structure which will use in execute stage
+ */
 import { Job } from "./base"
 import { ExecuteState } from "./enum"
 

package/src/interface/server.ts

@@ -3,14 +3,25 @@
 //      Share Codebase     
 //                           
 // ========================
+/**
+ * Express server related data structure
+ */
 import { Preference } from "./record"
+import { v6 as uuidv6 } from 'uuid'
 
+/**
+ * **Access Control Type**\
+ * Ot will have effect on permission value
+ */
 export enum ACLType {
     PUBLIC,
     PROTECTED,
     PRIVATE
 }
-
+/**
+ * **User Type**\
+ * It will have effect on permission value
+ */
 export enum UserType {
     ROOT,
     ADMIN,
@@ -31,20 +42,20 @@ export enum PermissionType {
 }
 
 export interface GlobalPermission {
-    project: LocalPermiision
-    task: LocalPermiision
-    job: LocalPermiision
-    parameter: LocalPermiision
+    project: LocalPermission
+    task: LocalPermission
+    job: LocalPermission
+    parameter: LocalPermission
 
-    plugin: LocalPermiision
-    node: LocalPermiision
-    lib: LocalPermiision
-    log: LocalPermiision
+    plugin: LocalPermission
+    node: LocalPermission
+    lib: LocalPermission
+    log: LocalPermission
 
     execute_job: boolean
 }
 
-export interface LocalPermiision {
+export interface LocalPermission {
     view: boolean
     create: boolean
     edit: boolean
@@ -53,13 +64,13 @@ export interface LocalPermiision {
 
 export interface LocalPermissionContainer {
     uuid: string
-    permission: LocalPermiision
+    permission: LocalPermission
 }
 
 export interface LocalPermissionContainer2 {
     uuid: string
     uuid2: string
-    permission: LocalPermiision
+    permission: LocalPermission
 }
 
 /**
@@ -68,6 +79,7 @@ export interface LocalPermissionContainer2 {
 export interface UserProfile {
     token: string
     name: string
+    email?: string
     preference: Preference
     type: UserType
     description?: string
@@ -88,4 +100,44 @@ export interface UserProfileClient {
 
 export interface ServerSetting {
     open_guest: boolean
+}
+
+export const CreateRootPermission = ():GlobalPermission => {
+    const perl:LocalPermission = {
+        view: true,
+        create: true,
+        edit: true,
+        delete: true,
+    }
+    const per:GlobalPermission = {
+        project: perl,
+        task: perl,
+        job: perl,
+        plugin: perl,
+        node: perl,
+        parameter: perl,
+        lib: perl,
+        log: perl,
+        execute_job: true
+    }
+    return per
+}
+
+export const CreateRootUser = ():UserProfile => {
+    return {
+        token: uuidv6(),
+        type: UserType.ROOT,
+        preference: {
+            lan: 'en',
+            log: true,
+            font: 18,
+            theme: "dark",
+            notification: false,
+            plugin_token: [],
+            animation: true,
+        },
+        name: "root",
+        description: "Root User",
+        permission: CreateRootPermission()
+    }
 }

package/src/interface/struct.ts

@@ -3,8 +3,13 @@
 //      Share Codebase     
 //                           
 // ========================
+/**
+ * All kinds of data structure
+ * It's a mess, i know
+ */
 import { ParameterContainer, Project } from "./base"
 import ws from 'ws'
+import { ServiceMode } from "./enum"
 
 type ProjectCall = (p:Project) => Project
 type ParameterCall = () => Array<ParameterContainer>
@@ -112,7 +117,6 @@ export interface FeedBack {
     message: string
 }
 
-
 export interface KeyValue {
     key: any
     value: any
@@ -289,4 +293,8 @@ export interface BuildinAssetsContent {
 
 export interface BuildinAssets {
     data: Array<BuildinAssetsContent>
+}
+
+export interface ServiceConfig {
+    mode: ServiceMode
 }

package/src/interface/table.ts

@@ -3,6 +3,10 @@
 //      Share Codebase     
 //                           
 // ========================
+/**
+ * Value override for some base value\
+ * The data structure that use in Vue
+ */
 import { Node } from './base'
 import { Plugin, SystemLoad } from './struct'
 

package/src/interface/ui.ts

@@ -3,6 +3,10 @@
 //      Share Codebase     
 //                           
 // ========================
+/**
+ * Vue Client-side only data structure
+ */
+
 export interface AppConfig {
     isExpress: boolean
     isElectron: boolean

package/src/lan/en.json

@@ -44,7 +44,8 @@
     "settings": {
         "system": "System",
         "appearance": "Appearance",
-        "workflow": "Workflow"
+        "workflow": "Workflow",
+        "token_remove": "Are you sure you want to remove the token"
     },
     "toast": {
         "server": "Server Mode",
@@ -338,6 +339,7 @@
             "messager_log": "messager_log(message:string)"
         }
     },
+    "token": "Token",
     "info": "Information",
     "search": "Search",
     "selectall": "Select All",

package/src/lan/zh_TW.json

@@ -44,7 +44,8 @@
     "settings": {
         "system": "系統",
         "appearance": "外觀",
-        "workflow": "流程"
+        "workflow": "流程",
+        "token_remove": "確定刪除密鑰嗎"
     },
     "toast": {
         "server": "伺服器模式",
@@ -338,6 +339,7 @@
             "messager_log": "messager_log(message:string)"
         }
     },
+    "token": "密鑰",
     "info": "資訊",
     "search": "搜尋",
     "selectall": "全選",

package/src/plugins/i18n.ts

@@ -22,6 +22,7 @@ export { createI18n as Create }
  * app.use(i18n)
  */
 export const i18nDefaultData = {
+    legacy: true,
     locale: 'en',
     globalInjection: true,
     fallbackFormat: 'en',