primate 0.15.1 → 0.15.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "primate",
-  "version": "0.15.1",
+  "version": "0.15.3",
   "description": "Expressive, minimal and extensible framework for JavaScript",
   "homepage": "https://primatejs.com",
   "bugs": "https://github.com/primatejs/primate/issues",

package/src/bin.js

@@ -5,4 +5,4 @@ import run from "./run.js";
 
 const command = name => commands[name] ?? commands.help;
 
-await run(args[0] === undefined ? commands.start : command(args[0]));
+await run(args[0] === undefined ? commands.dev : command(args[0]));

package/src/commands/create.js

@@ -15,6 +15,8 @@ const createModule = async () => {
       },
       scripts: {
         start: "npx primate",
+        dev: "npx primate dev",
+        serve: "npx primate serve",
       },
       type: "module",
     }, null, space);

package/src/commands/dev.js

@@ -0,0 +1,16 @@
+import register from "../register.js";
+import compile from "../compile.js";
+import publish from "../publish.js";
+import route from "../route.js";
+import serve from "../serve.js";
+
+export default async env => {
+  // register handlers
+  await register(env);
+  // compile server-side code
+  await compile(env);
+  // publish client-side code
+  await publish(env);
+  // serve
+  serve({router: await route(env), ...env});
+};

package/src/commands/exports.js

@@ -1,3 +1,4 @@
-export {default as start} from "./start.js";
+export {default as dev} from "./dev.js";
+export {default as serve} from "./serve.js";
 export {default as create} from "./create.js";
 export {default as help} from "./help.js";

package/src/config.js

@@ -80,9 +80,9 @@ export default async (filename = "primate.config.js") => {
         .replace("%body%", () => body)
         .replace("%head%", () => `${head}${heads}`);
     },
-    publish: async ({src, code, type = "", inline = false}) => {
+    publish: async ({src, code, type = "", inline = false, main}) => {
       const integrity = await hash(code);
-      resources.push({src, code, type, inline, integrity});
+      resources.push({src, code, type, inline, integrity, main});
       return integrity;
     },
   };

package/src/exports.js

@@ -1,5 +1,5 @@
-import {start} from "./commands/exports.js";
+import {serve} from "./commands/exports.js";
 import run from "./run.js";
 
 export * from "./handlers/exports.js";
-export default () => run(start);
+export default () => run(serve);

package/eslint.config.js

@@ -1 +0,0 @@
-export {default} from "maximin";

package/module.json

@@ -1,15 +0,0 @@
-{
-  "name": "primate",
-  "version": "0.15.1",
-  "description": "Expressive, minimal and extensible framework for JavaScript",
-  "homepage": "https://primatejs.com",
-  "bugs": "https://github.com/primatejs/primate/issues",
-  "license": "MIT",
-  "bin": "src/bin.js",
-  "repository": "https://github.com/primatejs/primate",
-  "scripts": {
-    "docs": "scripts/docs.sh",
-    "test": "npx debris",
-    "lint": "npx eslint ."
-  }
-}

package/readme/components/edit-user-for.html

@@ -1,10 +0,0 @@
-<form for="${user}" method="post">
-  <h1>Edit user</h1>
-  <p>
-    <input name="name" value="${name}" />
-  </p>
-  <p>
-    <input name="email" value="${email}" />
-  </p>
-  <input type="submit" value="Save user" />
-</form>

package/readme/components/edit-user.html

@@ -1,10 +0,0 @@
-<form method="post">
-  <h1>Edit user</h1>
-  <p>
-    <input name="name" value="${user.name}"></textarea>
-  </p>
-  <p>
-    <input name="email" value="${user.email}"></textarea>
-  </p>
-  <input type="submit" value="Save user" />
-</form>

package/readme/components/user-index.html

@@ -1,4 +0,0 @@
-<div for="${users}">
-  User ${name}.
-  Email ${email}.
-</div>

package/readme/components/users.html

@@ -1,4 +0,0 @@
-<div for="${users}">
-  User ${name}.
-  Email ${email}.
-</div>

package/readme/extensions/handlers/html/user-index.html

@@ -1,4 +0,0 @@
-<div for="${users}">
-  User ${name}.
-  Email ${email}.
-</div>

package/readme/extensions/handlers/html/user.js

@@ -1,13 +0,0 @@
-import html from "@primate/html";
-
-export default router => {
-  // the HTML tagged template handler loads a component from the `components`
-  // directory and serves it as HTML, passing any given data as attributes
-  router.get("/users", () => {
-    const users = [
-      {name: "Donald", email: "donald@the.duck"},
-      {name: "Joe", email: "joe@was.absent"},
-    ];
-    return html("user-index", {users});
-  });
-};

package/readme/extensions/handlers/htmx/user-index.html

@@ -1,4 +0,0 @@
-<div for="${users}" hx-get="/other-users" hx-swap="outerHTML">
-  User ${name}.
-  Email ${email}.
-</div>

package/readme/extensions/handlers/htmx/user.js

@@ -1,23 +0,0 @@
-import {default as htmx, partial} from "@primate/htmx";
-
-export default router => {
-  // the HTML tagged template handler loads a component from the `components`
-  // directory and serves it as HTML, passing any given data as attributes
-  router.get("/users", () => {
-    const users = [
-      {name: "Donald", email: "donald@the.duck"},
-      {name: "Joe", email: "joe@was.absent"},
-    ];
-    return htmx("user-index", {users});
-  });
-
-  // this is the same as above, with support for partial rendering (without
-  // index.html)
-  router.get("/other-users", () => {
-    const users = [
-      {name: "Other Donald", email: "donald@the.goose"},
-      {name: "Other Joe", email: "joe@was.around"},
-    ];
-    return partial("user-index", {users});
-  });
-};

package/readme/extensions/handlers/redirect/user.js

@@ -1,6 +0,0 @@
-import redirect from "@primate/html";
-
-export default router => {
-  // redirect the request
-  router.get("/user", () => redirect("/users"));
-};

package/readme/extensions/modules/configure.js

@@ -1,3 +0,0 @@
-export default {
-  modules: [],
-};

package/readme/extensions/modules/domains/configure.js

@@ -1,5 +0,0 @@
-import domains from "@primate/domains";
-
-export default {
-  modules: [domains()],
-};

package/readme/extensions/modules/domains/fields.js

@@ -1,11 +0,0 @@
-import {Domain} from "@primate/domains";
-
-// A basic domain with two properies
-export default class User extends Domain {
-  static fields = {
-    // a user's name is a string
-    name: String,
-    // a user's age is a number
-    age: Number,
-  };
-}

package/readme/extensions/modules/domains/predicates.js

@@ -1,14 +0,0 @@
-import {Domain} from "@primate/domains";
-import House from "./House.js";
-
-export default class User extends Domain {
-  static fields = {
-    // a user's name is a string unique across the user collection
-    name: [String, "unique"],
-    // a user's age is a positive integer
-    age: [Number, "integer", "positive"],
-    // a user's house has the foreign id of a house record and no two
-    // users may have the same house
-    house_id: [House, "unique"],
-  };
-}

package/readme/extensions/modules/domains/short-field-notation.js

@@ -1,13 +0,0 @@
-import {Domain} from "@primate/domains";
-import House from "./House.js";
-
-export default class User extends Domain {
-  static fields = {
-    // a user's name is a string
-    name: String,
-    // a user's age is a number
-    age: Number,
-    // a user's house has the foreign id of a house record
-    house_id: House,
-  };
-}

package/readme/getting-started.js

@@ -1,5 +0,0 @@
-export default {
-  get() {
-    return "Hello, world!";
-  },
-};

package/readme/routing/accessing-the-request-body.js

@@ -1,6 +0,0 @@
-// routes/site/login.js handles the `/site/login` route
-export default {
-  get(request) {
-    return `username submitted: ${request.body.username}`;
-  },
-};

package/readme/routing/basic.js

@@ -1,13 +0,0 @@
-import {redirect} from "primate";
-
-// routes/site/login.js handles the `/site/login` route
-export default {
-  get() {
-    // strings are served as plain text
-    return "Hello, world!";
-  },
-  // other HTTP verbs are also available
-  post() {
-    return redirect("/");
-  },
-};

package/readme/routing/explicit-handlers.js

@@ -1,8 +0,0 @@
-import {redirect} from "primate";
-
-// routes/source.js handles the `/source` route
-export default {
-  get() {
-    return redirect("/target");
-  },
-};

package/readme/routing/parameterized-routes.js

@@ -1,7 +0,0 @@
-// routes/user/{userId}.js handles all routes of the sort `/user/{userId}`
-// where {userId} can be anything
-export default {
-  get(request) {
-    return `user id: ${request.named.userId}`;
-  },
-};

package/readme/routing/the-request-object.js

@@ -1,7 +0,0 @@
-// routes/site/login.js handles the `/site/login` route
-export default {
-  get(request) {
-    // will serve `["site", "login"]` as JSON
-    return request.path;
-  },
-};

package/readme/serving-content/html.js

@@ -1,9 +0,0 @@
-import {html} from "primate";
-
-// routes/index.js handles the `/` route
-export default {
-  get() {
-    // to serve HTML, import and use the html handler
-    return html("<p>Hello, world!</p>");
-  },
-};

package/readme/serving-content/json.js

@@ -1,10 +0,0 @@
-// routes/index.js handles the `/` route
-export default {
-  get() {
-    // proper JavaScript objects are served as JSON
-    return [
-      {name: "Donald"},
-      {name: "Ryan"},
-    ];
-  },
-};

package/readme/serving-content/plain-text.js

@@ -1,7 +0,0 @@
-// routes/index.js handles the `/` route
-export default {
-  get() {
-    // strings are served as plain text
-    return "Donald";
-  },
-};

package/readme/serving-content/response.js

@@ -1,9 +0,0 @@
-import {Response} from "runtime-compat/http";
-
-// routes/index.js handles the `/` route
-export default {
-  get() {
-    // use a Response object for custom response status
-    return new Response("created!", {status: 201});
-  },
-};

package/readme/serving-content/streams.js

@@ -1,9 +0,0 @@
-import {File} from "runtime-compat/filesystem";
-
-// routes/index.js handles the `/` route
-export default {
-  get() {
-    // ReadableStream or Blob objects are streamed to the client
-    return new File("users.json");
-  },
-};

package/readme/template.md

@@ -1,121 +0,0 @@
-# Primate 
-
-Expressive, minimal and extensible framework for JavaScript.
-
-## Getting started
-
-Run `npx -y primate@latest create` to create a project structure.
-
-Create a route in `routes/index.js`
-
-```js
-// getting-started.js
-```
-
-Run `npm i && npm start` and visit `localhost:6161` in your browser.
-
-## Table of Contents
-
-- [Serving content](#serving-content)
-  - [Plain text](#plain-text)
-  - [JSON](#json)
-  - [Streams](#streams)
-  - [Response](#response)
-  - [HTML](#html)
-- [Routing](#routing)
-  - [Basic](#basic)
-  - [The request object](#the-request-object)
-  - [Accessing the request body](#accessing-the-request-body)
-  - [Parameterized routes](#parameterized-routes)
-  - [Explicit handlers](#explicit-handlers)
-
-## Serving content
-
-Create a file in `routes/index.js` to handle the special `/` route.
-
-### Plain text
-
-```js
-// serving-content/plain-text.js
-```
-
-### JSON
-
-```js
-// serving-content/json.js
-```
-
-### Streams
-
-```js
-// serving-content/streams.js
-```
-
-### Response
-
-```js
-// serving-content/response.js
-```
-
-### HTML
-
-```js
-// serving-content/html.js
-```
-
-## Routing
-
-Primate uses filesystem-based routes. Every path a client accesses is mapped to 
-a route under `routes`.
-
-* `index.js` handles the root route (`/`)
-* `post.js` handles the `/post` route
-* `post/{postId}.js` handles a parameterized route where `{postId}` can
-  be mapped to anything, such as `/post/1`
-
-### Basic
-
-```js
-// routing/basic.js
-```
-
-### The request object
-
-```js
-// routing/the-request-object.js
-```
-
-### Accessing the request body
-
-For requests containing a body, Primate will attempt to parse the body according
-to the content type sent along the request. Currently supported are
-`application/x-www-form-urlencoded` (typically for form submission) and
-`application/json`.
-
-```js
-// routing/accessing-the-request-body.js
-```
-
-### Parameterized routes
-
-```js
-// routing/parameterized-routes.js
-```
-
-### Explicit handlers
-
-Often we can figure out the content type to respond with based on the return
-type from the handler. For other cases, we need to use an explicit handler.
-
-```js
-// routing/explicit-handlers.js
-```
-
-## Resources
-
-* Website: https://primatejs.com
-* IRC: Join the `#primate` channel on `irc.libera.chat`.
-
-## License
-
-MIT

package/scripts/docs.sh

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-npx -y embedme\
-  --source-root readme\
-  --strip-embed-comment\
-  --stdout readme/template.md\
-  > README.md
-

package/src/extend.spec.js

@@ -1,103 +0,0 @@
-import extend from "./extend.js";
-
-export default test => {
-  test.case("no params", assert => {
-    assert(extend()).equals({});
-  });
-
-  test.case("no base", assert => {
-    const extension = {key: "value"};
-    assert(extend(undefined, extension)).equals(extension);
-  });
-
-  test.case("no extension", assert => {
-    const base = {keys: "values"};
-    assert(extend(base)).equals(base);
-  });
-
-  test.case("base and extension same", assert => {
-    const object = {key: "value"};
-    assert(extend(object, object)).equals(object);
-  });
-
-  test.case("one property", assert => {
-    const base = {key: "value"};
-    const extension = {key: "value2"};
-    assert(extend(base, extension)).equals(extension);
-  });
-
-  test.case("two properties, one replaced", assert => {
-    const base = {key: "value", key2: "value2"};
-    const extension = {key: "other value"};
-    const extended = {key: "other value", key2: "value2"};
-    assert(extend(base, extension)).equals(extended);
-  });
-
-  test.case("arrays overwritten", assert => {
-    const base = {key: ["value", "value2"]};
-    const extension = {key: ["value3", "value4"]};
-    assert(extend(base, extension)).equals(extension);
-  });
-
-  test.case("one property of a subobject", assert => {
-    const base = {key: {subkey: "subvalue"}};
-    const extension = {key: {subkey: "subvalue 2"}};
-    assert(extend(base, extension)).equals(extension);
-  });
-
-  test.case("two properties of a subobject, one replaced", assert => {
-    const base = {key: {subkey: "subvalue", subkey2: "subvalue2"}};
-    const extension = {key: {subkey: "subvalue 2"}};
-    const extended = {key: {subkey: "subvalue 2", subkey2: "subvalue2"}};
-    assert(extend(base, extension)).equals(extended);
-  });
-
-  test.case("config enhancement", assert => {
-    const base = {
-      base: "/",
-      debug: false,
-      defaults: {
-        action: "index",
-        context: "guest",
-      },
-      paths: {
-        public: "public",
-        static: "static",
-        routes: "routes",
-        components: "components",
-      },
-    };
-
-    const additional = {
-      debug: true,
-      environment: "testing",
-      defaults: {
-        context: "user",
-        mode: "operational",
-      },
-      paths: {
-        client: "client",
-      },
-    };
-
-    const extended = {
-      base: "/",
-      debug: true,
-      environment: "testing",
-      defaults: {
-        action: "index",
-        context: "user",
-        mode: "operational",
-      },
-      paths: {
-        client: "client",
-        public: "public",
-        static: "static",
-        routes: "routes",
-        components: "components",
-      },
-    };
-
-    assert(extend(base, additional)).equals(extended);
-  });
-};