{"_id":"@aimetar/wechaty-puppet-xp","name":"@aimetar/wechaty-puppet-xp","dist-tags":{"next":"1.13.1","latest":"1.13.1"},"versions":{"1.13.1":{"name":"@aimetar/wechaty-puppet-xp","version":"1.13.1","description":"Puppet XP for Wechaty","type":"module","exports":{".":{"import":"./dist/esm/src/mod.js","require":"./dist/cjs/src/mod.js"}},"typings":"./dist/esm/src/mod.d.ts","engines":{"node":">=16","npm":">=7"},"scripts":{"clean":"shx rm -fr dist/*","dist":"npm-run-all clean build dist:copy dist:commonjs","build":"tsc && tsc -p tsconfig.cjs.json","dist:commonjs":"jq -n \"{ type: \\\"commonjs\\\" }\" > dist/cjs/package.json","dist:copy":"npm-run-all copy:esm copy:cjs","copy:esm":"shx cp -R commonjs/ dist/esm/ && shx cp src/init-agent-script.js dist/esm/src","copy:cjs":"shx cp -R commonjs/ dist/cjs/ && shx cp src/init-agent-script.js dist/cjs/src","start":"cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" node examples/ding-dong-bot.ts","quick-start":"cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" node examples/quick-start.ts","start:raw":"cross-env BROLOG_LEVEL=silly NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" node examples/raw-sidecar.ts","start:ripe":"cross-env WECHATY_LOG=verbose NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" node examples/ripe-wechaty.ts","start:ripe:info":"cross-env WECHATY_LOG=info NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" node examples/ripe-wechaty.ts","lint":"npm run lint:es && npm run lint:ts && npm run lint:md","lint:md":"markdownlint README.md","lint:ts":"tsc --isolatedModules --noEmit","lint:es":"eslint \"src/**/*.ts\" \"tests/**/*.spec.ts\" --ignore-pattern tests/fixtures/","lint-fix":"eslint --fix \"src/**/*.ts\" \"tests/**/*.spec.ts\"","test":"npm run lint && npm run test:unit","test:pack":"bash -x scripts/npm-pack-testing.sh","test:unit":"cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" tap \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\""},"repository":{"type":"git","url":"git+https://github.com/wechaty/wechaty-puppet-mock.git"},"keywords":["chatie","wechaty","chatbot","bot","wechat","sdk","puppet","mock"],"author":{"name":"Huan LI","email":"zixia@zixia.net"},"license":"Apache-2.0","bugs":{"url":"https://github.com/wechaty/wechaty-puppet-mock/issues"},"homepage":"https://github.com/wechaty/wechaty-puppet-mock#readme","devDependencies":{"@chatie/eslint-config":"^1.0.4","@chatie/git-scripts":"^0.7.7","@chatie/semver":"^0.4.7","@chatie/tsconfig":"^4.5.3","@types/cuid":"^2.0.1","@types/faker":"^5.5.9","@types/qrcode-terminal":"^0.12.0","@types/xml2js":"^0.4.9","husky":"^7.0.4","qrcode-terminal":"^0.12.0","tstest":"^1.0.1","typed-emitter":"^1.4.0","wechaty":"^1.7.21"},"peerDependencies":{"wechaty-puppet":"^1.10.2"},"dependencies":{"cuid":"^2.1.8","sidecar":"^0.17.8","xml2js":"^0.4.23","xmlreader":"^0.2.3"},"tap":{"check-coverage":false},"publishConfig":{"access":"public","tag":"next"},"git":{"scripts":{"pre-push":"npx git-scripts-pre-push"}},"gitHead":"724138aa7c6072ba6619963997fbb5857e3d5595","_id":"@aimetar/wechaty-puppet-xp@1.13.1","_nodeVersion":"18.14.0","_npmVersion":"9.3.1","dist":{"integrity":"sha512-por5QEQPC4fDZr5ResyR1AnIaL4CyrQB+qplPh//DDT04XY46u+kVPDbqMn02LnON+VOmgWoutDWZuahxLPJWw==","shasum":"28740ba2a97e9005cebbd5eb2753bd3c14bd8093","tarball":"https://registry.npmjs.org/@aimetar/wechaty-puppet-xp/-/wechaty-puppet-xp-1.13.1.tgz","fileCount":176,"unpackedSize":652732,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC3gvgnpHVJbDZO17RahSKjr+HE0OJqcwF2Nv+mNTqeogIhANcup45OxHOJscGuZeWAwH7FkkD3lh8i7xY7BH/m4JwQ"}]},"_npmUser":{"name":"aimetaa","email":"reg@zhycit.com"},"directories":{},"maintainers":[{"name":"aimetaa","email":"reg@zhycit.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/wechaty-puppet-xp_1.13.1_1702571527783_0.728292784341642"},"_hasShrinkwrap":false}},"time":{"created":"2023-12-14T16:32:07.691Z","1.13.1":"2023-12-14T16:32:07.955Z","modified":"2023-12-14T16:32:08.217Z"},"maintainers":[{"name":"aimetaa","email":"reg@zhycit.com"}],"description":"Puppet XP for Wechaty","homepage":"https://github.com/wechaty/wechaty-puppet-mock#readme","keywords":["chatie","wechaty","chatbot","bot","wechat","sdk","puppet","mock"],"repository":{"type":"git","url":"git+https://github.com/wechaty/wechaty-puppet-mock.git"},"author":{"name":"Huan LI","email":"zixia@zixia.net"},"bugs":{"url":"https://github.com/wechaty/wechaty-puppet-mock/issues"},"license":"Apache-2.0","readme":"# Wechaty Puppet XP\r\n\r\n[![NPM](https://github.com/wechaty/wechaty-puppet-xp/workflows/NPM/badge.svg)](https://github.com/wechaty/wechaty/actions?query=workflow%3ANPM)\r\n[![NPM Version](https://img.shields.io/npm/v/wechaty-puppet-xp?color=brightgreen)](https://www.npmjs.com/package/wechaty-puppet-xp)\r\n[![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-xp/next.svg)](https://www.npmjs.com/package/wechaty-puppet-xp?activeTab=versions)\r\n[![ES Modules](https://img.shields.io/badge/ES-Modules-brightgreen)](https://github.com/Chatie/tsconfig/issues/16)\r\n\r\n[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/wechaty/wechaty)\r\n[![Powered by Sidecar](https://img.shields.io/badge/Powered%20By-Sidecar-red.svg)](https://github.com/huan/sidecar)\r\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)\r\n[![Downloads](https://img.shields.io/npm/dm/wechaty-puppet-xp.svg?style=flat-square)](https://www.npmjs.com/package/wechaty)\r\n[![GitHub stars](https://img.shields.io/github/stars/wechaty/wechaty-puppet-xp.svg?label=github%20stars)](https://github.com/wechaty/wechaty)\r\n[![Gitter](https://badges.gitter.im/wechaty/wechaty.svg)](https://gitter.im/wechaty/wechaty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)\r\n\r\n<img src=\"https://camo.githubusercontent.com/6c7c7e10053c8e1936c084d17ea74c3437759fd1c4d3e02acca9256e2bfe9bb3/68747470733a2f2f692e6c6f6c692e6e65742f323032302f30352f30392f4858436c49663541324570554734752e706e67\" alt=\"chatie puppet xp\" width=\"300\" height=\"300\" align=\"bottom\" />\r\n\r\nOfficial website: <https://wechaty.js.org/docs/puppet-providers/xp>\r\n\r\n## WECHATY PUPPET YOUTH STAR\r\n\r\nwechaty-puppet-xp is a local puppet for Wechaty:\r\n\r\n1. If you are a user of Windows,You can use this puppet to implement your chatbot.\r\n1. It's a completely free service and doesn't need token.\r\n\r\n## GETTING STARTED\r\n\r\n- STEP 1: Install wechat client in your Windows computer.\r\n- STEP 2: Login the wechat client on the computer.\r\n- STEP 3: Getting Started with TypeScript/JavaScript (RECOMMENDED).\r\n\r\n## QUICK START\r\n\r\n> 1.12.0+ is the latest version, only support WeChat v3.6.0.18, 1.11.14 is the last version base WeChat v3.3.0.115. Note to use the npm package that matches the WeChat version.\r\n\r\n```sh\r\ngit clone https://github.com/wechaty/wechaty-puppet-xp.git\r\ncd wechaty-puppet-xp\r\nnpm install\r\n#\r\n# Do not forget to install WeChat with requried version and login.\r\n#\r\n```\r\n\r\n| Run | Source code | Description |\r\n| :------------- |:-------------| :-----|\r\n| `npm start` | [examples/ding-dong-bot.ts](examples/ding-dong-bot.ts) | Puppet ding/dong |\r\n| `npm run start:ripe` | [examples/ripe-wechaty.ts](examples/ripe-wechaty.ts) | Wechaty ding/dong |\r\n| `npm run start:raw` | [examples/raw-sidecar.ts](examples/raw-sidecar.ts) | Sidecar ding/dong |\r\n\r\n## PUPPET COMPARISON\r\n\r\nXP is a young puppet,it keeps growing and improving.\r\n\r\nPuppet|xp👍|\r\n:---|:---|\r\n支持账号|个人微信|\r\n**<消息>**|\r\n接收文本|✅\r\n接收图片|✅\r\n接收文件|✅\r\n接收动图|✅\r\n接收表情|✅\r\n接收小程序卡片|✅\r\n接收联系人卡片|✅\r\n接收位置卡片|✅\r\n发送文本|✅\r\n发送图片|✅\r\n发送文件|✅\r\n发送动图|✅（以文件形式发送）\r\n**<群组>**|\r\n@群成员|✅\r\n群列表|✅\r\n群成员列表|✅\r\n群详情|✅\r\n进群提示|✅\r\n**<联系人>**|\r\n好友列表|✅\r\n好友详情|✅\r\n**<其他>**|\r\n登录事件|✅\r\n依赖协议|Windows\r\n\r\n## VERSION SUPPORT\r\n\r\npuppet-xp|wechat|\r\n|:---|:---|\r\n|1.11.14|[WeChat-v3.3.0.115](https://github.com/wechaty/wechaty-puppet-xp/releases/download/v0.5/WeChatSetup-v3.3.0.115.exe)|\r\n|1.12.7|[WeChat-v3.6.0.18](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.6.0.18/WeChatSetup-3.6.0.18.exe)|\r\n|1.3.x|[WeChat-v3.9.2.23](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.9.2.23/WeChatSetup-3.9.2.23.exe)|\r\n\r\n## HISTORY\r\n\r\n### next v1.13.0 (September 21, 2023)\r\n\r\n1. This version start to support WeChat v3.9.2.23,need to update WeChat on your pc to 3.9.2.23\r\n2. [WeChatSetup-v3.9.2.23.exe](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.9.2.23/WeChatSetup-3.9.2.23.exe)\r\n\r\n### main v1.12.7 (November 22, 2022)\r\n\r\n1. This version start to support WeChat v3.6.0.18,need to update WeChat on your pc to 3.6.0.18\r\n2. [WeChatSetup-v3.6.0.18.exe](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.6.0.18/WeChatSetup-3.6.0.18.exe)\r\n\r\n### v1.11.14\r\n\r\nthe last version base WeChat 3.3.0.115, next version will support WeChat 3.6.0.18\r\n\r\n### v1.0\r\n\r\nwechaty 1.xx support\r\n\r\n### v0.5\r\n\r\n1. ES Module support\r\n2. [WeChatSetup-v3.3.0.115.exe](https://github.com/wechaty/wechaty-puppet-xp/releases/download/v0.5/WeChatSetup-v3.3.0.115.exe)\r\n\r\n### v0.4.7 (Aug 15, 2021)\r\n\r\n1. Support send files.\r\n2. Support forward text message.\r\n\r\n### v0.4.2 (Aug 10, 2021)\r\n\r\nSupport room.say(text, ...mentionList), you can at RoomMember.\r\n\r\n### v0.4 (Aug 9, 2021)\r\n\r\n1. Added some support for classes Contact and Room\r\n1. Support bot.Contact.findAll()/bot.Contact.find(query)\r\n1. Support bot.Room.findAll()/bot.Room.find(query)\r\n\r\n### v0.2 (July 23, 2021)\r\n\r\n1. Code clean\r\n1. Fix all unit tests\r\n1. Run unit testings under Windows\r\n1. Deploy to NPM with GitHub actions\r\n1. [examples/ding-dong-bot.ts](examples/ding-dong-bot.ts) works on Windows!\r\n1. [examples/raw-sidecar.ts](examples/raw-sidecar.ts) works on Windows!\r\n1. [wechaty-getting-started](https://github.com/wechaty/wechaty-getting-started) supports `WECHATY_PUPPET=wechaty-puppet-xp` now.\r\n\r\n### v0.0.1 (July 19, 2021)\r\n\r\nInitial version: <https://wechaty.js.org/docs/puppet-providers/xp>\r\n\r\nBlogs:\r\n\r\n- [喜讯：使用Windows微信桌面版协议登录，wechaty免费版协议即将登场, @atorber, Jul 05, 2021](https://wechaty.js.org/2021/07/05/puppet-laozhang-wechat-bot/)\r\n- [全新的Windows puppet项目wechaty-puppet-xp启动, @atorber, Jul 13, 2021](https://wechaty.js.org/2021/07/13/wechaty-puppet-xp-start-up/)\r\n- [code如诗，bot如歌，由Wechaty引发的一个小白冒险之旅, @老张学技术, Jul 05, 2021](https://wechaty.js.org/2021/07/05/code-like-poetry-bot-like-song/)\r\n\r\n## Author\r\n\r\n1. Hua ZHANG [@cixingguangming55555](https://github.com/cixingguangming55555)\r\n2. Yuchao LU [@atorber](https://github.com/atorber)\r\n\r\n## Copyright & License\r\n\r\n- Code & Docs © 2021 Wechaty Contributors\r\n- Code released under the Apache-2.0 License\r\n- Docs released under Creative Commons\r\n","readmeFilename":"README.md"}