tw5-typed 0.4.3 → 0.4.4

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "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' {
   /**

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 {