@webqit/webflo 0.11.61-0 → 1.0.0

package/docker/Dockerfile

@@ -1,43 +1,43 @@
-# Base installations
-# (Node 18 is the minimum required version: stable Fetch API, etc)
-FROM node:18-alpine
-RUN apk add git
-RUN apk add certbot
-
-# Refer to https://www.digitalocean.com/community/tutorials/how-to-build-a-node-js-application-with-docker
-# By default, the Docker Node image includes a non-root node user that we can use to avoid running the application container as root.
-USER node
-
-# Create the working directory with node-user permissions
-RUN mkdir -p /home/node/www/app && chown -R node:node /home/node/www
-WORKDIR /home/node/www
-
-# Adding this COPY instruction before running npm install or copying the application code allows you to take advantage of Docker’s caching mechanism.
-COPY -chown=node:node package*.json ./
-
-# Install
-RUN npm install
-# If you are building your code for production
-# RUN npm ci --only=production
-
-# Copy application code with node-user permissions
-COPY --chown=node:node . .
-
-# Install Webflo and friends globally
-RUN npm install @webqit/webflo -g
-RUN npm install @webqit/oohtml-cli -g
-RUN npm install pm2 -g
-
-# The deployment directory
-WORKDIR /home/node/www/app
-
-# To auto-start app (flags optional), we would add...
-# CMD ["webflo", "start"]
-
-# To build the image locally...
-# docker build --no-cache -t webflo ./docker
-
-# To publish to docker hub...
-# docker login -u webqit
-# docker tag webflo webqit/webflo
+# Base installations
+# (Node 18 is the minimum required version: stable Fetch API, etc)
+FROM node:18-alpine
+RUN apk add git
+RUN apk add certbot
+
+# Refer to https://www.digitalocean.com/community/tutorials/how-to-build-a-node-js-application-with-docker
+# By default, the Docker Node image includes a non-root node user that we can use to avoid running the application container as root.
+USER node
+
+# Create the working directory with node-user permissions
+RUN mkdir -p /home/node/www/app && chown -R node:node /home/node/www
+WORKDIR /home/node/www
+
+# Adding this COPY instruction before running npm install or copying the application code allows you to take advantage of Docker’s caching mechanism.
+COPY -chown=node:node package*.json ./
+
+# Install
+RUN npm install
+# If you are building your code for production
+# RUN npm ci --only=production
+
+# Copy application code with node-user permissions
+COPY --chown=node:node . .
+
+# Install Webflo and friends globally
+RUN npm install @webqit/webflo -g
+RUN npm install @webqit/oohtml-cli -g
+RUN npm install pm2 -g
+
+# The deployment directory
+WORKDIR /home/node/www/app
+
+# To auto-start app (flags optional), we would add...
+# CMD ["webflo", "start"]
+
+# To build the image locally...
+# docker build --no-cache -t webflo ./docker
+
+# To publish to docker hub...
+# docker login -u webqit
+# docker tag webflo webqit/webflo
 # docker push webqit/webflo

package/docker/README.md

@@ -1,91 +1,91 @@
-# Webflo Container
-
-This is simply a node.js container with the `@webqit/webflo` framework installed. Once started, any webflo app can be deployed into the container from any git repository.
-
-## Usage
-
-This container image lives on Docker Hub and can be pulled to a local machine or a remote Virtual Machine (VM) on any cloud platform.
-
-+ [To Use Locally](#to-use-locally)
-+ [To Use In the Cloud](#to-use-in-the-cloud)
-* [To Deploy An App From Any Repo](#to-deploy-an-app-from-any-repo)
-
-### To Use Locally
-
-Ensure you have docker installed on your computer and run the following command from any location on your terminal:
-
-```shell
-docker pull webqit/webflo:latest
-```
-
-The above command pulls the `webqit/webflo` image to your local machine. (But this can be automatically done by docker on running any docker commands that reference the `webqit/webflo` image.)
-
-Next is to use the following commands to start the container and the Webflo runtime. In each case, the first part of the command starts the container, while the second part (from `webflo start`) starts the application.
-
-#### To Start
-
-Start the container using `docker run`; map a port (e.g `80`) of your host machine to `3000` of the container; optionally, give your container a name; reference `webqit/webflo` as the image to use; and lastly, start webflo using `webflo start`.
-
-```shell
-docker run -d -p 80:3000 --name my-app webqit/webflo webflo start
-```
-
-> Unless a port has been explicitly set via `webflo config server`, webflo *HTTP* port defaults to `3000` or the value specified in an environmental variable named `PORT`. If a `PORT` variable has been defined, then port mapping above would now need to use that variable: `-p 80:${PORT}`.
-
-Visit [localhost](http://localhost) to view your app. 
-
-#### To Run In HTTPS Mode
-
-To run Webflo apps in HTTPS inside a container, you basically need to map the appropriate SSL port from the host machine to a custom port in the container.
-
-Below, we're now mapping port `443` to an application-level port defined as `${SSL_PORT}`.
-
-```shell
-docker run -d -p 80:${PORT} 443:${SSL_PORT} --name my-app webqit/webflo webflo start
-```
-
-> Unless an SSL port has been explicitly set via `webflo config server`, webflo *HTTPS* port defaults to `0` (no HTTPS) or the value specified in an environmental variable named `SSL_PORT`.
-
-If you will be managing your SSL certificates in the host machine, you would also need to *bind-mount* the appropriate certificate volume from the host to the container.
-
-Below, we're now mapping the directory `/etc/letsencrypt/` - the default location for `letsencrypt` certificates - to an equivalent directory in the container.
-
-```shell
-docker run -d -p 80:${PORT} 443:${SSL_PORT} -v /etc/letsencrypt/:/etc/letsencrypt/ --name my-app webqit/webflo webflo start
-```
-
-> Webflo lets you generate `letsencrypt` certificates with the `webflo generate:cert <domain1,domain2,etc>` command. Just be sure to have your app running in HTTP mode to enable the process handle certbot's `http` challenge.
-
-#### To Start In Dev Mode
-
-Webflo's *dev* mode is the perfect mode for developing locally. All you do is append the `--env=dev --watch` flags to your webflo commands. [(Learn more)](#)
-
-```shell
-docker run -d -p 80:3000 --name my-app webqit/webflo webflo start --env=dev --watch
-```
-
-In *dev* mode, webflo automatically restarts as you make changes to your codebase. But since webflo now lives inside a container, you'll need to *bind* the directory of your source code on your host machine to the `/home/node/www/app` directory of the container.
-
-```shell
-docker run -d -v /Users/me/my-app:/home/node/www/app -p 80:3000 --name my-app webqit/webflo webflo start --env=dev --watch
-```
-
-### To Use In the Cloud
-
-TODO
-
-### To Deploy An App From Any Repo
-
-Whether running locally or in the cloud, webflo can easily take your application from any git repo. This follows webflo's normal `deploy` command.
-
-Simply point docker at your container (using `docker exec [container-name]`) and execute the `webflo deploy` command.
-
-```shell
-docker exec my-app webflo deploy https://github.com/me/my-app.git
-```
-
-If you will need to install any npm dependencies, you would run `npm install` from within your container.
-
-```shell
-docker exec my-app npm install
-```
+# Webflo Container
+
+This is simply a node.js container with the `@webqit/webflo` framework installed. Once started, any webflo app can be deployed into the container from any git repository.
+
+## Usage
+
+This container image lives on Docker Hub and can be pulled to a local machine or a remote Virtual Machine (VM) on any cloud platform.
+
++ [To Use Locally](#to-use-locally)
++ [To Use In the Cloud](#to-use-in-the-cloud)
+* [To Deploy An App From Any Repo](#to-deploy-an-app-from-any-repo)
+
+### To Use Locally
+
+Ensure you have docker installed on your computer and run the following command from any location on your terminal:
+
+```shell
+docker pull webqit/webflo:latest
+```
+
+The above command pulls the `webqit/webflo` image to your local machine. (But this can be automatically done by docker on running any docker commands that reference the `webqit/webflo` image.)
+
+Next is to use the following commands to start the container and the Webflo runtime. In each case, the first part of the command starts the container, while the second part (from `webflo start`) starts the application.
+
+#### To Start
+
+Start the container using `docker run`; map a port (e.g `80`) of your host machine to `3000` of the container; optionally, give your container a name; reference `webqit/webflo` as the image to use; and lastly, start webflo using `webflo start`.
+
+```shell
+docker run -d -p 80:3000 --name my-app webqit/webflo webflo start
+```
+
+> Unless a port has been explicitly set via `webflo config server`, webflo *HTTP* port defaults to `3000` or the value specified in an environmental variable named `PORT`. If a `PORT` variable has been defined, then port mapping above would now need to use that variable: `-p 80:${PORT}`.
+
+Visit [localhost](http://localhost) to view your app. 
+
+#### To Run In HTTPS Mode
+
+To run Webflo apps in HTTPS inside a container, you basically need to map the appropriate SSL port from the host machine to a custom port in the container.
+
+Below, we're now mapping port `443` to an application-level port defined as `${SSL_PORT}`.
+
+```shell
+docker run -d -p 80:${PORT} 443:${SSL_PORT} --name my-app webqit/webflo webflo start
+```
+
+> Unless an SSL port has been explicitly set via `webflo config server`, webflo *HTTPS* port defaults to `0` (no HTTPS) or the value specified in an environmental variable named `SSL_PORT`.
+
+If you will be managing your SSL certificates in the host machine, you would also need to *bind-mount* the appropriate certificate volume from the host to the container.
+
+Below, we're now mapping the directory `/etc/letsencrypt/` - the default location for `letsencrypt` certificates - to an equivalent directory in the container.
+
+```shell
+docker run -d -p 80:${PORT} 443:${SSL_PORT} -v /etc/letsencrypt/:/etc/letsencrypt/ --name my-app webqit/webflo webflo start
+```
+
+> Webflo lets you generate `letsencrypt` certificates with the `webflo generate:cert <domain1,domain2,etc>` command. Just be sure to have your app running in HTTP mode to enable the process handle certbot's `http` challenge.
+
+#### To Start In Dev Mode
+
+Webflo's *dev* mode is the perfect mode for developing locally. All you do is append the `--env=dev --watch` flags to your webflo commands. [(Learn more)](#)
+
+```shell
+docker run -d -p 80:3000 --name my-app webqit/webflo webflo start --env=dev --watch
+```
+
+In *dev* mode, webflo automatically restarts as you make changes to your codebase. But since webflo now lives inside a container, you'll need to *bind* the directory of your source code on your host machine to the `/home/node/www/app` directory of the container.
+
+```shell
+docker run -d -v /Users/me/my-app:/home/node/www/app -p 80:3000 --name my-app webqit/webflo webflo start --env=dev --watch
+```
+
+### To Use In the Cloud
+
+TODO
+
+### To Deploy An App From Any Repo
+
+Whether running locally or in the cloud, webflo can easily take your application from any git repo. This follows webflo's normal `deploy` command.
+
+Simply point docker at your container (using `docker exec [container-name]`) and execute the `webflo deploy` command.
+
+```shell
+docker exec my-app webflo deploy https://github.com/me/my-app.git
+```
+
+If you will need to install any npm dependencies, you would run `npm install` from within your container.
+
+```shell
+docker exec my-app npm install
+```

package/docker/package.json

@@ -1,3 +1,3 @@
-{
-    "name": "webqit/webflo-docker"
+{
+    "name": "webqit/webflo-docker"
 }

package/package.json

@@ -1,81 +1,80 @@
-{
-  "name": "@webqit/webflo",
-  "title": "Webflo",
-  "description": "The universal, fullstack JavaScript framework.",
-  "keywords": [
-    "git-workflow",
-    "self-hosting",
-    "automatic-deployment",
-    "command-line-interface",
-    "progressive-web-apps",
-    "single-page-apps",
-    "vanila-javascript"
-  ],
-  "homepage": "https://webqit.io/tooling/webflo",
-  "version": "0.11.61-0",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/webqit/webflo.git"
-  },
-  "bugs": {
-    "url": "https://github.com/webqit/webflo/issues"
-  },
-  "type": "module",
-  "main": "./src/index.js",
-  "scripts": {
-    "test": "mocha --extension .test.js --exit",
-    "test:coverage": "c8 --reporter=text-lcov npm run test | coveralls",
-    "postversion": "npm publish",
-    "postpublish": "git push && git push --tags"
-  },
-  "bin": {
-    "webflo": "src/webflo.js",
-    "webflo-certbot-http-auth-hook": "src/services-pi/cert/http-auth-hook.js",
-    "webflo-certbot-http-cleanup-hook": "src/services-pi/cert/http-cleanup-hook.js"
-  },
-  "dependencies": {
-    "@octokit/webhooks": "^7.15.1",
-    "@webqit/backpack": "^0.1.6",
-    "@webqit/oohtml-ssr": "^1.1.5",
-    "@webqit/util": "^0.8.9",
-    "client-sessions": "^0.8.0",
-    "esbuild": "^0.14.38",
-    "form-data-encoder": "^1.6.0",
-    "formdata-node": "^4.3.0",
-    "formidable": "^2.0.1",
-    "mime-types": "^2.1.33",
-    "simple-git": "^2.20.1",
-    "stream-slice": "^0.1.2",
-    "urlpattern-polyfill": "^4.0.3"
-  },
-  "devDependencies": {
-    "chai": "^4.3.6",
-    "coveralls": "^3.1.1",
-    "mocha": "^10.0.0",
-    "mocha-lcov-reporter": "^1.3.0"
-  },
-  "author": "Oxford Harrison <oxharris.dev@gmail.com>",
-  "maintainers": [
-    "Oxford Harrison <oxharris.dev@gmail.com>"
-  ],
-  "contributors": [],
-  "funding": {
-    "type": "patreon",
-    "url": "https://patreon.com/ox_harris"
-  },
-  "badges": {
-    "list": [
-      "npmversion",
-      "npmdownloads",
-      "patreon"
-    ],
-    "config": {
-      "patreonUsername": "ox_harris",
-      "githubUsername": "webqit",
-      "githubRepository": "webflo",
-      "githubSlug": "webqit/webflo",
-      "npmPackageName": "@webqit/webflo"
-    }
-  }
-}
+{
+  "name": "@webqit/webflo",
+  "title": "Webflo",
+  "description": "The universal, fullstack JavaScript framework.",
+  "keywords": [
+    "git-workflow",
+    "self-hosting",
+    "automatic-deployment",
+    "command-line-interface",
+    "progressive-web-apps",
+    "single-page-apps",
+    "vanila-javascript"
+  ],
+  "homepage": "https://webqit.io/tooling/webflo",
+  "version": "1.0.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/webqit/webflo.git"
+  },
+  "bugs": {
+    "url": "https://github.com/webqit/webflo/issues"
+  },
+  "type": "module",
+  "main": "./src/index.js",
+  "scripts": {
+    "test": "mocha --extension .test.js --exit",
+    "test:coverage": "c8 --reporter=text-lcov npm run test | coveralls",
+    "postversion": "npm publish --tag next",
+    "postpublish": "git push && git push --tags"
+  },
+  "bin": {
+    "webflo": "src/webflo.js",
+    "webflo-certbot-http-auth-hook": "src/services-pi/cert/http-auth-hook.js",
+    "webflo-certbot-http-cleanup-hook": "src/services-pi/cert/http-cleanup-hook.js"
+  },
+  "dependencies": {
+    "@octokit/webhooks": "^7.15.1",
+    "@webqit/backpack": "^0.1.6",
+    "@webqit/observer": "^2.0.7",
+    "@webqit/oohtml-ssr": "^2.1.1",
+    "@webqit/util": "^0.8.11",
+    "client-sessions": "^0.8.0",
+    "esbuild": "^0.14.38",
+    "jsdom": "^21.1.1",
+    "mime-types": "^2.1.33",
+    "simple-git": "^2.20.1",
+    "stream-slice": "^0.1.2",
+    "urlpattern-polyfill": "^4.0.3"
+  },
+  "devDependencies": {
+    "chai": "^4.3.6",
+    "coveralls": "^3.1.1",
+    "mocha": "^10.0.0",
+    "mocha-lcov-reporter": "^1.3.0"
+  },
+  "author": "Oxford Harrison <oxharris.dev@gmail.com>",
+  "maintainers": [
+    "Oxford Harrison <oxharris.dev@gmail.com>"
+  ],
+  "contributors": [],
+  "funding": {
+    "type": "patreon",
+    "url": "https://patreon.com/ox_harris"
+  },
+  "badges": {
+    "list": [
+      "npmversion",
+      "npmdownloads",
+      "patreon"
+    ],
+    "config": {
+      "patreonUsername": "ox_harris",
+      "githubUsername": "webqit",
+      "githubRepository": "webflo",
+      "githubSlug": "webqit/webflo",
+      "npmPackageName": "@webqit/webflo"
+    }
+  }
+}

package/src/{Context.js → AbstractContext.js}

@@ -1,80 +1,72 @@
-
-export default class Context {
-
-    /**
-     * Initializes a context.
-     * 
-     * @param Object  dict 
-     * @param String  CD 
-     */
-    constructor(dict, CD = null) {
-        // dict can be plain object or some Context instance itself
-        // Using it as only a prototype protects it from being mutated down here
-        Object.defineProperty(this, 'dict', { value: Object.create(dict), });
-        // Now, for enumerable props thet need to be enumerable, where no getter/setter on both instances
-        for (let prop in this.dict) {
-            if (prop in this) continue;
-            this[prop] = this.dict[prop];
-        }
-        if (arguments.length > 1) {
-            Object.defineProperty(this.dict, 'CWD', { get: () => CD });
-        }
-    }
-
-    get name() {
-        return 'webflo';
-    }
-
-    // create
-    static create(...args) {
-        return new this(...args);
-    }
-
-    // CWD
-    get CWD() {
-        return this.dict.CWD || '';
-    }
-
-    // meta
-    get meta() {
-        return this.dict.meta || {};
-    }
-
-    // app
-    get app() {
-        return this.dict.app || {};
-    }
-
-    // config
-    get config() {
-        return this.dict.config || {};
-    }
-
-    // flags
-    get flags() {
-        return this.dict.flags || {};
-    }
-
-    set flags(value) {
-        Object.defineProperty(this.dict, 'flags', { value } );
-    }
-
-    // layout
-    get layout() {
-        return this.dict.layout || {};
-    }
-
-    set layout(value) {
-        Object.defineProperty(this.dict, 'layout', { value } );
-    }
-
-    // logger
-    get logger() {
-        return this.dict.logger;
-    }
-
-    set logger(value) {
-        Object.defineProperty(this.dict, 'logger', { value } );
-    }
-
+export class AbstractContext {
+
+    constructor(dict, CD = null) {
+        // dict can be plain object or some Context instance itself
+        // Using it as only a prototype protects it from being mutated down here
+        Object.defineProperty(this, 'dict', { value: Object.create(dict), });
+        // Now, for enumerable props thet need to be enumerable, where no getter/setter on both instances
+        for (let prop in this.dict) {
+            if (prop in this) continue;
+            this[prop] = this.dict[prop];
+        }
+        if (arguments.length > 1) {
+            Object.defineProperty(this.dict, 'CWD', { get: () => CD });
+        }
+    }
+
+    get name() {
+        return 'webflo';
+    }
+
+    // create
+    static create(...args) {
+        return new this(...args);
+    }
+
+    // CWD
+    get CWD() {
+        return this.dict.CWD || '';
+    }
+
+    // meta
+    get meta() {
+        return this.dict.meta || {};
+    }
+
+    // app
+    get app() {
+        return this.dict.app || {};
+    }
+
+    // config
+    get config() {
+        return this.dict.config || {};
+    }
+
+    // flags
+    get flags() {
+        return this.dict.flags || {};
+    }
+
+    set flags(value) {
+        Object.defineProperty(this.dict, 'flags', { value } );
+    }
+
+    // layout
+    get layout() {
+        return this.dict.layout || {};
+    }
+
+    set layout(value) {
+        Object.defineProperty(this.dict, 'layout', { value } );
+    }
+
+    // logger
+    get logger() {
+        return this.dict.logger;
+    }
+
+    set logger(value) {
+        Object.defineProperty(this.dict, 'logger', { value } );
+    }
 }