chore(deps): update to types v4 and toolkit v5

Author: windingwind

.gitignore

@@ -6,6 +6,9 @@ node_modules
 pnpm-lock.yaml
 yarn.lock
 
+# TSC
+tsconfig.tsbuildinfo
+
 # Scaffold
 .env
 .scaffold

package-lock.json

@@ -30,7 +30,7 @@
     "update-deps": "npm update --save"
   },
   "dependencies": {
-    "zotero-plugin-toolkit": "^4.1.2"
+    "zotero-plugin-toolkit": "^5.0.0-0"
   },
   "devDependencies": {
     "@eslint/js": "^9.23.0",
@@ -40,7 +40,7 @@
     "typescript": "^5.8.2",
     "typescript-eslint": "^8.28.0",
     "zotero-plugin-scaffold": "^0.4.1",
-    "zotero-types": "^3.1.9"
+    "zotero-types": "^4.0.0-beta.3"
   },
   "prettier": {
     "printWidth": 80,

package.json

@@ -39,7 +39,7 @@ async function onStartup() {
   );
 }
 
-async function onMainWindowLoad(win: Window): Promise<void> {
+async function onMainWindowLoad(win: _ZoteroTypes.MainWindow): Promise<void> {
   // Create ztoolkit for every window
   addon.data.ztoolkit = createZToolkit();
 

src/hooks.ts

@@ -123,7 +123,7 @@ export class KeyExampleFactory {
 
 export class UIExampleFactory {
   @example
-  static registerStyleSheet(win: Window) {
+  static registerStyleSheet(win: _ZoteroTypes.MainWindow) {
     const doc = win.document;
     const styles = ztoolkit.UI.createElement(doc, "link", {
       properties: {
@@ -132,7 +132,7 @@ export class UIExampleFactory {
         href: `chrome://${addon.data.config.addonRef}/content/zoteroPane.css`,
       },
     });
-    doc.documentElement.appendChild(styles);
+    doc.documentElement?.appendChild(styles);
     doc.getElementById("zotero-item-pane-content")?.classList.add("makeItRed");
   }
 
@@ -165,7 +165,7 @@ export class UIExampleFactory {
         ],
       },
       "before",
-      win.document.querySelector(
+      win.document?.querySelector(
         "#zotero-itemmenu-addontemplate-test",
       ) as XUL.MenuItem,
     );
@@ -208,12 +208,9 @@ export class UIExampleFactory {
       dataProvider: (item: Zotero.Item, dataKey: string) => {
         return field + String(item.id);
       },
-      renderCell(index, data, column) {
+      renderCell(index, data, column, isFirstColumn, doc) {
         ztoolkit.log("Custom column cell is rendered!");
-        const span = Zotero.getMainWindow().document.createElementNS(
-          "http://www.w3.org/1999/xhtml",
-          "span",
-        );
+        const span = doc.createElement("span");
         span.className = `cell ${column.className}`;
         span.style.background = "#0dd068";
         span.innerText = "⭐" + data;
@@ -502,7 +499,7 @@ export class PromptExampleFactory {
             ids.forEach((id: number) => {
               const item = Zotero.Items.get(id);
               const title = item.getField("title");
-              const ele = ztoolkit.UI.createElement(window.document, "div", {
+              const ele = ztoolkit.UI.createElement(window.document!, "div", {
                 namespace: "html",
                 classList: ["command"],
                 listeners: [

src/modules/examples.ts

@@ -108,21 +108,21 @@ async function updatePrefsUI() {
 
 function bindPrefEvents() {
   addon.data
-    .prefs!.window.document.querySelector(
+    .prefs!.window.document?.querySelector(
       `#zotero-prefpane-${config.addonRef}-enable`,
     )
-    ?.addEventListener("command", (e) => {
+    ?.addEventListener("command", (e: Event) => {
       ztoolkit.log(e);
       addon.data.prefs!.window.alert(
         `Successfully changed to ${(e.target as XUL.Checkbox).checked}!`,
       );
     });
 
   addon.data
-    .prefs!.window.document.querySelector(
+    .prefs!.window.document?.querySelector(
       `#zotero-prefpane-${config.addonRef}-input`,
     )
-    ?.addEventListener("change", (e) => {
+    ?.addEventListener("change", (e: Event) => {
       ztoolkit.log(e);
       addon.data.prefs!.window.alert(
         `Successfully changed to ${(e.target as HTMLInputElement).value}!`,

src/modules/preferenceScript.ts

@@ -1,16 +1,5 @@
 {
-  "compilerOptions": {
-    "target": "ES2016",
-    "lib": ["ESNext"],
-    "experimentalDecorators": true,
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "types": ["zotero-types"],
-    "strict": true,
-    "outDir": "build/dist/",
-    "skipLibCheck": true
-  },
+  "extends": "zotero-types/entries/sandbox/",
   "include": ["src", "typings"],
   "exclude": ["build", "addon"]
 }