feat(engine): types for modules

.gitignore

@@ -57,3 +57,9 @@ dataEval.json
 
 # Ignore generated credentials from google-github-actions/auth
 gha-creds-*.json
+
+# Turborepo
+.turbo
+@types
+FeatureFlags.d.ts
+FeatureFlags.d.ts.map

checktypes.js

@@ -0,0 +1,13 @@
+const path = require('path');
+const fs = require('fs');
+
+const file = process.argv[2];
+const package = require(file);
+const types = package['types'];
+
+if (!types) return;
+
+const typesPath = path.join(path.dirname(file), types);
+
+if (fs.existsSync(typesPath)) console.log(`${typesPath} ✅`);
+else console.log(`${typesPath} ❌`);

jest.config.js

@@ -5,6 +5,7 @@ const ignorePaths = [
   '<rootDir>/.yarn-cache',
   '<rootDir>/src/management-system',
   '<rootDir>/src/management-system-v2/.next/',
+  '@types',
 ];
 
 let projects = [

package.json

@@ -1,5 +1,6 @@
 {
   "private": true,
+  "name": "PROCEED",
   "workspaces": {
     "packages": [
       "src/engine/universal/*",
@@ -51,6 +52,7 @@
     "dev-web": "yarn build && cd src/engine/native/web/server && yarn serve",
     "dev-many": "node src/engine/e2e_tests/process/deployment/startEngines.js",
     "build": "cd src/engine/native/node && webpack --config webpack.native.config.js && webpack --config webpack.injector.config.ts && cd ../../universal && NODE_OPTIONS=--openssl-legacy-provider webpack --config webpack.universal.config.js",
+    "build-engine-types": "turbo build --filter \"./src/engine/**/\"",
     "build-ms": "cd src/management-system-v2 && yarn build",
     "build-web": "yarn build && cd src/engine/native/web/server && yarn build",
     "docker:run": "docker container run --publish 33029:33029 --rm --network host --detach --name engine proceed/engine:latest",
@@ -65,6 +67,7 @@
     "jsdoc": "jsdoc -c ./jsdoc.config.json --pedantic",
     "android-prepare": "cd src/engine/universal && webpack --output-path ../native/android/app/src/main/assets --config webpack.universal.config.js",
     "build-android": "yarn android-prepare && cd src/engine/native/android && ./gradlew assembleDebug",
+    "postinstall": "yarn build && yarn build-engine-types",
     "prepare": "husky"
   },
   "lint-staged": {
@@ -73,7 +76,8 @@
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged",
-      "pre-push": "yarn test-engine && yarn test-ms"
+      "pre-push": "yarn test-engine && yarn test-ms",
+      "post-merge": "yarn build && yarn build-engine-types"
     }
   },
   "devDependencies": {
@@ -122,6 +126,7 @@
     "tsx": "4.19.2"
   },
   "dependencies": {
-    "react-resizable": "^3.0.5"
+    "react-resizable": "^3.0.5",
+    "turbo": "2.1.1"
   }
 }

src/config-server/package.json

@@ -6,6 +6,7 @@
   "description": "The central storage server for advanced use cases in the PROCEED project. It mainly stores config data used for multiple companies to cooperate",
   "license": "MIT",
   "main": "./configServer.js",
+  "types": "./@types/configServer.d.ts",
   "scripts": {
     "dev": "node ./configServer.js"
   },
@@ -26,5 +27,8 @@
     "express": "^4.17.1",
     "request": "^2.88.0"
   },
-  "devDependencies": {}
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  }
 }

src/config-server/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-capabilities/package.json

@@ -2,10 +2,15 @@
   "name": "@proceed/native-capabilities",
   "version": "1.0.0",
   "description": "Native module that implements the `capability` command.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
     "@proceed/native-module": "^1.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-capabilities/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./src"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-config/package.json

@@ -2,10 +2,15 @@
   "name": "@proceed/native-config",
   "version": "1.0.0",
   "description": "Native module that implements the `config` command.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
     "@proceed/native-module": "^1.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-config/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./src", "./src/config_default.json"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-console/package.json

@@ -2,10 +2,15 @@
   "name": "@proceed/native-console",
   "version": "1.0.0",
   "description": "Native module that implements the `console_log` command.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
     "@proceed/native-module": "^1.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-console/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-express/package.json

@@ -2,7 +2,8 @@
   "name": "@proceed/native-express",
   "version": "1.0.0",
   "description": "Native module that implements the `serve` and `respond` commands.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
@@ -12,5 +13,9 @@
     "busboy": "^0.3.1",
     "body-parser": "^1.19.0",
     "stoppable": "^1.1.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-express/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-fs/package.json

@@ -2,7 +2,8 @@
   "name": "@proceed/native-fs",
   "version": "1.0.0",
   "description": "Native module that implements the `read` and `write`commands.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
@@ -11,5 +12,9 @@
   },
   "devDependencies": {
     "@types/jest": "^25.1.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-fs/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./src"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-koa/package.json

@@ -2,7 +2,8 @@
   "name": "@proceed/native-koa",
   "version": "1.0.0",
   "description": "Native module that implements the `serve` and `respond` commands.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
@@ -13,5 +14,9 @@
     "koa-bodyparser": "^4.2.1",
     "busboy": "0.3.1",
     "stoppable": "^1.1.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-koa/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-machine/package.json

@@ -2,13 +2,18 @@
   "name": "@proceed/native-machine",
   "version": "1.0.0",
   "description": "Native module that implements the `read_device_info` command.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
     "@proceed/native-module": "^1.0.0",
     "machine-uuid": "^1.2.0",
     "systeminformation": "^4.30.1",
     "ping": "^0.3.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-machine/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-mdns/package.json

@@ -2,12 +2,17 @@
   "name": "@proceed/native-mdns",
   "version": "1.0.0",
   "description": "Native module that implements the `discover` and `publish` commands.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
     "@proceed/native-module": "^1.0.0",
     "bonjour-service": "1.1.1",
     "@darkobits/adeiu": "0.3.1"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-mdns/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-module/package.json

@@ -3,6 +3,11 @@
   "version": "1.0.0",
   "description": "Native module class for use in the @proceed/native part",
   "main": "src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
-  "license": "MIT"
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  }
 }

src/engine/native/node/native-module/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-mqtt/package.json

@@ -2,11 +2,16 @@
   "name": "@proceed/native-mqtt",
   "version": "1.0.0",
   "description": "Native module that implements the `publish`, `subscribe` and 'unsubscribe' commands.",
-  "main": "src/index.js",
+  "main": "./src/index.js",
+  "types": "./@types/index.d.ts",
   "author": "PROCEED Project",
   "license": "MIT",
   "dependencies": {
     "@proceed/native-module": "^1.0.0",
     "async-mqtt": "^2.6.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-mqtt/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}

src/engine/native/node/native-script-execution/package.json

@@ -8,5 +8,9 @@
   "dependencies": {
     "@proceed/native-module": "^1.0.0",
     "isolated-vm": "^5.0.1"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
 }

src/engine/native/node/native-script-execution/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../../../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "declarationDir": "./@types",
+    "emitDeclarationOnly": true
+  }
+}