@tiddlywiki/mws 0.0.15 → 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`
-- `npm install`
+- `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,12 +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';
 
@@ -226,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;
@@ -266,6 +268,8 @@ Parse a sequence of commands
 */
 declare class Commander extends StartupCommander {
     constructor(config: MWSConfig, $tw: TW, PasswordService: PasswordService);
+    program: commander.Command;
+    init(): Promise<void>;
     create_mws_listen: (params: string[]) => Command;
     /**
      * The promise of the current execution.
@@ -283,6 +287,8 @@ declare class Commander extends StartupCommander {
     static initCommands(moduleType?: string): void;
     addCommandTokens(params: string[]): void;
     execute(commandTokens: string[]): Promise<void>;
+    executeInternal(commandTokens: string[]): Promise<void>;
+    setPromise(): void;
     executeNextCommand(): void;
     extractNamedParameters(params: string[], mandatoryParameters?: string[]): any;
 }
@@ -293,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;
@@ -331,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>;
@@ -779,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>;
@@ -885,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;
 }