@jitar/plugin-vite 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+
+# Changelog
+
+This package doesn't keep a changelog. See the changelog in the [github repository](https://github.com/MaskingTechnology/jitar/blob/main/CHANGELOG.md)

package/README.md

@@ -0,0 +1,33 @@
+
+# Jitar Plugin for Vite
+
+This plugin allows you to use [Vite](https://vitejs.dev/) to build your [Jitar](https://jitar.dev/) app.
+
+## Installation
+
+```bash
+npm install --save-dev @jitar/vite-plugin
+```
+
+## Usage
+
+The plugin needs to be added to the vite config file.
+
+```js
+// vite.config.js
+import { defineConfig } from 'vite'
+import jitar from '@jitar/plugin-vite'
+
+export default defineConfig({
+  plugins: [
+    jitar(srcPath, jitarPath, jitarUrl, [segments])
+  ]
+})
+```
+
+The plugin takes 4 arguments:
+
+* **srcPath** - The path to the app source files. In most cases this is the `src` folder.
+* **jitarPath** - The path to the source files used by Jitar. This path is relative to the source root. We like to use `shared` (which points to `src/shared`), but feel free to use something else.
+* **jitarUrl** - The URL of the Jitar instance. Jitar uses by default `http://localhost:3000`, but can be configured differently in the Jitar config.
+* **segments** - The segments to use for the client app. This is an array of strings. The default is an empty array.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { PluginOption } from 'vite';
+export default function viteJitar(sourcePath: string, jitarPath: string, jitarUrl: string, segments?: string[]): PluginOption;

package/dist/index.js

@@ -0,0 +1,86 @@
+import path from 'path';
+import { normalizePath } from 'vite';
+import { Reflector, ReflectionFunction } from '@jitar/reflection';
+const reflector = new Reflector();
+function formatPath(path) {
+    path = normalizePath(path);
+    if (path.startsWith('/')) {
+        path = path.substring(1);
+    }
+    if (path.endsWith('/')) {
+        path = path.substring(0, path.length - 1);
+    }
+    return path;
+}
+function createServerConfig(jitarUrl) {
+    return {
+        build: {
+            target: 'esnext'
+        },
+        server: {
+            proxy: {
+                '/rpc': jitarUrl,
+                '/jitar': jitarUrl,
+                '/modules': jitarUrl,
+            }
+        }
+    };
+}
+function createBootstrapCode(segments) {
+    const segmentString = segments.map(segment => `'${segment}'`).join(', ');
+    return `<script type="module">const jitar = await import('/jitar/client.js'); await jitar.startClient(document.location.origin, [${segmentString}]);</script>`;
+}
+async function createImportCode(code, id, jitarFullPath, jitarPath) {
+    const relativeId = id
+        .replace(jitarFullPath, '')
+        .replace('.ts', '.js');
+    const module = reflector.parse(code);
+    const exported = module.exported;
+    const allKeys = [...exported.keys()];
+    const functionKeys = allKeys.filter(key => key !== 'default' && exported.get(key) instanceof ReflectionFunction);
+    let importCode = '';
+    let exportCode = '';
+    if (exported.has('default')) {
+        importCode += `const defaultExport = module.default;\n`;
+        exportCode += `export default defaultExport;\n`;
+    }
+    if (functionKeys.length > 0) {
+        importCode += functionKeys.map(key => `const ${key} = module.${key};`).join('\n');
+        exportCode += `export { ${functionKeys.join(', ')} };\n`;
+    }
+    return 'const jitar = await import(/* @vite-ignore */`/jitar/client.js`);\n'
+        + 'const client = await jitar.getClient();\n'
+        + `const module = await client.import('./${jitarPath}${relativeId}');\n`
+        + importCode
+        + exportCode;
+}
+export default function viteJitar(sourcePath, jitarPath, jitarUrl, segments = []) {
+    sourcePath = formatPath(sourcePath);
+    jitarPath = formatPath(jitarPath);
+    let jitarFullPath = undefined;
+    return {
+        name: 'jitar-plugin-vite',
+        enforce: 'post',
+        config() {
+            return createServerConfig(jitarUrl);
+        },
+        configResolved(resolvedConfig) {
+            jitarFullPath = path.join(resolvedConfig.root, sourcePath, jitarPath);
+        },
+        resolveId(source) {
+            if (source === '/jitar/client.js') {
+                return { id: source, external: 'absolute' };
+            }
+            return null;
+        },
+        async transform(code, id) {
+            if (jitarFullPath === undefined || id.includes(jitarFullPath) === false) {
+                return code;
+            }
+            return await createImportCode(code, id, jitarFullPath, jitarPath);
+        },
+        transformIndexHtml(html) {
+            return html.replace('<head>', `<head>${createBootstrapCode(segments)}`);
+        }
+    };
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@jitar/plugin-vite",
+  "version": "0.4.0",
+  "description": "Vite plugin for Jitar.",
+  "author": "Masking Technology <info@masking.tech> (https://jitar.dev)",
+  "license": "MIT",
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "lint": "eslint . --ext .ts",
+    "clean": "rm -rf dist build",
+    "release": "npm run clean && npm run build && npm publish --access public"
+  },
+  "dependencies": {
+    "@jitar/reflection": "^0.4.0"
+  },
+  "peerDependencies": {
+    "vite": "^4.3.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MaskingTechnology/jitar"
+  },
+  "bugs": {
+    "url": "https://github.com/MaskingTechnology/jitar/issues"
+  },
+  "homepage": "https://jitar.dev",
+  "keywords": [
+    "vite",
+    "jitar"
+  ]
+}