tw5-typed 0.2.22 → 0.2.24

package/package.json

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

package/src/core.d.ts

@@ -31,14 +31,15 @@ declare module 'tiddlywiki' {
     boot: IBoot;
     crypto: Crypto;
     utils: IUtils;
+    config: IConfig;
     version: string;
     safeMode: boolean;
-    config: IConfig;
+    modules: IModules;
     rootWidget: Widget;
     notifier: Notifier;
     language: ILanguage;
-    modules: IModules;
     locationHash: string;
+    fakeDocument: IFakeDocument;
     passwordPrompt: PasswordPrompt;
     packageInfo: Record<string, unknown>;
 

package/src/modules/utils/dom.d.ts

@@ -1,6 +1,6 @@
 declare const addClass: (element: Element, className: string) => void;
 declare const addEventListeners: (
-  domNode: Node,
+  domNode: Element,
   events: {
     handlerFunction?: (event: MouseEvent) => void;
     handlerMethod?: string;

package/src/modules/utils/fakedom.d.ts

@@ -0,0 +1,27 @@
+declare module 'tiddlywiki' {
+  export class TW_Element extends HTMLElement {
+    _style: Record<string, unknown>;
+    appendChild: <T extends TW_Element | TW_TextNode | Node>(node: T) => T;
+    isRaw: boolean;
+    isTiddlyWikiFakeDom: boolean;
+    namespaceURI: string;
+    tag: string;
+  }
+
+  export class TW_TextNode extends Node {
+    textContent: 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;
+  }
+}
+
+declare module '$:/core/modules/utils/fakedom.js' {
+  export type { TW_Element, TW_TextNode, IFakeDocument } from 'tiddlywiki';
+}

package/src/modules/utils/index.d.ts

@@ -1,3 +1,4 @@
 /// <reference path="dom.d.ts" />
 /// <reference path="utils.d.ts" />
-/// <reference path="filesystem.d.ts" /> 
+/// <reference path="fakedom.d.ts" />
+/// <reference path="filesystem.d.ts" />

package/src/modules/widgets/index.d.ts

@@ -77,9 +77,9 @@ declare module 'tiddlywiki' {
 
     attributes: Record<string, string>;
 
-    domNodes: Node[];
+    domNodes: Element[];
 
-    parentDomNode: Node;
+    parentDomNode: Element;
 
     eventListeners: Record<string, Function>;
 
@@ -128,7 +128,7 @@ declare module 'tiddlywiki' {
      * 生命周期方法: 将这个微件渲染到DOM中;
      * 只会在首次渲染、销毁后重新渲染时自动调用，或者通过 refreshSelf 等方法主动调用
      */
-    render(parent: Node, nextSibling: Node | null): void;
+    render(parent: Element, nextSibling: Element | null): void;
 
     /**
      * @en
@@ -304,7 +304,8 @@ declare module 'tiddlywiki' {
      * @return {*}  {string}
      * @memberof Widget
      */
-    getAttribute(name: string, fallbackText?: string): string;
+    getAttribute(name: string): string | undefined;
+    getAttribute(name: string, fallbackText: string): string;
 
     /**
      * @en
@@ -323,7 +324,7 @@ declare module 'tiddlywiki' {
      * @memberof Widget
      */
     assignAttributes(
-      domNode: Node,
+      domNode: Element,
       options?: { excludeEventAttributes?: boolean },
     );
 
@@ -379,7 +380,7 @@ declare module 'tiddlywiki' {
     /**
      * Render the children of this widget into the DOM
      */
-    renderChildren(parent: Node, nextSibling: Node | null): void;
+    renderChildren(parent: Element, nextSibling: Element | null): void;
 
     /**
      * Add a list of event listeners from an array [{type:,handler:},...]
@@ -420,12 +421,12 @@ declare module 'tiddlywiki' {
      * 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;
+    findNextSiblingDomNode(startIndex?: number): Element | null;
 
     /**
      * Find the first DOM node generated by a widget or its children
      */
-    findFirstDomNode(): Node | null;
+    findFirstDomNode(): Element | null;
 
     /**
      * Remove any DOM nodes created by this widget or its children
@@ -477,28 +478,6 @@ declare module 'tiddlywiki' {
     ): boolean;
   }
 
-  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;
-  }
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  export interface TW_Element extends HTMLElement {
-    _style: Record<string, unknown>;
-    appendChild: <T extends TW_Element | TW_TextNode | Node>(node: T) => T;
-    isRaw: boolean;
-    isTiddlyWikiFakeDom: boolean;
-    namespaceURI: string;
-    tag: string;
-  }
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  export interface TW_TextNode extends Node {
-    textContent: string;
-  }
-
   export type ModalWidget = {
     adjustPageClass: () => void;
     /**

package/src/utils/index.d.ts

@@ -56,7 +56,7 @@ declare module 'tiddlywiki' {
      * @type {CSSStyleDeclaration}
      * @memberof IDomMakerOptions
      */
-    style?: CSSStyleDeclaration;
+    style?: Partial<CSSStyleDeclaration>;
 
     /**
      * @en