tw5-typed 0.2.20 → 0.2.22

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.2.20",
+  "version": "0.2.22",
   "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/boot/config.d.ts

@@ -13,7 +13,6 @@ declare module 'tiddlywiki' {
   export type ITWConfig = IConfig;
 
   interface IConfig {
-    [configName: string]: unknown;
     /** Map type to file content type */
     contentTypeInfo: Record<string, IContentTypeInfo>;
     /** @default 'TIDDLYWIKI_EDITION_PATH' */
@@ -51,5 +50,7 @@ declare module 'tiddlywiki' {
     wikiThemesSubDir: string;
     /** @default './tiddlers' */
     wikiTiddlersSubDir: string;
+    htmlUnsafeElements: string[];
+    [configName: string]: any;
   }
 }

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

@@ -4,7 +4,7 @@ declare module 'tiddlywiki' {
     storyTitle: string;
     historyTitle: string;
 
-    constructor(options: {
+    constructor(options?: {
       wiki?: Wiki;
       storyTitle?: string;
       historyTitle?: string;

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

@@ -20,6 +20,14 @@ declare module 'tiddlywiki' {
     isMacroDefinition: boolean;
   }
 
+  export interface IWidgetInitialiseOptions {
+    document?: TWDocument;
+    parentWidget?: Widget;
+    wiki?: ITiddlyWiki;
+  }
+
+  export type IWidgetInitializeOptions = IWidgetInitialiseOptions;
+
   export interface IWidgetEvent {
     [extraKeys: string]: unknown;
     /** maybe a DOM click event, if trigger by button click */
@@ -46,11 +54,6 @@ declare module 'tiddlywiki' {
     widget: Widget;
   }
 
-  export interface IWidgetInitializeOptions {
-    wiki?: ITiddlyWiki;
-    parentWidget?: Widget;
-  }
-
   /**
    * @link https://tiddlywiki.com/dev/#Widgets
    *
@@ -104,7 +107,7 @@ declare module 'tiddlywiki' {
 
     constructor(
       parseTreeNode: IParseTreeNode,
-      options?: IWidgetInitializeOptions,
+      options?: IWidgetInitialiseOptions,
     );
 
     /**
@@ -115,11 +118,7 @@ declare module 'tiddlywiki' {
      */
     initialise(
       parseTreeNode: IParseTreeNode,
-      options?: {
-        document?: Document;
-        parentWidget?: Widget;
-        wiki?: ITiddlyWiki;
-      },
+      options?: IWidgetInitialiseOptions,
     ): void;
 
     /**
@@ -141,7 +140,7 @@ declare module 'tiddlywiki' {
      * @param {IChangedTiddlers} changedTiddlers Object key is tiddler title, value is metadata about the change
      * @link https://tiddlywiki.com/dev/#Selective%20Update
      */
-    refresh(changedTiddlers: IChangedTiddlers): boolean;
+    refresh(changedTiddlers: IChangedTiddlers): boolean | void;
 
     /**
      * Compute the internal state of the widget.

package/src/modules/wiki.d.ts

@@ -4,6 +4,12 @@ declare const getModificationFields: () => {
   modifier?: string;
 };
 declare const getTiddlersWithTag: (tag: string) => string[];
+declare const getTextReferenceParserInfo: (
+  title: string,
+  field?: string,
+  index?: string,
+  options: { subTiddler: string },
+) => { sourceText: null | string; parserType: string | null };
 
 declare module 'tiddlywiki' {
   export interface Wiki {

package/src/utils/index.d.ts

@@ -23,7 +23,7 @@ type Spread<A extends readonly [...any]> = A extends [infer L, ...infer R]
   : unknown;
 
 declare module 'tiddlywiki' {
-  export type TWDocument = Document;
+  export type TWDocument = Document | IFakeDocument;
   export type TWElement = Element;
   export type TWDOMElement = TWElement;
   export type ITWUtils = IUtils;
@@ -209,10 +209,15 @@ declare module 'tiddlywiki' {
      * 产生一个 DOM 元素
      *
      * @param {string} tag tag name
-     * @param {IDomMakerOptions} [options]
+     * @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
@@ -217,7 +216,10 @@ declare module 'tiddlywiki' {
       variables: hashmap of variables to set
       parentWidget: optional parent widget for the root node
     */
-    makeWidget(parser: WikiParser, options?: IMakeWidgetOptions): Widget;
+    makeWidget(
+      parser: { tree: IParseTreeNode[] },
+      options?: IMakeWidgetOptions,
+    ): Widget;
     /**
       Make a widget tree for transclusion
       @params title: target tiddler title