feat: add support for typescript plugins (#35)

Author: BatLeDev

api/src/routers/plugins.ts

@@ -70,14 +70,22 @@ router.post('/', permissions.isSuperAdmin, async (req, res) => {
     // create a pseudo npm package with a dependency to the plugin referenced from the registry
     await fs.writeFile(path.join(dir.path, 'package.json'), JSON.stringify({
       name: plugin.id.replace('@', ''),
+      type: 'module',
       dependencies: {
         [plugin.name]: '^' + plugin.version
       }
     }, null, 2))
     await exec('npm install --omit=dev', { cwd: dir.path })
-    await fs.writeFile(path.join(dir.path, 'index.js'), `module.exports = require('${plugin.name}')`)
-    plugin.pluginConfigSchema = await fs.readJson(path.join(dir.path, 'node_modules', plugin.name, 'plugin-config-schema.json'))
-    plugin.processingConfigSchema = await fs.readJson(path.join(dir.path, 'node_modules', plugin.name, 'processing-config-schema.json'))
+
+    // move the plugin to the src directory (Stripping types is currently unsupported for files under node_modules)
+    await fs.move(path.join(dir.path, 'node_modules', plugin.name), path.join(dir.path, 'src'), { overwrite: true })
+
+    // generate an index.js file to export the main file
+    const mainFile = (await fs.readJson(path.join(dir.path, 'src', 'package.json'))).main || 'index.js'
+    await fs.writeFile(path.join(dir.path, 'index.js'), `export * from './${path.join('src', mainFile)}'`)
+
+    plugin.pluginConfigSchema = await fs.readJson(path.join(dir.path, 'src', 'plugin-config-schema.json'))
+    plugin.processingConfigSchema = await fs.readJson(path.join(dir.path, 'src', 'processing-config-schema.json'))
     await fs.writeFile(path.join(dir.path, 'plugin.json'), JSON.stringify(plugin, null, 2))
     await fs.move(dir.path, pluginDir, { overwrite: true })
   } finally {

package-lock.json

@@ -2,7 +2,7 @@
   "name": "@data-fair/processings-shared",
   "type": "module",
   "devDependencies": {
-    "@data-fair/lib-express": "^1.8.0"
+    "@data-fair/lib-express": "^1.13.1"
   },
   "dependencies": {
     "@data-fair/lib-node": "^2.1.0",

shared/package.json

@@ -20,7 +20,6 @@ declare module 'vue-router/auto-routes' {
   export interface RouteNamedMap {
     '/admin/': RouteRecordInfo<'/admin/', '/admin', Record<never, never>, Record<never, never>>,
     '/admin/plugins': RouteRecordInfo<'/admin/plugins', '/admin/plugins', Record<never, never>, Record<never, never>>,
-    '/dev': RouteRecordInfo<'/dev', '/dev', Record<never, never>, Record<never, never>>,
     '/processings/': RouteRecordInfo<'/processings/', '/processings', Record<never, never>, Record<never, never>>,
     '/processings/[id]': RouteRecordInfo<'/processings/[id]', '/processings/:id', { id: ParamValue<true> }, { id: ParamValue<false> }>,
     '/runs/[id]': RouteRecordInfo<'/runs/[id]', '/runs/:id', { id: ParamValue<true> }, { id: ParamValue<false> }>,

ui/dts/typed-router.d.ts

@@ -13,7 +13,7 @@
   },
   "devDependencies": {
     "@data-fair/lib-common-types": "^1.5.4",
-    "@data-fair/lib-express": "^1.12.6",
+    "@data-fair/lib-express": "^1.13.1",
     "@types/child-process-promise": "^2.2.6",
     "@types/nodemailer": "^6.4.16",
     "@types/resolve-path": "^1.4.3"