@static-pages/core 2.0.1 → 3.0.0

package/README.md

@@ -15,7 +15,7 @@ Yes! Because I browsed the whole jamstack scene, but could not find one which
 3. can render with any template engine (Twig, ejs, Pug, Mustache etc.)
 4. supports incremental builds
 5. has a flexible CLI tool (see [@static-pages/cli](https://www.npmjs.com/package/@static-pages/cli) on npm)
-6. has a Docker image (see [lionel87/static-pages-js](https://hub.docker.com/repository/docker/lionel87/static-pages-js) on dockerhub)
+6. has a Docker image (see [staticpages/cli](https://hub.docker.com/repository/docker/staticpages/cli) on dockerhub)
 7. written in JS (preferably TypeScript)
 8. easy to extend with JS code
 9. learning and using is easy (Gatsby, Hugo, Jekyll, Eleventy etc. are so cool but harder to learn and configure)
@@ -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({
@@ -84,22 +84,7 @@ type Data = Record<string, unknown>;
 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.
-
-```js
-require("@static-pages/core").default([{
-    from: ...,
-    to: ...,
-    controller: function(data) {
-        this.myProp; // <-- 123
-    },
-    variables: {
-        myProp: 123,
-    },
-}]);
-```
+> When `Options` is not passed as an array, it is wrapped into an array.
 
 ## 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>;
 };
-declare const _default: (routes: Route | Route[]) => Promise<void>;
-export default _default;
+export declare const staticPages: (routes: Route | Route[]) => Promise<void>;
+export default staticPages;

package/cjs/index.js

@@ -1,15 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.staticPages = void 0;
 const getType = (x) => typeof x === 'object' ? (x ? 'object' : 'null') : typeof x;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const isIterable = (x) => typeof (x === null || x === void 0 ? void 0 : x[Symbol.iterator]) === 'function';
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const isAsyncIterable = (x) => typeof (x === null || x === void 0 ? void 0 : x[Symbol.asyncIterator]) === 'function';
-exports.default = async (routes) => {
+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')
@@ -18,7 +19,7 @@ exports.default = 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) {
@@ -32,3 +33,5 @@ exports.default = async (routes) => {
         }
     }
 };
+exports.staticPages = staticPages;
+exports.default = exports.staticPages;

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>;
 };
-declare const _default: (routes: Route | Route[]) => Promise<void>;
-export default _default;
+export declare const staticPages: (routes: Route | Route[]) => Promise<void>;
+export default staticPages;

package/esm/index.js

@@ -3,11 +3,11 @@ const getType = (x) => typeof x === 'object' ? (x ? 'object' : 'null') : typeof
 const isIterable = (x) => typeof (x === null || x === void 0 ? void 0 : x[Symbol.iterator]) === 'function';
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const isAsyncIterable = (x) => typeof (x === null || x === void 0 ? void 0 : x[Symbol.asyncIterator]) === 'function';
-export default async (routes) => {
+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 default 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) {
@@ -30,3 +30,4 @@ export default async (routes) => {
         }
     }
 };
+export default staticPages;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@static-pages/core",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "General purpose static pages renderer.",
   "type": "module",
   "main": "./cjs/index.js",
@@ -45,7 +45,7 @@
   },
   "homepage": "https://staticpagesjs.github.io/",
   "devDependencies": {
-    "@types/node": "^12.20.33",
+    "@types/node": "^14.18.9",
     "@typescript-eslint/eslint-plugin": "^5.3.0",
     "@typescript-eslint/parser": "^5.3.0",
     "coveralls": "^3.1.1",