tw5-typed 0.2.27 → 0.3.0

package/package.json

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

package/src/boot/config.d.ts

@@ -53,4 +53,29 @@ declare module 'tiddlywiki' {
     htmlUnsafeElements: string[];
     [configName: string]: any;
   }
+
+  export interface ITiddlyWikiInfoJSON {
+    description: string
+    plugins: string[]
+    themes: string[]
+    languages: any[]
+    build: ITiddlyWikiInfoJSONBuild
+    config: ITiddlyWikiInfoJSONConfig
+  }
+  
+  export interface ITiddlyWikiInfoJSONBuild {
+    index: string[]
+    empty: string[]
+    encrypted: string[]
+    favicon: string[]
+    readmes: string[]
+    tw2: string[]
+    static: string[]
+    "external-js": string[]
+  }
+  
+  export interface ITiddlyWikiInfoJSONConfig {
+    "retain-original-tiddler-path": boolean
+  }
+  
 }

package/src/boot/index.d.ts

@@ -28,5 +28,11 @@ declare module 'tiddlywiki' {
       trapErrors: boolean;
     };
     excludeRegExp: RegExp;
+    /** Exist in nodejs wiki, Load the tiddlers from the wiki directory */
+    wikiInfo?: ITiddlyWikiInfoJSON;
+    /** Exist in nodejs wiki, absolute path of wiki root folder */
+    wikiPath?: string;
+    /** Exist in nodejs wiki, usually is `./tiddlers` */
+    wikiTiddlersPath?: string;
   }
 }

package/src/core.d.ts

@@ -7,6 +7,7 @@
 /// <reference path="plugins/index.d.ts" />
 
 declare module 'tiddlywiki' {
+
   export interface IPluginInfo {
     version: string;
     'plugin-type': string;
@@ -42,6 +43,7 @@ declare module 'tiddlywiki' {
     fakeDocument: IFakeDocument;
     passwordPrompt: PasswordPrompt;
     packageInfo: Record<string, unknown>;
+    syncadaptor: SyncAdaptor;
 
     /**
      * 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

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

package/src/modules/syncer/syncAdaptor.d.ts

@@ -0,0 +1,13 @@
+declare module 'tiddlywiki' {
+  export abstract class SyncAdaptor {
+    name: string;
+    supportsLazyLoading: boolean;
+    isReady(): boolean;
+    getTiddlerInfo(title: string): IBootFilesIndexItem;
+    getTiddlerFileInfo(
+      title: string,
+      callback: (error: null, fileInfo: IFileInfo) => void,
+    ): void;
+    wiki: Wiki;
+  }
+}

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

@@ -1,25 +1,5 @@
-declare const addClass: (element: Element, className: string) => void;
-declare const addEventListeners: (
-  domNode: Element,
-  events: {
-    handlerFunction?: (event: MouseEvent) => void;
-    handlerMethod?: string;
-    handlerObject?: Widget;
-    name: string;
-  }[],
-) => void;
-
-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;
-}
-
 declare module 'tiddlywiki' {
+  import { addClass, addEventListeners } from '$:/core/modules/utils/dom.js';
   interface IUtils {
     /**
      * Alternative to `element.classList.add`, add a css class name to an element, see issue for detail.
@@ -44,8 +24,28 @@ declare module 'tiddlywiki' {
      */
     Notifier: typeof Notifier;
   }
+  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;
+  }
 }
 
 declare module '$:/core/modules/utils/dom.js' {
-  export { addClass, addEventListeners, Notifier };
+  import { Widget, Notifier } from 'tiddlywiki';
+  export const addClass: (element: Element, className: string) => void;
+  export const addEventListeners: (
+    domNode: Element,
+    events: {
+      handlerFunction?: (event: MouseEvent) => void;
+      handlerMethod?: string;
+      handlerObject?: Widget;
+      name: string;
+    }[],
+  ) => void;
+  export { Notifier }
 }

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

@@ -1,19 +1,42 @@
-declare const generateTiddlerFilepath: (
-  title: string,
-  options?: {
-    directory?: string;
-    extension?: string;
-    fileInfo?: {
-      originalpath?: string;
-      filePath?: string;
-      writeError?: boolean;
-    };
-    pathFilters?: string[];
-    wiki?: Wiki;
-  },
-) => string;
+declare module '$:/core/modules/utils/utils.js' {
+  import { IFileInfo, Tiddler, Wiki } from 'tiddlywiki';
+
+  export const generateTiddlerFilepath: (
+    title: string,
+    options?: {
+      directory?: string;
+      extension?: string;
+      fileInfo?: {
+        originalpath?: string;
+        filePath?: string;
+        writeError?: boolean;
+      };
+      pathFilters?: string[];
+      wiki?: Wiki;
+    },
+  ) => string;
+  export function generateTiddlerFileInfo(
+    tiddler: Tiddler,
+    options: {
+      directory?: string;
+      pathFilters?: string[];
+      extFilters?: string[];
+      wiki?: Wiki;
+      fileInfo?: IFileInfo;
+    },
+  ): IFileInfo;
+}
 
 declare module 'tiddlywiki' {
+  import { generateTiddlerFileInfo, generateTiddlerFilepath } from '$:/core/modules/utils/utils.js';
+  export interface IFileInfo {
+    isEditableFile: boolean;
+    originalpath: string;
+    type: string;
+    hasMetaFile: boolean;
+    encoding: string;
+    filepath: string;
+  }
   interface IUtils {
     /**
      * Generate the filepath for saving a tiddler
@@ -25,9 +48,19 @@ declare module 'tiddlywiki' {
      * * fileInfo: an existing fileInfo object to check against
      */
     generateTiddlerFilepath: typeof generateTiddlerFilepath;
+    /**
+    Create a fileInfo object for saving a tiddler:
+      filepath: the absolute path to the file containing the tiddler
+      type: the type of the tiddler file on disk (NOT the type of the tiddler)
+      hasMetaFile: true if the file also has a companion .meta file
+      isEditableFile: true if the tiddler was loaded via non-standard options & marked editable
+    Options include:
+      directory: absolute path of root directory to which we are saving
+      pathFilters: optional array of filters to be used to generate the base path
+      extFilters: optional array of filters to be used to generate the base path
+      wiki: optional wiki for evaluating the pathFilters,
+      fileInfo: an existing fileInfo to check against
+    */
+    generateTiddlerFileInfo: typeof generateTiddlerFileInfo;
   }
 }
-
-declare module '$:/core/modules/utils/utils.js' {
-  export { generateTiddlerFilepath };
-}

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

@@ -1,8 +1,6 @@
-declare const count: (object: object) => number;
-declare const hashString: (str: string) => number;
-declare const formatDateString: (date: Date, format: string) => string;
 
 declare module 'tiddlywiki' {
+  import { formatDateString, hashString, count } from "$:/core/modules/utils/utils.js";
   interface IUtils {
     /**
      * @en
@@ -21,5 +19,7 @@ declare module 'tiddlywiki' {
 }
 
 declare module '$:/core/modules/utils/utils.js' {
-  export { count, formatDateString, hashString };
+  export const count: (object: object) => number;
+  export const hashString: (str: string) => number;
+  export const formatDateString: (date: Date, format: string) => string;
 }

package/src/tiddler/index.d.ts

@@ -26,7 +26,22 @@ declare module 'tiddlywiki' {
      */
     constructor(...tiddlers: Array<Record<string, unknown> | Tiddler>);
 
-    hasField(field: string): boolean;
+    hasTag(field: string): boolean;
+    hasField(): boolean;
+    isPlugin(): boolean;
+    isDraft(): boolean;
+    getFieldStrings(field: string, defaultValue: string): string;
+    getFieldDay(field: string): string;
+    /**
+      Get the value of a field as a list
+    */
+    getFieldList(field: string, defaultValue: string): string[];
+    /**
+    Get all the fields as a name:value block.
+    @param options:
+      - exclude: an array of field names to exclude
+    */
+    getFieldStringBlock(options: { exclude?: string[] }): string;
 
     isEqual(tiddler: Tiddler, excludeFields: string[]): boolean;
   }

package/src/utils/index.d.ts

@@ -318,11 +318,13 @@ declare module 'tiddlywiki' {
      * Parse a string array from a bracketted list. For example `OneTiddler [[Another Tiddler]] LastOne`
      * @zh
      * 从一个带括号的列表中解析一个字符串数组。例如，`OneTiddler [[Another Tiddler]] LastOne`
+     * 
+     * @returns {string[]} An array of tiddler titles. null if input is not string or string array. This won't happened in TS.
      */
     parseStringArray: (
       value: string | string[],
       allowDuplicate?: boolean,
-    ) => string[] | null;
+    ) => string[];
 
     /**
      * @en

package/src/wiki/index.d.ts

@@ -78,6 +78,18 @@ declare module 'tiddlywiki' {
      * Returns a function iterator(callback) that iterates through the specified titles, and invokes the callback with callback(tiddler,title)
      */
     makeTiddlerIterator(titles: string[]): SourceIterator;
+    /**
+     * You can use this with `makeTiddlerIterator`:
+     * 
+     * ```js
+     * $tw.wiki.filterTiddlers(filter, undefined, $tw.wiki.makeTiddlerIterator(['title']))
+     * ```
+     * 
+     * This calls `compileFilter`
+     * @param filterString 
+     * @param widget 
+     * @param source 
+     */
     filterTiddlers(
       filterString: string,
       widget?: Widget,