feat: Jan Server, API and decoupled clients

Makefile

@@ -18,6 +18,7 @@ ifeq ($(OS),Windows_NT)
 	yarn config set network-timeout 300000
 endif
 	yarn build:core
+	yarn build:server
 	yarn install
 	yarn build:extensions
 

core/package.json

@@ -22,6 +22,27 @@
   "engines": {
     "node": ">=6.0.0"
   },
+  "exports": {
+    ".": "./dist/core.umd.js",
+    "./sdk": "./dist/core.umd.js",
+    "./node": "./dist/node/index.cjs.js"
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/core.es5.js.map",
+        "./dist/types/index.d.ts"
+      ],
+      "sdk": [
+        "./dist/core.es5.js.map",
+        "./dist/types/index.d.ts"
+      ],
+      "node": [
+        "./dist/node/index.cjs.js.map",
+        "./dist/types/node/index.d.ts"
+      ]
+    }
+  },
   "scripts": {
     "lint": "tslint  --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*.ts'",
     "prebuild": "rimraf dist",

core/rollup.config.ts

@@ -8,30 +8,69 @@ const pkg = require('./package.json')
 
 const libraryName = 'core'
 
-export default {
-  input: `src/index.ts`,
-  output: [
-    { file: pkg.main, name: libraryName, format: 'umd', sourcemap: true },
-    { file: pkg.module, format: 'es', sourcemap: true },
-  ],
-  // Indicate here external modules you don't wanna include in your bundle (i.e.: 'lodash')
-  external: [],
-  watch: {
-    include: 'src/**',
+export default [
+  {
+    input: `src/index.ts`,
+    output: [
+      { file: pkg.main, name: libraryName, format: 'umd', sourcemap: true },
+      { file: pkg.module, format: 'es', sourcemap: true },
+    ],
+    // Indicate here external modules you don't wanna include in your bundle (i.e.: 'lodash')
+    external: ['path'],
+    watch: {
+      include: 'src/**',
+    },
+    plugins: [
+      // Allow json resolution
+      json(),
+      // Compile TypeScript files
+      typescript({ useTsconfigDeclarationDir: true }),
+      // Allow bundling cjs modules (unlike webpack, rollup doesn't understand cjs)
+      commonjs(),
+      // Allow node_modules resolution, so you can use 'external' to control
+      // which external modules to include in the bundle
+      // https://github.com/rollup/rollup-plugin-node-resolve#usage
+      resolve(),
+
+      // Resolve source maps to the original source
+      sourceMaps(),
+    ],
   },
-  plugins: [
-    // Allow json resolution
-    json(),
-    // Compile TypeScript files
-    typescript({ useTsconfigDeclarationDir: true }),
-    // Allow bundling cjs modules (unlike webpack, rollup doesn't understand cjs)
-    commonjs(),
-    // Allow node_modules resolution, so you can use 'external' to control
-    // which external modules to include in the bundle
-    // https://github.com/rollup/rollup-plugin-node-resolve#usage
-    resolve(),
+  {
+    input: `src/node/index.ts`,
+    output: [{ file: 'dist/node/index.cjs.js', format: 'cjs', sourcemap: true }],
+    // Indicate here external modules you don't wanna include in your bundle (i.e.: 'lodash')
+    external: [
+      'fs/promises',
+      'path',
+      'pacote',
+      '@types/pacote',
+      '@npmcli/arborist',
+      'ulid',
+      'node-fetch',
+      'fs',
+      'request',
+      'crypto',
+      'url',
+      'http',
+    ],
+    watch: {
+      include: 'src/node/**',
+    },
+    plugins: [
+      // Allow json resolution
+      json(),
+      // Compile TypeScript files
+      typescript({ useTsconfigDeclarationDir: true }),
+      // Allow bundling cjs modules (unlike webpack, rollup doesn't understand cjs)
+      commonjs(),
+      // Allow node_modules resolution, so you can use 'external' to control
+      // which external modules to include in the bundle
+      // https://github.com/rollup/rollup-plugin-node-resolve#usage
+      resolve(),
 
-    // Resolve source maps to the original source
-    sourceMaps(),
-  ],
-}
+      // Resolve source maps to the original source
+      sourceMaps(),
+    ],
+  },
+]

core/src/api/index.ts

@@ -5,7 +5,6 @@
 export enum AppRoute {
   appDataPath = 'appDataPath',
   appVersion = 'appVersion',
-  getResourcePath = 'getResourcePath',
   openExternalUrl = 'openExternalUrl',
   openAppDirectory = 'openAppDirectory',
   openFileExplore = 'openFileExplorer',
@@ -41,20 +40,20 @@ export enum ExtensionRoute {
   uninstallExtension = 'uninstallExtension',
 }
 export enum FileSystemRoute {
-  appendFile = 'appendFile',
-  copyFile = 'copyFile',
-  syncFile = 'syncFile',
-  deleteFile = 'deleteFile',
-  exists = 'exists',
-  getResourcePath = 'getResourcePath',
+  appendFileSync = 'appendFileSync',
+  copyFileSync = 'copyFileSync',
+  unlinkSync = 'unlinkSync',
+  existsSync = 'existsSync',
+  readdirSync = 'readdirSync',
+  mkdirSync = 'mkdirSync',
+  readFileSync = 'readFileSync',
+  rmdirSync = 'rmdirSync',
+  writeFileSync = 'writeFileSync',
+}
+export enum FileManagerRoute {
+  synceFile = 'syncFile',
   getUserSpace = 'getUserSpace',
-  isDirectory = 'isDirectory',
-  listFiles = 'listFiles',
-  mkdir = 'mkdir',
-  readFile = 'readFile',
-  readLineByLine = 'readLineByLine',
-  rmdir = 'rmdir',
-  writeFile = 'writeFile',
+  getResourcePath = 'getResourcePath',
 }
 
 export type ApiFunction = (...args: any[]) => any
@@ -83,17 +82,23 @@ export type FileSystemRouteFunctions = {
   [K in FileSystemRoute]: ApiFunction
 }
 
+export type FileManagerRouteFunctions = {
+  [K in FileManagerRoute]: ApiFunction
+}
+
 export type APIFunctions = AppRouteFunctions &
   AppEventFunctions &
   DownloadRouteFunctions &
   DownloadEventFunctions &
   ExtensionRouteFunctions &
-  FileSystemRouteFunctions
+  FileSystemRouteFunctions &
+  FileManagerRoute
 
 export const APIRoutes = [
   ...Object.values(AppRoute),
   ...Object.values(DownloadRoute),
   ...Object.values(ExtensionRoute),
   ...Object.values(FileSystemRoute),
+  ...Object.values(FileManagerRoute),
 ]
 export const APIEvents = [...Object.values(AppEvent), ...Object.values(DownloadEvent)]

core/src/fs.ts

@@ -1,89 +1,74 @@
 /**
  * Writes data to a file at the specified path.
- * @param {string} path - The path to the file.
- * @param {string} data - The data to write to the file.
  * @returns {Promise<any>} A Promise that resolves when the file is written successfully.
  */
-const writeFile: (path: string, data: string) => Promise<any> = (path, data) =>
-  global.core.api?.writeFile(path, data)
-
-/**
- * Checks whether the path is a directory.
- * @param path - The path to check.
- * @returns {boolean} A boolean indicating whether the path is a directory.
- */
-const isDirectory = (path: string): Promise<boolean> => global.core.api?.isDirectory(path)
+const writeFileSync = (...args: any[]) => global.core.api?.writeFileSync(...args)
 
 /**
  * Reads the contents of a file at the specified path.
- * @param {string} path - The path of the file to read.
  * @returns {Promise<any>} A Promise that resolves with the contents of the file.
  */
-const readFile: (path: string) => Promise<any> = (path) => global.core.api?.readFile(path)
+const readFileSync = (...args: any[]) => global.core.api?.readFileSync(...args)
 /**
  * Check whether the file exists
  * @param {string} path
  * @returns {boolean} A boolean indicating whether the path is a file.
  */
-const exists = (path: string): Promise<boolean> => global.core.api?.exists(path)
+const existsSync = (...args: any[]) => global.core.api?.existsSync(...args)
 /**
  * List the directory files
- * @param {string} path - The path of the directory to list files.
  * @returns {Promise<any>} A Promise that resolves with the contents of the directory.
  */
-const listFiles: (path: string) => Promise<any> = (path) => global.core.api?.listFiles(path)
+const readdirSync = (...args: any[]) => global.core.api?.readdirSync(...args)
 /**
  * Creates a directory at the specified path.
- * @param {string} path - The path of the directory to create.
  * @returns {Promise<any>} A Promise that resolves when the directory is created successfully.
  */
-const mkdir: (path: string) => Promise<any> = (path) => global.core.api?.mkdir(path)
+const mkdirSync = (...args: any[]) => global.core.api?.mkdirSync(...args)
 
 /**
  * Removes a directory at the specified path.
- * @param {string} path - The path of the directory to remove.
  * @returns {Promise<any>} A Promise that resolves when the directory is removed successfully.
  */
-const rmdir: (path: string) => Promise<any> = (path) => global.core.api?.rmdir(path)
+const rmdirSync = (...args: any[]) =>
+  global.core.api?.rmdirSync(...args, { recursive: true, force: true })
 /**
  * Deletes a file from the local file system.
  * @param {string} path - The path of the file to delete.
  * @returns {Promise<any>} A Promise that resolves when the file is deleted.
  */
-const deleteFile: (path: string) => Promise<any> = (path) => global.core.api?.deleteFile(path)
+const unlinkSync = (...args: any[]) => global.core.api?.unlinkSync(...args)
 
 /**
  * Appends data to a file at the specified path.
- * @param path path to the file
- * @param data data to append
  */
-const appendFile: (path: string, data: string) => Promise<any> = (path, data) =>
-  global.core.api?.appendFile(path, data)
-
-const copyFile: (src: string, dest: string) => Promise<any> = (src, dest) =>
-  global.core.api?.copyFile(src, dest)
+const appendFileSync = (...args: any[]) => global.core.api?.appendFileSync(...args)
 
+/**
+ * Synchronizes a file from a source path to a destination path.
+ * @param {string} src - The source path of the file to be synchronized.
+ * @param {string} dest - The destination path where the file will be synchronized to.
+ * @returns {Promise<any>} - A promise that resolves when the file has been successfully synchronized.
+ */
 const syncFile: (src: string, dest: string) => Promise<any> = (src, dest) =>
   global.core.api?.syncFile(src, dest)
+
 /**
- * Reads a file line by line.
- * @param {string} path - The path of the file to read.
- * @returns {Promise<any>} A promise that resolves to the lines of the file.
+ * Copy file sync.
  */
-const readLineByLine: (path: string) => Promise<any> = (path) =>
-  global.core.api?.readLineByLine(path)
+const copyFileSync = (...args: any[]) => global.core.api?.copyFileSync(...args)
 
+// TODO: Export `dummy` fs functions automatically
+// Currently adding these manually
 export const fs = {
-  isDirectory,
-  writeFile,
-  readFile,
-  exists,
-  listFiles,
-  mkdir,
-  rmdir,
-  deleteFile,
-  appendFile,
-  readLineByLine,
-  copyFile,
+  writeFileSync,
+  readFileSync,
+  existsSync,
+  readdirSync,
+  mkdirSync,
+  rmdirSync,
+  unlinkSync,
+  appendFileSync,
+  copyFileSync,
   syncFile,
 }

core/src/node/api/HttpServer.ts

@@ -0,0 +1,8 @@
+export interface HttpServer {
+  post: (route: string, handler: (req: any, res: any) => Promise<any>) => void
+  get: (route: string, handler: (req: any, res: any) => Promise<any>) => void
+  patch: (route: string, handler: (req: any, res: any) => Promise<any>) => void
+  put: (route: string, handler: (req: any, res: any) => Promise<any>) => void
+  delete: (route: string, handler: (req: any, res: any) => Promise<any>) => void
+  register: (router: any, opts?: any) => void
+}