primate 0.9.0 → 0.9.2

package/README.md

@@ -1,54 +1,19 @@
 # Primate 
 
-Primal JavaScript framework.
+An expressive, minimal and extensible framework for JavaScript.
 
 ## Getting started
 
-Lay out app
-
-```sh
-mkdir -p app/{routes,components,ssl} && cd app
-
-```
-
-Create a route for `/` in `routes/site.js`
+Create a route in `routes/hello.js`
 
 ```js
-import html from "@primate/html";
-
 export default router => {
-  router.get("/", () => html`<site-index date="${new Date()}" />`);
+  router.get("/", () => "Hello, world!");
 };
 
 ```
 
-Create a component in `components/site-index.html`
-
-```html
-Today's date is ${date}.
-
-```
-
-Generate SSL files
-
-```sh
-openssl req -x509 -out ssl/default.crt -keyout ssl/default.key -newkey rsa:2048 -nodes -sha256 -batch
-
-```
-
-Run
-
-```sh
-npx primate
-```
-
-## Table of contents
-
-* [Serving content](#serving-content)
-* [Routing](#routing)
-* [Domains](#domains)
-* [Stores](#stores)
-* [Components](#components)
+Add `{"type": "module"}` to your `package.json` and run `npx primate`.
 
 ## Serving content
 
@@ -127,10 +92,10 @@ export default router => {
 
 ## Routing
 
-Routes map requests to responses. All routes are loaded from `routes`.
+Routes map requests to responses. They are loaded from `routes`.
 
 The order in which routes are declared is irrelevant. Redeclaring a route
-(same pathname and same HTTP verb) throws a `RouteError`.
+(same pathname and same HTTP verb) throws an error.
 
 ### Basic GET route
 
@@ -189,7 +154,7 @@ export default router => {
   router.get("/user/view/_id", request => request.path[2]);
 
   // can be combined with named groups
-  router.alias("_name", "(<name>[a-z])+");
+  router.alias("_name", "(?<name>[a-z])+");
 
   // will return name if matched, 404 otherwise
   router.get("/user/view/_name", request => request.named.name);
@@ -223,10 +188,8 @@ export default router => {
 
 ## Domains
 
-Domains represent a collection in a store. All domains are loaded from
-`domains`.
-
-A collection is primarily described using the class `fields` property.
+Domains represent a collection in a store, primarily with the class `fields`
+property.
 
 ### Fields
 
@@ -294,14 +257,7 @@ export default class User extends Domain {
 
 ```
 
-## Stores
-
-Stores interface data. Primate comes with volatile in-memory store used as a
-default. Other stores can be imported as modules.
-
-All stores are loaded from `stores`.
-
-### Resources
+## Resources
 
 * Website: https://primatejs.com
 * IRC: Join the `#primate` channel on `irc.libera.chat`.
@@ -309,12 +265,3 @@ All stores are loaded from `stores`.
 ## License
 
 MIT
-
-[getting-started]: https://primatejs.com/getting-started
-[source-code]: https://github.com/primatejs/primate
-[issues]: https://github.com/primatejs/primate/issues
-[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
-[primate-react]: https://github.com/primatejs/primate-react
-[primate-vue]: https://github.com/primatejs/primate-vue

package/README.template.md

@@ -1,46 +1,16 @@
 # Primate 
 
-Primal JavaScript framework.
+An expressive, minimal and extensible framework for JavaScript.
 
 ## Getting started
 
-Lay out app
-
-```sh
-# getting-started/lay-out-app.sh
-```
-
-Create a route for `/` in `routes/site.js`
+Create a route in `routes/hello.js`
 
 ```js
-// getting-started/site.js
-```
-
-Create a component in `components/site-index.html`
-
-```html
-<!-- getting-started/site-index.html -->
-```
-
-Generate SSL files
-
-```sh
-# getting-started/generate-ssl.sh
+// getting-started/hello.js
 ```
 
-Run
-
-```sh
-npx primate
-```
-
-## Table of contents
-
-* [Serving content](#serving-content)
-* [Routing](#routing)
-* [Domains](#domains)
-* [Stores](#stores)
-* [Components](#components)
+Add `{"type": "module"}` to your `package.json` and run `npx primate`.
 
 ## Serving content
 
@@ -80,10 +50,10 @@ Serve the component in your route
 
 ## Routing
 
-Routes map requests to responses. All routes are loaded from `routes`.
+Routes map requests to responses. They are loaded from `routes`.
 
 The order in which routes are declared is irrelevant. Redeclaring a route
-(same pathname and same HTTP verb) throws a `RouteError`.
+(same pathname and same HTTP verb) throws an error.
 
 ### Basic GET route
 
@@ -123,10 +93,8 @@ The order in which routes are declared is irrelevant. Redeclaring a route
 
 ## Domains
 
-Domains represent a collection in a store. All domains are loaded from
-`domains`.
-
-A collection is primarily described using the class `fields` property.
+Domains represent a collection in a store, primarily with the class `fields`
+property.
 
 ### Fields
 
@@ -155,14 +123,7 @@ aside from the type.
 // domains/predicates.js
 ```
 
-## Stores
-
-Stores interface data. Primate comes with volatile in-memory store used as a
-default. Other stores can be imported as modules.
-
-All stores are loaded from `stores`.
-
-### Resources
+## Resources
 
 * Website: https://primatejs.com
 * IRC: Join the `#primate` channel on `irc.libera.chat`.
@@ -170,12 +131,3 @@ All stores are loaded from `stores`.
 ## License
 
 MIT
-
-[getting-started]: https://primatejs.com/getting-started
-[source-code]: https://github.com/primatejs/primate
-[issues]: https://github.com/primatejs/primate/issues
-[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
-[primate-react]: https://github.com/primatejs/primate-react
-[primate-vue]: https://github.com/primatejs/primate-vue

package/TODO

@@ -0,0 +1,4 @@
+remove ssl hint from documentation -> maybe add a "running an https server"
+add RouteError
+add the possibility to pass strings to attributes (rework internally data to
+hang at attributes)

package/module.json

@@ -1,6 +1,6 @@
 {
   "name": "primate",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "author": "Terrablue <terrablue@proton.me>",
   "bugs": "https://github.com/primatejs/primate/issues",
   "repository": "https://github.com/primatejs/primate",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "primate",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "author": "Terrablue <terrablue@proton.me>",
   "homepage": "https://primatejs.com",
   "bugs": "https://github.com/primatejs/primate/issues",
@@ -8,7 +8,7 @@
   "description": "Primal JavaScript framework",
   "license": "MIT",
   "dependencies": {
-    "runtime-compat": "file:../../flogjs/std/runtime-compat"
+    "runtime-compat": "^0.12.3"
   },
   "bin": "bin/primate.js",
   "devDependencies": {

package/src/bundle.js

@@ -0,0 +1,15 @@
+import {File} from "runtime-compat/filesystem";
+
+export default async conf => {
+  const {paths} = conf;
+  // remove public directory in case exists
+  if (await paths.public.exists) {
+    await paths.public.file.remove();
+  }
+  await paths.public.file.create();
+
+  if (await paths.static.exists) {
+    // copy static files to public
+    await File.copy(paths.static, paths.public);
+  }
+};

package/src/preset/primate.json

@@ -7,10 +7,6 @@
   "http": {
     "host": "localhost",
     "port": 9999,
-    "ssl": {
-      "key": "ssl/default.key",
-      "cert": "ssl/default.crt"
-    },
     "csp": {
       "default-src": "'self'",
       "object-src": "'none'",

package/src/route.js

@@ -55,7 +55,9 @@ export default async definitions => {
       return typeof result === "function" ? result : guess(result);
     },
   };
-  const files = (await Path.list(definitions)).map(route => import(route));
-  await Promise.all(files.map(async route => (await route).default(router)));
+  if (await definitions.exists) {
+    const files = (await Path.list(definitions)).map(route => import(route));
+    await Promise.all(files.map(async route => (await route).default(router)));
+  }
   return router;
 };

package/src/run.js

@@ -1,7 +1,6 @@
-import {Path, File} from "runtime-compat/filesystem";
-import {default as Bundler, index} from "./Bundler.js";
 import serve from "./serve.js";
 import route from "./route.js";
+import bundle from "./bundle.js";
 import package_json from "../package.json" assert {type: "json"};
 import log from "./log.js";
 
@@ -9,18 +8,11 @@ export default async conf => {
   log.reset("Primate").yellow(package_json.version);
   const {paths} = conf;
   const router = await route(paths.routes);
-  await new Bundler(conf).bundle();
+  await bundle(conf);
 
   await serve({router,
     paths: conf.paths,
-    index: await index(conf),
     from: conf.paths.public,
-    http: {
-      ...conf.http,
-      key: await File.read(Path.resolve(conf.http.ssl.key)),
-      cert: await File.read(Path.resolve(conf.http.ssl.cert)),
-      keyFile: Path.resolve(conf.http.ssl.key),
-      certFile: Path.resolve(conf.http.ssl.cert),
-    },
+    http: conf.http,
   });
 };

package/src/serve.js

@@ -38,7 +38,7 @@ const Server = class Server {
       return this.try(pathname + search, request, payload);
     }, http);
     const {port, host} = this.conf.http;
-    log.reset("on").yellow(`https://${host}:${port}`).nl();
+    log.reset("on").yellow(`${host}:${port}`).nl();
   }
 
   async try(url, request, payload) {

package/html.js

@@ -1,13 +0,0 @@
-import html from "../src/handlers/html.js";
-const components = {
-  "custom-tag": "<ct></ct>",
-  "custom-with-attribute": "<cwa value=\"${foo}\"></cwa>",
-  "custom-with-object-attribute": "<cwoa value=\"${foo.bar}\"></cwoa>",
-  "custom-with-slot": "<cws><slot/></cws>",
-  "for-with-object": "<fwo for=\"${foo}\"><span value=\"${bar}\"></span></fwo>",
-  "slot-before-custom": "<slot/><custom-tag></custom-tag>",
-  "custom-before-slot": "<custom-tag></custom-tag><slot/>",
-};
-const index = "<body>";
-const conf = {components, index};
-export default () => (strings, ...keys) => html(strings, ...keys)(conf);

package/src/Bundler.js

@@ -1,40 +0,0 @@
-import {Path, File} from "runtime-compat/filesystem";
-
-const meta_url = new Path(import.meta.url).path;
-const directory = Path.directory(meta_url);
-const preset = `${directory}/preset`;
-
-export default class Bundler {
-  constructor(conf) {
-    this.conf = conf;
-    this.debug = conf.debug;
-    this.index = conf.files.index;
-    this.scripts = [];
-  }
-
-  async bundle() {
-    const {paths} = this.conf;
-
-    // remove public directory in case exists
-    await File.remove(paths.public);
-    // create public directory
-    await File.create(paths.public);
-
-    // copy static files to public
-    await File.copy(paths.static, paths.public);
-
-    // read index.html from public, then remove it (we serve it dynamically)
-    await File.remove(`${paths.public}/${this.index}`);
-  }
-}
-
-export const index = async conf => {
-  let file;
-  const subdirectory = "static";
-  try {
-    file = await File.read(`${conf.paths[subdirectory]}/${conf.files.index}`);
-  } catch (error) {
-    file = await File.read(`${preset}/${subdirectory}/${conf.files.index}`);
-  }
-  return file;
-};