tw5-typed 0.3.4 → 0.3.6

package/package.json

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

package/src/boot/index.d.ts

@@ -20,6 +20,10 @@ declare module 'tiddlywiki' {
 
   export interface IBoot {
     argv: string[];
+    /**
+     * Parse any extra plugin references from `$tw.boot.argv[0]` that with `+` prefix.
+     */
+    extraPlugins: string[];
     boot: (callback?: () => void) => void;
     files: IBootFilesIndex;
     log: (logString: string) => void;

package/src/core.d.ts

@@ -7,7 +7,6 @@
 /// <reference path="plugins/index.d.ts" />
 
 declare module 'tiddlywiki' {
-
   export interface IPluginInfo {
     version: string;
     'plugin-type': string;
@@ -32,7 +31,7 @@ declare module 'tiddlywiki' {
      * Presents when we have $tw.syncadaptor
      */
     syncer?: Syncer;
-    Syncer: { new(): Syncer };
+    Syncer: { new (): Syncer };
 
     wiki: Wiki;
     boot: IBoot;
@@ -139,5 +138,10 @@ declare module 'tiddlywiki' {
     node: null | Record<string, any>;
     /** Broswer features, if tw isn't running on a browser environment, the value will be `null` */
     nodeWebKit: null | Record<string, any>;
+    platform: {
+      isLinux: boolean;
+      isMac: boolean;
+      isWindows: boolean;
+    };
   }
 }

package/src/hooks.d.ts

@@ -68,7 +68,7 @@ declare module 'tiddlywiki' {
     addHook(
       hookName: 'th-importing-file',
       callback: (props: {
-        file: unknown;
+        file: { path?: string, name: string };
         type: string;
         isBinary: boolean;
         callback: Function;

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

@@ -1,9 +1,34 @@
 declare module 'tiddlywiki' {
   export class Syncer {
+    pollTimerInterval: number;
     syncadaptor?: SyncAdaptor;
     /**
       Synchronise from the server by reading the skinny tiddler list and queuing up loads for any tiddlers that we don't already have up to date
     */
     syncFromServer(): void;
+    /**
+      Process the next task
+    */
+    processTaskQueue(): void;
+    /**
+      Update the document body with the class "tc-dirty" if the wiki has unsaved/unsynced changes
+    */
+    updateDirtyStatus(): void;
+    /**
+    Checks whether the wiki is dirty (ie the window shouldn't be closed)
+    */
+    isDirty(): boolean;
+    /**
+     * Return an array of the tiddler titles that are subjected to syncing
+     */
+    getSyncedTiddlers(): string[];
+    /**
+     * Get stringified revision number, for example, `'0'`.
+     */
+    getTiddlerRevision(title: string): string;
+    /**
+     * Read (or re-read) the latest tiddler info from the store
+     */
+    readTiddlerInfo(): void;
   }
 }

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

@@ -1,3 +1,5 @@
+/// <reference path="./navigator.d.ts" />
+
 declare module 'tiddlywiki' {
   /**
    * Parameter of Widget.refresh

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

@@ -0,0 +1,35 @@
+declare module 'tiddlywiki' {
+  export class NavigatorWidget extends Widget {
+    getStoryList(): string[] | null;
+    saveStoryList(storyList: string[]): void;
+    removeTitleFromStory(storyList: string[], title: string): void;
+    replaceFirstTitleInStory(
+      storyList: string[],
+      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;
+    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;
+  }
+}
+declare module '$:/core/modules/widgets/widget.js' {
+  import { NavigatorWidget } from 'tiddlywiki';
+  export { NavigatorWidget as navigator };
+}