Package Health Score

42 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.20.2	\|	06/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.19.7	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.53.10	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.52.1	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.51.21	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (737)

GitHub Stars: 231
Forks: 52
Contributors: 20

Direct Usage Popularity

The npm package wechaty-puppet receives a total of 737 downloads a week. As such, we scored wechaty-puppet popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package wechaty-puppet, we found that it has been starred 231 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the wechaty-puppet repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like wechaty-puppet is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 35
Open PR: 2
Last Release: 2 years ago
Last Commit: 1 year ago

Further analysis of the maintenance status of wechaty-puppet based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for wechaty-puppet is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16

Age: 6 years
Dependencies: 12 Direct
Versions: 367
Install Size: 1.35 MB
Dist-tags: 2
# of Files: 738
Maintainers: 1
TS Typings: Yes

wechaty-puppet has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use wechaty-puppet?

To help you get started, we've collected the most common ways that wechaty-puppet is being used within popular public projects.

wechaty / wechaty / src / puppet-padchat / pure-function-helpers / friendship-raw-payload-parser.spec.ts View on Github

test('friendshipRawPayloadParser()', async t => {
  const DATA = '%5B%7B%22content%22%3A%22%3Cmsg+fromusername%3D%5C%22lizhuohuan%5C%22+encryptusername%3D%5C%22v1_cf269def9b946093f9d131a5e733ba169351013c95e46a860cddecaf485c4b10%40stranger%5C%22+fromnickname%3D%5C%22%E6%9D%8E%E5%8D%93%E6%A1%93%5C%22+content%3D%5C%22xixixi%5C%22+fullpy%3D%5C%22lizhuohuan%5C%22+shortpy%3D%5C%22LZH%5C%22+imagestatus%3D%5C%223%5C%22+scene%3D%5C%226%5C%22+country%3D%5C%22CN%5C%22+province%3D%5C%22Beijing%5C%22+city%3D%5C%22Haidian%5C%22+sign%3D%5C%22PreAngel%E6%8A%95%E8%B5%84%E4%BA%BA%E3%80%82%E6%B0%B4%E6%9C%A8%E6%B8%85%E5%8D%8EBBS%E7%AB%99%E9%95%BF%E3%80%82%E6%8A%95%E8%B5%84%E4%BA%BA%E4%B8%AD%E6%9C%80%E4%BC%9A%E9%A3%9E%E7%9A%84AI%E7%A8%8B%E5%BA%8F%E5%91%98%E3%80%82%5C%22+percard%3D%5C%221%5C%22+sex%3D%5C%221%5C%22+alias%3D%5C%22%5C%22+weibo%3D%5C%22%5C%22+weibonickname%3D%5C%22%5C%22+albumflag%3D%5C%220%5C%22+albumstyle%3D%5C%220%5C%22+albumbgimgid%3D%5C%22913943270785024_913943270785024%5C%22+snsflag%3D%5C%22177%5C%22+snsbgimgid%3D%5C%22http%3A%2F%2Fshmmsns.qpic.cn%2Fmmsns%2FNoFChqEQomEyhyNjzExH3v78BHSVmIzHBIdOECg9jgcTpRNwThgXJicCsGicI6Kib4xLETc2PuKwhM%2F0%5C%22+snsbgobjectid%3D%5C%2212683064081608282338%5C%22+mhash%3D%5C%22d98b28f4cb1708bb584f3e66078e0a0d%5C%22+mfullhash%3D%5C%22d98b28f4cb1708bb584f3e66078e0a0d%5C%22+bigheadimgurl%3D%5C%22http%3A%2F%2Fwx.qlogo.cn%2Fmmhead%2Fver_1%2FciaaFRTCqfHIKLY0wBjv3h0LSPkCEEcJ0fo6kQkMxQLBiahJWFk7rS9G4VLU5n9OfAnXWlMaIV01oeTITYS0OHlg%2F0%5C%22+smallheadimgurl%3D%5C%22http%3A%2F%2Fwx.qlogo.cn%2Fmmhead%2Fver_1%2FciaaFRTCqfHIKLY0wBjv3h0LSPkCEEcJ0fo6kQkMxQLBiahJWFk7rS9G4VLU5n9OfAnXWlMaIV01oeTITYS0OHlg%2F96%5C%22+ticket%3D%5C%22v2_1a0d2cf325e64b6f74bed09e944529e7cc7a7580cb323475050664566dd0302d89b8e2ed95b596b459cf762d94a0ce606da39babbae0dc26b18a62e079bfc120%40stranger%5C%22+opcode%3D%5C%222%5C%22+googlecontact%3D%5C%22%5C%22+qrticket%3D%5C%22%5C%22+chatroomusername%3D%5C%22%5C%22+sourceusername%3D%5C%22%5C%22+sourcenickname%3D%5C%22%5C%22%3E%3Cbrandlist+count%3D%5C%220%5C%22+ver%3D%5C%22652101432%5C%22%3E%3C%2Fbrandlist%3E%3C%2Fmsg%3E%22%2C%22continue%22%3A1%2C%22description%22%3A%22%22%2C%22from_user%22%3A%22fmessage%22%2C%22msg_id%22%3A%222957327798149218888%22%2C%22msg_source%22%3A%22%22%2C%22msg_type%22%3A5%2C%22status%22%3A1%2C%22sub_type%22%3A37%2C%22timestamp%22%3A1528557626%2C%22to_user%22%3A%22wxid_5zj4i5htp9ih22%22%2C%22uin%22%3A1928023446%7D%5D%0A'

  const TENCENT_PAYLOAD_LIST: PadchatMessagePayload[] = padchatDecode(DATA)
  const PADCHAT_MESSAGE_PAYLOAD = TENCENT_PAYLOAD_LIST[0]
  const EXPECTED_FRIEND_REQUEST_PAYLOAD = {
    id        : '2957327798149218888',
    contactId : 'lizhuohuan',
    hello     : 'xixixi',
    stranger  : 'v1_cf269def9b946093f9d131a5e733ba169351013c95e46a860cddecaf485c4b10@stranger',
    ticket    : 'v2_1a0d2cf325e64b6f74bed09e944529e7cc7a7580cb323475050664566dd0302d89b8e2ed95b596b459cf762d94a0ce606da39babbae0dc26b18a62e079bfc120@stranger',
    type      : FriendshipType.Receive,
  }

  // console.log(PADCHAT_MESSAGE_PAYLOAD)

  const friendshipPayload: FriendshipPayload = await friendshipRawPayloadParser(PADCHAT_MESSAGE_PAYLOAD)
  // console.log(friendshipPayload)

  t.deepEqual(friendshipPayload, EXPECTED_FRIEND_REQUEST_PAYLOAD, 'should parse friendshipPayload right')
})

View more ways to use wechaty-puppet

wechaty-puppet

> Picture Credit: https://www.shareicon.net

Abstract(Base) Class of Puppet Providers for Wechaty Framework.

This module is part of the Wechaty Framework SDK.

Learn more at:

Wiki:
Issue:

Documentation

Wechaty Puppet Provider Interface Documentation can be found at

> Automatica Generated by TypeDoc

Example

PuppetMock:

The above puppet provider is just for mocking and easy to understand. It will be a good starter when you want to develope a new puppet by yourself for fullfil your need, for example, connect Wechaty with Wechat Official Account.

Providers

PuppetPadchat iPad API via Protocol Server, created by @lijiarui
PuppetIoscat iPhone App Hook API, created by @linyimin-bupt
PuppetWechat4u Web API via HTTP, created by @huan
PuppetPuppeteer Web API via Browser, created by @huan
PuppetService gRPC Proxy via Chatie.io(PaaS - Puppets as a Service), created by @huan

Dependencies

FileBox (npm module file-box) MUST be imported from wechaty-puppet because all the Wechaty Framework needs to check instanceof FileBox, we must be sure all FileBox is the same version.
MemoryCard (npm module memory-card) MUST be imported from wechaty-puppet because all the Wechaty Framework needs to check instanceof MemoryCard, we must be sure all MemoryCard is the same version.

Peer Dependence

Puppet(npm module wechaty-puppet) itself must be a peer Dependencies for all the Puppet Providers, and should only be installed via Wechaty because all Puppet Providers should share the same Puppet Base Class with Wechaty, we must be sure all Puppet is the same version.

Wechaty Puppet Toolsets

1. Using SwitchState

You can get to know the puppet start/stop state from the state property:

puppet.state.on() === 'pending' will be true when the puppet is starting
puppet.state.on() === true will be true when the puppet is started
puppet.state.off() === 'pending' will be true when the puppet is stoping
`puppet.state.off() === true' will be true when the puppet is stopped

Learn more about the puppet.state at

2. Using Brolog

Using Brolog to output necessary log messages.

2.1 Get log from Brolog

import { log } from 'brolog'

2.2 Log Format

log.verbose('ModuleName', 'methodName() Your Verbose Message Here')
log.silly('ModuleName', 'methodName() Your Silly Message Here')

2.3 Log Level

Brolog has five log levels, it should be used and follow the following rules:

Log Level	What does it means	Usage in Puppet
`log.silly()`	There's some detail debug information	Can be used in everywhere as you like
`log.verbose()`	There's some debug information	Should be used at the beginning of every method()
~~`log.info()`~~	~~There's something we need to let user know~~	~~Should NEVER to be used because Puppet is Library~~
`log.warn()`	There's a Coverable Error	Should not be used unless we have to
`log.error()`	There's a Un-covered Error	Should not be used unless we have to

3. Using LRU Cache

Set the max size for wechaty entities in LRU Cache.

Env Name	What does it means
`WECHATY_PUPPET_LRU_CACHE_SIZE_CONTACT`	The max cache size for contact, default value `3000`
`WECHATY_PUPPET_LRU_CACHE_SIZE_FRIENDSHIP`	The max cache size for friendship, default value `100`
`WECHATY_PUPPET_LRU_CACHE_SIZE_MESSAGE`	The max cache size for message, default value `500`
`WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM`	The max cache size for room, default value `500`
`WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM_INVITATION`	The max cache size for room invitation, default value `100`
`WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM_MEMBER`	The max cache size for room member, default value `30000`

Resources

Pure Function

Mixin

History

master v1.0 - Initial Release

v0.49 (Oct 2021)

~~Add Error interface to EventErrorPayload, and make .data optional~~
Using Mixin to extend Puppet

v0.43 (Aug 28, 2021)

Support ES Modules

v0.16 (Sep 2019)

Works with the following Puppet Providers:

wechaty-puppet-puppeteer
wechaty-puppet-padchat
wechaty-puppet-mock
wechaty-puppet-wechat4u

v0.0.1 (Jun 2018)

Define the Abstract Puppet Layer for Wechaty
Seperate code from Wechaty

Author

Huan LI (李卓桓) zixia@zixia.net

Copyright & License

Code released under the Apache-2.0 License
Docs released under Creative Commons

wechaty-puppet dependencies

@alloc/quick-lru brolog clone-class file-box fp-ts gerror memory-card state-switch typed-emitter typesafe-actions uuid watchdog

wechaty-puppet development dependencies

@chatie/eslint-config @chatie/git-scripts @chatie/semver @chatie/tsconfig @swc/core @swc/helpers @types/uuid nop regenerator-runtime rxjs tstest yocto-queue

FAQs

What is wechaty-puppet?

Abstract Puppet for Wechaty. Visit Snyk Advisor to see a full health score report for wechaty-puppet, including popularity, security, maintenance & community analysis.

Is wechaty-puppet popular?

The npm package wechaty-puppet receives a total of 737 weekly downloads. As such, wechaty-puppet popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is wechaty-puppet well maintained?

We found indications that wechaty-puppet is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is wechaty-puppet safe to use?

While scanning the latest version of wechaty-puppet, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 14 November-2024, at 20:24 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP