tw5-typed 0.2.1 → 0.2.2

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -20,17 +20,17 @@
     "prepublishOnly": "npx tsc --noEmit"
   },
   "devDependencies": {
-    "@types/node": "^17.0.23",
-    "@typescript-eslint/eslint-plugin": "5.17.0",
-    "@typescript-eslint/parser": "5.17.0",
-    "eslint": "8.12.0",
+    "@types/node": "^17.0.24",
+    "@typescript-eslint/eslint-plugin": "5.19.0",
+    "@typescript-eslint/parser": "5.19.0",
+    "eslint": "8.13.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard": "16.0.3",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-import-resolver-alias": "1.1.2",
-    "eslint-import-resolver-typescript": "2.7.0",
+    "eslint-import-resolver-typescript": "2.7.1",
     "eslint-plugin-html": "6.2.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-n": "15.1.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-prettier": "4.0.0",
@@ -41,7 +41,7 @@
     "eslint-plugin-security-node": "1.1.1",
     "eslint-plugin-typescript-sort-keys": "2.1.0",
     "eslint-plugin-unicorn": "42.0.0",
-    "prettier": "2.6.1",
+    "prettier": "2.6.2",
     "typescript": "4.6.3"
   }
 }

package/src/Wiki.d.ts

@@ -31,9 +31,9 @@ declare module 'tiddlywiki' {
      */
     addTiddler: (tiddler: Tiddler | Partial<ITiddlerFields>) => void;
     /**
-     * Call `addTiddler` for each iton of the list
+     * Call `addTiddler` for each iton of the list, but should passing `tiddler.fields`, directly passing tiddler object may failed to add in some cases.
      */
-    addTiddlers: (tiddler: Array<Tiddler | Partial<ITiddlerFields>>) => void;
+    addTiddlers: (tiddler: Array<Partial<ITiddlerFields>>) => void;
     /**
      * Get tiddler's text field, with an optional default text.
      * If have _is_skinny field, will just return null (this is a rare case, so not put in the return type for now).
@@ -43,6 +43,36 @@ declare module 'tiddlywiki' {
      */
     getTiddlerText(title: string, fallbackText: string): string;
     getTiddlerText(title: string, fallbackText?: string): string | undefined;
+    /**
+      Get the content of a tiddler as a JavaScript object. How this is done depends on the type of the tiddler:
+
+      application/json: the tiddler JSON is parsed into an object
+      application/x-tiddler-dictionary: the tiddler is parsed as sequence of name:value pairs
+
+      Other types currently just return undefined or as same as fallbackData.
+
+      titleOrTiddler: string tiddler title or a tiddler object
+      defaultData: default data to be returned if the tiddler is missing or doesn't contain data
+
+      Alternative, uncached version of getTiddlerDataCached(). The return value can be mutated freely and reused
+    */
+    getTiddlerData<D extends Record<string, unknown> | undefined>(titleOrTiddler: string, fallbackData?: D): D;
+    getTiddlerData<D extends Record<string, unknown> | undefined>(titleOrTiddler: Tiddler, fallbackData?: D): D;
+    /**
+      Get the content of a tiddler as a JavaScript object. How this is done depends on the type of the tiddler:
+
+      application/json: the tiddler JSON is parsed into an object
+      application/x-tiddler-dictionary: the tiddler is parsed as sequence of name:value pairs
+
+      Other types currently just return undefined or as same as fallbackData.
+
+      titleOrTiddler: string tiddler title or a tiddler object
+      defaultData: default data to be returned if the tiddler is missing or doesn't contain data
+
+      Note that the same value is returned for repeated calls for the same tiddler data. The value is frozen to prevent modification; otherwise modifications would be visible to all callers
+    */
+    getTiddlerDataCached<D extends Record<string, unknown> | undefined>(titleOrTiddler: string, fallbackData?: D): D;
+    getTiddlerDataCached<D extends Record<string, unknown> | undefined>(titleOrTiddler: Tiddler, fallbackData?: D): D;
     /**
      * Set tiddler text of any field.
      *
@@ -55,5 +85,19 @@ declare module 'tiddlywiki' {
     setText: (title: string, field?: string, index?: string | undefined, value?: string, options?: any) => void;
     parseTiddler(title: string, options?: IParserOptions): WikiParser;
     parseText(type: string, text: string, options?: IParserOptions): WikiParser;
+    /*
+      Parse text from a tiddler and render it into another format
+        outputType: content type for the output
+        title: title of the tiddler to be rendered
+        options: see below
+      Options include:
+      variables: hashmap of variables to set
+      parentWidget: optional parent widget for the root node
+      */
+    renderTiddler(
+      outputType: 'text/html' | 'text/plain-formatted' | 'text/plain',
+      title: string,
+      options?: { parentWidget?: Widget; variables?: Record<string, any> },
+    ): string;
   }
 }