tw5-typed 0.5.13 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tw5-typed",
-  "version": "0.5.13",
+  "version": "0.6.0",
   "scripts": {
     "check": "tsc --noEmit && eslint src/**/*.ts",
     "docs": "docs-ts",
@@ -23,6 +23,13 @@
     "url": "git+https://github.com/tiddly-gittly/tw5-typed.git"
   },
   "types": "src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.d.ts",
+      "require": "./src/index.d.ts",
+      "types": "./src/index.d.ts"
+    }
+  },
   "files": [
     "src/"
   ],

package/src/hooks.d.ts

@@ -69,7 +69,7 @@ declare module 'tiddlywiki' {
       callback: (props: {
         // eslint-disable-next-line @typescript-eslint/ban-types
         callback: Function;
-        file: { name: string; path?: string };
+        file: { lastModified?: number; lastModifiedDate?: Date; name: string; path?: string; size: number; type: string; webkitRelativePath?: string };
         isBinary: boolean;
         type: string;
       }) => boolean | undefined,
@@ -78,7 +78,7 @@ declare module 'tiddlywiki' {
     /**
      * Invoke the hook by key
      */
-    invokeHook(hookName: string, event: IWidgetEvent): undefined | IWidgetEvent | undefined;
+    invokeHook(hookName: string, event: IWidgetEvent): undefined | IWidgetEvent;
     // eslint-disable-next-line @typescript-eslint/ban-types
     names: Record<string, Function[]>;
   }

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

@@ -1,5 +1,18 @@
 declare module 'tiddlywiki' {
   /**
+   * # Usage
+   * 
+   * ```ts
+   * const yourFilter: IFilterOperator = (source,operator) => {
+   * 	var results = [];
+   * 	source(function(tiddler,title) {
+   * 	  if (!tiddler.fields['xxx']) return;
+   * 	  results.push(title);
+   * 	});
+   * 	return results;
+   * }
+   * ```
+   * 
    * # Overview
 
 Filter operators are modules (tiddlers of type `application/javascript`) with their `module-type` field set to `filteroperator`, exporting one or more functions implementing a filter.

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

@@ -1,3 +1,5 @@
+import { IParseTreeNode } from 'tiddlywiki';
+
 /**
  * A utility module for working with parse trees.
  * @description 用于处理解析树的实用程序模块。
@@ -78,4 +80,11 @@ declare module '$:/core/modules/utils/parsetree.js' {
    * @description 获取解析树节点或节点数组的文本。
    */
   export function getParseTreeText(tree: any): string;
+  /**
+   * Serialize parse tree.
+   * @param tree - The parse tree node or array of nodes.
+   * @returns The serialized parse tree.
+   * @description 序列化解析树。
+   */
+  export function serializeParseTree(tree: IParseTreeNode | IParseTreeNode[]): string;
 }

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

@@ -41,7 +41,7 @@ declare module '$:/core/modules/utils/parseutils.js' {
   export function parseStringLiteral(source: string, pos: number): { end: number; start: number; type: 'string'; value: string } | null;
 
   /**
-   * Returns an array of {name:} with an optional "default" property. Options include `requireParenthesis`.
+   * Returns an array of `{name:}` with an optional "default" property. Options include `requireParenthesis`.
    */
   export function parseParameterDefinition(parameterString: string, options?: { requireParenthesis?: boolean }): Array<{ default?: string; name: string }>;