tw5-typed 1.0.1 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tw5-typed",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "scripts": {
     "check": "tsc --noEmit && eslint src/**/*.ts test/**/*.ts",
     "docs": "docs-ts",

package/src/hooks.d.ts

@@ -1,4 +1,6 @@
 declare module 'tiddlywiki' {
+  import type { Server as HttpServer } from 'node:http';
+
   interface ImportFileInfo {
     callback: (tiddlerFieldsArray: unknown[]) => void;
     file: { lastModified?: number; lastModifiedDate?: Date; name: string; path?: string; size: number; type: string; webkitRelativePath?: string };
@@ -12,10 +14,10 @@ declare module 'tiddlywiki' {
       hookName: 'th-server-command-post-start',
       callback: (
         server: unknown,
-        nodeServer: Server,
+        nodeServer: HttpServer,
         who: 'tiddlywiki',
       ) => void,
-    );
+    ): void;
     addHook(
       hookName: 'th-saving-tiddler' | 'th-renaming-tiddler' | 'th-relinking-tiddler',
       callback: (toTiddler: Tiddler, fromTiddler: Tiddler) => Tiddler | undefined,

package/src/index.d.ts

@@ -1,4 +1,30 @@
-export * from 'tiddlywiki';
+/// <reference path="./boot/config.d.ts" />
+/// <reference path="./boot/index.d.ts" />
+/// <reference path="./core.d.ts" />
+/// <reference path="./hooks.d.ts" />
+/// <reference path="./tiddler/index.d.ts" />
+/// <reference path="./utils/Crypto.d.ts" />
+/// <reference path="./utils/PasswordPrompt.d.ts" />
+/// <reference path="./utils/index.d.ts" />
+/// <reference path="./wiki/index.d.ts" />
+/// <reference path="./modules/index.d.ts" />
+/// <reference path="./modules/filters/index.d.ts" />
+/// <reference path="./modules/indexers/index.d.ts" />
+/// <reference path="./modules/keyboard.d.ts" />
+/// <reference path="./modules/parsers/index.d.ts" />
+/// <reference path="./modules/server/index.d.ts" />
+/// <reference path="./modules/story.d.ts" />
+/// <reference path="./modules/syncer/syncadaptor.d.ts" />
+/// <reference path="./modules/syncer/syncer.d.ts" />
+/// <reference path="./modules/utils/filesystem.d.ts" />
+/// <reference path="./modules/utils/logger.d.ts" />
+/// <reference path="./modules/utils/dom/index.d.ts" />
+/// <reference path="./modules/utils/linked-list.d.ts" />
+/// <reference path="./modules/widgets/index.d.ts" />
+/// <reference path="./plugins/index.d.ts" />
+
+// Export something to make this a module (required for global declarations to work)
+export {};
 
 declare module 'tiddlywiki' {
   export type TW5InitFunction = (baseObject?: Record<string, unknown>) => ITiddlyWiki;
@@ -6,5 +32,5 @@ declare module 'tiddlywiki' {
 }
 
 declare global {
-  export const $tw: import('tiddlywiki').ITiddlyWiki;
+  const $tw: import('tiddlywiki').ITiddlyWiki;
 }

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

@@ -1,4 +1,13 @@
 declare module 'tiddlywiki' {
+  /**
+   * File information for a tiddler stored in the filesystem
+   */
+  export interface FileInfo {
+    filepath: string;
+    hasMetaFile?: boolean;
+    type: string;
+  }
+
   /**
    * SyncAdaptorModules
    * @url https://tiddlywiki.com/dev/#SyncAdaptorModules
@@ -6,7 +15,7 @@ declare module 'tiddlywiki' {
   export interface SyncAdaptor {
     getTiddlerFileInfo(
       title: string,
-      callback: (error: null, fileInfo: IFileInfo) => void,
+      callback: (error: Error | null | string, fileInfo: FileInfo) => void,
     ): void;
     getTiddlerInfo(title: string): IBootFilesIndexItem;
     /**

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

@@ -2,7 +2,7 @@ declare module 'tiddlywiki' {
   /**
    * File information for saving a tiddler
    */
-  export interface FileInfo {
+  export interface IFileInfo {
     filepath: string;
     type: string;
     hasMetaFile: boolean;
@@ -15,7 +15,7 @@ declare module 'tiddlywiki' {
 }
 
 declare module '$:/core/modules/utils/filesystem.js' {
-  import type { FileInfo, Tiddler, Wiki } from 'tiddlywiki';
+  import type { IFileInfo, Tiddler, Wiki } from 'tiddlywiki';
 
   /**
    * Return the subdirectories of a path
@@ -114,11 +114,11 @@ declare module '$:/core/modules/utils/filesystem.js' {
     options: {
       directory: string;
       extFilters?: string[];
-      fileInfo?: FileInfo;
+      fileInfo?: IFileInfo;
       pathFilters?: string[];
       wiki?: Wiki;
     },
-  ): FileInfo;
+  ): IFileInfo;
 
   /**
    * Generate the file extension for saving a tiddler
@@ -153,7 +153,7 @@ declare module '$:/core/modules/utils/filesystem.js' {
       directory?: string;
       extension?: string;
       extFilters?: string[];
-      fileInfo?: FileInfo;
+      fileInfo?: IFileInfo;
       pathFilters?: string[];
       wiki?: Wiki;
     },
@@ -168,8 +168,8 @@ declare module '$:/core/modules/utils/filesystem.js' {
    */
   export function saveTiddlerToFile(
     tiddler: Tiddler,
-    fileInfo: FileInfo,
-    callback: (error: Error | null, fileInfo?: FileInfo) => void,
+    fileInfo: IFileInfo,
+    callback: (error: Error | null, fileInfo?: IFileInfo) => void,
   ): void;
 
   /**
@@ -179,7 +179,7 @@ declare module '$:/core/modules/utils/filesystem.js' {
    * @returns The fileInfo object
    * @description 同步地将 tiddler 保存到由 fileInfo 描述的文件
    */
-  export function saveTiddlerToFileSync(tiddler: Tiddler, fileInfo: FileInfo): FileInfo;
+  export function saveTiddlerToFileSync(tiddler: Tiddler, fileInfo: IFileInfo): IFileInfo;
 
   /**
    * Delete a file described by the fileInfo if it exists
@@ -188,8 +188,8 @@ declare module '$:/core/modules/utils/filesystem.js' {
    * @description 删除由 fileInfo 描述的文件（如果存在）
    */
   export function deleteTiddlerFile(
-    fileInfo: FileInfo,
-    callback: (error: Error | null, fileInfo?: FileInfo) => void,
+    fileInfo: IFileInfo,
+    callback: (error: Error | null, fileInfo?: IFileInfo) => void,
   ): void;
 
   /**
@@ -200,10 +200,10 @@ declare module '$:/core/modules/utils/filesystem.js' {
    */
   export function cleanupTiddlerFiles(
     options: {
-      adaptorInfo?: FileInfo;
-      bootInfo?: FileInfo;
+      adaptorInfo?: IFileInfo;
+      bootInfo?: IFileInfo;
       title?: string;
     },
-    callback: (error: Error | null, fileInfo?: FileInfo) => void,
+    callback: (error: Error | null, fileInfo?: IFileInfo) => void,
   ): void;
 }

package/src/utils/index.d.ts

@@ -462,6 +462,42 @@ declare module 'tiddlywiki' {
      * Parse a filter variable
      */
     parseFilterVariable: (source: string) => unknown;
+    /**
+     * Create directory recursively
+     */
+    createDirectory: (directoryPath: string) => void;
+    /**
+     * Generate tiddler file info for saving
+     */
+    generateTiddlerFileInfo: (
+      tiddler: Tiddler,
+      options: {
+        directory: string;
+        pathFilters?: string[];
+        extFilters?: string[];
+        wiki: Wiki;
+        fileInfo?: Partial<IFileInfo>;
+      },
+    ) => IFileInfo;
+    /**
+     * Save tiddler to file
+     */
+    saveTiddlerToFile: (tiddler: Tiddler, fileInfo: IFileInfo, callback?: (error: Error | null) => void) => void;
+    /**
+     * Cleanup tiddler files (delete old files when tiddler is moved)
+     */
+    cleanupTiddlerFiles: (
+      fileInfo: IFileInfo | Record<string, unknown>,
+      callback?: (error: Error | null, cleanedFileInfo?: IFileInfo) => void,
+    ) => void;
+    /**
+     * Delete tiddler file
+     */
+    deleteTiddlerFile: (fileInfo: IFileInfo, callback?: (error: Error | null, deletedFileInfo?: IFileInfo) => void) => void;
+    /**
+     * Format date string
+     */
+    formatDateString: (date: Date, template: string) => string;
   }
 
   export type IUtilities = IUtilitiesBoot;