tw5-typed 0.1.9 → 0.1.12

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.1.9",
+  "version": "0.1.12",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -20,28 +20,28 @@
     "prepublishOnly": "npx tsc --noEmit"
   },
   "devDependencies": {
-    "@types/node": "^17.0.18",
-    "@typescript-eslint/eslint-plugin": "5.11.0",
-    "@typescript-eslint/parser": "5.11.0",
-    "eslint": "8.8.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-config-standard": "17.0.0-1",
+    "@types/node": "^17.0.22",
+    "@typescript-eslint/eslint-plugin": "5.16.0",
+    "@typescript-eslint/parser": "5.16.0",
+    "eslint": "8.11.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.5.0",
     "eslint-plugin-html": "6.2.0",
     "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-n": "14.0.0",
+    "eslint-plugin-n": "15.0.1",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-react": "7.28.0",
+    "eslint-plugin-react": "7.29.4",
     "eslint-plugin-react-hooks": "4.3.0",
     "eslint-plugin-security": "1.4.0",
     "eslint-plugin-security-node": "1.1.1",
     "eslint-plugin-typescript-sort-keys": "2.1.0",
-    "eslint-plugin-unicorn": "40.1.0",
-    "prettier": "2.5.1",
-    "typescript": "4.5.5"
+    "eslint-plugin-unicorn": "41.0.1",
+    "prettier": "2.6.0",
+    "typescript": "4.6.2"
   }
 }

package/src/ast.d.ts

@@ -1,11 +1,12 @@
 declare module 'tiddlywiki' {
   export interface IParseTreeAttribute {
-    start: number;
-    name: string;
+    start?: number;
+    name?: string;
     type: 'string' | 'number';
     value: string;
-    end: number;
+    end?: number;
   }
+
   export interface IWikiASTNode {
     type: string;
     children?: IParseTreeNode[];
@@ -24,9 +25,28 @@ declare module 'tiddlywiki' {
     type: 'link';
     text: string;
   }
+  export type HTMLTags = keyof HTMLElementTagNameMap | 'strike';
+
   export interface IDomParseTreeNode extends IWikiASTNode {
     type: 'element';
-    tag: string;
+    tag: HTMLTags;
+  }
+  export interface ICodeBlockParseTreeNode extends IWikiASTNode {
+    type: 'codeblock';
+    attributes: {
+      code?:
+        | {
+            type: 'string';
+            value: string;
+          }
+        | undefined;
+      language?:
+        | {
+            type: 'string';
+            value: string;
+          }
+        | undefined;
+    };
   }
   export interface IMacroParamCallParseTreeNode extends IWikiASTNode {
     type: 'macro-parameter';
@@ -44,5 +64,5 @@ declare module 'tiddlywiki' {
     params: IMacroParamCallParseTreeNode[];
     text?: string;
   }
-  export type IParseTreeNode = IDomParseTreeNode | IMacroParamCallParseTreeNode | IMacroCallParseTreeNode | ICustomParseTreeNode;
+  export type IParseTreeNode = IDomParseTreeNode | IMacroParamCallParseTreeNode | IMacroCallParseTreeNode | ITextParseTreeNode | ICustomParseTreeNode;
 }

package/src/parser.d.ts

@@ -1,3 +1,5 @@
+/// <reference path="ast.d.ts" />
+
 declare module 'tiddlywiki' {
   export interface IParserOptions {
     /**
@@ -10,7 +12,7 @@ declare module 'tiddlywiki' {
     _canonical_uri?: string;
   }
 
-  export declare class WikiParseRule {
+  export class WikiParseRule {
     is: { block?: boolean; inline?: boolean };
     match?: null;
     matchRegExp?: RegExp;
@@ -26,14 +28,7 @@ declare module 'tiddlywiki' {
       name: string;
     };
   }
-  export interface IParseTreeAttribute {
-    start: number;
-    name: string;
-    type: 'string' | 'number';
-    value: string;
-    end: number;
-  }
-  export declare class WikiParser {
+  export class WikiParser {
     blockRules: { rule: WikiParseRule; matchIndex?: number }[];
     inlineRules: { rule: WikiParseRule; matchIndex?: number }[];
     pragmaRules: { rule: WikiParseRule; matchIndex?: number }[];

package/src/utils.d.ts

@@ -6,6 +6,13 @@ declare module 'tiddlywiki' {
   export type TWDOMElement = Element;
   export type TWEachCallback<T> = (element?: unknown, index?: string | number, object?: T) => boolean | undefined;
   export interface ITWUtils {
+    /**
+     * Alternative to `element.classList.add`, add a css class name to an element, see issue for detail.
+     * @link https://github.com/Jermolene/TiddlyWiki5/issues/6475
+     * @param element 
+     * @param className 
+     */
+    addClass(element: Element, className: string): void;
     Crypto: typeof Crypto;
     PasswordPrompt: typeof PasswordPrompt;
     /** Returns true if the version string A is greater than the version string B. Returns true if the versions are the same */

package/src/widget.d.ts

@@ -1,7 +1,19 @@
 declare module 'tiddlywiki' {
+  /**
+   * Parameter of Widget.refresh
+   * Key is tiddler title
+   */
+  export type IChangedTiddlers = Record<string, IChangedTiddlersMeta>;
+  export interface IChangedTiddlersMeta {
+    modified: boolean;
+  }
+
   // 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 +43,13 @@ 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: IChangedTiddlers): boolean;
     computeAttributes(): void;
     /**
      * Get parameters that user set in the widget