primate 0.6.3 → 0.6.4

package/README.md

@@ -7,9 +7,77 @@ expressive code.
 ## Installing
 
 ```
-npm install primate
+$ npm install primate
 ```
 
+## Quick start
+
+Lay out your app
+
+```
+$ mkdir -p primate-app/{routes,components,ssl} && cd primate-app
+```
+
+Create a route for `/`
+
+```
+// routes/site.js
+
+import {router, html} from "primate";
+
+router.get("/", () => html`<site-index date=${new Date()} />`);
+```
+
+Create component for your route
+
+```
+// components/site-index.html
+
+Today's date is <span data-value="date"></span>.
+```
+
+Generate SSL key/certificate
+
+```
+openssl req -x509 -out ssl/default.crt -keyout ssl/default.key -newkey rsa:2048 -nodes -sha256 -batch
+```
+
+Add an entry file
+
+```
+// app.js
+
+import {app} from "primate";
+app.run();
+```
+
+Create and start script and enable ES modules
+
+```
+// package.json
+
+{
+  "scripts": {
+    "start": "node --experimental-json-modules app.js"
+  },
+  "type": "module"
+}
+```
+
+Install Primate
+
+```
+$ npm install primate
+```
+
+Run app
+
+```
+$ npm start
+```
+
+Visit `https://localhost:9999`
+
 ## Highlights
 
 * Flexible HTTP routing, returning HTML, JSON or a custom handler
@@ -17,15 +85,15 @@ npm install primate
 * Built-in support for sessions with secure cookies
 * Input verification using data domains
 * Many different data store modules: In-Memory (built-in),
-[File][primate-store-file], [JSON][primate-store-json],
-[MongoDB][primate-store-mongodb]
+[File][primate-file-store], [JSON][primate-json-store],
+[MongoDB][primate-mongodb-store]
 * Easy modelling of`1:1`, `1:n` and `n:m` relationships
 * Minimally opinionated with sane, overrideable defaults
 * No dependencies
 
-## Getting started
+## Resources
 
-See the [getting started][getting-started] guide.
+* [Getting started guide]
 
 ## License
 
@@ -34,6 +102,6 @@ BSD-3-Clause
 [getting-started]: https://primatejs.com/getting-started
 [source-code]: https://github.com/primatejs/primate
 [issues]: https://github.com/primatejs/primate/issues
-[primate-store-file]: https://npmjs.com/primate-store-file
-[primate-store-json]: https://npmjs.com/primate-store-json
-[primate-store-mongodb]: https://npmjs.com/primate-store-mongodb
+[primate-file-store]: https://npmjs.com/primate-file-store
+[primate-json-store]: https://npmjs.com/primate-json-store
+[primate-mongodb-store]: https://npmjs.com/primate-mongodb-store

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "primate",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "author": "Primate core team <core@primatejs.com>",
   "homepage": "https://primatejs.com",
   "bugs": "https://github.com/primatejs/primate/issues",

package/source/EagerPromise.js

@@ -44,6 +44,6 @@ const last = -1;
 const eager = async (strings, ...keys) =>
   (await Promise.all(strings.slice(0, last).map(async (string, i) =>
     strings[i] + await keys[i]
-  ))).join("") + strings[strings.length+last];
+  ))).join("") + strings.at(last);
 
 export {eager};

package/source/handlers/DOM/Parser.js

@@ -74,12 +74,19 @@ export default class Parser {
     }
   }
 
+  try_create_text_node() {
+    if (this.buffer.length > 0) {
+      const child = new Node(this.node, "span");
+      child.text = this.buffer;
+      this.buffer = "";
+    }
+  }
+
   // currently outside of a tag
   process_not_reading_tag() {
     // encountered '<'
     if (this.current === "<") {
-      this.node.text = this.buffer;
-      this.buffer = "";
+      this.try_create_text_node();
       // mark as inside tag
       this.reading_tag = true;
       if (this.next === "/") {
@@ -111,6 +118,8 @@ export default class Parser {
     if (this.balance !== 0) {
       throw Error(`unbalanced DOM tree: ${this.balance}`);
     }
+    // anything left at the end could be potentially a text node
+    this.try_create_text_node();
     return this.tree;
   }
 

package/source/invariants.js

@@ -1,4 +1,5 @@
 import {constructible, nullish} from "./attributes.js";
+import map_entries from "./map_entries.js";
 
 const errored = error => {
   if (typeof error === "function") {
@@ -14,6 +15,9 @@ const assert = (predicate, error) => Boolean(predicate) || errored(error);
 const is = {
   "array": value => assert(Array.isArray(value), "must be array"),
   "string": value => assert(typeof value === "string", "must be string"),
+  "object": value => assert(typeof value === "object" && value !== null,
+    "must be object"),
+  "function": value => assert(typeof value === "function", "must be function"),
   "defined": (value, error) => assert(value !== undefined, error),
   "undefined": value => assert(value === undefined, "must be undefined"),
   "constructible": (value, error) => assert(constructible(value), error),
@@ -24,9 +28,10 @@ const is = {
 };
 const {defined} = is;
 
-const maybe = Object.keys(is).reduce((aggregator, property) => {
-  aggregator[property] = value => nullish(value) || is[property](value);
-  return aggregator;
-}, {});
+// too early to use map_entries here, as it relies on invariants
+const maybe = Object.fromEntries(Object.entries(is).map(([key, value]) =>
+  [key, (...args) => nullish(args[0]) || value(...args)]));
 
-export {assert, defined, is, maybe};
+const invariant = predicate => predicate();
+
+export {assert, defined, is, maybe, invariant};

package/source/map_entries.js

@@ -0,0 +1,6 @@
+import {is, invariant} from "./invariants.js";
+
+export default (object = {}, mapper = (...args) => args) =>
+  invariant(() => is.object(object) && is.function(mapper))
+  && Object.fromEntries(Object.entries(object).map(([key, value]) =>
+    mapper(key, value)));

package/source/sanitize.js

@@ -1,10 +1,8 @@
-export default (payload = {}) => Object.keys(payload)
-  .map(key => ({key, "value": payload[key].toString().trim()}))
-  .map(datum => {
-    datum.value = datum.value === "" ? undefined : datum.value;
-    return datum;
-  })
-  .reduce((data, {key, value}) => {
-    data[key] = value;
-    return data;
-  }, {});
+import {is} from "./invariants.js";
+import map_entries from "./map_entries.js";
+
+export default (dirty = {}) => is.object(dirty)
+  && map_entries(dirty, (key, value) => {
+    const trimmed = value.toString().trim();
+    return [key, trimmed === "" ? undefined : trimmed];
+  });