@tiddlywiki/mws 0.0.16 → 0.0.17

package/README.md

@@ -1,8 +1,22 @@
 # MultiWikiServer
 
-MultiWikiServer for TiddlyWiki.
+Multiple users, multiple wikis for TiddlyWiki.
 
-### How to run
+- Bag & Recipe system for storing tiddlers.
+- User and Role management with ACL.
+- Multiple database engines supported, using Prisma.
+- Third-party OAuth and password-based login.
+
+## Flexible and Extendible 
+
+- Plugins can add routes and hooks.
+- Abstractions everywhere, allowing flexibility.
+- The source code is fully typed and easy to navigate.
+- Admin endpoints can also be called from the CLI.
+
+Most of these features are still in development. 
+
+## How to run
 
 The init command creates a new folder and installs what you need to get started. 
 
@@ -36,42 +50,15 @@ If there are any database changes, MWS should pick them up and apply them. The c
 If you want to work on the project, 
 
 - `git clone https://github.com/TiddlyWiki/MultiWikiServer`
+- `cd MultiWikiServer`
 - `npm install` or `npm run install-android`
 - `cd react-user-mgmt`
 - `npm install`
 - `cd ..`
-- `npm run certs` - if you want https
+- `npm run certs` - if you want https (unix only)
 - `npm start` - this runs the build and test every time, but it's pretty fast
 
-You can change the listeners as explained in the mws.dev.mjs file.
-
-### The Server
-
-- Supports HTTP and HTTPS listeners. All requests are funneled into one stack.
-- Uses abstractions and state objects to make the server as flexible as possible.
-- Supports overriding classes to implement custom handling of various features.
-- All of the features from the old MWS branch have been converted to the new system.
-
-### The Store
-
-- Written using Prisma and entirely promise-based.
-- Swapping to a different database engine should be a breeze. For sqlite it uses the libsql adapter, which also allows connections to libsql servers.
-- The tiddler text attachment system, which stores some tiddler bodies on the file system, is promise-based and can be modified to store files in the cloud.
-
-### The Features
-
-- Bag & Recipe system for storing tiddlers.
-- User and Role management with ACL.
-- Attachment system for storing binary tiddlers on the file system.
-- Various import and export commands (currently still in development).
-- Customization of these features should be quite easy as they are fairly self-contained. The TypeScript code is fully typed and easy to navigate.
-
-### Planned (hopefully) for the future
-
-- AuthJS or a similar integration that supports third-party OAuth (you can already write your own).
-- Compiling filters to SQL to optimize memory on both the client and server.
-- Support for other database and storage systems. Most likely MariaDB and Postgres.
-- Additional recipe strategies with features like prefixed bags and namespaces.
-- Server rendering of pages, for a more wikipedia-like experience.
+The development wiki will be active at http://localhost:8080/dev
 
+You can change the listeners as explained in the mws.dev.mjs file.
 

package/dist/server.d.ts

@@ -5,13 +5,13 @@ import { PassThrough, Writable } from 'node:stream';
 import * as z from 'zod';
 import { z as z$1, ZodEffects } from 'zod';
 import { PrismaClient, Prisma } from '@prisma/client';
-import { ITXClientDenyList, Types } from '@prisma/client/runtime/library';
 import * as fs from 'fs';
 import * as tiddlywiki from 'tiddlywiki';
-import { TW } from 'tiddlywiki';
-import * as http2 from 'node:http2';
+import { TW, TiddlerFieldModule } from 'tiddlywiki';
+import { ITXClientDenyList, Types } from '@prisma/client/runtime/library';
 import * as commander from 'commander';
 import { SqlMigrationAwareDriverAdapterFactory, SqlDriverAdapter } from '@prisma/driver-adapter-utils';
+import * as http2 from 'node:http2';
 import * as http2$1 from 'http2';
 import { OutgoingHttpHeaders, IncomingHttpHeaders as IncomingHttpHeaders$1, IncomingMessage as IncomingMessage$1, ServerResponse as ServerResponse$1 } from 'node:http';
 
@@ -227,6 +227,7 @@ declare class StartupCommander {
     config: MWSConfig;
     $tw: TW;
     PasswordService: PasswordService;
+    fieldModules: Record<string, TiddlerFieldModule>;
     constructor(config: MWSConfig, $tw: TW, PasswordService: PasswordService);
     init(): Promise<void>;
     wikiPath: string;
@@ -298,7 +299,7 @@ declare class StateObject<B extends BodyFormat = BodyFormat, M extends AllowedMe
     /** The bodyformat that ended up taking precedence. This should be correctly typed. */
     bodyFormat: B;
     user: AuthUser;
-    commander: Commander;
+    router: Router;
     tiddlerCache: Router["tiddlerCache"];
     z: typeof z;
     STREAM_ENDED: typeof STREAM_ENDED;
@@ -336,7 +337,7 @@ declare class StateObject<B extends BodyFormat = BodyFormat, M extends AllowedMe
     /** The array of Route tree nodes the request matched. */
     routePath: RouteMatch[], 
     /** The bodyformat that ended up taking precedence. This should be correctly typed. */
-    bodyFormat: B, user: AuthUser, commander: Commander, tiddlerCache: Router["tiddlerCache"]);
+    bodyFormat: B, user: AuthUser, router: Router, tiddlerCache: Router["tiddlerCache"]);
     okUser(): void;
     okAdmin(): void;
     $transaction: <T>(fn: (prisma: PrismaTxnClient) => Promise<T>) => Promise<T>;
@@ -784,15 +785,18 @@ declare const BodyFormats: readonly ["stream", "string", "json", "buffer", "www-
 type BodyFormat = typeof BodyFormats[number];
 declare class Router {
     private rootRoute;
-    private commander;
     private tiddlerCache;
     static makeRouter(commander: Commander, enableDevServer: boolean): Promise<Router>;
-    pathPrefix: string;
     enableBrowserCache: boolean;
     enableGzip: boolean;
     csrfDisable: boolean;
+    siteConfig: SiteConfig;
+    get pathPrefix(): string;
     engine: Commander["engine"];
     private SessionManager;
+    PasswordService: Commander["PasswordService"];
+    fieldModules: Commander["$tw"]["Tiddler"]["fieldModules"];
+    AttachmentService: Commander["AttachmentService"];
     constructor(rootRoute: rootRoute$1, commander: Commander, tiddlerCache: CacheState);
     handleIncomingRequest(req: http.IncomingMessage | http2$1.Http2ServerRequest, res: http.ServerResponse | http2$1.Http2ServerResponse): void;
     handle(streamer: Streamer): Promise<void | typeof STREAM_ENDED>;
@@ -890,8 +894,10 @@ interface SiteConfig extends MWSConfigConfig {
     storePath: string;
     /**
      * The path prefix is a essentially folder mount point.
-     * It starts with a slash, and ends without a slash.
-     * If there is not a prefix, it is an empty string.
+     *
+     * It starts with a slash, and ends without a slash (`"/dev"`).
+     *
+     * If there is not a prefix, it is an empty string (`""`).
      */
     pathPrefix: string;
 }

package/dist/server.js

@@ -11660,7 +11660,7 @@ var init_data_checks = __esm({
           // allow unowned for any user (conditional for anon reads)
           (user_id || allowAnon) && { acl: { none: {} }, owner_id: null },
           // allow owner for user 
-          user_id && { owner_id: user_id },
+          user_id && { owner_id: { equals: user_id, not: null } },
           // allow acl for user 
           user_id && role_ids?.length && {
             acl: {
@@ -12154,12 +12154,12 @@ var init_StateObject = __esm({
     init_streamer();
     init_utils2();
     _StateObject = class _StateObject extends StreamerState {
-      constructor(streamer, routePath, bodyFormat, user, commander2, tiddlerCache) {
+      constructor(streamer, routePath, bodyFormat, user, router, tiddlerCache) {
         super(streamer);
         this.routePath = routePath;
         this.bodyFormat = bodyFormat;
         this.user = user;
-        this.commander = commander2;
+        this.router = router;
         this.tiddlerCache = tiddlerCache;
         this.z = z3;
         this.STREAM_ENDED = STREAM_ENDED;
@@ -12170,9 +12170,9 @@ var init_StateObject = __esm({
         this.$transaction = /* @__PURE__ */ __name(async (fn) => {
           return await this.engine.$transaction((prisma) => fn(prisma));
         }, "$transaction");
-        this.engine = commander2.engine;
-        this.config = commander2.siteConfig;
-        this.PasswordService = commander2.PasswordService;
+        this.engine = router.engine;
+        this.config = router.siteConfig;
+        this.PasswordService = router.PasswordService;
         this.readMultipartData = readMultipartData.bind(this);
         this.sendResponse = sendResponse.bind(void 0, this.config, this);
         this.pathParams = Object.fromEntries(routePath.map(
@@ -12222,7 +12222,7 @@ var init_StateObject = __esm({
        * - **308 Permanent Redirect:** The resource has permanently moved; the client should use the new URL in future requests.
        */
       redirect(location, pushLocation) {
-        return this.sendEmpty(302, { "Location": location });
+        return this.sendEmpty(302, { "Location": this.config.pathPrefix + location });
       }
       sendSSE(retryMilliseconds) {
         if (retryMilliseconds !== void 0) {
@@ -12414,7 +12414,12 @@ var init_manager_recipes = __esm({
                 }
               }
             },
-            where: isAdmin ? void 0 : { recipe_bags: { every: { bag: { OR } } } }
+            where: isAdmin ? void 0 : {
+              OR: [
+                { recipe_bags: { every: { bag: { OR } } } },
+                { owner_id: { equals: user_id, not: null } }
+              ]
+            }
           });
           const userListUser = !isAdmin && await prisma.users.findMany({
             select: { user_id: true, username: true }
@@ -12601,7 +12606,7 @@ var init_manager_recipes = __esm({
         const existing = await prisma.recipes.findUnique({ where: { recipe_name } });
         this.assertCreateOrUpdate({ user, type: "recipe", isCreate, owner_id, existing });
         const { isAdmin, user_id } = user;
-        const OR = this.checks.getWhereACL({ permission: "ADMIN", user_id });
+        const OR = isAdmin ? void 0 : this.checks.getWhereACL({ permission: "ADMIN", user_id });
         const bags = new Map(
           await prisma.bags.findMany({
             where: { bag_name: { in: bag_names.map((e) => e.bag_name) } }
@@ -12609,14 +12614,12 @@ var init_manager_recipes = __esm({
         );
         const missing = bag_names.filter((e) => !bags.has(e.bag_name));
         if (missing.length) throw "Some bags not found: " + JSON.stringify(missing);
-        const bagsAcl = new Map(
-          await prisma.bags.findMany({
-            where: { bag_name: { in: bag_names.map((e) => e.bag_name) }, OR }
-          }).then((bags2) => bags2.map((bag) => [bag.bag_name, bag]))
-        );
+        const bagsAcl = new Map((await prisma.bags.findMany({
+          where: { bag_name: { in: bag_names.map((e) => e.bag_name) }, OR }
+        })).map((bag) => [bag.bag_name, bag]));
         const createBags = bag_names.map((bag, position) => ({
           bag_id: bags.get(bag.bag_name).bag_id,
-          with_acl: bagsAcl && bagsAcl.has(bag.bag_name) && bag.with_acl,
+          with_acl: bagsAcl.has(bag.bag_name) && bag.with_acl,
           position
         }));
         if (existing) {
@@ -12914,13 +12917,20 @@ var init_TiddlerStore = __esm({
     init_esm_shims();
     init_utils2();
     _TiddlerStore = class _TiddlerStore {
-      constructor(commander2, prisma) {
-        this.commander = commander2;
+      constructor(fieldModules, attachService, siteConfig, prisma) {
+        this.fieldModules = fieldModules;
+        this.attachService = attachService;
+        this.siteConfig = siteConfig;
         this.prisma = prisma;
-        this.fieldModules = this.commander.$tw.Tiddler.fieldModules;
-        this.attachService = new commander2.AttachmentService(commander2.siteConfig, prisma);
-        this.storePath = commander2.siteConfig.storePath;
-        this.config = commander2.siteConfig;
+        this.storePath = this.siteConfig.storePath;
+      }
+      static fromCommander(commander2, prisma) {
+        return new _TiddlerStore(
+          commander2.$tw.Tiddler.fieldModules,
+          new commander2.AttachmentService(commander2.siteConfig, prisma),
+          commander2.siteConfig,
+          prisma
+        );
       }
       /*
       Returns null if a bag/recipe name is valid, or a string error message if not
@@ -13170,7 +13180,7 @@ var init_TiddlerStore = __esm({
           const stream = new Readable();
           stream._read = () => {
             const type = tiddlerInfo.tiddler.type || "text/plain";
-            stream.push(tiddlerInfo.tiddler.text || "", (this.config.contentTypeInfo[type] || { encoding: "utf8" }).encoding);
+            stream.push(tiddlerInfo.tiddler.text || "", (this.siteConfig.contentTypeInfo[type] || { encoding: "utf8" }).encoding);
             stream.push(null);
           };
           return {
@@ -14093,7 +14103,13 @@ var init_bag_file_server = __esm({
     import_sjcl = __toESM(require_sjcl(), 1);
     _TiddlerServer = class _TiddlerServer extends TiddlerStore {
       constructor(state, prisma) {
-        super(state.commander, prisma);
+        const router = state.router;
+        super(
+          router.fieldModules,
+          new router.AttachmentService(router.siteConfig, prisma),
+          router.siteConfig,
+          prisma
+        );
         this.state = state;
       }
       toTiddlyWebJson(info12) {
@@ -14611,6 +14627,62 @@ var init_router_tiddlers = __esm({
   }
 });
 
+// src/routes/tw-test.ts
+import { TiddlyWiki } from "tiddlywiki";
+function DocsRoute(parent, config) {
+  const wikiRouter = new TWRouter(config);
+  parent.defineRoute({
+    method: ["OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE"],
+    bodyFormat: "stream",
+    path: /^\/mws(\/|$)/,
+    pathParams: []
+  }, async (state) => {
+    if (state.urlInfo.pathname === "/mws") throw state.redirect("/mws/");
+    const { req, res } = state.streamer;
+    if (req.url === "/mws") req.url = "/mws/";
+    wikiRouter.twserver.requestHandler(req, res, {});
+    return new Promise((r, c) => res.on("finish", r).on("error", c));
+  });
+}
+var _TWRouter, TWRouter;
+var init_tw_test = __esm({
+  "src/routes/tw-test.ts"() {
+    "use strict";
+    init_esm_shims();
+    __name(DocsRoute, "DocsRoute");
+    _TWRouter = class _TWRouter {
+      constructor(config) {
+        this.config = config;
+        this.$tw = TiddlyWiki();
+        this.$tw.boot.argv = [
+          "+plugins/tiddlywiki/tiddlyweb",
+          "+plugins/tiddlywiki/filesystem",
+          "./editions/mws-docs"
+        ];
+        this.$tw.preloadTiddler({
+          text: "$protocol$//$host$" + this.config.pathPrefix + "/mws/",
+          title: "$:/config/tiddlyweb/host"
+        });
+        this.$tw.boot.boot(() => {
+          const Server2 = this.$tw.modules.execute("$:/core/modules/server/server.js", "tw-test.ts").Server;
+          this.twserver = new Server2({
+            wiki: this.$tw.wiki,
+            variables: {
+              // do not use a trailing slash
+              "path-prefix": this.config.pathPrefix + "/mws",
+              "root-tiddler": "$:/core/save/all"
+            },
+            routes: []
+          });
+          this.$tw.hooks.invokeHook("th-server-command-post-start", this.twserver, null, "mws");
+        });
+      }
+    };
+    __name(_TWRouter, "TWRouter");
+    TWRouter = _TWRouter;
+  }
+});
+
 // import("./**/*/**/*") in src/routes/index.ts
 var globImport;
 var init_ = __esm({
@@ -14627,9 +14699,10 @@ var init_ = __esm({
 // src/routes/index.ts
 import { Prisma } from "@prisma/client";
 async function RootRoute(root, config) {
+  if (process.env.ENABLE_DOCS_ROUTE) DocsRoute(root, config);
   TiddlerRouter.defineRoutes(root);
   ManagerRoutes(root, config);
-  if (typeof ENABLE_UNSAFE_PRISMA_ROUTE !== "undefined")
+  if (process.env.ENABLE_UNSAFE_PRISMA_ROUTE)
     root.defineRoute({
       method: ["POST"],
       path: /^\/prisma$/,
@@ -14686,6 +14759,7 @@ var init_routes = __esm({
     init_utils2();
     init_managers();
     init_router_tiddlers();
+    init_tw_test();
     init_();
     __name(RootRoute, "RootRoute");
     __name(importEsbuild, "importEsbuild");
@@ -14960,15 +15034,16 @@ var init_router = __esm({
     _Router = class _Router {
       constructor(rootRoute2, commander2, tiddlerCache) {
         this.rootRoute = rootRoute2;
-        this.commander = commander2;
         this.tiddlerCache = tiddlerCache;
-        this.pathPrefix = "";
         this.enableBrowserCache = true;
         this.enableGzip = false;
         this.csrfDisable = false;
         this.engine = commander2.engine;
         this.SessionManager = commander2.SessionManager;
-        this.pathPrefix = commander2.siteConfig.pathPrefix;
+        this.siteConfig = commander2.siteConfig;
+        this.PasswordService = commander2.PasswordService;
+        this.fieldModules = commander2.$tw.Tiddler.fieldModules;
+        this.AttachmentService = commander2.AttachmentService;
       }
       static async makeRouter(commander2, enableDevServer) {
         const sendDevServer = await setupDevServer(enableDevServer, commander2.siteConfig.pathPrefix);
@@ -14984,6 +15059,9 @@ var init_router = __esm({
         const cache = await startupCache(commander2);
         return new _Router(rootRoute2, commander2, cache);
       }
+      get pathPrefix() {
+        return this.siteConfig.pathPrefix;
+      }
       handleIncomingRequest(req, res) {
         const [ok8, err, streamer] = function() {
           try {
@@ -15019,7 +15097,7 @@ var init_router = __esm({
             routePath,
             bodyFormat,
             authUser,
-            this.commander,
+            this,
             this.tiddlerCache
           )
         );
@@ -15162,10 +15240,10 @@ var init_router = __esm({
 });
 
 // src/tiddlywiki.ts
-import { TiddlyWiki } from "tiddlywiki";
+import { TiddlyWiki as TiddlyWiki2 } from "tiddlywiki";
 import { ok as ok5 } from "node:assert";
 async function bootTiddlyWiki(wikiPath) {
-  const $tw2 = TiddlyWiki();
+  const $tw2 = TiddlyWiki2();
   $tw2.utils.eachAsync = eachAsync;
   $tw2.boot.boot = async (callback) => {
     $tw2.crypto = new $tw2.utils.Crypto();
@@ -15197,22 +15275,14 @@ async function bootTiddlyWiki(wikiPath) {
     startup: /* @__PURE__ */ __name(() => {
     }, "startup")
   });
-  $tw2.preloadTiddler({ title: "$:/plugins/tiddlywiki/multiwikiserver/startup.js" });
-  $tw2.modules.define("$:/plugins/tiddlywiki/multiwikiserver/startup.js", "startup", {
-    name: "multiwikiserver",
-    platforms: ["node"],
-    after: ["load-modules"],
-    before: ["story", "commands"],
-    synchronous: true,
-    startup: /* @__PURE__ */ __name(() => {
-    }, "startup")
-  });
   $tw2.boot.argv = [
     "++" + dist_resolve("../plugins/client"),
     "+plugins/tiddlywiki/tiddlyweb",
+    // these are sane defaults, these should be in the recipe
     "+themes/tiddlywiki/vanilla",
     "+themes/tiddlywiki/snowwhite",
     wikiPath
+    // this should be inert
   ];
   await new Promise((resolve13) => $tw2.boot.boot(resolve13));
   ok5(!$tw2.boot.tasks.readBrowserTiddlers);
@@ -19004,7 +19074,7 @@ var init_load_plugin_bags = __esm({
         console.time(`${info.name} complete`);
         await loadPluginBags(
           this.$tw,
-          new TiddlerStore(this.commander, this.commander.engine),
+          TiddlerStore.fromCommander(this.commander, this.commander.engine),
           this.commander.engine
         );
         console.timeEnd(`${info.name} complete`);
@@ -19160,7 +19230,7 @@ var init_load_wiki_folder = __esm({
           bagDescription: this.params[2],
           recipeName: this.params[3],
           recipeDescription: this.params[4],
-          store: new TiddlerStore(this.commander, this.commander.engine),
+          store: TiddlerStore.fromCommander(this.commander, this.commander.engine),
           $tw: this.commander.$tw
         }));
         console.log(info3.name, "complete:", this.params[0]);
@@ -19213,7 +19283,7 @@ var init_save_archive = __esm({
       async execute() {
         if (this.params.length < 1) throw "Missing pathname";
         await this.commander.$transaction(async (prisma) => {
-          this.store = new TiddlerStore(this.commander, prisma);
+          this.store = TiddlerStore.fromCommander(this.commander, prisma);
           await this.saveArchive();
           this.store = void 0;
         });
@@ -20012,6 +20082,7 @@ var init_commander = __esm({
         this.PasswordService = PasswordService;
         /** Signals that database setup is required. May be set to false by any qualified setup command. */
         this.setupRequired = true;
+        this.fieldModules = $tw2.Tiddler.fieldModules;
         if (config.config?.pathPrefix) {
           ok7(config.config.pathPrefix.startsWith("/"), "pathPrefix must start with a slash");
           ok7(!config.config.pathPrefix.endsWith("/"), "pathPrefix must not end with a slash");
@@ -20067,7 +20138,6 @@ var init_commander = __esm({
         config.listeners = [];
         config.onListenersCreated = void 0;
         this.create_mws_listen = (params) => {
-          console.log(listeners);
           return new listen_exports.Command(params, this, listeners, onListenersCreated);
         };
       }
@@ -20168,7 +20238,6 @@ var init_commander = __esm({
           this.callback(params);
           return;
         }
-        console.log(params);
         new Promise(async (resolve13) => {
           const { Command: Command13, info: info12 } = command;
           try {