tw5-typed 0.1.10 → 0.2.0

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.1.10",
+  "version": "0.2.0",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -20,28 +20,28 @@
     "prepublishOnly": "npx tsc --noEmit"
   },
   "devDependencies": {
-    "@types/node": "^17.0.18",
-    "@typescript-eslint/eslint-plugin": "5.11.0",
-    "@typescript-eslint/parser": "5.11.0",
-    "eslint": "8.8.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-config-standard": "17.0.0-1",
+    "@types/node": "^17.0.23",
+    "@typescript-eslint/eslint-plugin": "5.17.0",
+    "@typescript-eslint/parser": "5.17.0",
+    "eslint": "8.12.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-config-standard": "16.0.3",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-import-resolver-alias": "1.1.2",
-    "eslint-import-resolver-typescript": "2.5.0",
+    "eslint-import-resolver-typescript": "2.7.0",
     "eslint-plugin-html": "6.2.0",
     "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-n": "14.0.0",
+    "eslint-plugin-n": "15.1.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-react": "7.28.0",
-    "eslint-plugin-react-hooks": "4.3.0",
+    "eslint-plugin-react": "7.29.4",
+    "eslint-plugin-react-hooks": "4.4.0",
     "eslint-plugin-security": "1.4.0",
     "eslint-plugin-security-node": "1.1.1",
     "eslint-plugin-typescript-sort-keys": "2.1.0",
-    "eslint-plugin-unicorn": "40.1.0",
-    "prettier": "2.5.1",
-    "typescript": "4.5.5"
+    "eslint-plugin-unicorn": "42.0.0",
+    "prettier": "2.6.1",
+    "typescript": "4.6.3"
   }
 }

package/src/Wiki.d.ts

@@ -29,6 +29,10 @@ declare module 'tiddlywiki' {
      * Update existed tiddler based on the title field.
      */
     addTiddler: (tiddler: Tiddler | ITiddlerFields) => void;
+    /**
+     * Call `addTiddler` for each iton of the list
+     */
+    addTiddlers: (tiddler: Array<Tiddler | ITiddlerFields>) => void;
     /**
      * 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).

package/src/ast.d.ts

@@ -1,49 +1,68 @@
 declare module 'tiddlywiki' {
   export interface IParseTreeAttribute {
-    start: number;
-    name: string;
+    end?: number;
+    name?: string;
+    start?: number;
     type: 'string' | 'number';
     value: string;
-    end: number;
   }
+
   export interface IWikiASTNode {
-    type: string;
+    attributes?: Record<string, IParseTreeAttribute>;
     children?: IParseTreeNode[];
-    start?: number;
     end?: number;
     isBlock?: boolean;
     isSelfClosing?: boolean;
-    attributes?: Record<string, IParseTreeAttribute>;
     orderedAttributes?: IParseTreeAttribute[];
+    start?: number;
+    type: string;
   }
   export interface ITextParseTreeNode extends IWikiASTNode {
-    type: 'text';
     text: string;
+    type: 'text';
   }
   export interface ILinkParseTreeNode extends IWikiASTNode {
-    type: 'link';
     text: string;
+    type: 'link';
   }
-  export type HTMLTags = keyof HTMLElementTagNameMap
+  export type HTMLTags = keyof HTMLElementTagNameMap | 'strike';
+
   export interface IDomParseTreeNode extends IWikiASTNode {
-    type: 'element';
     tag: HTMLTags;
+    type: 'element';
+  }
+  export interface ICodeBlockParseTreeNode extends IWikiASTNode {
+    attributes: {
+      code?:
+        | {
+            type: 'string';
+            value: string;
+          }
+        | undefined;
+      language?:
+        | {
+            type: 'string';
+            value: string;
+          }
+        | undefined;
+    };
+    type: 'codeblock';
   }
-  export interface IMacroParamCallParseTreeNode extends IWikiASTNode {
+  export interface IMacroParameterCallParseTreeNode extends IWikiASTNode {
+    name?: string;
     type: 'macro-parameter';
     value: string;
-    name?: string;
   }
   export interface IMacroCallParseTreeNode extends IWikiASTNode {
-    type: 'macrocall';
     name: string;
-    params: IMacroParamCallParseTreeNode[];
+    params: IMacroParameterCallParseTreeNode[];
+    type: 'macrocall';
   }
   export interface ICustomParseTreeNode extends IWikiASTNode {
-    type: string;
+    params: IMacroParameterCallParseTreeNode[];
     tag?: string;
-    params: IMacroParamCallParseTreeNode[];
     text?: string;
+    type: string;
   }
-  export type IParseTreeNode = IDomParseTreeNode | IMacroParamCallParseTreeNode | IMacroCallParseTreeNode | ITextParseTreeNode | ICustomParseTreeNode;
+  export type IParseTreeNode = IDomParseTreeNode | IMacroParameterCallParseTreeNode | IMacroCallParseTreeNode | ITextParseTreeNode | ICustomParseTreeNode;
 }

package/src/filter-operator.d.ts

@@ -93,7 +93,10 @@ Either way, we could interpret the `!` flag on the filter, if present, to mean t
 As with [JavaScript Macros](#JavaScript%20Macros), filter operators should not make modifications to tiddlers, but only return a list of tiddlers or a tiddler iterator.
 
    */
-  export type IFilterOperator = (source: (iter: SourceIterator) => void, operator: IFilterOperatorParameterOperator) => string[] | ((iter: SourceIterator) => void);
+  export type IFilterOperator = (
+    source: (iter: SourceIterator) => void,
+    operator: IFilterOperatorParameterOperator,
+  ) => string[] | ((iter: SourceIterator) => void);
 
   /**
    * A [tiddler iterator](#Tiddler%20Iterators) representing the results of the previous filter step (or all tiddlers, if this filter appears first in an expression), conventionally named `source`.

package/src/index.d.ts

@@ -1,24 +1,19 @@
 /// <reference path="tw.d.ts" />
-
-export * from 'tiddlywiki';
+/// <reference path="server.d.ts" />
 
 import * as TW from 'tiddlywiki';
 
-import '@types/node';
+export * from 'tiddlywiki';
 declare global {
-    const $tw: TW.ITiddlyWiki;
-    // const Buffer: ?Buffer;
-    // const clearInterval: typeof global.clearInterval;
-    // const clearTimeout: typeof global.clearTimeout;
-    // const console: Console;
-    // const exports: TW.ITWModuleExports;
-    // const module: { exports: TW.ITWModuleExports; readonly id: string };
-    // const process: ?NodeJS.Process;
-    // const require: ITWRequire;
-    // const setInterval: typeof global.setInterval;
-    // const setTimeout: typeof global.setTimeout;
-}
-
-declare module '@types/tiddlywiki' {
-  export const TiddlyWiki: TW.TW5InitFunction;
+  const $tw: TW.ITiddlyWiki;
+  // const Buffer: ?Buffer;
+  // const clearInterval: typeof global.clearInterval;
+  // const clearTimeout: typeof global.clearTimeout;
+  // const console: Console;
+  // const exports: TW.ITWModuleExports;
+  // const module: { exports: TW.ITWModuleExports; readonly id: string };
+  // const process: ?NodeJS.Process;
+  // const require: ITWRequire;
+  // const setInterval: typeof global.setInterval;
+  // const setTimeout: typeof global.setTimeout;
 }

package/src/modules.d.ts

@@ -69,7 +69,7 @@ declare module 'tiddlywiki' {
      * @param {(title, moduleExports) => void} callback function called as callback(title,moduleExports) for each module
      * @memberof ITWModules
      */
-    forEachModuleOfType(moduleType: string, callback: (title, moduleExports) => void): void;
+    forEachModuleOfType(moduleType: string, callback: (title: string, moduleExports: unknown) => void): void;
     /** Get all the modules of a particular type in a hashmap by their `name` field */
     getModulesByTypeAsHashmap(moduleType: string, nameField: string): Record<string, IModuleInfo>;
     /** hashmap by module name of moduleInfo */

package/src/parser.d.ts

@@ -1,16 +1,18 @@
+/// <reference path="ast.d.ts" />
+
 declare module 'tiddlywiki' {
   export interface IParserOptions {
-    /**
-     * While calling `getCacheForTiddler`, use inlineParseTree or blockParseTree
-     */
-    parseAsInline?: boolean;
     /**
      * Optional source uri, used in parseText
      */
     _canonical_uri?: string;
+    /**
+     * While calling `getCacheForTiddler`, use inlineParseTree or blockParseTree
+     */
+    parseAsInline?: boolean;
   }
 
-  export declare class WikiParseRule {
+  export class WikiParseRule {
     is: { block?: boolean; inline?: boolean };
     match?: null;
     matchRegExp?: RegExp;
@@ -18,25 +20,18 @@ declare module 'tiddlywiki' {
     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;
+      /** `{ type: 'macro-parameter'; start: 276; value: '快速创建新笔记按钮'; end: 288 }` */
+      params: { end: number; start: number; type: string; value: string };
+      start: number;
+      type: 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 }[];
+  export class WikiParser {
+    blockRules: Array<{ matchIndex?: number; rule: WikiParseRule }>;
+    inlineRules: Array<{ matchIndex?: number; rule: WikiParseRule }>;
+    pragmaRules: Array<{ matchIndex?: number; rule: WikiParseRule }>;
     configTrimWhiteSpace: boolean;
     pos: number;
     source: string;

package/src/server.d.ts

@@ -0,0 +1,28 @@
+/// <reference path="Wiki.d.ts" />
+
+import type Http from 'http';
+
+declare module 'tiddlywiki' {
+  export interface IServerStatus {
+    anonymous: boolean;
+    read_only: boolean;
+    space: {
+      recipe: string;
+    };
+    tiddlywiki_version: string;
+    username: string;
+  }
+
+  export interface ServerEndpointContext {
+    data: string;
+    wiki: Wiki;
+  }
+  /**
+   * @link https://talk.tiddlywiki.org/t/what-is-the-state-in-server-route-handler/2877
+   */
+  export type ServerEndpointHandler<T = Record<string, any>> = (
+    request: Http.ClientRequest,
+    response: Http.ServerResponse,
+    context: ServerEndpointContext & T,
+  ) => void;
+}

package/src/tw.d.ts

@@ -8,6 +8,8 @@
 /// <reference path="parser.d.ts" />
 /// <reference path="ast.d.ts" />
 
+import { Server } from 'http';
+
 declare module 'tiddlywiki' {
   export interface IBootFilesIndexItem {
     filepath: string;
@@ -24,8 +26,6 @@ declare module 'tiddlywiki' {
     tiddlers: ITiddlerFields[];
   }
 
-  export class Server {}
-
   export interface IFileExtensionInfo {
     type: string;
   }
@@ -43,11 +43,11 @@ declare module 'tiddlywiki' {
 
     boot: {
       argv: string[];
+      boot(callback?: () => unknown): void;
       files: IBootFilesIndex;
       log(logString: string): void;
       logMessages: string[];
       startup(options: { callback?: () => unknown }): void;
-      boot(callback?: () => unknown): void;
       /** Default boot tasks */
       tasks: {
         readBrowserTiddlers: boolean;

package/src/utils.d.ts

@@ -8,6 +8,13 @@ declare module 'tiddlywiki' {
   export interface ITWUtils {
     Crypto: typeof Crypto;
     PasswordPrompt: typeof PasswordPrompt;
+    /**
+     * Alternative to `element.classList.add`, add a css class name to an element, see issue for detail.
+     * @link https://github.com/Jermolene/TiddlyWiki5/issues/6475
+     * @param element
+     * @param className
+     */
+    addClass(element: Element, className: string): void;
     /** Returns true if the version string A is greater than the version string B. Returns true if the versions are the same */
     checkVersions(versionStringA: string, versionStringB: string): boolean;
     /**
@@ -95,6 +102,7 @@ declare module 'tiddlywiki' {
     parseDate(value: string | Date): Date;
     /** Parse a block of name:value fields. The `fields` object is used as the basis for the return value */
     parseFields(text: string, fields?: object): object;
+    parseJSONSafe(input: string): any;
     /** Parse a string array from a bracketted list. For example "OneTiddler [[Another Tiddler]] LastOne" */
     parseStringArray(value: string | string[], allowDuplicate?: boolean): string[];
     /** Parse a semantic version string into its constituent parts -- see https://semver.org */

package/src/widget.d.ts

@@ -1,4 +1,13 @@
 declare module 'tiddlywiki' {
+  /**
+   * Parameter of Widget.refresh
+   * Key is tiddler title
+   */
+  export type IChangedTiddlers = Record<string, IChangedTiddlersMeta>;
+  export interface IChangedTiddlersMeta {
+    modified: boolean;
+  }
+
   // eslint-disable-next-line @typescript-eslint/no-extraneous-class
   class variablesConstructor {}
 
@@ -40,9 +49,7 @@ declare module 'tiddlywiki' {
      * @param changedTiddlers Object key is tiddler title, value is metadata about the change
      * @link https://tiddlywiki.com/dev/#Selective%20Update
      */
-    refresh(changedTiddlers: Record<string, {
-      modified: boolean
-    }>): boolean;
+    refresh(changedTiddlers: IChangedTiddlers): boolean;
     computeAttributes(): void;
     /**
      * Get parameters that user set in the widget