@kopflos-cms/vite 0.1.2 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @kopflos-cms/vite
 
+## 0.2.1
+
+### Patch Changes
+
+- 46491b5: Relative `configPath` option will be resolved against `basePath` from kopflos environment.
+- 0c33953: Build plugin command now receives `KopflosEnvironment` as argument
+
+## 0.2.0
+
+### Minor Changes
+
+- accad6e: Removed the type `KopflosPluginConstructor` and now all plugins are exported as classes directly and their options are passed to the constructor
+
+### Patch Changes
+
+- 6511af6: build(deps): bump glob from 11.0.0 to 11.1.0
+- 4214fce: Added an accessor to the `ViteDevServer` the plugin instance
+- cdbb172: Adopt a simpler definition of a plugin where all methods are instance methods. Kopflos instance is passed as parameter
+- 5295694: build(deps): bump express from 5.0.1 to 5.2.0
+
 ## 0.1.2
 
 ### Patch Changes

package/index.d.ts

@@ -1,5 +1,6 @@
-import type { KopflosPluginConstructor } from '@kopflos-cms/core';
-import type { InlineConfig } from 'vite';
+import type { Kopflos, KopflosEnvironment, KopflosPlugin } from '@kopflos-cms/core';
+import express from 'express';
+import type { InlineConfig, ViteDevServer } from 'vite';
 export { defineConfig } from 'vite';
 export interface Options {
     configPath?: string;
@@ -8,9 +9,27 @@ export interface Options {
     outDir?: string;
     entrypoints?: string[];
 }
+interface VitePlugin extends KopflosPlugin {
+    viteDevServer?: ViteDevServer;
+}
 declare module '@kopflos-cms/core' {
     interface PluginConfig {
         '@kopflos-cms/vite'?: Options;
     }
+    interface Plugins {
+        '@kopflos-cms/vite': VitePlugin;
+    }
+}
+export default class implements VitePlugin {
+    private readonly options;
+    readonly name = "@kopflos-cms/vite";
+    private readonly rootDir;
+    private readonly buildDir;
+    private readonly outDir;
+    private _viteDevServer?;
+    constructor(options: Options);
+    get viteDevServer(): ViteDevServer | undefined;
+    onStart({ env }: Kopflos): Promise<void> | void;
+    beforeMiddleware(host: express.Router, { env }: Kopflos): Promise<void>;
+    build(env: KopflosEnvironment): Promise<void>;
 }
-export default function ({ outDir, ...options }: Options): KopflosPluginConstructor;

package/index.js

@@ -5,35 +5,53 @@ import { createViteServer } from './lib/server.js';
 import { prepareConfig } from './lib/config.js';
 import { log } from './lib/log.js';
 export { defineConfig } from 'vite';
-export default function ({ outDir = 'dist', ...options }) {
-    const rootDir = resolve(process.cwd(), options.root || '');
-    const buildDir = resolve(process.cwd(), outDir);
-    return class {
-        constructor(instance) {
-            this.env = instance.env;
+export default class {
+    constructor(options) {
+        this.options = options;
+        this.name = '@kopflos-cms/vite';
+        this.outDir = options.outDir || 'dist';
+        this.rootDir = options.root || '';
+        this.buildDir = this.outDir;
+    }
+    get viteDevServer() {
+        return this._viteDevServer;
+    }
+    onStart({ env }) {
+        const viteVars = {
+            basePath: resolve(env.kopflos.basePath, env.kopflos.config.mode === 'development' ? this.rootDir : this.buildDir),
+        };
+        log.info('Variables', viteVars);
+        env.kopflos.variables.VITE = Object.freeze(viteVars);
+    }
+    async beforeMiddleware(host, { env }) {
+        if (env.kopflos.config.mode === 'development') {
+            log.info('Development UI mode. Creating Vite server...');
+            const configPath = this.options.configPath
+                ? resolve(env.kopflos.basePath, this.options.configPath)
+                : this.options.configPath;
+            this._viteDevServer = await createViteServer({
+                configPath,
+                ...this.options,
+            });
+            host.use(this._viteDevServer.middlewares);
         }
-        onStart() {
-            const viteVars = {
-                basePath: this.env.kopflos.config.mode === 'development' ? rootDir : buildDir,
-            };
-            log.info('Variables', viteVars);
-            this.env.kopflos.variables.VITE = Object.freeze(viteVars);
+        else {
+            const buildDir = resolve(env.kopflos.basePath, this.buildDir);
+            log.info('Serving UI from build directory');
+            log.debug('Build directory:', buildDir);
+            host.use(express.static(buildDir));
         }
-        async beforeMiddleware(host) {
-            if (this.env.kopflos.config.mode === 'development') {
-                log.info('Development UI mode. Creating Vite server...');
-                const viteServer = await createViteServer(options);
-                host.use(viteServer.middlewares);
-            }
-            else {
-                log.info('Serving UI from build directory');
-                log.debug('Build directory:', buildDir);
-                host.use(express.static(buildDir));
-            }
-        }
-        static async build() {
-            log.info('Building UI...');
-            await build(await prepareConfig({ outDir, ...options }));
-        }
-    };
+    }
+    async build(env) {
+        log.info('Building UI...');
+        const outDir = resolve(env.kopflos.basePath, this.outDir);
+        const configPath = this.options.configPath
+            ? resolve(env.kopflos.basePath, this.options.configPath)
+            : this.options.configPath;
+        await build(await prepareConfig({
+            outDir,
+            configPath,
+            ...this.options,
+        }));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kopflos-cms/vite",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "type": "module",
   "main": "index.js",
   "author": "Zazuko GmbH",
@@ -28,21 +28,19 @@
   "homepage": "https://github.com/zazuko/kopflos",
   "dependencies": {
     "@kopflos-cms/logger": "^0.1.0",
-    "express": "^5.0.1",
-    "glob": "^11.0.0",
+    "express": "^5.2.0",
+    "glob": "^11.1.0",
     "onetime": "^7.0.0",
-    "vite": "^6.0.9"
+    "vite": "^6.4.1"
   },
   "devDependencies": {
+    "@kopflos-cms/core": "^0.6.1",
+    "@zazuko/env-node": "^2.0.0",
     "@types/glob": "^8.1.0",
     "chai": "^5.1.1"
   },
   "mocha": {
-    "extension": [
-      "ts"
-    ],
     "spec": "test/**/*.test.ts",
-    "loader": "ts-node/esm/transpile-only",
-    "require": "../../mocha-setup.js"
+    "extends": "../../package.json"
   }
 }

package/template.d.ts

@@ -1,2 +1,2 @@
-import type { SubjectHandler } from '@kopflos-cms/core';
-export declare const transform: () => SubjectHandler;
+import type { Kopflos, SubjectHandler } from '@kopflos-cms/core';
+export declare const transform: (this: Kopflos) => SubjectHandler;

package/template.js

@@ -1,22 +1,25 @@
-import { createViteServer } from './lib/server.js';
 import { log } from './lib/log.js';
-async function prepareDevTemplate(env, subject, template) {
-    const config = env.kopflos.config.plugins?.['@kopflos-cms/vite'];
-    const vite = await createViteServer(config || {});
-    const subjectPath = new URL(subject.value).pathname;
-    return vite.transformIndexHtml(subjectPath, template);
-}
-export const transform = () => async ({ subject, env }, response) => {
-    if (!isHtmlResponse(response)) {
-        throw new Error('Vite handler must be chained after another which returns a HTML response');
-    }
-    if (env.kopflos.config.mode === 'production') {
-        return response;
-    }
-    log.debug('Compiling page template');
-    return {
-        ...response,
-        body: await prepareDevTemplate(env, subject, response.body),
+export const transform = function () {
+    const prepareDevTemplate = async (subject, template) => {
+        const vite = this.getPlugin('@kopflos-cms/vite');
+        if (!vite?.viteDevServer) {
+            throw new Error('Vite dev server not initialized. Check vite plugin configuration.');
+        }
+        const subjectPath = new URL(subject.value).pathname;
+        return vite.viteDevServer.transformIndexHtml(subjectPath, template);
+    };
+    return async ({ subject, env }, response) => {
+        if (!isHtmlResponse(response)) {
+            throw new Error('Vite handler must be chained after another which returns a HTML response');
+        }
+        if (env.kopflos.config.mode === 'production') {
+            return response;
+        }
+        log.debug('Compiling page template');
+        return {
+            ...response,
+            body: await prepareDevTemplate(subject, response.body),
+        };
     };
 };
 function isHtmlResponse(response) {