tw5-typed 0.1.7 → 0.1.10

package/README.md

@@ -51,4 +51,11 @@ You can add new `*.d.ts` file to contain your types:
 1. to add type for global variable, add `global { }` inside that `declare module 'tiddlywiki' { }`, like `global { var $tw: I$TW; }`
 1. add type import like `/// <reference path="ast.d.ts" />` in the `tw.d.ts`
 
+### Importing type from other files
+
+- add type import like `/// <reference path="parser.d.ts" />`
+- using normal import, like `import { parse } from './parser';` will not work
+
+### Test in your node_modules
+
 To rapid prototype the type, just right click a type to open `.d.ts` file in the `node_modules`, and try create new file there, and copy to this repo after a success.

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.1.7",
+  "version": "0.1.10",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {

package/src/Wiki.d.ts

@@ -1,3 +1,5 @@
+/// <reference path="parser.d.ts" />
+
 declare module 'tiddlywiki' {
   export class Wiki {
     /**
@@ -7,7 +9,7 @@ declare module 'tiddlywiki' {
      * @memberof Wiki
      */
     constructor(options: { enableIndexers: unknown[] });
-    addIndexer(indexer, name): void;
+    addIndexer(indexer: unknown, name: string): void;
     getTiddler: (title: string) => Tiddler | undefined;
     /**
      * Get full list of tiddler titles in the wiki

package/src/ast.d.ts

@@ -8,17 +8,26 @@ declare module 'tiddlywiki' {
   }
   export interface IWikiASTNode {
     type: string;
-    children: IParseTreeNode[];
-    start: number;
-    end: number;
+    children?: IParseTreeNode[];
+    start?: number;
+    end?: number;
     isBlock?: boolean;
     isSelfClosing?: boolean;
     attributes?: Record<string, IParseTreeAttribute>;
     orderedAttributes?: IParseTreeAttribute[];
   }
+  export interface ITextParseTreeNode extends IWikiASTNode {
+    type: 'text';
+    text: string;
+  }
+  export interface ILinkParseTreeNode extends IWikiASTNode {
+    type: 'link';
+    text: string;
+  }
+  export type HTMLTags = keyof HTMLElementTagNameMap
   export interface IDomParseTreeNode extends IWikiASTNode {
     type: 'element';
-    tag: string;
+    tag: HTMLTags;
   }
   export interface IMacroParamCallParseTreeNode extends IWikiASTNode {
     type: 'macro-parameter';
@@ -34,6 +43,7 @@ declare module 'tiddlywiki' {
     type: string;
     tag?: string;
     params: IMacroParamCallParseTreeNode[];
+    text?: string;
   }
-  export type IParseTreeNode = IDomParseTreeNode | IMacroParamCallParseTreeNode | IMacroCallParseTreeNode | ICustomParseTreeNode;
+  export type IParseTreeNode = IDomParseTreeNode | IMacroParamCallParseTreeNode | IMacroCallParseTreeNode | ITextParseTreeNode | ICustomParseTreeNode;
 }

package/src/tw.d.ts

@@ -5,6 +5,7 @@
 /// <reference path="utils.d.ts" />
 /// <reference path="Widget.d.ts" />
 /// <reference path="Wiki.d.ts" />
+/// <reference path="parser.d.ts" />
 /// <reference path="ast.d.ts" />
 
 declare module 'tiddlywiki' {
@@ -23,6 +24,8 @@ declare module 'tiddlywiki' {
     tiddlers: ITiddlerFields[];
   }
 
+  export class Server {}
+
   export interface IFileExtensionInfo {
     type: string;
   }
@@ -44,6 +47,7 @@ declare module 'tiddlywiki' {
       log(logString: string): void;
       logMessages: string[];
       startup(options: { callback?: () => unknown }): void;
+      boot(callback?: () => unknown): void;
       /** Default boot tasks */
       tasks: {
         readBrowserTiddlers: boolean;

package/src/widget.d.ts

@@ -2,6 +2,9 @@ declare module 'tiddlywiki' {
   // eslint-disable-next-line @typescript-eslint/no-extraneous-class
   class variablesConstructor {}
 
+  /**
+   * @link https://tiddlywiki.com/dev/#Widgets
+   */
   export class Widget {
     constructor(parseTreeNode: unknown, options: unknown);
     initialize: (parseTreeNode: unknown, options: unknown) => void;
@@ -31,6 +34,15 @@ declare module 'tiddlywiki' {
      * Lifecycle method: Render this widget into the DOM
      */
     render(parent: Node, nextSibling: Node): 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.
+     * @param changedTiddlers Object key is tiddler title, value is metadata about the change
+     * @link https://tiddlywiki.com/dev/#Selective%20Update
+     */
+    refresh(changedTiddlers: Record<string, {
+      modified: boolean
+    }>): boolean;
     computeAttributes(): void;
     /**
      * Get parameters that user set in the widget