tw5-typed 0.2.7 → 0.2.8

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -21,9 +21,9 @@
   },
   "devDependencies": {
     "@types/node": "^17.0.31",
-    "@typescript-eslint/eslint-plugin": "5.21.0",
-    "@typescript-eslint/parser": "5.21.0",
-    "eslint": "8.14.0",
+    "@typescript-eslint/eslint-plugin": "5.22.0",
+    "@typescript-eslint/parser": "5.22.0",
+    "eslint": "8.15.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard": "17.0.0",
     "eslint-config-standard-with-typescript": "21.0.1",

package/src/Wiki.d.ts

@@ -122,7 +122,20 @@ declare module 'tiddlywiki' {
      * @param {object} options options, see tiddlywiki dev doc for details
      */
     setText: (title: string, field?: string, index?: string | undefined, value?: string, options?: { suppressTimestamp?: boolean }) => void;
+    /**
+      Parse a tiddler according to its MIME type
+    */
     parseTiddler(title: string, options?: IParserOptions): WikiParser;
+    /**
+      Parse a block of text of a specified MIME type
+      @param {string} type: content type of text to be parsed
+      @param {string} text: text
+      @param {object}options: see below
+
+    Options include:
+      - 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;
     /**
       Parse text from a tiddler and render it into another format

package/src/ast.d.ts

@@ -3,7 +3,7 @@ declare module 'tiddlywiki' {
     end?: number;
     name?: string;
     start?: number;
-    type: 'string' | 'number';
+    type: 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
     value: string;
   }
 
@@ -42,19 +42,15 @@ declare module 'tiddlywiki' {
   }
   export interface ICodeBlockParseTreeNode extends IWikiASTNode {
     attributes: {
-      code?:
-        | {
-            type: 'string';
-            value: string;
-          }
-        | undefined;
-      language?:
-        | {
-            type: 'string';
-            value: string;
-          }
-        | undefined;
-    };
+      code?: {
+        type: 'string';
+        value: string;
+      };
+      language?: {
+        type: 'string';
+        value: string;
+      };
+    } & IWikiASTNode['attributes'];
     type: 'codeblock';
   }
   export interface IMacroParameterCallParseTreeNode extends IWikiASTNode {
@@ -81,5 +77,7 @@ declare module 'tiddlywiki' {
     | IImageParseTreeNode
     | ITranscludeParseTreeNode
     | ITiddlerParseTreeNode
+    | ICodeBlockParseTreeNode
+    | ILinkParseTreeNode
     | ICustomParseTreeNode;
 }

package/src/server.d.ts

@@ -81,6 +81,11 @@ declare module 'tiddlywiki' {
       prefix: optional prefix (falls back to value of "path-prefix" variable)
       */
     listen(port?: string, host?: string, prefix?: string): void;
+
+    on(eventName: 'error', callback: (error: Error) => void): void;
+    on(eventName: 'listening', callback: () => void): void;
+    on(eventName: string, callback: (...arguments_: unknown[]) => unknown): void;
+
     /**
       Check whether a given user is authorized for the specified authorizationType ("readers" or "writers"). Pass null or undefined as the username to check for anonymous access
     */

package/src/tw.d.ts

@@ -63,6 +63,12 @@ declare module 'tiddlywiki' {
 
     config: ITWConfig;
 
+    /**
+     * Check for this window being the source of the drag. If true, some drop target widget will stop responding to the drop event, so you can handle drop event in your own widget.
+     * Used by `DropZoneWidget.prototype.handleDropEvent`
+     */
+    dragInProgress?: boolean;
+
     /**
       Global Hooks mechanism which allows plugins to modify default functionality
     */
@@ -77,9 +83,11 @@ declare module 'tiddlywiki' {
       */
       invokeHook(hookName: string, event: IWidgetEvent): undefined | IWidgetEvent;
     };
-
+    /** Determines if a tiddler is a shadow tiddler, regardless of whether it has been overridden by a real tiddler */
+    isShadowTiddler(title: string): boolean;
     language: ILanguage;
     modules: ITWModules;
+
     /** NodeJS features, if tw isn't running on a NodeJS environment, the value will be `null` */
     node: null | object;
     /** Broswer features, if tw isn't running on a browser environment, the value will be `null` */
@@ -96,6 +104,8 @@ declare module 'tiddlywiki' {
 
     rootWidget: Widget;
 
+    /** Test for the existence of a tiddler (excludes shadow tiddlers) */
+    tiddlerExists(title: string): boolean;
     utils: ITWUtils;
     version: string;
     wiki: Wiki;