tw5-typed 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tw5-typed",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "scripts": {
5
5
  "check": "tsc --noEmit && eslint src/**/*.ts test/**/*.ts",
6
6
  "docs": "docs-ts",
package/src/hooks.d.ts CHANGED
@@ -1,4 +1,6 @@
1
1
  declare module 'tiddlywiki' {
2
+ import type { Server as HttpServer } from 'node:http';
3
+
2
4
  interface ImportFileInfo {
3
5
  callback: (tiddlerFieldsArray: unknown[]) => void;
4
6
  file: { lastModified?: number; lastModifiedDate?: Date; name: string; path?: string; size: number; type: string; webkitRelativePath?: string };
@@ -12,10 +14,10 @@ declare module 'tiddlywiki' {
12
14
  hookName: 'th-server-command-post-start',
13
15
  callback: (
14
16
  server: unknown,
15
- nodeServer: Server,
17
+ nodeServer: HttpServer,
16
18
  who: 'tiddlywiki',
17
19
  ) => void,
18
- );
20
+ ): void;
19
21
  addHook(
20
22
  hookName: 'th-saving-tiddler' | 'th-renaming-tiddler' | 'th-relinking-tiddler',
21
23
  callback: (toTiddler: Tiddler, fromTiddler: Tiddler) => Tiddler | undefined,
package/src/index.d.ts CHANGED
@@ -1,4 +1,30 @@
1
- export * from 'tiddlywiki';
1
+ /// <reference path="./boot/config.d.ts" />
2
+ /// <reference path="./boot/index.d.ts" />
3
+ /// <reference path="./core.d.ts" />
4
+ /// <reference path="./hooks.d.ts" />
5
+ /// <reference path="./tiddler/index.d.ts" />
6
+ /// <reference path="./utils/Crypto.d.ts" />
7
+ /// <reference path="./utils/PasswordPrompt.d.ts" />
8
+ /// <reference path="./utils/index.d.ts" />
9
+ /// <reference path="./wiki/index.d.ts" />
10
+ /// <reference path="./modules/index.d.ts" />
11
+ /// <reference path="./modules/filters/index.d.ts" />
12
+ /// <reference path="./modules/indexers/index.d.ts" />
13
+ /// <reference path="./modules/keyboard.d.ts" />
14
+ /// <reference path="./modules/parsers/index.d.ts" />
15
+ /// <reference path="./modules/server/index.d.ts" />
16
+ /// <reference path="./modules/story.d.ts" />
17
+ /// <reference path="./modules/syncer/syncadaptor.d.ts" />
18
+ /// <reference path="./modules/syncer/syncer.d.ts" />
19
+ /// <reference path="./modules/utils/filesystem.d.ts" />
20
+ /// <reference path="./modules/utils/logger.d.ts" />
21
+ /// <reference path="./modules/utils/dom/index.d.ts" />
22
+ /// <reference path="./modules/utils/linked-list.d.ts" />
23
+ /// <reference path="./modules/widgets/index.d.ts" />
24
+ /// <reference path="./plugins/index.d.ts" />
25
+
26
+ // Export something to make this a module (required for global declarations to work)
27
+ export {};
2
28
 
3
29
  declare module 'tiddlywiki' {
4
30
  export type TW5InitFunction = (baseObject?: Record<string, unknown>) => ITiddlyWiki;
@@ -6,5 +32,5 @@ declare module 'tiddlywiki' {
6
32
  }
7
33
 
8
34
  declare global {
9
- export const $tw: import('tiddlywiki').ITiddlyWiki;
35
+ const $tw: import('tiddlywiki').ITiddlyWiki;
10
36
  }
@@ -462,6 +462,42 @@ declare module 'tiddlywiki' {
462
462
  * Parse a filter variable
463
463
  */
464
464
  parseFilterVariable: (source: string) => unknown;
465
+ /**
466
+ * Create directory recursively
467
+ */
468
+ createDirectory: (directoryPath: string) => void;
469
+ /**
470
+ * Generate tiddler file info for saving
471
+ */
472
+ generateTiddlerFileInfo: (
473
+ tiddler: Tiddler,
474
+ options: {
475
+ directory: string;
476
+ pathFilters?: string[];
477
+ extFilters?: string[];
478
+ wiki: Wiki;
479
+ fileInfo?: Partial<FileInfo>;
480
+ },
481
+ ) => FileInfo;
482
+ /**
483
+ * Save tiddler to file
484
+ */
485
+ saveTiddlerToFile: (tiddler: Tiddler, fileInfo: FileInfo, callback?: (error: Error | null) => void) => void;
486
+ /**
487
+ * Cleanup tiddler files (delete old files when tiddler is moved)
488
+ */
489
+ cleanupTiddlerFiles: (
490
+ fileInfo: FileInfo | Record<string, unknown>,
491
+ callback?: (error: Error | null, cleanedFileInfo?: FileInfo) => void,
492
+ ) => void;
493
+ /**
494
+ * Delete tiddler file
495
+ */
496
+ deleteTiddlerFile: (fileInfo: FileInfo, callback?: (error: Error | null, deletedFileInfo?: FileInfo) => void) => void;
497
+ /**
498
+ * Format date string
499
+ */
500
+ formatDateString: (date: Date, template: string) => string;
465
501
  }
466
502
 
467
503
  export type IUtilities = IUtilitiesBoot;