@static-pages/core 2.1.0 → 3.0.2

package/README.md

@@ -32,10 +32,10 @@ This project targets small and medium sized projects. The rendering process trie
 __Readers__ provides an iterable list of page data. __Controllers__ can manipulate and extend each data object. __Writers__ render the final output for you.
 
 ```js
-const staticPages = require("@static-pages/core").default;
-const markdownReader = require("@static-pages/markdown-reader").default;
-const yamlReader = require("@static-pages/yaml-reader").default;
-const twigWriter = require("@static-pages/twig-writer").default;
+import staticPages from '@static-pages/core';
+import markdownReader from '@static-pages/markdown-reader';
+import yamlReader from '@static-pages/yaml-reader';
+import twigWriter from '@static-pages/twig-writer';
 
 staticPages([{
     from: markdownReader({
@@ -46,11 +46,11 @@ staticPages([{
         viewsDir: "path/to/views/folder",
         outDir: "path/to/output/folder",
     }),
-    controller: function(data) {
+    controller(data) {
         data.timestamp = new Date().toJSON(); // adds a "timestamp" variable
         return data; // returning the data is required if you want to send it to the renderer
     }
-},{
+}, {
     from: yamlReader({ // assume we have the home page data in yaml format.
         pattern: "home/*.yaml" // <-- reads home/en.yaml, home/de.yaml, home/fr.yaml etc.
     }),
@@ -59,47 +59,33 @@ staticPages([{
         viewsDir: "path/to/views/folder",
         outDir: "path/to/output/folder",
     }),
-    controller: function(data) {
+    controller(data) {
         data.commitHash = yourGetCommitHashFn();
         return data;
     }
-}]).catch(console.error);
+}])
+.catch(error => {
+    console.error('Error:', error);
+    console.error(error.stack);
+});
 ```
 
-## Options of `staticPages()`
-The `staticPages()` function expects one parameter which must be an array.
-Each item should contain `from`, `to` and optionally a `controller` property matching the definition below.
+## `staticPages(routes: Route | Route[])`
+The function expects the `routes` parameter to be an array. It is wrapped into an array automatically when other type is provided.
+Each item in this array should be an object containing a `from`, `to` and optionally a `controller` property matching the definition below.
 
 ```ts
-type Options = {
+type Data = Record<string, unknown>;
+type Route = {
     from: Iterable<Data> | AsyncIterable<Data>;
     to: (data: Data) => void | Promise<void>;
     controller?: (data: Data) => undefined | Data | Data[] | Promise<undefined | Data | Data[]>;
-    variables?: Record<string, unknown>;
-}[];
-
-// Where `Data` is:
-type Data = Record<string, unknown>;
-// Or the same definition in a more known form:
-type Data = { [k: string]: unknown };
+};
 ```
 
-## Custom options for the controller
-You can pass additional configuration options to your controller under the `variables` property.
-These variables are accessible through the `this` context variable of the controller.
+> Tip: Controllers may return an array of `Data` objects. Each data object will be rendered as a separate page.
 
-```js
-require("@static-pages/core").default([{
-    from: ...,
-    to: ...,
-    controller: function(data) {
-        this.myProp; // <-- 123
-    },
-    variables: {
-        myProp: 123,
-    },
-}]);
-```
+> Tip: Controllers may return `undefined` to prevent the rendering of the current data object.
 
 ## Missing a feature?
 Create an issue describing your needs. If it fits the scope of the project I will implement it or you can implement it your own and submit a pull request.

package/cjs/index.d.ts

@@ -4,7 +4,6 @@ export declare type Route = {
     from: Iterable<Data> | AsyncIterable<Data>;
     to: (data: Data) => void | Promise<void>;
     controller?: Controller;
-    variables?: Record<string, unknown>;
 };
 export declare const staticPages: (routes: Route | Route[]) => Promise<void>;
 export default staticPages;

package/cjs/index.js

@@ -10,7 +10,7 @@ const staticPages = async (routes) => {
     for (const route of Array.isArray(routes) ? routes : [routes]) {
         if (typeof route !== 'object' || !route)
             throw new Error(`Route type mismatch, expected 'object', got '${getType(route)}'.`);
-        const { from, to, controller, variables } = route;
+        const { from, to, controller } = route;
         if (!isIterable(from) && !isAsyncIterable(from))
             throw new Error('Route \'from\' is not an \'iterable\' or an \'asyncIterable\'.');
         if (typeof to !== 'function')
@@ -19,7 +19,7 @@ const staticPages = async (routes) => {
             throw new Error(`Route 'controller' type mismatch, expected 'function', got '${getType(controller)}'.`);
         const isController = typeof controller === 'function';
         for await (const data of from) {
-            const results = isController ? await controller.call(variables, data) : data;
+            const results = isController ? await controller(data) : data;
             if (typeof results === 'object' && results) {
                 if (Array.isArray(results)) {
                     for (const result of results) {

package/esm/index.d.ts

@@ -4,7 +4,6 @@ export declare type Route = {
     from: Iterable<Data> | AsyncIterable<Data>;
     to: (data: Data) => void | Promise<void>;
     controller?: Controller;
-    variables?: Record<string, unknown>;
 };
 export declare const staticPages: (routes: Route | Route[]) => Promise<void>;
 export default staticPages;

package/esm/index.js

@@ -7,7 +7,7 @@ export const staticPages = async (routes) => {
     for (const route of Array.isArray(routes) ? routes : [routes]) {
         if (typeof route !== 'object' || !route)
             throw new Error(`Route type mismatch, expected 'object', got '${getType(route)}'.`);
-        const { from, to, controller, variables } = route;
+        const { from, to, controller } = route;
         if (!isIterable(from) && !isAsyncIterable(from))
             throw new Error('Route \'from\' is not an \'iterable\' or an \'asyncIterable\'.');
         if (typeof to !== 'function')
@@ -16,7 +16,7 @@ export const staticPages = async (routes) => {
             throw new Error(`Route 'controller' type mismatch, expected 'function', got '${getType(controller)}'.`);
         const isController = typeof controller === 'function';
         for await (const data of from) {
-            const results = isController ? await controller.call(variables, data) : data;
+            const results = isController ? await controller(data) : data;
             if (typeof results === 'object' && results) {
                 if (Array.isArray(results)) {
                     for (const result of results) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@static-pages/core",
-  "version": "2.1.0",
+  "version": "3.0.2",
   "description": "General purpose static pages renderer.",
   "type": "module",
   "main": "./cjs/index.js",