@lumeland/plugin-jsx 0.0.0-stage → 1.0.0-beta-3

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## 1.0.0 - Unreleased
+
+First version

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 - Oscar Otero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/build/deps/ssx.d.ts

@@ -0,0 +1 @@
+export { renderComponent } from "@lumeland/ssx/jsx-runtime";

package/build/deps/ssx.js

@@ -0,0 +1 @@
+export { renderComponent } from "@lumeland/ssx/jsx-runtime";

package/build/src/mod.d.ts

@@ -0,0 +1,45 @@
+import type Site from "@lumeland/core/site.ts";
+import type { Engine, Helper } from "@lumeland/core/renderer.ts";
+export interface Options {
+    /** File extensions to load */
+    extensions?: string[];
+    /** Optional sub-extension for page files */
+    pageSubExtension?: string;
+    /**
+     * Custom includes path
+     * @default `site.options.includes`
+     */
+    includes?: string;
+}
+export declare const defaults: {
+    extensions: string[];
+    pageSubExtension: string;
+};
+/** Template engine to render JSX files */
+export declare class JsxEngine implements Engine {
+    helpers: Record<string, Helper>;
+    basePath: string;
+    includes: string;
+    constructor(basePath: string, includes: string);
+    deleteCache(): void;
+    render(content: unknown, data?: Record<string, unknown>): Promise<string>;
+    addHelper(name: string, fn: Helper): void;
+}
+/**
+ * A plugin to render JSX files to HTML
+ * @see https://lume.land/plugins/jsx/
+ */
+export declare function jsx(userOptions?: Options): (site: Site) => void;
+export default jsx;
+/** Extends global data interface */
+declare global {
+    namespace Lume {
+        interface GlobalData {
+            /**
+             * The JSX children elements
+             * @see https://lume.land/plugins/jsx/
+             */
+            children?: JSX.Children;
+        }
+    }
+}

package/build/src/mod.js

@@ -0,0 +1,57 @@
+import { renderComponent } from "../deps/ssx.js";
+import loader from "@lumeland/core/loaders/module.ts";
+import { merge } from "@lumeland/core/utils/object.ts";
+// Default options
+export const defaults = {
+    extensions: [".jsx", ".tsx"],
+    pageSubExtension: ".page",
+};
+/** Template engine to render JSX files */
+export class JsxEngine {
+    helpers = {};
+    basePath;
+    includes;
+    constructor(basePath, includes) {
+        this.basePath = basePath;
+        this.includes = includes;
+    }
+    deleteCache() { }
+    async render(content, data = {}) {
+        // If content is a string, convert to a JSX element
+        if (typeof content === "string") {
+            content = { __html: content };
+        }
+        // Create the children property
+        let children = data.content ?? data.children;
+        // If the children is a string, convert to a JSX element
+        if (typeof children === "string") {
+            children = { __html: children };
+        }
+        const result = typeof content === "function" ? await content({ ...data, children }, this.helpers) : content;
+        return typeof result === "string" ? result : renderComponent(result);
+    }
+    addHelper(name, fn) {
+        this.helpers[name] = fn;
+    }
+}
+/**
+ * A plugin to render JSX files to HTML
+ * @see https://lume.land/plugins/jsx/
+ */
+export function jsx(userOptions) {
+    return (site) => {
+        const options = merge({ ...defaults, includes: site.options.includes }, userOptions);
+        const engine = new JsxEngine(site.src("/"), options.includes);
+        // Ignore includes folder
+        if (options.includes) {
+            site.ignore(options.includes);
+        }
+        // Load the pages and register the engine
+        site.loadPages(options.extensions, {
+            loader,
+            engine,
+            pageSubExtension: options.pageSubExtension,
+        });
+    };
+}
+export default jsx;

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "@lumeland/plugin-jsx",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0-beta-3",
+  "description": "",
+  "homepage": "https://lume.land/plugins/jsx/",
+  "license": "MIT",
+  "author": "Óscar Otero",
+  "files": [
+    "build",
+    "CHANGELOG.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./build/src/mod.d.ts",
+      "import": "./build/src/mod.js"
+    },
+    "./*.ts": {
+      "types": "./build/src/*.d.ts",
+      "import": "./build/src/*.js"
+    },
+    "./*.js": {
+      "types": "./build/src/*.d.ts",
+      "import": "./build/src/*.js"
+    }
+  },
+  "dependencies": {
+    "@lumeland/ssx": "^0.1.16"
+  },
+  "peerDependencies": {
+    "@lumeland/core": "1.0.0-beta-5"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.