Signing CLA

.github/workflows/eslint.yml

@@ -0,0 +1,40 @@
+name: ESLint
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:
+
+concurrency:
+  group: lint-${{ github.event.pull_request.number || github.ref_name }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  # Needed for GitHub Checks API
+  checks: write
+
+jobs:
+  eslint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm install --include=dev
+
+      - name: Run ESLint with reviewdog (GitHub Checks)
+        uses: reviewdog/action-eslint@v1
+        with:
+          eslint_flags: '.'
+          reporter: github-pr-check
+          fail_level: error
+          level: error
+          tool_name: ESLint PR code

bin/build-site.sh

@@ -5,7 +5,7 @@
 # Default to the current version number for building the plugin library
 
 if [  -z "$TW5_BUILD_VERSION" ]; then
-    TW5_BUILD_VERSION=v5.3.8
+    TW5_BUILD_VERSION=v5.4.0
 fi
 
 echo "Using TW5_BUILD_VERSION as [$TW5_BUILD_VERSION]"

core/modules/commander.js → core-server/commander.js

@@ -99,16 +99,18 @@ Commander.prototype.executeNextCommand = function() {
 					}
 				}
 				if(command.info.synchronous) {
-					// Synchronous command
+					// Synchronous command (await thenables)
 					c = new command.Command(params,this);
 					err = c.execute();
-					if(err) {
+					if(err && typeof err.then === "function") {
+						err.then(e => { e ? this.callback(e) : this.executeNextCommand(); });
+					} else if(err) {
 						this.callback(err);
 					} else {
 						this.executeNextCommand();
 					}
 				} else {
-					// Asynchronous command
+					// Asynchronous command (await thenables)
 					c = new command.Command(params,this,function(err) {
 						if(err) {
 							self.callback(err);
@@ -117,7 +119,9 @@ Commander.prototype.executeNextCommand = function() {
 						}
 					});
 					err = c.execute();
-					if(err) {
+					if(err && typeof err.then === "function") {
+						err.then(e => { if(e) this.callback(e); });
+					} else if(err) {
 						this.callback(err);
 					}
 				}

core/modules/commands/savewikifolder.js → core-server/commands/savewikifolder.js

@@ -76,6 +76,7 @@ WikiFolderMaker.prototype.tiddlersToIgnore = [
 	"$:/boot/boot.js",
 	"$:/boot/bootprefix.js",
 	"$:/core",
+	"$:/core-server",
 	"$:/library/sjcl.js",
 	"$:/temp/info-plugin"
 ];

core-server/plugin.info

@@ -0,0 +1,11 @@
+{
+	"title": "$:/core-server",
+	"name": "Core Server Components",
+	"description": "TiddlyWiki5 core server components",
+	"author": "JeremyRuston",
+	"core-version": ">=5.0.0",
+	"platform": "server",
+	"plugin-priority": "0",
+	"list": "readme",
+	"stability": "STABILITY_2_STABLE"
+}

core-server/readme.tid

@@ -0,0 +1,7 @@
+title: $:/core-server/readme
+
+This plugin contains TiddlyWiki's core components that are only needed on the server, comprising:
+
+* Commands
+* HTTP server code
+* Utility functions for server

core/modules/server/routes/delete-tiddler.js → core-server/server/routes/delete-tiddler.js

@@ -8,10 +8,14 @@ DELETE /recipes/default/tiddlers/:title
 \*/
 "use strict";
 
-exports.method = "DELETE";
+exports.methods = ["DELETE"];
 
 exports.path = /^\/bags\/default\/tiddlers\/(.+)$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var title = $tw.utils.decodeURIComponentSafe(state.params[0]);
 	state.wiki.deleteTiddler(title);

core/modules/server/routes/get-favicon.js → core-server/server/routes/get-favicon.js

@@ -8,10 +8,14 @@ GET /favicon.ico
 \*/
 "use strict";
 
-exports.method = "GET";
+exports.methods = ["GET"];
 
 exports.path = /^\/favicon.ico$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var buffer = state.wiki.getTiddlerText("$:/favicon.ico","");
 	state.sendResponse(200,{"Content-Type": "image/x-icon"},buffer,"base64");

core/modules/server/routes/get-file.js → core-server/server/routes/get-file.js

@@ -8,10 +8,14 @@ GET /files/:filepath
 \*/
 "use strict";
 
-exports.method = "GET";
+exports.methods = ["GET"];
 
 exports.path = /^\/files\/(.+)$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var path = require("path"),
 		fs = require("fs"),

core/modules/server/routes/get-index.js → core-server/server/routes/get-index.js

@@ -8,10 +8,14 @@ GET /
 \*/
 "use strict";
 
-exports.method = "GET";
+exports.methods = ["GET"];
 
 exports.path = /^\/$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var text = state.wiki.renderTiddler(state.server.get("root-render-type"),state.server.get("root-tiddler")),
 		responseHeaders = {

core/modules/server/routes/get-login-basic.js → core-server/server/routes/get-login-basic.js

@@ -8,10 +8,14 @@ GET /login-basic -- force a Basic Authentication challenge
 \*/
 "use strict";
 
-exports.method = "GET";
+exports.methods = ["GET"];
 
 exports.path = /^\/login-basic$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	if(!state.authenticatedUsername) {
 		// Challenge if there's no username

core/modules/server/routes/get-status.js → core-server/server/routes/get-status.js

@@ -8,10 +8,14 @@ GET /status
 \*/
 "use strict";
 
-exports.method = "GET";
+exports.methods = ["GET"];
 
 exports.path = /^\/status$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var text = JSON.stringify({
 		username: state.authenticatedUsername || state.server.get("anon-username") || "",

core/modules/server/routes/get-tiddler-html.js → core-server/server/routes/get-tiddler-html.js

@@ -8,10 +8,14 @@ GET /:title
 \*/
 "use strict";
 
-exports.method = "GET";
+exports.methods = ["GET"];
 
 exports.path = /^\/([^\/]+)$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var title = $tw.utils.decodeURIComponentSafe(state.params[0]),
 		tiddler = state.wiki.getTiddler(title);

core/modules/server/routes/get-tiddler.js → core-server/server/routes/get-tiddler.js

@@ -8,10 +8,14 @@ GET /recipes/default/tiddlers/:title
 \*/
 "use strict";
 
-exports.method = "GET";
+exports.methods = ["GET"];
 
 exports.path = /^\/recipes\/default\/tiddlers\/(.+)$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var title = $tw.utils.decodeURIComponentSafe(state.params[0]),
 		tiddler = state.wiki.getTiddler(title),

core/modules/server/routes/get-tiddlers-json.js → core-server/server/routes/get-tiddlers-json.js

@@ -10,10 +10,14 @@ GET /recipes/default/tiddlers.json?filter=<filter>
 
 var DEFAULT_FILTER = "[all[tiddlers]!is[system]sort[title]]";
 
-exports.method = "GET";
+exports.methods = ["GET"];
 
 exports.path = /^\/recipes\/default\/tiddlers.json$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var filter = state.queryParameters.filter || DEFAULT_FILTER;
 	if(state.wiki.getTiddlerText("$:/config/Server/AllowAllExternalFilters") !== "yes") {

core/modules/server/routes/put-tiddler.js → core-server/server/routes/put-tiddler.js

@@ -8,10 +8,14 @@ PUT /recipes/default/tiddlers/:title
 \*/
 "use strict";
 
-exports.method = "PUT";
+exports.methods = ["PUT"];
 
 exports.path = /^\/recipes\/default\/tiddlers\/(.+)$/;
 
+exports.info = {
+	priority: 100
+};
+
 exports.handler = function(request,response,state) {
 	var title = $tw.utils.decodeURIComponentSafe(state.params[0]),
 	fields = $tw.utils.parseJSONSafe(state.data);

core/modules/server/server.js → core-server/server/server.js

@@ -74,6 +74,11 @@ function Server(options) {
 		// console.log("Loading server route " + title);
 		self.addRoute(routeDefinition);
 	});
+	this.routes.sort((a, b) => {
+		const priorityA = a.info?.priority ?? 100,
+			priorityB = b.info?.priority ?? 100;
+		return priorityB - priorityA;
+	});
 	// Initialise the http vs https
 	this.listenOptions = null;
 	this.protocol = "http";
@@ -217,7 +222,7 @@ Server.prototype.findMatchingRoute = function(request,state) {
 		} else {
 			match = potentialRoute.path.exec(pathname);
 		}
-		if(match && request.method === potentialRoute.method) {
+		if(match && (potentialRoute.methods?.includes(request.method) || potentialRoute.method === request.method)) {
 			state.params = [];
 			for(var p=1; p<match.length; p++) {
 				state.params.push(match[p]);