tw5-typed 0.3.8 → 0.3.10

package/package.json

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

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

@@ -9,6 +9,8 @@ declare module 'tiddlywiki' {
      */
     parseAsInline?: boolean;
     defaultType?: string;
+    parentWidget?: Widget;
+    document?: TWDocument;
   }
 
   export class WikiParseRule {

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

@@ -106,6 +106,12 @@ declare module 'tiddlywiki' {
     data: string;
     server: Server;
     wiki: Wiki;
+    /**
+     * With `exports.path = /^\/recipes\/default\/tiddlers\/(.+)$/;` you can use:
+     * 
+     * `title = $tw.utils.decodeURIComponentSafe(state.params[0])`
+     */
+    params: string[];
   }
   /**
    * @link https://talk.tiddlywiki.org/t/what-is-the-state-in-server-route-handler/2877

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

@@ -23,6 +23,12 @@ declare module 'tiddlywiki' {
      * Notifier mechanism
      */
     Notifier: typeof Notifier;
+    /**
+     * Copy plain text to the clipboard on browsers that support it.
+     * 
+     * And send a notification to the user if doNotNotify is not true.
+     */
+    copyToClipboard(text: string, option?: { doNotNotify?: boolean }): void;
   }
   export class Notifier {
     /**

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

@@ -470,6 +470,14 @@ declare module 'tiddlywiki' {
       event: IWidgetEvent,
       variables: Record<string, IWidgetVariable>,
     ): boolean;
+
+    /**
+     * The destroy method will be called by parent widget.
+     * If you widget don't have any child widget, you can just write your own tear down logic. If it may have some child widget, don't forget to call original destroy method in the Widget class to destroy children widgets.
+     * @version >=5.3.0
+     * @url https://tiddlywiki.com/dev/#Widget%20%60destroy%60%20method%20examples
+    */
+    destroy(): void;
   }
 
   export type ModalWidget = {

package/src/tiddler/index.d.ts

@@ -38,7 +38,7 @@ declare module 'tiddlywiki' {
       Get all the fields as a hashmap of strings. Options:
       exclude: an array of field names to exclude
     */
-    getFieldStrings(field: string, defaultValue?: string): string;
+    getFieldStrings(options?: { exclude?: string[] }): Record<string, string>;
     getFieldDay(field: string): string;
     /**
       Get the value of a field as a list

package/src/wiki/index.d.ts

@@ -194,7 +194,7 @@ declare module 'tiddlywiki' {
     parseTiddler(title: string, options?: IParseOptions): WikiParser;
     /**
       Parse a block of text of a specified MIME type
-      @param {string} type: content type of text to be parsed
+      @param {string} type: MIME content type of text to be parsed
       @param {string} text: text
       @param {object}options: see below
 
@@ -203,6 +203,22 @@ declare module 'tiddlywiki' {
       - _canonical_uri: optional string of the canonical URI of this content
     */
     parseText(type: string, text: string, options?: IParseOptions): WikiParser;
+    /**
+     * Extracts tiddlers from a typed block of text, specifying default field values
+     * @param {string} type: MIME content type of text to be parsed
+     * @param {string} text: text
+     * @param {object} srcFields: default field values
+     * @param {object} options: see below
+     *
+     * Options include:
+     *  - deserializer: string, key of `$tw.Wiki.tiddlerDeserializerModules`
+     */
+    deserializeTiddlers(
+      type: string,
+      text: string,
+      srcFields?: ITiddlerFieldsParam,
+      options?: IParseOptions,
+    ): ITiddlerFieldsParam[];
     /**
       Parse text from a tiddler and render it into another format
         outputType: content type for the output
@@ -314,17 +330,11 @@ declare module 'tiddlywiki' {
       handler: (event: unknown) => void | Promise<void>,
     ): void;
     addEventListener(
-      type: "change",
+      type: 'change',
       handler: (change: IChangedTiddlers) => void | Promise<void>,
     ): void;
 
-    dispatchEvent(
-      type: string,
-      dataOrEvent: unknown,
-    ): void;
-    dispatchEvent(
-      type: "change",
-      change: IChangedTiddlers,
-    ): void;
+    dispatchEvent(type: string, dataOrEvent: unknown): void;
+    dispatchEvent(type: 'change', change: IChangedTiddlers): void;
   }
 }