Skip to content

Commit 476fbd7

Browse files
authored
Merge branch 'main' into mid-term
2 parents 8f02c97 + b0296a8 commit 476fbd7

File tree

185 files changed

+4385
-57
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

185 files changed

+4385
-57
lines changed

.file-name-linter.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
],
77
"jekyll/assets": [
88
"/[0-9\\-a-z_]+\\.",
9-
"\\.(webp|pdf|zip)$"
9+
"\\.(webp|pdf|zip|svg)$"
1010
]
1111
},
1212
"ignore": [

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1-
## wechaty.js.org
1+
<div align="center">
2+
<img src="https://github.com/wechaty/wechaty.js.org/blob/main/docs/images/wechaty-docusaurus.png" alt="wechaty logo" height ="auto" width="800" />
3+
<br />
4+
<h1>Wechaty Organization Website</h1>
5+
<p>
6+
Repository for the Wechaty Organization Website, a resource for the Wechaty Organization. It is the official Wechaty website for publishing latest news, blog posts, and documentation from our open source community.
7+
</p>
8+
<p align="center">
9+
<a href="https://github.com/wechaty/wechaty.js.org" alt="GitHub contributors">
10+
<img src="https://img.shields.io/github/contributors/wechaty/wechaty.js.org.svg" /></a>
11+
<a href="https://github.com/wechaty/wechaty.js.org" alt="GitHub issues by-label">
12+
<img src="https://img.shields.io/github/issues/wechaty/wechaty.js.org" /></a>
13+
<a href="https://gitter.im/wechaty/wechaty" alt="Gitter">
14+
<img src="https://img.shields.io/badge/Gitter-@layer5.svg?logo=slack" /></a>
15+
</p>
216

317
[![GitHub Pages CI](https://github.com/wechaty/wechaty.js.org/workflows/GitHub%20Pages%20CI/badge.svg)](https://github.com/wechaty/wechaty.js.org/actions?query=workflow%3A%22GitHub+Pages+CI%22)
418
[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)
519
[![DIVIO documentation system](https://img.shields.io/badge/DIVIO-Documentation%20System-blue)](https://documentation.divio.com/)
620
[![ES Modules](https://img.shields.io/badge/ES-Modules-brightgreen)](https://github.com/Chatie/tsconfig/issues/16)
721

8-
![Wechaty Docusaurus](docs/images/wechaty-docusaurus.png)
9-
10-
<https://wechaty.js.org> is the official Wechaty website for publishing latest news, blog posts, and documentation from our open source community.
22+
</div>
1123

1224
## How To Post a Blog
1325

@@ -88,7 +100,7 @@ npm test
88100

89101
## How To Preview Your changes
90102

91-
If you want to preview your blog post or changes on locahost, you need to have Jekyll installed in your machine. You can follow the [jekyll quickstart](https://jekyllrb.com/docs/) instructions to install jekyll.
103+
If you want to preview your blog post or changes on localhost, you need to have Jekyll installed in your machine. You can follow the [jekyll quickstart](https://jekyllrb.com/docs/) instructions to install jekyll.
92104

93105
### 1. Install Jekyll by Hand
94106

docusaurus/config/presets/redocusaurus.js

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ const redocusaurus = [
33
{
44
specs: [
55
{
6-
routePath: "/docs/openapi/",
7-
specUrl: "https://cdn.jsdelivr.net/npm/wechaty-grpc/dist/generated/wechaty/puppet.swagger.json",
6+
route: "/docs/openapi/",
7+
spec: "https://cdn.jsdelivr.net/npm/wechaty-grpc/dist/esm/out/wechaty/puppet.swagger.json",
88
},
99
{
10-
routePath: "/docs/openapi@latest",
11-
specUrl: "https://cdn.jsdelivr.net/npm/wechaty-grpc@latest/dist/generated/wechaty/puppet.swagger.json",
10+
route: "/docs/openapi@latest",
11+
spec: "https://cdn.jsdelivr.net/npm/wechaty-grpc@latest/dist/esm/out/wechaty/puppet.swagger.json",
1212
},
1313
{
14-
routePath: "/docs/openapi@next",
15-
specUrl: "https://cdn.jsdelivr.net/npm/wechaty-grpc@next/dist/generated/wechaty/puppet.swagger.json",
14+
route: "/docs/openapi@next",
15+
spec: "https://cdn.jsdelivr.net/npm/wechaty-grpc@next/dist/esm/out/wechaty/puppet.swagger.json",
1616
},
1717
],
1818
theme: {

docusaurus/config/theme/mod.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ const themeConfig = {
99
navbar,
1010
footer,
1111
algolia: {
12+
appId : 'BH4D9OD16A',
1213
apiKey : 'cd8ca324c447a803e8a196a5c8fa22dd',
1314
indexName : 'wechaty',
1415
searchParameters : {}, // Optional (if provided by Algolia)
@@ -34,7 +35,7 @@ const themeConfig = {
3435
// and https://docusaurus.io/docs/api/themes/configuration#metadatas
3536
// know more about Metadata configuration.
3637
image: 'img/wechaty-logo.svg',
37-
metadatas: [
38+
metaData: [
3839
{name: 'twitter:card', content: 'summary_large_image'},
3940
{name: 'twitter:image', content: 'img/wechaty-icon.png'},
4041
{name: 'twitter:title', content: 'Wechaty'},

docusaurus/docs/case-study/money-bot.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_label: Money BOT
33
title: 'Case Study: Money BOT'
44
---
55

6-
![image](https://wechaty.js.org/assets/2021/02-how-to-use-wechaty-to-ask-for-payment-before-user-joining-the-group/paying-by-qrcode.png)
6+
![image](https://wechaty.js.org/assets/2021/02-how-to-use-wechaty-to-ask-for-payment-before-user-joining-the-group/paying-by-qrcode.webp)
77

88
一直以来在私域流量运营领域都有这样一个需求:自动通过好友,并在新好友支付一定的费用之后,依据新好友所发送的关键字,将其拉到对应的微信群。关键字与微信群对应,并且微信群满员以后可以自动扩建。
99

@@ -132,4 +132,4 @@ Git: https://github.com/rixingyike/wechat-operation-assistant
132132
## Credit
133133

134134
@rixingyike [Programmer LIYI](https://yishulun.com), Tencent TVP.
135-
First published on the official account: [A small smart robot: help us automatically pull people, automatically verify payment, and automatically transfer the payment to the personal bank card] (https://mp.weixin.qq.com/s/TUKmK7IgJElECt7hNq5QEA).
135+
First published on the official account: [A small smart robot: help us automatically pull people, automatically verify payment, and automatically transfer the payment to the personal bank card] (https://mp.weixin.qq.com/s/TUKmK7IgJElECt7hNq5QEA).

docusaurus/docs/gsoc/2022.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: GSoC 2022
3+
---
4+
5+
![Wechaty Summer of Code](/img/docs/gsoc/wechaty-gsoc.png)
6+
7+
This page aggregates project ideas for Google Summer of Code 2022. See more information about this project and applications on the [Wechaty Google Summer of Code page](../).
8+
9+
## The Ideas
10+
11+
### Project 1: Create a Web Component for a Chat UI for Wechaty
12+
13+
UI is very user-friendly to the user, so UI developer kit is import to the developers. We want to create a Web Component in Angular for a Chat UI for Wechaty.
14+
15+
We will not try to reinvent the wheel. There are already exists some great resource for us to use:
16+
17+
1. [Fiora](https://fiora.suisuijiang.com/) is an interesting chat application power by socket.io, koa, MongoDB and React. (See: [https://github.com/yinxin630/fiora/issues/185](https://github.com/yinxin630/fiora/issues/185))
18+
2. [Aurora IMUI](https://github.com/jpush/aurora-imui) is a general IM UI components library, which does not depend on any specific IM SDK.
19+
3. [Chatvia](https://themeforest.net/item/chatvia-angular-chat-app-template/28316331) - Angular Chat App Template
20+
21+
* Expected outcomes: a Web UI Component that is good enough in production
22+
* Potential Mentor(s): lijiarui, Huan
23+
* Category: Core development
24+
* Skills Required: TypeScript (programming language), Angular
25+
* Difficulty Level: Medium
26+
* Hours: 175
27+
28+
### Project 2: Wechaty Rust
29+
30+
Rust is a new programming language with increasing popularity for its performance, memory safety and extensibility with existing systems.
31+
32+
Wechaty will benefit from a Rust Core module that interfaces with its original TypeScript code base for performance boost, and a potential to ship to browser and Native apps by building to binary and webAssembly.
33+
34+
* Expected outcomes: a Wechaty Minimum Viable Product (MVP) rewritten in Rust
35+
* Potential Mentor(s): Simon LIANG, Zihua WU
36+
* Category: Core development
37+
* Skills Required: Rust (programming language)
38+
* Difficulty Level: Medium
39+
* Hours: 175
40+
41+
### Project 3: Implement Wechaty Rasa Plugin
42+
43+
Rasa is a popular task-oriented dialogue system which can be a pipeline in IM platform. What's more, wechaty is an unifiy conversation AI SDK for chatbot. So Wechaty + Rasa will be the perfect project that developer can easily deploy their chatbot on multi-platforms.
44+
45+
1. Running Rasa Server. When you run the rasa server, it will expose the message service with http protocol.
46+
2. Communicating with Rasa Server. This process is a simple work which will send the request to the server and receive the message sending the wechaty end account.
47+
48+
* Expected outcomes: A production-ready server that can communicated with Wechaty service and Rasa servers
49+
* Potential Mentor(s): @wj-Mcat, Xiaoquan Kong
50+
* Category: Core development
51+
* Skills Required: Python (programming language), Natural Language Processing, Rasa
52+
* Difficulty Level: Medium
53+
* Hours: 175
54+
55+
### Project 4: Implement "Twitter" Puppet
56+
57+
We want Wechaty to be the universal instant messaging SDK on all IM platforms for chatbot makers to build their great conversational user interface, so while these are our ideas of what we think would make good projects for the summer, we're eager to hear your ideas and proposals as well.
58+
59+
Implement Twitter Puppet. The Puppet abstraction allows Wechaty to provide a consisting API on all IM platforms for build a chatbot. We are supporting WeChat, WeCom, Whatsapp already, and we want to support Twitter so that our developers can run their chatbots on Twitter to serve users from Twitter.
60+
61+
* Expected outcomes: A production-ready puppet that can support Twitter communicate with Wechaty
62+
* Potential Mentor(s): Huan
63+
* Category: Core development
64+
* Skills Required: TypeScript (programming language), Twitter API
65+
* Difficulty Level: Medium
66+
* Hours: 175
67+
68+
### Project 5: Conversational robot that provides COVID-19 information services for elderly groups
69+
70+
The elderly population is more susceptible to COVID-19 virus infection and has a very high mortality rate. At the same time, the elderly population has barriers in accessing information: devices such as smartphones are not friendly to the elderly population. Many parts of the world have a high level of population aging and therefore have a large number of elderly populations. Society should pay more attention to the health of these elderly people and act quickly. Let's make a voice-based intelligent assistant to help the elderly population get information to protect themselves from COVID-19 virus infection.
71+
72+
We will use [Rasa](https://rasa.com) as the backend engine to provide conversational AI experience. And, we will use Wechaty to provide the frontend. Wechaty has the ablility to connect with lots of IM in different countries, so we can serve as many elders as possible.
73+
74+
* Expected outcomes: A chatbot backend server and multiple IM clients. It should provide Information on covid-19 travel ban, virus protection, self-diagnosis, and medical consultation. All this need to be done by talk with the user by text or audio.
75+
* Potential Mentor(s): Xiaoquan Kong
76+
* Category: Public welfare
77+
* Skills Required: Python (programming language), Rasa framework
78+
* Difficulty Level: Medium
79+
* Hours: 175

docusaurus/docs/gsoc/overview.md

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Wechaty is applying to join GSoC in 2021 as its first time.
1717
## Iterations of Summer of Wechaty for GSoC
1818

1919
- [2021](2021.md)
20+
- [2022](2022.md)
2021

2122
### Useful Links
2223

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: 'Puppet Provider: Oicq'
3+
sidebar_label: Oicq
4+
---
5+
6+
[![Wechaty Puppet Oicq](https://img.shields.io/badge/Puppet-Oicq-blueviolet)](oicq)
7+
8+
[![NPM Version](https://badge.fury.io/js/wechaty-puppet-oicq.svg)](https://badge.fury.io/js/wechaty-puppet-oicq)
9+
[![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-oicq/next.svg)](https://www.npmjs.com/package/wechaty-puppet-oicq?activeTab=versions)
10+
11+
Wechaty Puppet for QQ based on project takayama-lily/oicq-template
12+
13+
## Features
14+
15+
1. Send & receive messages
16+
1. Message type support: TEXT
17+
18+
## Usage
19+
20+
<!-- MDX import -->
21+
import Tabs from '@theme/Tabs'
22+
import TabItem from '@theme/TabItem'
23+
24+
<Tabs
25+
groupId="operating-systems"
26+
defaultValue="linux"
27+
values={[
28+
{ label: 'Linux', value: 'linux', },
29+
{ label: 'macOS', value: 'mac', },
30+
{ label: 'Windows', value: 'windows', },
31+
]
32+
}>
33+
34+
<TabItem value="linux">
35+
36+
```sh
37+
npm install wechaty-puppet-oicq
38+
export WECHATY_PUPPET=wechaty-puppet-oicq
39+
npm start
40+
```
41+
42+
</TabItem>
43+
<TabItem value="mac">
44+
45+
```sh
46+
npm install wechaty-puppet-oicq
47+
export WECHATY_PUPPET=wechaty-puppet-oicq
48+
npm start
49+
```
50+
51+
</TabItem>
52+
<TabItem value="windows">
53+
54+
```sh
55+
npm install wechaty-puppet-oicq
56+
set WECHATY_PUPPET=wechaty-puppet-oicq
57+
npm start
58+
```
59+
60+
</TabItem>
61+
</Tabs>
62+
63+
## Roadmap
64+
65+
- Add `roomList` support
66+
- Add `roomMembers` support
67+
68+
## Important Links
69+
70+
- Repo: <https://github.com/wechaty/wechaty-puppet-oicq>
71+
- Support & Feedback: <https://github.com/wechaty/wechaty-puppet-oicq/issues>
72+
73+
## Blogs
74+
75+
- [OSPP 2021-结项报告-开发支持 QQ 聊天软件的 Wechaty Puppet Provider 模块, @anaivebird, Oct 6, 2021](https://wechaty.js.org/2021/10/06/ospp-final-term-qq-puppet/)
76+
77+
## Maintainers
78+
79+
- [@anaivebird](https://wechaty.js.org/contributors/anaivebird)

docusaurus/docs/puppet-providers/padlocal.md

+10
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@ sidebar_label: PadLocal
1414
- Repo: <https://github.com/padlocal/wechaty-puppet-padlocal>
1515
- Support & Feedback: <https://github.com/padlocal/wechaty-puppet-padlocal/issues>
1616

17+
## Known Issues
18+
19+
1. `TypeError [ERR_INVALID_ARG_TYPE]: The "listener" argument must be of type function. Received undefined`
20+
21+
The PadLocal version v0.4 can only be used with Wechaty version v0.x (below v1.0). You need to use Wechaty v0.x when you are using PadLocal v0.4.
22+
23+
Related issues:
24+
25+
- [can't use gateway padlocal/wechaty-puppet-padlocal#117](https://github.com/padlocal/wechaty-puppet-padlocal/issues/117#issuecomment-988773575)
26+
1727
## Features
1828

1929
PadLocal is a full-featured Wechaty Puppet Provider.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: 'Puppet Provider: SimplePad'
3+
sidebar_label: SimplePad
4+
---
5+
6+
[![Wechaty Puppet SimplePad](https://img.shields.io/badge/Puppet-SimplePad-blueviolet)](simplepad)
7+
8+
[![npm version](https://badge.fury.io/js/wechaty-puppet-simplepad.svg)](https://badge.fury.io/js/wechaty-puppet-simplepad)
9+
10+
- Repo: <https://github.com/chatrbot/wechaty-puppet-simplepad>
11+
- Support & Feedback: <https://github.com/chatrbot/wechaty-puppet-simplepad/issues>
12+
13+
## Origin
14+
15+
In fact, before we knew wechaty, our team already had a complete set of wechat api used in internal projects. The entire SimplePad-Puppet is built on this api system. So when using SimplePad, you can not only Through Wechaty-Puppet, you can also use the Http protocol directly.
16+
Thanks to [@Huan](https://wechaty.js.org/contributors/huan/) and the Wechaty community for their great work, we quickly joined the Wechaty community and ecosystem.
17+
18+
## Features
19+
20+
- Simple enough architecture.The simpler it is, the less mistakes.
21+
- Based on Http protocol.You can request the API directly in your favorite programming language,if you're not good at typescript.
22+
- Perfect debugging tool.We provide a complete debugging tool to debug all api.
23+
- For a reasonable charge, you can only buy the api you need.
24+
25+
## Why SimplePad?
26+
27+
We provide support for multiple protocols (PC/Mac/Ipad, Ipad is recommended). Compared with other Puppets, it also provides moments api.
28+
29+
## How to install and run?
30+
31+
Just three steps, you can quickly experience!
32+
33+
1. [Sign up](http://121.199.64.183:8866/user/#/login) for a test token(7 days)
34+
35+
2. clone [demo project](https://github.com/chatrbot/wechaty-puppet-simplepad-demo)
36+
37+
3. install demo packages and run:
38+
39+
```shell
40+
cd wechaty-puppet-simplepad-demo
41+
npm install
42+
npx ts-node ./bot.ts -t {YOUR_TOKEN}
43+
```
44+
45+
## WIKI
46+
47+
You can get more project information and usage from [here](https://github.com/chatrbot/wechaty-puppet-simplepad/wiki)
48+
49+
## Conclusion
50+
51+
If you are interested in wechaty and looking for a flexible and stable Puppet, try SimplePad.
52+
We are also actively preparing to update to Wechaty 1.x version, we are getting better together with Wechaty.
53+
54+
## Maintainer
55+
56+
[@simplepad](https://wechaty.js.org/contributors/simplepad/)
57+
58+
## Related Post
59+
60+
[New Wechaty Puppet Service: SimplePad](https://wechaty.js.org/2021/06/17/puppet-simplepad-hello/)

docusaurus/docs/puppet-providers/transclusions/badges.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[![Wechaty Puppet PadLocal](https://img.shields.io/badge/Puppet-PadLocal-blueviolet)](../padlocal.md)
77
[![Wechaty Puppet WeChat4U](https://img.shields.io/badge/Puppet-WeChat4U-blueviolet)](../wechat4u.md)
88
[![Wechaty Puppet XP](https://img.shields.io/badge/Puppet-XP-blueviolet)](../xp.mdx)
9+
[![Wechaty Puppet Oicq](https://img.shields.io/badge/Puppet-Oicq-blueviolet)](../oicq.mdx)
10+
[![Wechaty Puppet SimplePad](https://img.shields.io/badge/Puppet-SimplePad-blueviolet)](../simplepad.mdx)
911
[![Wechaty Puppet Service](https://img.shields.io/badge/Puppet-Service-blueviolet)](../service.md)
1012
[![Wechaty Puppet Mock](https://img.shields.io/badge/Puppet-Mock-blueviolet)](../mock.md)
1113
[![Wechaty Puppet DIY](https://img.shields.io/badge/Provider-DIY-blueviolet)](../diy.md)

docusaurus/docs/puppet-providers/wechat.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,12 @@ WeChat Accounts that are registered after 2017 might not be able to login Web We
2424

2525
Few points to be kept in mind :
2626

27+
1. [Can not login with UOS patch any more, Jan 1, 2022](https://github.com/wechaty/puppet-wechat/issues/192)
2728
1. Web API can not create room and invite members to room since 2018.
28-
2. The ID of contacts and rooms will change across sessions. [#1644](https://github.com/wechaty/wechaty/issues/1644)
29+
1. The ID of contacts and rooms will change across sessions. [#1644](https://github.com/wechaty/wechaty/issues/1644)
2930

3031
If you want to break the above limitations, then you need consider to use a Wechaty Puppet other than Web. Learn them from [Wechaty Puppet Providers](puppet-providers/overview.mdx).
3132

32-
## Fixed Issues
33-
34-
1. Support UOS with puppeteer : [#127](https://github.com/wechaty/wechaty-puppet-wechat/issues/127)
35-
3633
## Usage
3734

3835
<!-- MDX import -->

docusaurus/docs/puppet-services/faq.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
slug: /puppet-services/
32
title: FAQ - Wechaty Puppet Services
43
sidebar_label: 'Puppet Services: FAQ'
54
---

docusaurus/docs/puppet-services/overview.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
slug: /puppet-services/
23
title: Wechaty Puppet Services
34
sidebar_label: 'Overview'
45
---

0 commit comments

Comments
 (0)