tw5-typed 0.2.8 → 0.2.9

package/package.json

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

package/src/ast.d.ts

@@ -3,8 +3,8 @@ declare module 'tiddlywiki' {
     end?: number;
     name?: string;
     start?: number;
-    type: 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
-    value: string;
+    type: 'string' | 'number' | 'bigint' | 'boolean' | 'macro' | 'macro-parameter';
+    value: string | IMacroCallParseTreeNode;
   }
 
   export interface IWikiASTNode {
@@ -59,10 +59,17 @@ declare module 'tiddlywiki' {
     value: string;
   }
   export interface IMacroCallParseTreeNode extends IWikiASTNode {
-    name: string;
-    params: IMacroParameterCallParseTreeNode[];
+    name?: string;
+    params?: IMacroParameterCallParseTreeNode[];
+    /** `tag: '$macrocall',` */
+    tag?: string;
     type: 'macrocall';
   }
+  export interface IMacroParseTreeNode extends IWikiASTNode {
+    name: string;
+    type: 'macro';
+    value: IMacroCallParseTreeNode;
+  }
   export interface ICustomParseTreeNode extends IWikiASTNode {
     params: IMacroParameterCallParseTreeNode[];
     tag?: string;
@@ -70,6 +77,7 @@ declare module 'tiddlywiki' {
     type: string;
   }
   export type IParseTreeNode =
+    | IWikiASTNode
     | IDomParseTreeNode
     | IMacroParameterCallParseTreeNode
     | IMacroCallParseTreeNode
@@ -79,5 +87,7 @@ declare module 'tiddlywiki' {
     | ITiddlerParseTreeNode
     | ICodeBlockParseTreeNode
     | ILinkParseTreeNode
-    | ICustomParseTreeNode;
+    | ICustomParseTreeNode
+    | IMacroParseTreeNode
+    | IParseTreeAttribute;
 }

package/src/tw.d.ts

@@ -59,7 +59,43 @@ declare module 'tiddlywiki' {
       };
     };
 
-    browser: null | object;
+    browser: null | {
+      is?: {
+        android?: boolean;
+        bada?: boolean;
+        blackberry?: boolean;
+        chrome?: boolean;
+        firefox?: boolean;
+        firefoxos?: boolean;
+        gecko?: boolean;
+        ios?: boolean;
+        ipad?: boolean;
+        iphone?: boolean;
+        mobile?: boolean;
+        name?: boolean;
+        opera?: boolean;
+        phantomjs?: boolean;
+        safari?: boolean;
+        sailfish?: boolean;
+        seamonkey?: boolean;
+        silk?: boolean;
+        tizen?: boolean;
+        version?: boolean;
+        webkit?: boolean;
+        webos?: boolean;
+        windowsphone?: boolean;
+      };
+      /**
+       * @deprecated
+       * Install `$:/plugins/tiddlywiki/browser-sniff` to use `browser.is`
+       */
+      isFirefox: boolean;
+      /**
+       * @deprecated
+       * Install `$:/plugins/tiddlywiki/browser-sniff` to use `browser.is`
+       */
+      isIE: boolean;
+    };
 
     config: ITWConfig;
 

package/src/widget.d.ts

@@ -12,6 +12,7 @@ declare module 'tiddlywiki' {
     [extraKeys: string]: unknown;
     /** maybe a DOM click event, if trigger by button click */
     event: UIEvent | Event;
+    name: string;
     navigateFromTitle?: string;
     /**
      * Get `$param`
@@ -45,8 +46,11 @@ declare module 'tiddlywiki' {
     parseTreeNode: IParseTreeNode;
     wiki: ITiddlyWiki;
     parentWidget?: Widget;
-    /** we can use $tw.rootWidget.widgetClasses.widget to new a widget */
-    widgetClasses: Widget;
+    /** we can use $tw.rootWidget.widgetClasses.widget to new a widget
+     *
+     * This is a set of all widgets defined in tiddlywiki.
+     */
+    widgetClasses: Record<string, Widget>;
     /** we can use $tw.rootWidget.widgetClasses.widget to new a widget
      *
      * Like `new widget.widget(widgetNode,{` in `$tw.wiki.makeWidget`
@@ -59,6 +63,13 @@ declare module 'tiddlywiki' {
       @param parseTreeNodes default to `this.parseTreeNode.children`, can be undefined
     */
     makeChildWidgets(parseTreeNodes?: IParseTreeNode[], options?: { variables?: unknown }): void;
+    /**
+     * Remove any DOM nodes created by this widget or its children
+     *
+     * If this widget has directly created DOM nodes, delete them and exit. This assumes that any child widgets are contained within the created DOM nodes, which would normally be the case.
+     * Otherwise, ask the child widgets to delete their DOM nodes
+     */
+    removeChildDomNodes(): void;
     /**
       Construct the widget object for a parse tree node, and return the new widget
       options include:
@@ -90,6 +101,23 @@ declare module 'tiddlywiki' {
       
     */
     execute(): void;
+    /**
+     * Invoke the action widgets that are descendents of the current widget. Will call child widget's invokeAction recursively.
+     *
+     * @param triggeringWidget
+     * @param event
+     * @returns handled by any children
+     */
+    invokeActions(triggeringWidget: Widget, event: IWidgetEvent): boolean;
+    /**
+     * Invoke the action associated with this widget
+     *
+     * No every widget has this method, but some do, like `action-xxx` widget, e.g., `action-sendmessage`
+     * @param triggeringWidget
+     * @param event
+     * @returns handled
+     */
+    invokeAction: (triggeringWidget: Widget, event: IWidgetEvent) => boolean | undefined;
 
     /**
      * Lifecycle method: Render this widget into the DOM
@@ -112,9 +140,18 @@ declare module 'tiddlywiki' {
     */
     refreshChildren(changedTiddlers: IChangedTiddlers): boolean;
     /**
-      Rebuild a previously rendered widget
-    */
-    refreshSelf(): boolean;
+     * Rebuild a previously rendered widget
+     */
+    refreshSelf(): boolean | void;
+    /**
+     * Find the next sibling in the DOM to this widget. This is done by scanning the widget tree through all next siblings and their descendents that share the same parent DOM node
+     * @param startIndex Refer to this widget by its index within its parents children
+     */
+    findNextSiblingDomNode(startIndex?: number): Node | null;
+    /**
+     * Find the first DOM node generated by a widget or its children
+     */
+    findFirstDomNode(): Node | null;
     computeAttributes(): Record<string, IParseTreeAttribute>;
     /**
      * Get parameters that user set in the widget