tw5-typed 0.2.21 → 0.2.23

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.2.21",
+  "version": "0.2.23",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -16,9 +16,6 @@
   "files": [
     "src/"
   ],
-  "scripts": {
-    "check": "tsc --noEmit && eslint src/**/*.ts"
-  },
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged"
@@ -45,5 +42,8 @@
     "@types/codemirror": "^5.60.6",
     "@types/echarts": "^4.9.16",
     "@types/node": "^18.11.9"
+  },
+  "scripts": {
+    "check": "tsc --noEmit && eslint src/**/*.ts"
   }
-}
+}

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/parsers/index.d.ts

@@ -1,5 +1,5 @@
 declare module 'tiddlywiki' {
-  export interface IParserOptions {
+  export interface IParseOptions {
     /**
      * Optional source uri, used in parseText
      */
@@ -8,6 +8,7 @@ declare module 'tiddlywiki' {
      * While calling `getCacheForTiddler`, use inlineParseTree or blockParseTree
      */
     parseAsInline?: boolean;
+    defaultType?: string;
   }
 
   export class WikiParseRule {

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

@@ -21,7 +21,7 @@ declare module 'tiddlywiki' {
   }
 
   export interface IWidgetInitialiseOptions {
-    document?: Document;
+    document?: TWDocument;
     parentWidget?: Widget;
     wiki?: ITiddlyWiki;
   }
@@ -477,28 +477,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

@@ -212,7 +212,12 @@ declare module 'tiddlywiki' {
      * @param {IDomMakerOptions} options
      * @returns {TWElement}
      */
-    domMaker: (tag: string, options: IDomMakerOptions) => TWElement;
+    domMaker: <K extends keyof HTMLElementTagNameMap | string>(
+      tag: K,
+      options: IDomMakerOptions,
+    ) => K extends keyof HTMLElementTagNameMap
+      ? HTMLElementTagNameMap[K]
+      : HTMLElement;
 
     /**
      * @en

package/src/wiki/index.d.ts

@@ -1,9 +1,12 @@
 /// <reference path="../modules/filters/index.d.ts" />>
 
 declare module 'tiddlywiki' {
-  export interface IMakeWidgetOptions extends IRenderOptions {
-    document: typeof document | IFakeDocument;
+  export interface IMakeWidgetOptions {
+    document?: TWDocument;
+    variables?: Record<string, string>;
+    parentWidget?: Widget;
   }
+  export type IRenderOptions = IMakeWidgetOptions & IParseOptions;
 
   export type OutputMimeTypes =
     | 'text/html'
@@ -13,10 +16,6 @@ declare module 'tiddlywiki' {
     | 'text/html'
     | 'text/vnd.tiddlywiki'
     | 'text/plain';
-  export interface IRenderOptions {
-    parentWidget?: Widget;
-    variables?: Record<string, any>;
-  }
   export type ITiddlerFieldsParam = Omit<
     Partial<ITiddlerFields>,
     'created' | 'modified'
@@ -167,7 +166,7 @@ declare module 'tiddlywiki' {
     /**
       Parse a tiddler according to its MIME type
     */
-    parseTiddler(title: string, options?: IParserOptions): WikiParser;
+    parseTiddler(title: string, options?: IParseOptions): WikiParser;
     /**
       Parse a block of text of a specified MIME type
       @param {string} type: content type of text to be parsed
@@ -178,7 +177,7 @@ declare module 'tiddlywiki' {
       - parseAsInline: if true, the text of the tiddler will be parsed as an inline run
       - _canonical_uri: optional string of the canonical URI of this content
     */
-    parseText(type: string, text: string, options?: IParserOptions): WikiParser;
+    parseText(type: string, text: string, options?: IParseOptions): WikiParser;
     /**
       Parse text from a tiddler and render it into another format
         outputType: content type for the output