{"versions":{"1.0.0":{"name":"@ztools-center/ztools-api-types","version":"1.0.0","description":"ZTools API 代码提示 （直接Copy uTools的，部分API未完成适配）","main":"index.d.ts","types":"index.d.ts","keywords":["ztools","utools","plugin","typescript","types","api"],"author":{"name":"ZTools Contributors"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/ZToolsCenter/ZTools.git","directory":"ztools-api-types"},"bugs":{"url":"https://github.com/ZToolsCenter/ZTools/issues"},"homepage":"https://github.com/ZToolsCenter/ZTools/tree/main/ztools-api-types","utools-version":"7.2.0","utools-commit":"22df3aa","sync-date":"2025-12-12","_id":"@ztools-center/ztools-api-types@1.0.0","gitHead":"29222c0238a54bc43866429291124c59ab19d3a9","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-3YPgE9dj7X1qNsmdtG4a/M6ph3Ygm7rxtfMa6hmt9XEx6Ov3BNfktm5EH9NQZpfj8aHwsr6LiwDEDCpkz/2gNA==","shasum":"3a8d2a02a589527eb54435bbb8b06e20fa8d0349","tarball":"http://123.232.10.234:8212/nexus/content/groups/npm-public/@ztools-center/ztools-api-types/-/ztools-api-types-1.0.0.tgz","fileCount":8,"unpackedSize":38293,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQChs1N3kn0pAiLyUcJOSa3YdTfaVJa4+Dzzp0WPnr2MEAIhAOnd4Pe7loOUdrl3h/Lwu9Bq86dc8CHLAvrYwT1RfgE8"}],"size":12321},"_npmUser":{"name":"anonymous","email":"yueby_sp@qq.com"},"directories":{},"maintainers":[{"name":"anonymous","email":"yueby_sp@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ztools-api-types_1.0.0_1765517827251_0.5757812199462935"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-12-12T05:37:07.388Z","publish_time":1765517827388,"_source_registry_name":"default","contributors":[]},"1.0.1":{"name":"@ztools-center/ztools-api-types","version":"1.0.1","description":"ZTools API 代码提示 （直接Copy uTools的，部分API未完成适配）","main":"index.d.ts","types":"index.d.ts","keywords":["ztools","utools","plugin","typescript","types","api"],"author":{"name":"ZTools Contributors"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/ZToolsCenter/ZTools.git","directory":"ztools-api-types"},"bugs":{"url":"https://github.com/ZToolsCenter/ZTools/issues"},"homepage":"https://github.com/ZToolsCenter/ZTools/tree/main/ztools-api-types","utools-version":"7.2.0","utools-commit":"22df3aa","sync-date":"2025-12-12","_id":"@ztools-center/ztools-api-types@1.0.1","gitHead":"6bad19aa19cf86e019e698b35252e23e256dc594","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-YfioDUGDATJElrgexK3SoyxicNCg/tBadOPTSpBnG2/SJQwOMV6pcyVreBKPTIO+9BNRGBSqNvlyeIVJDZV26w==","shasum":"d3bcbcfa34aba25eb6d15b92fda24f22c0462fde","tarball":"http://123.232.10.234:8212/nexus/content/groups/npm-public/@ztools-center/ztools-api-types/-/ztools-api-types-1.0.1.tgz","fileCount":9,"unpackedSize":46097,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCleuPUW8Q8ntN5N0JmLEW5g6sZ8rAotJT2TTWpt5UhgQIhAPfan1iauBVYw04hkH3q3Y3njzo077Tyr+EuKBtlyTiP"}],"size":13971},"_npmUser":{"name":"anonymous","email":"yueby_sp@qq.com"},"directories":{},"maintainers":[{"name":"anonymous","email":"8589561@qq.com"},{"name":"anonymous","email":"yueby_sp@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ztools-api-types_1.0.1_1765522648614_0.525887884542277"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-12-12T06:57:28.764Z","publish_time":1765522648764,"_source_registry_name":"default","contributors":[]},"1.0.2":{"name":"@ztools-center/ztools-api-types","version":"1.0.2","description":"ZTools API 代码提示 （直接Copy uTools的，部分API未完成适配）","main":"index.d.ts","types":"index.d.ts","keywords":["ztools","utools","plugin","typescript","types","api"],"author":{"name":"ZTools Contributors"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/ZToolsCenter/ZTools.git","directory":"ztools-api-types"},"bugs":{"url":"https://github.com/ZToolsCenter/ZTools/issues"},"homepage":"https://github.com/ZToolsCenter/ZTools/tree/main/ztools-api-types","utools-version":"7.2.0","utools-commit":"22df3aa","sync-date":"2025-12-12","_id":"@ztools-center/ztools-api-types@1.0.2","gitHead":"5862ee1cfd2e884faadf85c0cd3c78428fc7bc3d","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-dY4of1gISHH0IUnoRjcK+WFF4bvUQlwUA18ixphUZAyJUH4g28B0YU8RWHlE5osG58ACJhCRSu4g8Hl6xMykJA==","shasum":"8b4d61daa64052555b763ca54addfb23cc4e0369","tarball":"http://123.232.10.234:8212/nexus/content/groups/npm-public/@ztools-center/ztools-api-types/-/ztools-api-types-1.0.2.tgz","fileCount":9,"unpackedSize":46140,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCQMrEJt8v8QjSfHB9GCnveTmOf65bf09SZ1vcR5J1J7AIhAPDnsCWAq6CuXzvL8VSBvceWbbBxKWDznMNZIvsa4mSo"}],"size":13988},"_npmUser":{"name":"anonymous","email":"yueby_sp@qq.com"},"directories":{},"maintainers":[{"name":"anonymous","email":"8589561@qq.com"},{"name":"anonymous","email":"yueby_sp@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ztools-api-types_1.0.2_1765523647072_0.32917059243997526"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-12-12T07:14:07.287Z","publish_time":1765523647287,"_source_registry_name":"default","contributors":[]},"1.0.3":{"name":"@ztools-center/ztools-api-types","version":"1.0.3","description":"ZTools API 代码提示 （直接Copy uTools的，部分API未完成适配）","main":"index.d.ts","types":"index.d.ts","keywords":["ztools","utools","plugin","typescript","types","api"],"author":{"name":"ZTools Contributors"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/ZToolsCenter/ZTools.git","directory":"ztools-api-types"},"bugs":{"url":"https://github.com/ZToolsCenter/ZTools/issues"},"homepage":"https://github.com/ZToolsCenter/ZTools/tree/main/ztools-api-types","utools-version":"7.2.0","utools-commit":"22df3aa","sync-date":"2025-12-12","_id":"@ztools-center/ztools-api-types@1.0.3","gitHead":"da38e5d1e885888c69abec51d0aa021784e0c8a4","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-dv1eOAIasAupqKaQL/gESk1i2+RebdM/1gvZhrvH2D/bo3enCUsAGJ8nrHnlCLBSOGB81eC/SU0IH8BNsUlmvA==","shasum":"54f28da8b73ede9c1b247fad288d3130ad31096d","tarball":"http://123.232.10.234:8212/nexus/content/groups/npm-public/@ztools-center/ztools-api-types/-/ztools-api-types-1.0.3.tgz","fileCount":9,"unpackedSize":46255,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQC5AqAcOSCg4UTWDMdHirigvNZvUlYqlcJWmEbgJaH8xQIhANCTF36jgPKBfjlOZ431WzFT2ABz6UCySRF3cfSdjTgi"}],"size":14023},"_npmUser":{"name":"anonymous","email":"yueby_sp@qq.com"},"directories":{},"maintainers":[{"name":"anonymous","email":"8589561@qq.com"},{"name":"anonymous","email":"yueby_sp@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ztools-api-types_1.0.3_1765526338718_0.42267926426408686"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-12-12T07:58:58.873Z","publish_time":1765526338873,"_source_registry_name":"default","contributors":[]}},"dist-tags":{"latest":"1.0.3"},"name":"@ztools-center/ztools-api-types","time":{"created":"2025-12-12T05:37:28.253Z","modified":"2025-12-12T07:59:11.226Z","1.0.0":"2025-12-12T05:37:07.388Z","1.0.1":"2025-12-12T06:57:28.764Z","1.0.2":"2025-12-12T07:14:07.287Z","1.0.3":"2025-12-12T07:58:58.873Z"},"readme":"# ZTools 官方类型辅助文件\n\n## 提供代码提示文件\n\n- [ztools.api.d.ts](./ztools.api.d.ts) `window.ztools` 对象类型提示\n- [electron.d.ts](./electron.d.ts) preload 内 `electron` 模块导入提示\n- [resource/ztools.schema](./resource/ztools.schema.json) 配置文件 JSON Schema\n\n## `window.ztools` 对象类型提示\n\n目前将 ztools 挂载到全局 window 下，提供在渲染层跟 preload 层的群体代码提示\n\n第一步\n\n```bash\nnpm install @ztools-center/ztools-api-types --save-dev\n```\n\n第二步 配置 tsconfig.json\n\n```json\n{\n  \"compilerOptions\": {\n    \"types\": [\"@ztools-center/ztools-api-types\"]\n  },\n  \"includes\": [\n    // 如果使用ts或者框架，请添加需要类型提示的文件范围\n    // 案例：\n    // src/**/*.ts\n    // preload.js\n  ]\n}\n```\n\n### API 代码示例\n\n```javascript\n// 默认浏览器打开网页\nwindow.ztools.shellOpenExternal(\"https://u.tools\");\n\n// 在资源管理器中显示文件\nwindow.ztools.shellShowItemInFolder(\"d:\\\\test\");\n\n// zbrowser 网页自动化\nwindow.ztools.zbrowser\n  .goto(\"https://cn.bing.com\")\n  .value(\"#sb_form_q\", \"ZTools\")\n  .click(\"#sb_form_go\")\n  .run({ width: 1000, height: 600 });\n\n// 值键对方式存储数据\nwindow.ztools.dbStorage.setItem(\"key\", \"value\");\n\n// 执行截图\nwindow.ztools.screenCapture((imagebase64) => {\n  // 截图完的回调\n});\n\n// 执行取色\nwindow.ztools.screenColorPick(({ hex, rgb }) => {\n  // 取色完的回调\n});\n```\n\n## `electron` 模块代码提示\n\n引入此类型文件后，支持在 cjs 模式下也提供定制化的 `electron` 模块 api 提示\n\n> 在 ZTools 中，可以通过 cjs 的形式直接使用部分 `electron` 的 api ，但是此部分支持是直接通过 ZTools 内置的 nodejs 实现，因此请勿下载额外的 `electron` 依赖。\n\n### API 代码示例\n\n```javascript\n// preload.js\n\nconst { ipcRenderer } = require(\"electron\");\n\nwindow.onMyChannel = (callback) => {\n  ipcRenderer.on(\"myChannel\", (e, data) => {\n    callback?.({\n      ...data,\n      senderId: e.senderId,\n    });\n  });\n};\n\nwindow.ipc = ipcRenderer;\n```\n\n## 配置文件 JSON Schema\n\n通过 JSON Schema 实现了在 `plugin.json` 内的代码提示\n\n引入 JSON Schema 需要在 `plugin.json` 的第一行添加 `$schema` 字段：\n\n```json\n{\n  \"$schema\": \"node_modules/@ztools-center/ztools-api-types/resource/ztools.schema.json\"\n}\n```\n\n> 添加 `$schema` 时，需要注意跟 `plugin.json` 所在的文件位置有关系，必须是相对于 `plugin.json` 的位置","users":{}}