@static-pages/core 7.0.0-beta.4 → 7.0.0

package/index.cjs

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.staticPages = void 0;
-const isIterable = (x) => !!x && typeof x === 'object' && Symbol.iterator in x && typeof x[Symbol.iterator] === 'function';
-const isAsyncIterable = (x) => !!x && typeof x === 'object' && Symbol.asyncIterator in x && typeof x[Symbol.asyncIterator] === 'function';
+const isIterable = (x) => !!x && typeof x === 'object' && typeof x[Symbol.iterator] === 'function';
+const isAsyncIterable = (x) => !!x && typeof x === 'object' && typeof x[Symbol.asyncIterator] === 'function';
 const getType = (x) => typeof x === 'object' ? (x ? (Array.isArray(x) ? 'array' : 'object') : 'null') : typeof x;
 async function staticPages(...routes) {
     for (const route of routes) {

package/index.d.mts

@@ -0,0 +1,13 @@
+export interface Route<F = any, T = any> {
+    from: Iterable<F> | AsyncIterable<F>;
+    to(data: T): void | Promise<void>;
+    controller?(data: F): undefined | T | Iterable<T> | AsyncIterable<T> | Promise<undefined | T | Iterable<T> | AsyncIterable<T>>;
+}
+export declare function staticPages<F1, T1>(...route: [Route<F1, T1>]): Promise<void>;
+export declare function staticPages<F1, T1, F2, T2>(...route: [Route<F1, T1>, Route<F2, T2>]): Promise<void>;
+export declare function staticPages<F1, T1, F2, T2, F3, T3>(...route: [Route<F1, T1>, Route<F2, T2>, Route<F3, T3>]): Promise<void>;
+export declare function staticPages<F1, T1, F2, T2, F3, T3, F4, T4>(...route: [Route<F1, T1>, Route<F2, T2>, Route<F3, T3>, Route<F4, T4>]): Promise<void>;
+export declare function staticPages<F1, T1, F2, T2, F3, T3, F4, T4, F5, T5>(...route: [Route<F1, T1>, Route<F2, T2>, Route<F3, T3>, Route<F4, T4>, Route<F5, T5>]): Promise<void>;
+export declare function staticPages<F1, T1, F2, T2, F3, T3, F4, T4, F5, T5, F6, T6>(...route: [Route<F1, T1>, Route<F2, T2>, Route<F3, T3>, Route<F4, T4>, Route<F5, T5>, Route<F6, T6>]): Promise<void>;
+export declare function staticPages(...routes: Route[]): Promise<void>;
+export default staticPages;

package/{index.js → index.mjs}

@@ -1,5 +1,5 @@
-const isIterable = (x) => !!x && typeof x === 'object' && Symbol.iterator in x && typeof x[Symbol.iterator] === 'function';
-const isAsyncIterable = (x) => !!x && typeof x === 'object' && Symbol.asyncIterator in x && typeof x[Symbol.asyncIterator] === 'function';
+const isIterable = (x) => !!x && typeof x === 'object' && typeof x[Symbol.iterator] === 'function';
+const isAsyncIterable = (x) => !!x && typeof x === 'object' && typeof x[Symbol.asyncIterator] === 'function';
 const getType = (x) => typeof x === 'object' ? (x ? (Array.isArray(x) ? 'array' : 'object') : 'null') : typeof x;
 export async function staticPages(...routes) {
     for (const route of routes) {

package/package.json

@@ -1,68 +1,41 @@
-{
-  "name": "@static-pages/core",
-  "version": "7.0.0-beta.4",
-  "description": "General purpose static pages renderer.",
-  "type": "module",
-  "module": "./index.js",
-  "main": "./index.cjs",
-  "types": "./index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./index.js",
-      "require": "./index.cjs",
-      "types": "./index.d.ts"
-    },
-    "./package.json": "./package.json"
-  },
-  "engines": {
-    "node": ">=16.0.0",
-    "deno": ">=1.0.0"
-  },
-  "scripts": {
-    "clean": "rimraf --glob \"!(.*).{d.ts,js,cjs,mjs}\" build coverage",
-    "preversion": "npm run build && npm run test",
-    "postversion": "git push && git push --tags",
-    "watch": "chokidar src tsconfig.json -c \"npm run build\" --initial",
-    "build": "npm run build:esm && npm run build:cjs && npm run build:types",
-    "build:esm": "rimraf build && tsc && npm run move-build && rimraf build",
-    "build:cjs": "rimraf build && tsc --module commonjs --moduleResolution node && npm run move-build -- -- --cjs && rimraf build",
-    "build:types": "rimraf build && tsc --declaration --emitDeclarationOnly && npm run move-build && rimraf build",
-    "move-build": "node -e \"process.chdir('build');const fs=require('fs');const path=require('path');fs.readdirSync('.',{recursive:true,withFileTypes:true}).filter(x=>x.isFile()).forEach(x=>{const f=path.join(x.path,x.name);const o=path.join('..',f);fs.mkdirSync(path.dirname(o),{recursive:true});if(process.argv[1]==='--cjs'){fs.writeFileSync(o.slice(0,-2)+'cjs',fs.readFileSync(f,'utf8').replace(/require\\(\\\"(.+?)\\.js\\\"\\)/g,'require\\(\\\"\\$1.cjs\\\"\\)'));}else{fs.renameSync(f,o);}});\"",
-    "lint": "eslint src",
-    "test": "mocha",
-    "coverage": "c8 -r text -r text-summary -r lcov --include \"*.js\" npm test"
-  },
-  "devDependencies": {
-    "@types/node": "^20.11.5",
-    "@typescript-eslint/eslint-plugin": "^6.15.0",
-    "@typescript-eslint/parser": "^6.15.0",
-    "c8": "^9.1.0",
-    "chokidar": "^3.5.3",
-    "chokidar-cli": "^3.0.0",
-    "eslint": "^8.1.0",
-    "mocha": "^10.2.0",
-    "rimraf": "^5.0.1",
-    "typescript": "^5.1.6"
-  },
-  "author": "László BULIK",
-  "license": "MPL-2.0",
-  "homepage": "https://staticpagesjs.github.io/",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/staticpagesjs/core.git"
-  },
-  "bugs": {
-    "url": "https://github.com/staticpagesjs/core/issues"
-  },
-  "keywords": [
-    "static",
-    "pages",
-    "generator",
-    "renderer",
-    "mvc",
-    "jamstack",
-    "view",
-    "template",
-    "controller"
-  ]
-}
+{
+  "name": "@static-pages/core",
+  "version": "7.0.0",
+  "description": "General purpose static pages renderer.",
+  "main": "./index.cjs",
+  "module": "./index.mjs",
+  "types": "./index.d.mts",
+  "exports": {
+    ".": {
+      "require": "./index.cjs",
+      "import": "./index.mjs",
+      "types": "./index.d.mts"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "deno": ">=1.0.0"
+  },
+  "author": "László BULIK",
+  "license": "MPL-2.0",
+  "homepage": "https://staticpagesjs.github.io/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/staticpagesjs/core.git"
+  },
+  "bugs": {
+    "url": "https://github.com/staticpagesjs/core/issues"
+  },
+  "keywords": [
+    "static",
+    "pages",
+    "generator",
+    "renderer",
+    "mvc",
+    "jamstack",
+    "view",
+    "template",
+    "controller"
+  ]
+}

package/CHANGELOG.md

@@ -1,110 +0,0 @@
-# CHANGELOG
-
-## 7.0.0
-- Reverted `route.to` callbacks to work as it was in `v4.0.0`. The function is called per doucument, recieving the current page data.
-- Type defintion improvements.
-- Test suite switched from tap to mocha for now.
-- Coverage reports switched from nyc to c8.
-
-
-## 6.0.0
-- Use JS iterator protocol for the `route.to` callbacks.
-- Removed the `.teardown()` call on the `route.to` when iteration finished.
-
-
-## 5.0.3
-- Updated .npmignore to remove unneeded files from package.
-
-## 5.0.2
-- Use Github Actions instead of Travis-CI, replace Build status badge.
-
-## 5.0.1
-- Updated maintenance badge in README.md.
-
-## 5.0.0
-- Added a `.teardown()` call on the `route.to` which is executed when iteration finished.
-- Provided better type definitions.
-
-
-## 4.0.0
-- Now types are exported in a namespace.
-
-
-## 3.0.4
-- Updated eslint config.
-
-## 3.0.3
-- Added esm tests.
-- Improved build configuration.
-
-## 3.0.2
-- Improved examples.
-
-## 3.0.1
-- Updated docs.
-
-## 3.0.0
-- Removed `variables` option on `Route` type. You can use `.bind()` on the writer to achieve the same functionality.
-- Updated tests.
-- Updated README.md.
-
-
-## 2.1.0
-- In addition to the default export, now the main function also gets exported as `staticPages`.
-
-## 2.0.2
-- Updated dependencies.
-- Updated docker image link in README.md.
-
-## 2.0.1
-- Fixed a typo in README.md.
-
-## 2.0.0
-- Made configuration a bit cleaner and predictable by wrapping additional variables in a `variables` key in the `Route` type.
-- Updated tests.
-- Updated docs.
-- Changed some eslint configuration.
-
-
-## 1.0.4
-- Improved esmodule compatibility.
-- Simplified syntax of `Data` type.
-
-## 1.0.3
-- Made `isIterable` test a bit cleaner.
-
-## 1.0.2
-- Added eslint support.
-
-## 1.0.1
-- First stable release.
-- Added node12 support.
-- Updated .npmignore to remove unneeded files from package.
-- Updated dependencies.
-- Updated examples in README.md.
-- Added badges to README.md.
-
-
-## 0.1.6
-- Updated tests to get 100% coverage.
-- Added test cases when `staticPages()` should throw.
-- Fixed a faulty throws case.
-
-## 0.1.5
-- Added Travis testing and Coveralls coverage badge to README.md.
-
-## 0.1.4
-- Improved README.md.
-
-## 0.1.3
-- Added error handling which should throw when invalid params provided.
-
-## 0.1.2
-- Configured a `prepack` script to automatically test before publish.
-
-## 0.1.1
-- Updated .npmignore to omit /src folder from release.
-- Updated package keywords.
-
-## 0.1.0
-- Initial work in progress release.