tw5-typed 0.4.3 → 0.4.5

package/package.json

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

package/src/core.d.ts

@@ -21,6 +21,12 @@ declare module 'tiddlywiki' {
     getString(key: string, options: { variables: { title: string } }): string;
   }
 
+  export interface IMacro {
+    name: string;
+    params: Array[];
+    run: Function;
+  }
+
   export type IWikiInfo = Record<string, unknown>;
 
   export interface ITiddlyWiki {
@@ -50,6 +56,8 @@ declare module 'tiddlywiki' {
     passwordPrompt: PasswordPrompt;
     packageInfo: Record<string, unknown>;
     modal: IModal;
+    keyboardManager: KeyboardManager;
+    macros: Record<string, IMacro>;
 
     /**
      * 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.

package/src/modules/index.d.ts

@@ -7,6 +7,7 @@
 /// <reference path="parsers/index.d.ts" />
 /// <reference path="syncer/syncAdaptor.d.ts" />
 /// <reference path="syncer/syncer.d.ts" />
+/// <reference path="keyboard.d.ts" />
 
 declare module 'tiddlywiki' {
   export interface ITWModuleExports {

package/src/modules/keyboard.d.ts

@@ -0,0 +1,49 @@
+declare module 'tiddlywiki' {
+  // 定义键盘事件信息的接口
+  export interface KeyInfo {
+    keyCode: number;
+    shiftKey: boolean;
+    altKey: boolean;
+    ctrlKey: boolean;
+    metaKey: boolean;
+  }
+
+  // 定义键盘管理器类的接口
+  export interface KeyboardManager {
+    namedKeys: Record<string, number>;
+    keyNames: string[];
+    metaKeyName: string;
+    shortcutKeysList: string[];
+    shortcutActionList: string[];
+    shortcutParsedList: (KeyInfo[] | undefined)[];
+    shortcutPriorityList: boolean[];
+    lookupNames: string[];
+    getModifierKeys: () => number[];
+    parseKeyDescriptor: (
+      keyDescriptor: string,
+      options?: { keyDescriptor?: string },
+    ) => KeyInfo | null;
+    parseKeyDescriptors: (
+      keyDescriptors: string[] | string,
+      options?: { stack?: string[]; wiki?: any },
+    ) => KeyInfo[];
+    getPrintableShortcuts: (keyInfoArray: KeyInfo[]) => string[];
+    checkKeyDescriptor: (event: any, keyInfo: KeyInfo) => boolean;
+    checkKeyDescriptors: (event: any, keyInfoArray: KeyInfo[]) => boolean;
+    getMatchingKeyDescriptor: (
+      event: any,
+      keyInfoArray: KeyInfo[],
+    ) => KeyInfo | null;
+    getEventModifierKeyDescriptor: (event: any) => string;
+    getShortcutTiddlerList: () => string[];
+    updateShortcutLists: (tiddlerList: string[]) => void;
+    handleKeydownEvent: (
+      event: any,
+      options?: { onlyPriority?: boolean },
+    ) => boolean;
+    detectNewShortcuts: (
+      changedTiddlers: Record<string, any>,
+    ) => boolean | string[];
+    handleShortcutChanges: (changedTiddlers: Record<string, any>) => void;
+  }
+}

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

@@ -0,0 +1,16 @@
+declare module 'tiddlywiki' {
+  export class EditWidget extends Widget {
+    editTitle: string;
+    editField: string;
+    editIndex: string;
+    editClass: string;
+    editPlaceholder: string;
+    editTabIndex: string;
+    editFocus: string;
+    editCancelPopups: string;
+    editInputActions: string;
+    editRefreshTitle: string;
+    editAutoComplete: string;
+    editorType: string;
+  }
+}

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

@@ -1,4 +1,5 @@
 /// <reference path="./navigator.d.ts" />
+/// <reference path="./edit.d.ts" />
 
 declare module 'tiddlywiki' {
   /**
@@ -387,7 +388,10 @@ declare module 'tiddlywiki' {
     ): void;
 
     /**
-     * Add an event listener
+     * Add an event listener.
+     * If the handler is sync, then should return a boolean, `false` means the event is handled and don't propagate, and `true` will be dispatched to the parent widget.
+     * If the handler is async, then it is always propagate to the parent widget.
+     * @returns should propagate to parent widget
      */
     addEventListener(
       type: string,
@@ -398,7 +402,7 @@ declare module 'tiddlywiki' {
      * Dispatch an event to a widget. If the widget doesn't handle the event then it is also dispatched to the parent widget
      * Events added via `addEventListener`, like `tm-notify`, can be invoked by this.
      */
-    dispatchEvent(typeOrEvent: string | Omit<IWidgetEvent, 'widget'>): void;
+    dispatchEvent(widgetEvent: Omit<IWidgetEvent, 'widget'> & { widget?: IWidgetEvent['widget'] }): void;
 
     /**
      * Rebuild a previously rendered widget
@@ -471,13 +475,6 @@ declare module 'tiddlywiki' {
       variables: Record<string, IWidgetVariable>,
     ): boolean;
 
-    /**
-     * The destroy method will be called by parent widget.
-     * If you widget don't have any child widget, you can just write your own tear down logic. If it may have some child widget, don't forget to call original destroy method in the Widget class to destroy children widgets.
-     * @version >=5.3.0
-     * @url https://tiddlywiki.com/dev/#Widget%20%60destroy%60%20method%20examples
-     */
-    destroy(): void;
     removeLocalDomNodes(): void;
   }
 }

package/src/tiddler/index.d.ts

@@ -11,6 +11,7 @@ declare module 'tiddlywiki' {
     readonly text: string;
     readonly title: string;
     readonly type: string;
+    readonly 'color-scheme': 'dark' | 'light';
   }
 
   export class Tiddler {