@static-pages/core 1.0.4 → 2.0.0

package/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://app.travis-ci.com/staticpagesjs/core.svg?branch=master)](https://app.travis-ci.com/staticpagesjs/core)
 [![Coverage Status](https://coveralls.io/repos/github/staticpagesjs/core/badge.svg?branch=master)](https://coveralls.io/github/staticpagesjs/core?branch=master)
 ![npms.io (quality)](https://img.shields.io/npms-io/quality-score/@static-pages/core?label=quality)
-![Maintenance](https://img.shields.io/maintenance/yes/2021)
+![Maintenance](https://img.shields.io/maintenance/yes/2022)
 
 This package contains only the core; this means it does not provide CLI support or readers and writers.
 You can import this library to your JS project then add your own controllers, readers and writers.
@@ -75,14 +75,18 @@ type Options = {
     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 define additional properties at the same level as the `from`, `to` and `controller` keys.
-These user defined properties are accessible through the `this` context variable of 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([{
@@ -91,7 +95,9 @@ require("@static-pages/core").default([{
     controller: function(data) {
         this.myProp; // <-- 123
     },
-    myProp: 123,
+    variables: {
+        myProp: 123,
+    },
 }]);
 ```
 

package/cjs/index.d.ts

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

package/cjs/index.js

@@ -9,7 +9,7 @@ exports.default = 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, ...userOptions } = route;
+        const { from, to, controller, variables } = route;
         if (!isIterable(from) && !isAsyncIterable(from))
             throw new Error('Route \'from\' is not an \'iterable\' or an \'asyncIterable\'.');
         if (typeof to !== 'function')
@@ -18,7 +18,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(userOptions, data) : data;
+            const results = isController ? await controller.call(variables, data) : data;
             if (typeof results === 'object' && results) {
                 if (Array.isArray(results)) {
                     for (const result of results) {

package/esm/index.d.ts

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

package/esm/index.js

@@ -7,7 +7,7 @@ export default 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, ...userOptions } = route;
+        const { from, to, controller, variables } = 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(userOptions, data) : data;
+            const results = isController ? await controller.call(variables, 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": "1.0.4",
+  "version": "2.0.0",
   "description": "General purpose static pages renderer.",
   "type": "module",
   "main": "./cjs/index.js",