tw5-typed 0.1.5 → 0.1.8

package/README.md

@@ -49,7 +49,13 @@ You can add new `*.d.ts` file to contain your types:
 1. use `declare module 'tiddlywiki' { }` to wrap all your types.
 1. don't forget to `export` all your types.
 1. to add type for global variable, add `global { }` inside that `declare module 'tiddlywiki' { }`, like `global { var $tw: I$TW; }`
+1. add type import like `/// <reference path="ast.d.ts" />` in the `tw.d.ts`
 
-And add `import './xxx';` in the `index.d.ts` file.
+### Importing type from other files
+
+- add type import like `/// <reference path="parser.d.ts" />`
+- using normal import, like `import { parse } from './parser';` will not work
+
+### Test in your node_modules
 
 To rapid prototype the type, just right click a type to open `.d.ts` file in the `node_modules`, and try create new file there, and copy to this repo after a success.

package/package.json

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

package/src/Wiki.d.ts

@@ -1,3 +1,5 @@
+/// <reference path="parser.d.ts" />
+
 declare module 'tiddlywiki' {
   export class Wiki {
     /**
@@ -7,7 +9,7 @@ declare module 'tiddlywiki' {
      * @memberof Wiki
      */
     constructor(options: { enableIndexers: unknown[] });
-    addIndexer(indexer, name): void;
+    addIndexer(indexer: unknown, name: string): void;
     getTiddler: (title: string) => Tiddler | undefined;
     /**
      * Get full list of tiddler titles in the wiki
@@ -30,7 +32,7 @@ declare module 'tiddlywiki' {
     /**
      * Get tiddler's text field, with an optional default text.
      * If have _is_skinny field, will just return null (this is a rare case, so not put in the return type for now).
-     * 
+     *
      * @param title will return undefined (or fallback) if the tiddler isn't found
      * @param fallbackText default text when text field is empty or undefined
      */
@@ -46,5 +48,7 @@ declare module 'tiddlywiki' {
      * @param {object} options options, see tiddlywiki dev doc for details
      */
     setText: (title: string, field?: string, index?: string | undefined, value?: string, options?: any) => void;
+    parseTiddler(title: string, options?: IParserOptions): WikiParser;
+    parseText(type: string, text: string, options?: IParserOptions): WikiParser;
   }
 }

package/src/ast.d.ts

@@ -0,0 +1,48 @@
+declare module 'tiddlywiki' {
+  export interface IParseTreeAttribute {
+    start: number;
+    name: string;
+    type: 'string' | 'number';
+    value: string;
+    end: number;
+  }
+  export interface IWikiASTNode {
+    type: string;
+    children?: IParseTreeNode[];
+    start?: number;
+    end?: number;
+    isBlock?: boolean;
+    isSelfClosing?: boolean;
+    attributes?: Record<string, IParseTreeAttribute>;
+    orderedAttributes?: IParseTreeAttribute[];
+  }
+  export interface ITextParseTreeNode extends IWikiASTNode {
+    type: 'text';
+    text: string;
+  }
+  export interface ILinkParseTreeNode extends IWikiASTNode {
+    type: 'link';
+    text: string;
+  }
+  export interface IDomParseTreeNode extends IWikiASTNode {
+    type: 'element';
+    tag: string;
+  }
+  export interface IMacroParamCallParseTreeNode extends IWikiASTNode {
+    type: 'macro-parameter';
+    value: string;
+    name?: string;
+  }
+  export interface IMacroCallParseTreeNode extends IWikiASTNode {
+    type: 'macrocall';
+    name: string;
+    params: IMacroParamCallParseTreeNode[];
+  }
+  export interface ICustomParseTreeNode extends IWikiASTNode {
+    type: string;
+    tag?: string;
+    params: IMacroParamCallParseTreeNode[];
+    text?: string;
+  }
+  export type IParseTreeNode = IDomParseTreeNode | IMacroParamCallParseTreeNode | IMacroCallParseTreeNode | ICustomParseTreeNode;
+}

package/src/parser.d.ts

@@ -0,0 +1,48 @@
+declare module 'tiddlywiki' {
+  export interface IParserOptions {
+    /**
+     * While calling `getCacheForTiddler`, use inlineParseTree or blockParseTree
+     */
+    parseAsInline?: boolean;
+    /**
+     * Optional source uri, used in parseText
+     */
+    _canonical_uri?: string;
+  }
+
+  export declare class WikiParseRule {
+    is: { block?: boolean; inline?: boolean };
+    match?: null;
+    matchRegExp?: RegExp;
+    parser?: WikiParser;
+    nextTag?: null;
+    /** `{type: 'macrocall', start: 261, params: Array(1), name: 'reuse-tiddler', end: 290}` */
+    nextCall?: {
+      type: string;
+      start: number;
+      end: number;
+      /** `{ type: 'macro-parameter'; start: 276; value: '快速创建新笔记按钮'; end: 288 }` */
+      params: { type: string; start: number; end: number; value: string };
+      name: string;
+    };
+  }
+  export interface IParseTreeAttribute {
+    start: number;
+    name: string;
+    type: 'string' | 'number';
+    value: string;
+    end: number;
+  }
+  export declare class WikiParser {
+    blockRules: { rule: WikiParseRule; matchIndex?: number }[];
+    inlineRules: { rule: WikiParseRule; matchIndex?: number }[];
+    pragmaRules: { rule: WikiParseRule; matchIndex?: number }[];
+    configTrimWhiteSpace: boolean;
+    pos: number;
+    source: string;
+    sourceLength: number;
+    type: string;
+    wiki: Wiki;
+    tree: IParseTreeNode[];
+  }
+}

package/src/tw.d.ts

@@ -5,6 +5,8 @@
 /// <reference path="utils.d.ts" />
 /// <reference path="Widget.d.ts" />
 /// <reference path="Wiki.d.ts" />
+/// <reference path="parser.d.ts" />
+/// <reference path="ast.d.ts" />
 
 declare module 'tiddlywiki' {
   export interface IBootFilesIndexItem {
@@ -22,6 +24,8 @@ declare module 'tiddlywiki' {
     tiddlers: ITiddlerFields[];
   }
 
+  export class Server {}
+
   export interface IFileExtensionInfo {
     type: string;
   }