tw5-typed 0.2.0 → 0.2.3

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.2.0",
+  "version": "0.2.3",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -20,17 +20,17 @@
     "prepublishOnly": "npx tsc --noEmit"
   },
   "devDependencies": {
-    "@types/node": "^17.0.23",
-    "@typescript-eslint/eslint-plugin": "5.17.0",
-    "@typescript-eslint/parser": "5.17.0",
-    "eslint": "8.12.0",
+    "@types/node": "^17.0.24",
+    "@typescript-eslint/eslint-plugin": "5.19.0",
+    "@typescript-eslint/parser": "5.19.0",
+    "eslint": "8.13.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard": "16.0.3",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-import-resolver-alias": "1.1.2",
-    "eslint-import-resolver-typescript": "2.7.0",
+    "eslint-import-resolver-typescript": "2.7.1",
     "eslint-plugin-html": "6.2.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-n": "15.1.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-prettier": "4.0.0",
@@ -41,7 +41,7 @@
     "eslint-plugin-security-node": "1.1.1",
     "eslint-plugin-typescript-sort-keys": "2.1.0",
     "eslint-plugin-unicorn": "42.0.0",
-    "prettier": "2.6.1",
+    "prettier": "2.6.2",
     "typescript": "4.6.3"
   }
 }

package/src/Tiddler.d.ts

@@ -1,6 +1,10 @@
 declare module 'tiddlywiki' {
   export class Tiddler {
-    constructor(...fields: Array<Record<string, unknown> | Tiddler>);
+    /**
+     *
+     * @param tiddlers multiple tiddler fields or instances, will merge them to create a new one
+     */
+    constructor(...tiddlers: Array<Record<string, unknown> | Tiddler>);
     readonly cache: ITiddlerCache;
     readonly fields: ITiddlerFields;
     static fieldModules: Record<string, IModuleInfo>;
@@ -10,9 +14,9 @@ declare module 'tiddlywiki' {
 
   export interface ITiddlerFields {
     readonly [anyKey: string]: unknown;
-    readonly color: string;
+    readonly color?: string;
     readonly created: Date;
-    readonly list: string[];
+    readonly list?: string[];
     readonly modified: Date;
     readonly tags: string[];
     readonly text: string;

package/src/Wiki.d.ts

@@ -1,6 +1,11 @@
 /// <reference path="parser.d.ts" />
 
 declare module 'tiddlywiki' {
+  export interface IMakeWidgetOptions {
+    document: typeof document | IFakeDocument;
+    parentWidget?: Widget;
+    variables?: Record<string, any>;
+  }
   export class Wiki {
     /**
      * Wiki constructor. State is stored in private members that only a small number of privileged accessor methods have direct access. Methods added via the prototype have to use these accessors and cannot access the state data directly.
@@ -10,7 +15,7 @@ declare module 'tiddlywiki' {
      */
     constructor(options: { enableIndexers: unknown[] });
     addIndexer(indexer: unknown, name: string): void;
-    getTiddler: (title: string) => Tiddler | undefined;
+    getTiddler: <T extends Tiddler>(title: string) => T | undefined;
     /**
      * Get full list of tiddler titles in the wiki
      */
@@ -22,17 +27,18 @@ declare module 'tiddlywiki' {
     compileFilter: (filterString: string) => (iterator?: SourceIterator) => string[];
     /**
      * Set JSON tiddler, Object in data field will be JSON.stringify and put into the text.
+     * This will make tiddler to be JSON data tiddler `"type":"application/json"`, so if you just want to modify existed tiddler's data, use `addTiddler` instead.
      */
     setTiddlerData: (title: string, data?: object, fields?: ITiddlerFields, options?: any) => void;
     /**
      * Create or update tiddler.
      * Update existed tiddler based on the title field.
      */
-    addTiddler: (tiddler: Tiddler | ITiddlerFields) => void;
+    addTiddler: (tiddler: Tiddler | Partial<ITiddlerFields>) => void;
     /**
-     * Call `addTiddler` for each iton of the list
+     * Call `addTiddler` for each iton of the list, but should passing `tiddler.fields`, directly passing tiddler object may failed to add in some cases.
      */
-    addTiddlers: (tiddler: Array<Tiddler | ITiddlerFields>) => void;
+    addTiddlers: (tiddler: Array<Partial<ITiddlerFields>>) => void;
     /**
      * Get tiddler's text field, with an optional default text.
      * If have _is_skinny field, will just return null (this is a rare case, so not put in the return type for now).
@@ -42,6 +48,36 @@ declare module 'tiddlywiki' {
      */
     getTiddlerText(title: string, fallbackText: string): string;
     getTiddlerText(title: string, fallbackText?: string): string | undefined;
+    /**
+      Get the content of a tiddler as a JavaScript object. How this is done depends on the type of the tiddler:
+
+      application/json: the tiddler JSON is parsed into an object
+      application/x-tiddler-dictionary: the tiddler is parsed as sequence of name:value pairs
+
+      Other types currently just return undefined or as same as fallbackData.
+
+      titleOrTiddler: string tiddler title or a tiddler object
+      defaultData: default data to be returned if the tiddler is missing or doesn't contain data
+
+      Alternative, uncached version of getTiddlerDataCached(). The return value can be mutated freely and reused
+    */
+    getTiddlerData<D extends Record<string, unknown> | undefined>(titleOrTiddler: string, fallbackData?: D): D;
+    getTiddlerData<D extends Record<string, unknown> | undefined>(titleOrTiddler: Tiddler, fallbackData?: D): D;
+    /**
+      Get the content of a tiddler as a JavaScript object. How this is done depends on the type of the tiddler:
+
+      application/json: the tiddler JSON is parsed into an object
+      application/x-tiddler-dictionary: the tiddler is parsed as sequence of name:value pairs
+
+      Other types currently just return undefined or as same as fallbackData.
+
+      titleOrTiddler: string tiddler title or a tiddler object
+      defaultData: default data to be returned if the tiddler is missing or doesn't contain data
+
+      Note that the same value is returned for repeated calls for the same tiddler data. The value is frozen to prevent modification; otherwise modifications would be visible to all callers
+    */
+    getTiddlerDataCached<D extends Record<string, unknown> | undefined>(titleOrTiddler: string, fallbackData?: D): D;
+    getTiddlerDataCached<D extends Record<string, unknown> | undefined>(titleOrTiddler: Tiddler, fallbackData?: D): D;
     /**
      * Set tiddler text of any field.
      *
@@ -54,5 +90,58 @@ declare module 'tiddlywiki' {
     setText: (title: string, field?: string, index?: string | undefined, value?: string, options?: any) => void;
     parseTiddler(title: string, options?: IParserOptions): WikiParser;
     parseText(type: string, text: string, options?: IParserOptions): WikiParser;
+    /**
+      Parse text from a tiddler and render it into another format
+        outputType: content type for the output
+        title: title of the tiddler to be rendered
+        options: see below
+      Options include:
+      variables: hashmap of variables to set
+      parentWidget: optional parent widget for the root node
+      */
+    renderTiddler(
+      outputType: 'text/html' | 'text/plain-formatted' | 'text/plain',
+      title: string,
+      options?: { parentWidget?: Widget; variables?: Record<string, any> },
+    ): string;
+    /**
+      Make a widget tree for a parse tree
+      @params parser: parser object
+      @params options: see below
+      Options include:
+      document: optional document to use
+      variables: hashmap of variables to set
+      parentWidget: optional parent widget for the root node
+    */
+    makeWidget(parser: WikiParser, options?: IMakeWidgetOptions): Widget;
+    /**
+      Make a widget tree for transclusion
+      @params title: target tiddler title
+      @params options: as for wiki.makeWidget() plus:
+
+      - options.field: optional field to transclude (defaults to "text")
+      - options.mode: transclusion mode "inline" or "block"
+      - options.recursionMarker : optional flag to set a recursion marker, defaults to "yes"
+      - options.children: optional array of children for the transclude widget
+      - options.importVariables: optional importvariables filter string for macros to be included
+      - options.importPageMacros: optional boolean; if true, equivalent to passing "[[$:/core/ui/PageMacros]] [all[shadows+tiddlers]tag[$:/tags/Macro]!has[draft.of]]" to options.importVariables
+      */
+    makeTranscludeWidget(
+      title: string,
+      options: {
+        /**  optional array of children for the transclude widget */
+        children?: Widget[];
+        /** optional field to transclude (defaults to "text") */
+        field?: string;
+        /**  optional boolean; if true, equivalent to passing "[[$:/core/ui/PageMacros]] [all[shadows+tiddlers]tag[$:/tags/Macro]!has[draft.of]]" to options.importVariables */
+        importPageMacros?: boolean;
+        /**  optional importvariables filter string for macros to be included */
+        importVariables?: string;
+        /**  transclusion mode "inline" or "block" */
+        mode?: 'inline' | 'block';
+        /**  optional flag to set a recursion marker, defaults to "yes" */
+        recursionMarker?: 'yes' | 'no';
+      } & IMakeWidgetOptions,
+    ): Widget;
   }
 }

package/src/server.d.ts

@@ -13,14 +13,91 @@ declare module 'tiddlywiki' {
     username: string;
   }
 
+  export interface IRoute {
+    handler: ServerEndpointHandler;
+    method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'OPTIONS' | 'HEAD';
+    path: RegExp;
+  }
+
+  export interface IServerOptions {
+    routes: IRoute[];
+    variables?: { [key: string]: string };
+    wiki: Wiki;
+  }
+
+  /**
+    A simple HTTP server with regexp-based routes
+
+    options: variables - optional hashmap of variables to set (a misnomer - they are really constant parameters)
+        routes - optional array of routes to use
+        wiki - reference to wiki object
+  */
+  export class Server {
+    constructor(options: IServerOptions);
+    routes: IRoute[];
+    addRoute(route: IRoute): void;
+    /**
+     * ```json
+     * {
+          port: "8080",
+          host: "127.0.0.1",
+          "required-plugins": "$:/plugins/tiddlywiki/filesystem,$:/plugins/tiddlywiki/tiddlyweb",
+          "root-tiddler": "$:/core/save/all",
+          "root-render-type": "text/plain",
+          "root-serve-type": "text/html",
+          "tiddler-render-type": "text/html",
+          "tiddler-render-template": "$:/core/templates/server/static.tiddler.html",
+          "system-tiddler-render-type": "text/plain",
+          "system-tiddler-render-template": "$:/core/templates/wikified-tiddler",
+          "debug-level": "none",
+          "gzip": "no",
+          "use-browser-cache": "no"
+        }
+        ```
+     */
+    defaultVariables: {
+      'debug-level': string;
+      gzip: string;
+      host: string;
+      port: string;
+      'required-plugins': string;
+      'root-render-type': string;
+      'root-serve-type': string;
+      'root-tiddler': string;
+      'system-tiddler-render-template': string;
+      'system-tiddler-render-type': string;
+      'tiddler-render-template': string;
+      'tiddler-render-type': string;
+      'use-browser-cache': string;
+    };
+
+    variables: Record<string, any>;
+    get(variableName: string): any;
+    requestHandler: ServerEndpointHandler;
+    /**
+      Listen for requests
+      port: optional port number (falls back to value of "port" variable)
+      host: optional host address (falls back to value of "host" variable)
+      prefix: optional prefix (falls back to value of "path-prefix" variable)
+      */
+    listen(port?: string, host?: string, prefix?: string): void;
+    /**
+      Check whether a given user is authorized for the specified authorizationType ("readers" or "writers"). Pass null or undefined as the username to check for anonymous access
+    */
+    isAuthorized(authorizationType: 'readers' | 'writers', username?: string | undefined): boolean;
+    close(): void;
+  }
+
   export interface ServerEndpointContext {
+    authenticatedUsername: string | undefined;
     data: string;
+    server: Server;
     wiki: Wiki;
   }
   /**
    * @link https://talk.tiddlywiki.org/t/what-is-the-state-in-server-route-handler/2877
    */
-  export type ServerEndpointHandler<T = Record<string, any>> = (
+  export type ServerEndpointHandler<T = Record<string, unknown>> = (
     request: Http.ClientRequest,
     response: Http.ServerResponse,
     context: ServerEndpointContext & T,

package/src/tw.d.ts

@@ -59,9 +59,19 @@ declare module 'tiddlywiki' {
 
     config: ITWConfig;
 
+    /**
+      Global Hooks mechanism which allows plugins to modify default functionality
+    */
     hooks: {
+      /**
+        Add hooks to the  hashmap
+      */
       addHook(hookName: 'th-server-command-post-start', callback: (listenCommand: unknown, server: Server) => void): void;
       addHook(hookName: string, callback: (...arguments_: unknown[]) => unknown): void;
+      /**
+        Invoke the hook by key
+      */
+      invokeHook(hookName: string): void;
     };
 
     modules: ITWModules;
@@ -70,17 +80,18 @@ declare module 'tiddlywiki' {
     /** Broswer features, if tw isn't running on a browser environment, the value will be `null` */
     nodeWebKit: null | object;
 
+    notifier: Notifier;
     /** Convenience function for pushing a tiddler onto the preloading array */
     preloadTiddler(fields: Record<string, unknown>): void;
     /** Convenience function for pushing an array of tiddlers onto the preloading array */
     preloadTiddlerArray(fieldsArray: Array<Record<string, unknown>>): void;
+
     /** External JavaScript can populate this array before calling boot.js in order to preload tiddlers */
     preloadTiddlers: Record<string, Record<string, unknown>>;
 
     rootWidget: Widget;
 
     utils: ITWUtils;
-
     version: string;
     wiki: Wiki;
   }

package/src/utils.d.ts

@@ -15,6 +15,20 @@ declare module 'tiddlywiki' {
      * @param className
      */
     addClass(element: Element, className: string): void;
+    /**
+      Attach specified event handlers to a DOM node
+      @param domNode: where to attach the event handlers
+      @param events: array of event handlers to be added (see below)
+      Each entry in the events array is an object with these properties:
+      - name: event name of `addEventListener`
+      - handlerFunction: optional event handler function
+      - handlerObject: optional event handler object
+      - handlerMethod: optionally specifies object handler method name (defaults to `handleEvent`)
+    */
+    addEventListeners(
+      domNode: Node,
+      events: Array<{ handlerFunction?: (event: MouseEvent) => void; handlerMethod?: string; handlerObject?: Widget; name: string }>,
+    ): void;
     /** Returns true if the version string A is greater than the version string B. Returns true if the versions are the same */
     checkVersions(versionStringA: string, versionStringB: string): boolean;
     /**
@@ -80,6 +94,8 @@ declare module 'tiddlywiki' {
     evalSandboxed(code: string, context: IModuleSandbox, filename: string): unknown;
     /** Extend an object with the properties from a list of source objects */
     extend(object: object, ...sourceObjectList: object[]): object;
+    /** the function behind `<<now "format">> */
+    formatDateString(date: Date, format: string): string;
     /** Given an extension, always access the $tw.config.fileExtensionInfo using a lowercase extension only. */
     getFileExtensionInfo(extension: string): IFileExtensionInfo | null;
     /** Get the browser location.hash. We don't use location.hash because of the way that Firefox auto-urldecodes it (see http://stackoverflow.com/questions/1703552/encoding-of-window-location-hash) */
@@ -152,4 +168,16 @@ declare module 'tiddlywiki' {
     /** Stringify an array of tiddler titles into a list string */
     stringifyList(value: string[]): string;
   }
+  /**
+   * Notifier mechanism
+   */
+  export class Notifier {
+    /*
+      Display a notification
+        title: Title of tiddler containing the notification text
+        options: see below
+      Options include:
+      */
+    display(title: string, options?: Record<string, unknown>): void;
+  }
 }

package/src/widget.d.ts

@@ -8,6 +8,29 @@ declare module 'tiddlywiki' {
     modified: boolean;
   }
 
+  export interface IWidgetEvent {
+    /** maybe a DOM click event, if trigger by button click */
+    event: Event;
+    navigateFromTitle?: string;
+    /**
+     * Get `$param`
+     */
+    param?: string | undefined;
+    /** Optional hashmap of additional tiddler fields. Widget event can carry any other parameters
+     *
+     * For example, `<$action-sendmessage $message="tw-mobile-sync-set-active-server-and-sync" title={{!!title}} />` will produce `paramObject: { title: "xxxx" }`
+     */
+    paramObject?: {
+      [othersParamKeys: string]: unknown;
+    };
+    /** the first parameter of addEventListener
+     *
+     * For example, the `'open-command-palette'` in `$tw.rootWidget.addEventListener('open-command-palette', (e: IWidgetEvent) => this.openPalette(e));`
+     */
+    type: string;
+    widget: Widget;
+  }
+
   // eslint-disable-next-line @typescript-eslint/no-extraneous-class
   class variablesConstructor {}
 
@@ -15,26 +38,37 @@ declare module 'tiddlywiki' {
    * @link https://tiddlywiki.com/dev/#Widgets
    */
   export class Widget {
-    constructor(parseTreeNode: unknown, options: unknown);
-    initialize: (parseTreeNode: unknown, options: unknown) => void;
-    parseTreeNode: unknown;
-    wiki: unknown;
+    constructor(parseTreeNode: IParseTreeNode, options?: unknown);
+    initialize: (parseTreeNode: IParseTreeNode, options?: unknown) => void;
+    parseTreeNode: IParseTreeNode;
+    wiki: ITiddlyWiki;
     parentWidget?: Widget;
+    children: Widget[];
+    /*
+Make child widgets correspondng to specified parseTreeNodes
+*/
+    makeChildWidgets(parseTreeNodes: IParseTreeNode[], options?: { variables?: unknown }): void;
+    /**
+      Construct the widget object for a parse tree node
+      options include:
+        variables: optional hashmap of variables to wrap around the widget
+    */
+    makeChildWidget(parseTreeNode: IParseTreeNode, options?: { variables?: unknown }): void;
     variablesConstructor: variablesConstructor;
     variables: unknown;
     domNodes: Node[];
     /**
-    Add an event listener
-  */
-    addEventListener(type: string, handler: (arguments_: unknown[]) => void): void;
+      Add an event listener
+    */
+    addEventListener(type: string, handler: (event: IWidgetEvent) => void | Promise<void>): void;
     /**
-    Dispatch an event to a widget. If the widget doesn't handle the event then it is also dispatched to the parent widget
-  */
-    dispatchEvent(type: string): void;
+      Dispatch an event to a widget. If the widget doesn't handle the event then it is also dispatched to the parent widget
+    */
+    dispatchEvent(typeOrEvent: string | Omit<IWidgetEvent, 'widget'>): void;
     /**
-    Add a list of event listeners from an array [{type:,handler:},...]
-  */
-    addEventListeners(listeners: Array<{ handler: (arguments_: unknown[]) => void; type: string }>): void;
+      Add a list of event listeners from an array [{type:,handler:},...]
+    */
+    addEventListeners(listeners: Array<{ handler: (event: IWidgetEvent) => void | Promise<void>; type: string }>): void;
 
     parentDomNode: Node;
     execute: () => void;
@@ -42,7 +76,7 @@ declare module 'tiddlywiki' {
     /**
      * Lifecycle method: Render this widget into the DOM
      */
-    render(parent: Node, nextSibling: Node): void;
+    render(parent: Node, nextSibling: Node | null): void;
     /**
      * Selectively refreshes the widget if needed. Returns true if the widget or any of its children needed re-rendering.
      * You can do some cleanup or buildup before return true.
@@ -50,6 +84,15 @@ declare module 'tiddlywiki' {
      * @link https://tiddlywiki.com/dev/#Selective%20Update
      */
     refresh(changedTiddlers: IChangedTiddlers): boolean;
+    /**
+      Refresh all the children of a widget
+      will call `this.render`
+    */
+    refreshChildren(changedTiddlers: IChangedTiddlers): boolean;
+    /**
+      Rebuild a previously rendered widget
+    */
+    refreshSelf(): boolean;
     computeAttributes(): void;
     /**
      * Get parameters that user set in the widget
@@ -74,4 +117,25 @@ declare module 'tiddlywiki' {
      */
     getVariable(name: string, options?: object): string;
   }
+
+  export interface IFakeDocument {
+    compatMode: string;
+    createElement: (tag: string) => TW_Element;
+    createElementNS: (namespace: string, tag: string) => TW_Element;
+    createTextNode: (text: string) => TW_TextNode;
+    isTiddlyWikiFakeDom: boolean;
+    setSequenceNumber: (value: any) => void;
+  }
+  export class TW_Element {
+    isTiddlyWikiFakeDom: boolean;
+    tag: string;
+    attributes: Record<string, unknown>;
+    isRaw: boolean;
+    children: Array<TW_Element | TW_TextNode>;
+    _style: Record<string, unknown>;
+    namespaceURI: string;
+  }
+  export class TW_TextNode {
+    textContent: string;
+  }
 }