@static-pages/core 1.0.1 → 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/{lib/cjs → cjs}/index.d.ts

@@ -1,12 +1,10 @@
-export declare type Data = {
-    [key: string]: unknown;
-};
+export declare type Data = Record<string, unknown>;
 export declare type Controller = (data: Data) => undefined | Data | Data[] | Promise<undefined | Data | Data[]>;
 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/{lib/cjs → cjs}/index.js

@@ -1,20 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 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) => {
     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;
-        if (typeof from[Symbol.iterator] !== 'function' && typeof from[Symbol.asyncIterator] !== 'function')
-            throw new Error(`Route 'from' is not an 'iterable' or an 'asyncIterable'.`);
+        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')
             throw new Error(`Route 'to' type mismatch, expected 'function', got '${getType(to)}'.`);
         if (typeof controller !== 'undefined' && typeof controller !== 'function')
             throw new Error(`Route 'controller' type mismatch, expected 'function', got '${getType(controller)}'.`);
         const isController = typeof controller === 'function';
-        for await (let data of from) {
-            const results = isController ? await controller.call(userOptions, data) : data;
+        for await (const data of from) {
+            const results = isController ? await controller.call(variables, data) : data;
             if (typeof results === 'object' && results) {
                 if (Array.isArray(results)) {
                     for (const result of results) {

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/{lib/esm → esm}/index.d.ts

@@ -1,12 +1,10 @@
-export declare type Data = {
-    [key: string]: unknown;
-};
+export declare type Data = Record<string, unknown>;
 export declare type Controller = (data: Data) => undefined | Data | Data[] | Promise<undefined | Data | Data[]>;
 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/{lib/esm → esm}/index.js

@@ -1,18 +1,22 @@
 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';
 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;
-        if (typeof from[Symbol.iterator] !== 'function' && typeof from[Symbol.asyncIterator] !== 'function')
-            throw new Error(`Route 'from' is not an 'iterable' or an 'asyncIterable'.`);
+        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')
             throw new Error(`Route 'to' type mismatch, expected 'function', got '${getType(to)}'.`);
         if (typeof controller !== 'undefined' && typeof controller !== 'function')
             throw new Error(`Route 'controller' type mismatch, expected 'function', got '${getType(controller)}'.`);
         const isController = typeof controller === 'function';
-        for await (let data of from) {
-            const results = isController ? await controller.call(userOptions, data) : data;
+        for await (const data of from) {
+            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,19 +1,27 @@
 {
   "name": "@static-pages/core",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "General purpose static pages renderer.",
-  "main": "lib/cjs/index.js",
-  "module": "lib/esm/index.js",
-  "browser": "lib/esm/index.js",
+  "type": "module",
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "browser": "./esm/index.js",
+  "exports": {
+    ".": {
+      "require": "./cjs/index.js",
+      "default": "./esm/index.js"
+    }
+  },
   "scripts": {
     "prepack": "npm run build",
     "build": "npm run build:esm && npm run build:cjs",
-    "build:esm": "tsc --outDir lib/esm",
-    "build:cjs": "tsc --outDir lib/cjs --module commonjs --target ES2019",
-    "watch:esm": "tsc --watch --outDir lib/esm",
-    "watch:cjs": "tsc --watch --outDir lib/cjs --module commonjs --target ES2019",
-    "test": "jest",
-    "coverage": "jest --coverage && cat ./coverage/lcov.info | coveralls"
+    "build:esm": "tsc",
+    "build:cjs": "tsc --outDir cjs --module commonjs",
+    "watch:esm": "tsc --watch",
+    "watch:cjs": "tsc --watch --outDir cjs --module commonjs",
+    "test": "eslint src && npm run build && jest",
+    "coverage": "jest --coverage && cat ./coverage/lcov.info | coveralls",
+    "clean": "rimraf esm cjs/*.?s"
   },
   "repository": {
     "type": "git",
@@ -38,8 +46,12 @@
   "homepage": "https://staticpagesjs.github.io/",
   "devDependencies": {
     "@types/node": "^12.20.33",
+    "@typescript-eslint/eslint-plugin": "^5.3.0",
+    "@typescript-eslint/parser": "^5.3.0",
     "coveralls": "^3.1.1",
+    "eslint": "^8.1.0",
     "jest": "^27.2.5",
+    "rimraf": "^3.0.2",
     "typescript": "^4.4.4"
   }
 }