@lumeland/plugin-modules 0.0.0-stage → 1.0.0-beta-2

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/src/mod.d.ts

@@ -0,0 +1,33 @@
+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 js/ts files */
+export declare class ModuleEngine implements Engine {
+    helpers: Record<string, Helper>;
+    includes: string;
+    constructor(includes: string);
+    deleteCache(): void;
+    render(content: unknown, data: Record<string, unknown>): Promise<unknown>;
+    addHelper(name: string, fn: Helper): void;
+}
+/**
+ * A plugin to load js/ts files as data and pages
+ * Installed by default
+ * @see https://lume.land/plugins/modules/
+ */
+export declare function modules(userOptions?: Options): (site: Site) => void;
+export default modules;

package/build/src/mod.js

@@ -0,0 +1,46 @@
+import loader from "@lumeland/core/loaders/module.ts";
+import { merge } from "@lumeland/core/utils/object.ts";
+// Default options
+export const defaults = {
+    extensions: [".js", ".ts"],
+    pageSubExtension: ".page",
+};
+/** Template engine to render js/ts files */
+export class ModuleEngine {
+    helpers = {};
+    includes;
+    constructor(includes) {
+        this.includes = includes;
+    }
+    deleteCache() { }
+    async render(content, data) {
+        return typeof content === "function" ? await content(data, this.helpers) : content;
+    }
+    addHelper(name, fn) {
+        this.helpers[name] = fn;
+    }
+}
+/**
+ * A plugin to load js/ts files as data and pages
+ * Installed by default
+ * @see https://lume.land/plugins/modules/
+ */
+export function modules(userOptions) {
+    return (site) => {
+        const options = merge({ ...defaults, includes: site.options.includes }, userOptions);
+        const engine = new ModuleEngine(options.includes);
+        // Ignore includes folder
+        if (options.includes) {
+            site.ignore(options.includes);
+        }
+        // Load the _data files
+        site.loadData(options.extensions, loader);
+        // Load the pages and register the engine
+        site.loadPages(options.extensions, {
+            loader,
+            engine,
+            pageSubExtension: options.pageSubExtension,
+        });
+    };
+}
+export default modules;

package/package.json

@@ -1,6 +1,28 @@
 {
   "name": "@lumeland/plugin-modules",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0-beta-2",
+  "description": "Plugin to use ESM and TypeScript modules to create pages, layouts, and store data",
+  "license": "MIT",
+  "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"
+    }
+  },
+  "peerDependencies": {
+    "@lumeland/core": "1.0.0-beta-4"
+  }
 }

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.