tw5-typed 0.3.6 → 0.3.7

package/package.json

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

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

@@ -71,7 +71,7 @@ declare module 'tiddlywiki' {
   export class Widget {
     parseTreeNode: IParseTreeNode;
 
-    wiki: ITiddlyWiki;
+    wiki: Wiki;
 
     document: IFakeDocument;
 

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

@@ -8,28 +8,45 @@ declare module 'tiddlywiki' {
       oldTitle: string,
       newTitle: string,
     ): void;
-    addToStory(title: string, fromTitle: string): void;
-    addToHistory(title: string, fromPageRect): void;
-    handleNavigateEvent(event: Event): void;
-    handleCloseTiddlerEvent(event: Event): void;
-    handleCloseAllTiddlersEvent(event: Event): void;
-    handleCloseOtherTiddlersEvent(event: Event): void;
-    handleEditTiddlerEvent(event: Event): void;
-    handleDeleteTiddlerEvent(event: Event): void;
+    addToStory(title: string, fromTitle?: string): void;
+    /**
+      Add a new record to the top of the history stack
+      title: a title string or an array of title strings
+      fromPageRect: page coordinates of the origin of the navigation
+    */
+    addToHistory(title: string, fromPageRect?: DOMRect): void;
+    handleNavigateEvent(event: IWidgetEvent): void;
+    handleCloseTiddlerEvent(event: IWidgetEvent): void;
+    handleCloseAllTiddlersEvent(event: IWidgetEvent): void;
+    handleCloseOtherTiddlersEvent(event: IWidgetEvent): void;
+    handleEditTiddlerEvent(event: IWidgetEvent): void;
+    handleDeleteTiddlerEvent(event: IWidgetEvent): void;
     makeDraftTiddler(targetTitle): void;
     generateDraftTitle(title): void;
-    handleSaveTiddlerEvent(event: Event): void;
-    handleCancelTiddlerEvent(event: Event): void;
-    handleNewTiddlerEvent(event: Event): void;
-    handleImportTiddlersEvent(event: Event): void;
-    handlePerformImportEvent(event: Event): void;
-    handleFoldTiddlerEvent(event: Event): void;
-    handleFoldOtherTiddlersEvent(event: Event): void;
-    handleFoldAllTiddlersEvent(event: Event): void;
-    handleUnfoldAllTiddlersEvent(event: Event): void;
+    handleSaveTiddlerEvent(event: IWidgetEvent): void;
+    handleCancelTiddlerEvent(event: IWidgetEvent): void;
+    /**
+     * Create a new draft tiddler
+     * event.param can either be the title of a template tiddler, or a hashmap of fields.
+     * The title of the newly created tiddler follows these rules:
+     * * If a hashmap was used and a title field was specified, use that title
+     * * If a hashmap was used without a title field, use a default title, if necessary making it unique with a      *numeric suffix
+     * * If a template tiddler was used, use the title of the template, if necessary making it unique with a      *numeric suffix
+     * If a draft of the target tiddler already exists then it is reused
+     */
+    handleNewTiddlerEvent(event: IWidgetEvent): void;
+    /**
+     * Import JSON tiddlers into a pending import tiddler
+     */
+    handleImportTiddlersEvent(event: IWidgetEvent): void;
+    handlePerformImportEvent(event: IWidgetEvent): void;
+    handleFoldTiddlerEvent(event: IWidgetEvent): void;
+    handleFoldOtherTiddlersEvent(event: IWidgetEvent): void;
+    handleFoldAllTiddlersEvent(event: IWidgetEvent): void;
+    handleUnfoldAllTiddlersEvent(event: IWidgetEvent): void;
   }
 }
-declare module '$:/core/modules/widgets/widget.js' {
+declare module '$:/core/modules/widgets/navigator.js' {
   import { NavigatorWidget } from 'tiddlywiki';
   export { NavigatorWidget as navigator };
 }