tw5-typed 0.4.2 → 0.4.3

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -18,7 +18,7 @@
   ],
   "scripts": {
     "check": "tsc --noEmit && eslint src/**/*.ts",
-    "prepublishOnly": "npm run check"
+    "prepublishOnly": "tsc --noEmit"
   },
   "husky": {
     "hooks": {
@@ -36,6 +36,8 @@
   "devDependencies": {
     "@modern-js/eslint-config": "latest",
     "@modern-js/tsconfig": "latest",
+    "dprint": "^0.45.0",
+    "eslint-config-tidgi": "^1.1.5",
     "husky": "^8.0.2",
     "lint-staged": "^13.1.0",
     "rimraf": "^3.0.2",

package/src/core.d.ts

@@ -5,6 +5,7 @@
 /// <reference path="tiddler/index.d.ts" />
 /// <reference path="modules/index.d.ts" />
 /// <reference path="plugins/index.d.ts" />
+/// <reference path="modules/utils/dom/index.d.ts" />
 
 declare module 'tiddlywiki' {
   export interface IPluginInfo {
@@ -48,6 +49,7 @@ declare module 'tiddlywiki' {
     fakeDocument: IFakeDocument;
     passwordPrompt: PasswordPrompt;
     packageInfo: Record<string, unknown>;
+    modal: IModal;
 
     /**
      * 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/utils/{dom.d.ts → dom/dom.d.ts}

@@ -115,7 +115,10 @@ declare module '$:/core/modules/utils/dom.js' {
    * @param srcWindow The source window to get the scroll position from, defaults to the current window if not specified.
    * @returns An object with 'x' and 'y' properties representing the horizontal and vertical scroll positions in pixels.
    */
-  export function getScrollPosition(srcWindow?: Window): { x: number; y: number; };
+  export function getScrollPosition(srcWindow?: Window): {
+    x: number;
+    y: number;
+  };
 
   /**
    * Adjusts the height of a textarea to fit its content, preserving scroll position, and returns the new height.
@@ -123,14 +126,24 @@ declare module '$:/core/modules/utils/dom.js' {
    * @param minHeight The minimum height to use for the textarea.
    * @returns The new height of the textarea.
    */
-  export function resizeTextAreaToFit(domNode: HTMLTextAreaElement, minHeight: string): number;
+  export function resizeTextAreaToFit(
+    domNode: HTMLTextAreaElement,
+    minHeight: string,
+  ): number;
 
   /**
    * Gets the bounding rectangle of an element in absolute page coordinates.
    * @param element The element to get the bounding rectangle for.
    * @returns An object representing the bounding rectangle with properties: left, width, right, top, height, bottom.
    */
-  export function getBoundingPageRect(element: Element): { left: number; width: number; right: number; top: number; height: number; bottom: number; };
+  export function getBoundingPageRect(element: Element): {
+    left: number;
+    width: number;
+    right: number;
+    top: number;
+    height: number;
+    bottom: number;
+  };
 
   /**
    * Saves a named password in the browser.
@@ -185,7 +198,10 @@ declare module '$:/core/modules/utils/dom.js' {
    * @param options Options for copying, including 'doNotNotify' to suppress notifications.
    * @returns True if the operation succeeded, otherwise false.
    */
-  export function copyToClipboard(text: string, options?: { doNotNotify?: boolean }): boolean;
+  export function copyToClipboard(
+    text: string,
+    options?: { doNotNotify?: boolean },
+  ): boolean;
 
   /**
    * Gets the path part of the current location.
@@ -200,7 +216,11 @@ declare module '$:/core/modules/utils/dom.js' {
    * @param event The event object.
    * @returns An object containing variables derived from the DOM and event.
    */
-  export function collectDOMVariables(selectedNode: Element, domNode: Element, event: Event): Record<string, string>;
+  export function collectDOMVariables(
+    selectedNode: Element,
+    domNode: Element,
+    event: Event,
+  ): Record<string, string>;
 
   /**
    * Safely executes a querySelector, avoiding exceptions on invalid selectors.
@@ -208,7 +228,10 @@ declare module '$:/core/modules/utils/dom.js' {
    * @param baseElement The base element to start the query from, defaults to document.
    * @returns The first element matching the selector, or null if none are found or the selector is invalid.
    */
-  export function querySelectorSafe(selector: string, baseElement?: Element): Element | null;
+  export function querySelectorSafe(
+    selector: string,
+    baseElement?: Element,
+  ): Element | null;
 
   /**
    * Safely executes a querySelectorAll, avoiding exceptions on invalid selectors.
@@ -216,18 +239,8 @@ declare module '$:/core/modules/utils/dom.js' {
    * @param baseElement The base element to start the query from, defaults to document.
    * @returns A NodeList of elements matching the selector, or an empty NodeList if none are found or the selector is invalid.
    */
-  export function querySelectorAllSafe(selector: string, baseElement?: Element): NodeList;
-
-  /**
-   * Notifier mechanism
-   */
-  export class Notifier {
-    /**
-     * Display a notification
-     * * title: Title of tiddler containing the notification text
-     * * options: see below
-     * Options include:
-     */
-    display(title: string, options?: Record<string, unknown>): void;
-  }
+  export function querySelectorAllSafe(
+    selector: string,
+    baseElement?: Element,
+  ): NodeList;
 }

package/src/modules/utils/dom/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="notifier.d.ts" />
+/// <reference path="dom.d.ts" />
+/// <reference path="modal.d.ts" />

package/src/modules/utils/dom/modal.d.ts

@@ -0,0 +1,24 @@
+/// <reference path="../../widgets/index.d.ts" />
+
+declare module 'tiddlywiki' {
+  export interface IModal {
+    adjustPageClass: () => void;
+    /**
+     *
+     * @param title
+     * @param options
+     * variables: optional hashmap of variables to wrap around the widget
+     * downloadLink: normally is used for "Right-click to save changes"
+     */
+    display: (
+      title: string,
+      options?: {
+        downloadLink?: string;
+        event?: IWidgetEvent;
+        variables?: unknown;
+      },
+    ) => void;
+
+    // new (wiki: Wiki): ModalWidget;
+  }
+}

package/src/modules/utils/dom/notifier.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Notifier mechanism
+ */
+declare module 'tiddlywiki' {
+  export interface Notifier {
+    /**
+     * Display a notification
+     * * title: Title of tiddler containing the notification text
+     * * options: see below
+     * Options include:
+     */
+    display(title: string, options?: Record<string, unknown>): void;
+  }
+}

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

@@ -1,4 +1,3 @@
-/// <reference path="dom.d.ts" />
 /// <reference path="utils.d.ts" />
 /// <reference path="fakedom.d.ts" />
 /// <reference path="filesystem.d.ts" />

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

@@ -123,7 +123,7 @@ declare module 'tiddlywiki' {
      * @en
      * Initialise widget properties. These steps are pulled out of the constructor so that we can reuse them in subclasses
      * @zh
-     * 初始化widget属性。这些步骤被拉出构造函数，以便我们可以在子类中重复使用它们
+     * 初始化 widget 属性。这些步骤被拉出构造函数，以便我们可以在子类中重复使用它们
      */
     initialise(
       parseTreeNode: IParseTreeNode,
@@ -134,7 +134,7 @@ declare module 'tiddlywiki' {
      * @en
      * Lifecycle method: Render this widget into the DOM
      * @zh
-     * 生命周期方法: 将这个微件渲染到DOM中;
+     * 生命周期方法：将这个微件渲染到 DOM 中;
      * 只会在首次渲染、销毁后重新渲染时自动调用，或者通过 refreshSelf 等方法主动调用
      */
     render(parent: Element, nextSibling: Element | null): void;
@@ -307,7 +307,7 @@ declare module 'tiddlywiki' {
      * options include:
      * * `excludeEventAttributes`: ignores attributes whose name begins with "on"
      * @zh
-     * 将微件的计算属性分配给一个domNode, 选项包括:
+     * 将微件的计算属性分配给一个 domNode, 选项包括:
      * * `excludeEventAttributes`: 忽略名称以 "on "开头的属性
      * 一些特殊的属性：
      * * `xlink:<xlink-name>`
@@ -476,31 +476,10 @@ declare module 'tiddlywiki' {
      * 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;
   }
-
-  export type ModalWidget = {
-    adjustPageClass: () => void;
-    /**
-     *
-     * @param title
-     * @param options
-     * variables: optional hashmap of variables to wrap around the widget
-     * downloadLink: normally is used for "Right-click to save changes"
-     */
-    display: (
-      title: string,
-      options?: {
-        downloadLink?: string;
-        event?: IWidgetEvent;
-        variables?: unknown;
-      },
-    ) => void;
-
-    new (wiki: Wiki): ModalWidget;
-  };
 }
 
 declare module '$:/core/modules/widgets/widget.js' {

package/src/utils/index.d.ts

@@ -1,6 +1,7 @@
 /// <reference path="Crypto.d.ts" />
 /// <reference path="PasswordPrompt.d.ts" />
 
+
 type OptionalPropertyNames<T> = {
   [K in keyof T]-?: {} extends { [P in K]: T[K] } ? K : never;
 }[keyof T];
@@ -253,7 +254,7 @@ declare module 'tiddlywiki' {
      * @en
      * Convert a URIComponent encoded string to a string safely
      * @zh
-     * 将一个URIComponent编码的字符串安全地转换为一个字符串。
+     * 将一个 URIComponent 编码的字符串安全地转换为一个字符串。
      */
     decodeURIComponentSafe: (uri: string) => string;
 
@@ -261,7 +262,7 @@ declare module 'tiddlywiki' {
      * @en
      * Convert a URI encoded string to a string safely
      * @zh
-     * 将一个URI编码的字符串安全地转换为一个字符串
+     * 将一个 URI 编码的字符串安全地转换为一个字符串
      */
     decodeURISafe: (uri: string) => string;
 
@@ -277,7 +278,7 @@ declare module 'tiddlywiki' {
      * @en
      * Get the browser location.hash. We don't use location.hash because of the way that Firefox auto-urldecodes it (see http://stackoverflow.com/questions/1703552/encoding-of-window-location-hash)
      * @zh
-     * 获取浏览器的location.hash。我们不使用location.hash，因为Firefox的自动解码方式（见http://stackoverflow.com/questions/1703552/encoding-of-window-location-hash）。
+     * 获取浏览器的 location.hash。我们不使用 location.hash，因为 Firefox 的自动解码方式（见 http://stackoverflow.com/questions/1703552/encoding-of-window-location-hash）。
      */
     getLocationHash: () => string;
 
@@ -285,7 +286,7 @@ declare module 'tiddlywiki' {
      * @en
      * Pad a string to a given length with "0"s. Length defaults to 2
      * @zh
-     * 用 "0 "将一个字符串填充到指定的长度。长度默认为2
+     * 用 "0 "将一个字符串填充到指定的长度。长度默认为 2
      */
     pad: (value: number, length?: number) => string;
 
@@ -293,7 +294,7 @@ declare module 'tiddlywiki' {
      * @en
      * Convert a date into UTC `YYYYMMDDHHMMSSmmm` format
      * @zh
-     * 将日期转换成UTC `YYYYMMDDHMMSSmmm` 格式
+     * 将日期转换成 UTC `YYYYMMDDHMMSSmmm` 格式
      */
     stringifyDate: (value: Date) => string;
 
@@ -301,7 +302,7 @@ declare module 'tiddlywiki' {
      * @en
      * Parse a date from a UTC `YYYYMMDDHHMMSSmmm` format string
      * @zh
-     * 从UTC `YYYYMMDDHHMMSSmmm` 格式字符串中解析一个日期
+     * 从 UTC `YYYYMMDDHHMMSSmmm` 格式字符串中解析一个日期
      */
     parseDate: (value: string | Date) => Date | null;
 
@@ -309,7 +310,7 @@ declare module 'tiddlywiki' {
      * @en
      * Stringify an array of tiddler titles into a list string
      * @zh
-     * 将一个数组的tiddler标题字符串化为一个列表字符串
+     * 将一个数组的 tiddler 标题字符串化为一个列表字符串
      */
     stringifyList: (value: string[]) => string;
 
@@ -330,7 +331,7 @@ declare module 'tiddlywiki' {
      * @en
      * Parse a block of name:value fields. The `fields` object is used as the basis for the return value
      * @zh
-     * 解析一个name:value字段的块。`fields`对象被用作返回值的基础。
+     * 解析一个 name:value 字段的块。`fields`对象被用作返回值的基础。
      */
     parseFields: (text: string, fields?: object) => Record<string, string>;
 
@@ -376,8 +377,8 @@ declare module 'tiddlywiki' {
      * Returns +1 if the version string A is greater than the version string B, 0 if they are the same, and +1 if B is greater than A.
      * Missing or malformed version strings are parsed as 0.0.0
      * @zh
-     * 如果版本字符串A大于版本字符串B，则返回+1；如果它们相同，则返回0；如果B大于A，则返回+1；
-     * 缺失或畸形的版本字符串被解析为0.0.0
+     * 如果版本字符串 A 大于版本字符串 B，则返回 +1；如果它们相同，则返回 0；如果 B 大于 A，则返回 +1；
+     * 缺失或畸形的版本字符串被解析为 0.0.0
      */
     compareVersions: (
       versionStringA: string,
@@ -388,7 +389,7 @@ declare module 'tiddlywiki' {
      * @en
      * Returns true if the version string A is greater than the version string B. Returns true if the versions are the same
      * @zh
-     * 如果版本字符串A大于版本字符串B，返回true；如果版本相同，返回true。
+     * 如果版本字符串 A 大于版本字符串 B，返回 true；如果版本相同，返回 true。
      */
     checkVersions: (versionStringA: string, versionStringB: string) => boolean;
 
@@ -430,7 +431,7 @@ declare module 'tiddlywiki' {
      * @en
      * Given an extension, get the correct encoding for that file. defaults to utf8
      * @zh
-     * 给定一个扩展名，获得该文件的正确编码。 默认为utf8
+     * 给定一个扩展名，获得该文件的正确编码。默认为 utf8
      */
     getTypeEncoding: (extension: string) => string;