tw5-typed 0.3.0 → 0.3.2

package/package.json

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

package/src/boot/index.d.ts

@@ -4,10 +4,13 @@ declare module 'tiddlywiki' {
   export interface IBootFilesIndexItem {
     filepath: string;
     hasMetaFile: boolean;
-    tiddlerTitle: string;
+    isEditableFile: boolean;
     type: string;
   }
 
+  /**
+   * Key is `tiddlerTitle: string;`
+   */
   export type IBootFilesIndex = Record<string, IBootFilesIndexItem>;
 
   export interface IStartUpOption {

package/src/core.d.ts

@@ -82,12 +82,7 @@ declare module 'tiddlywiki' {
     loadTiddlersFromFile(
       filepath: string,
       defaultFields?: Record<string, unknown>,
-    ): {
-      filepath: string;
-      type: string;
-      tiddlers: ITiddlerFields[];
-      hasMetaFile: boolean;
-    };
+    ): ITiddlersInFile;
     loadMetadataForFile(filepath: string): ITiddlerFields | null;
     loadTiddlersFromPath(
       filepath: string,

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

@@ -37,6 +37,12 @@ declare module 'tiddlywiki' {
     encoding: string;
     filepath: string;
   }
+  export interface ITiddlersInFile {
+    filepath: string;
+    type: string;
+    tiddlers: ITiddlerFields[];
+    hasMetaFile: boolean;
+  }
   interface IUtils {
     /**
      * Generate the filepath for saving a tiddler

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

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

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

@@ -0,0 +1,23 @@
+declare module 'tiddlywiki' {
+  export class Logger {
+    new (): Logger;
+    setSaveBuffer(logger: Logger): void;
+    /**
+      Log a message
+    */
+    log: typeof console.log;
+    clearAlerts(): void;
+    getBuffer(): string;
+    table: typeof console.table;
+    /**
+      Alert a message
+    */
+    alert(...args: any[]): void;
+  }
+  interface IUtils {
+    /**
+     * A basic logging implementation
+     */
+    Logger: Logger;
+  }
+}

package/src/tiddler/index.d.ts

@@ -30,12 +30,20 @@ declare module 'tiddlywiki' {
     hasField(): boolean;
     isPlugin(): boolean;
     isDraft(): boolean;
-    getFieldStrings(field: string, defaultValue: string): string;
+    /**
+     * Stringify the field with the associated tiddler field module (if any)
+     */
+    getFieldString(field: string, defaultValue?: string): string;
+    /**
+      Get all the fields as a hashmap of strings. Options:
+      exclude: an array of field names to exclude
+    */
+    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[];
+    getFieldList(field: string, defaultValue?: string): string[];
     /**
     Get all the fields as a name:value block.
     @param options:
@@ -43,6 +51,6 @@ declare module 'tiddlywiki' {
     */
     getFieldStringBlock(options: { exclude?: string[] }): string;
 
-    isEqual(tiddler: Tiddler, excludeFields: string[]): boolean;
+    isEqual(tiddler: Tiddler, excludeFields?: string[]): boolean;
   }
 }

package/src/utils/index.d.ts

@@ -318,7 +318,7 @@ 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: (
@@ -457,5 +457,20 @@ declare module 'tiddlywiki' {
       context: IEvalContent,
       filename: string,
     ) => unknown;
+    /**
+     * Transliterate string to ASCII
+     * (Some pairs taken from http://semplicewebsites.com/ removing-accents-javascript)
+     */
+    transliterationPairs: Record<string, string>;
+    /**
+     * Remove any of the characters that are illegal in Windows filenames
+     * See `$tw.utils.transliterationPairs` for the list of replacements
+     */
+    transliterate: (str: string) => string;
+    /**
+     * Remove any of the characters that are illegal in Windows filenames
+     * See `$tw.utils.transliterationPairs` for the list of replacements
+     */
+    transliterateToSafeASCII: (str: string) => string;
   }
 }

package/src/wiki/index.d.ts

@@ -276,5 +276,6 @@ declare module 'tiddlywiki' {
     getTiddlerBacklinks(targetTitle: string): string[];
     getTiddlerLinks(title: string): string[];
     getPluginInfo(title: string): { tiddlers: Record<string, ITiddlerFields> };
+    getChangeCount(title: string): number;
   }
 }