tw5-typed 0.2.12 → 0.2.14

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.2.12",
+  "version": "0.2.14",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -20,10 +20,10 @@
     "prepublishOnly": "npx tsc --noEmit"
   },
   "devDependencies": {
-    "@types/node": "^18.11.9",
-    "@typescript-eslint/eslint-plugin": "5.44.0",
-    "@typescript-eslint/parser": "5.44.0",
-    "eslint": "8.28.0",
+    "@types/node": "^18.11.12",
+    "@typescript-eslint/eslint-plugin": "5.46.0",
+    "@typescript-eslint/parser": "5.46.0",
+    "eslint": "8.29.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard": "17.0.0",
     "eslint-config-standard-with-typescript": "23.0.0",
@@ -31,7 +31,7 @@
     "eslint-import-resolver-typescript": "3.5.2",
     "eslint-plugin-html": "7.1.0",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-n": "15.5.1",
+    "eslint-plugin-n": "15.6.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-promise": "6.1.1",
@@ -40,8 +40,8 @@
     "eslint-plugin-security": "1.5.0",
     "eslint-plugin-security-node": "1.1.1",
     "eslint-plugin-typescript-sort-keys": "2.1.0",
-    "eslint-plugin-unicorn": "45.0.0",
-    "prettier": "2.8.0",
-    "typescript": "4.9.3"
+    "eslint-plugin-unicorn": "45.0.1",
+    "prettier": "2.8.1",
+    "typescript": "4.9.4"
   }
 }

package/src/Wiki.d.ts

@@ -12,6 +12,7 @@ declare module 'tiddlywiki' {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     variables?: Record<string, any>;
   }
+  export type ITiddlerFieldsParam = Omit<Partial<ITiddlerFields>, 'created' | 'modified'> & { created?: string; modified?: string };
   export class Wiki {
     /**
      * Wiki constructor. State is stored in private members that only a small number of privileged accessor methods have direct access. Methods added via the prototype have to use these accessors and cannot access the state data directly.
@@ -63,16 +64,16 @@ declare module 'tiddlywiki' {
      * Set JSON tiddler, Object in data field will be JSON.stringify and put into the text.
      * This will make tiddler to be JSON data tiddler `"type":"application/json"`, so if you just want to modify existed tiddler's data, use `addTiddler` instead.
      */
-    setTiddlerData: (title: string, data?: object, fields?: ITiddlerFields, options?: any) => void;
+    setTiddlerData: (title: string, data?: object, fields?: ITiddlerFieldsParam, options?: any) => void;
     /**
      * Create or update tiddler.
      * Update existed tiddler based on the title field.
      */
-    addTiddler: (tiddler: Tiddler | Partial<ITiddlerFields>) => void;
+    addTiddler: (tiddler: Tiddler | Partial<ITiddlerFieldsParam> | Partial<ITiddlerFields>) => void;
     /**
      * 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<Partial<ITiddlerFields>>) => void;
+    addTiddlers: (tiddler: Array<Partial<ITiddlerFieldsParam>| 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).

package/src/widget.d.ts

@@ -4,8 +4,10 @@ declare module 'tiddlywiki' {
    * Key is tiddler title
    */
   export type IChangedTiddlers = Record<string, IChangedTiddlersMeta>;
+  /** Only one of these fields will be `true` */
   export interface IChangedTiddlersMeta {
-    modified: boolean;
+    deleted?: boolean;
+    modified?: boolean;
   }
 
   export interface IWidgetEvent {