@juzi/wechaty-grpc 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-now Huan LI (李卓桓) <zixia@zixia.net>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,351 @@
+<!-- markdownlint-disable MD033 MD041 -->
+
+<div align="center">
+<img src="docs/images/wechaty-grpc-logo.svg" width="400" />
+<br />
+<h1>Wechaty gRPC</h1>
+<p>
+gRPC Service & Protocol Buffers for Wechaty Puppet
+</p>
+<a href="https://github.com/wechaty/grpc/issues
+"><img src="https://img.shields.io/github/issues/wechaty/grpc?style=flat-square" /></a>
+<a href="https://github.com/wechaty/grpc/network/members"><img src="https://img.shields.io/github/forks/wechaty/grpc?style=flat-square" /></a>
+<a href="https://github.com/wechaty/grpc/stargazers"><img src="https://img.shields.io/github/stars/wechaty/grpc?style=flat-square" /></a>
+<a href="https://github.com/wechaty/grpc/blob/master/LICENSE"><img src="https://img.shields.io/github/license/wechaty/grpc?style=flat-square" /></a>
+<a href="https://github.com/Chatie/tsconfig/issues/16"><img src="https://img.shields.io/badge/ES-Modules-brightgreen" /></a>
+</div>
+
+<div align="center">
+
+[![Node.js NPM](https://github.com/wechaty/grpc/actions/workflows/node.yml/badge.svg)](https://github.com/wechaty/grpc/actions/workflows/node.yml)
+[![C# Nuget](https://github.com/wechaty/grpc/actions/workflows/csharp.yml/badge.svg)](https://github.com/wechaty/grpc/actions/workflows/csharp.yml)
+[![Go](https://github.com/wechaty/grpc/actions/workflows/go.yml/badge.svg)](https://github.com/wechaty/grpc/actions/workflows/go.yml)
+[![Java Maven](https://github.com/wechaty/grpc/actions/workflows/java.yml/badge.svg)](https://github.com/wechaty/grpc/actions/workflows/java.yml)
+[![PHP](https://github.com/wechaty/grpc/actions/workflows/php.yml/badge.svg)](https://github.com/wechaty/grpc/actions/workflows/php.yml)
+[![Python PyPI](https://github.com/wechaty/grpc/actions/workflows/python.yml/badge.svg)](https://github.com/wechaty/grpc/actions/workflows/python.yml)
+
+[![NPM Version](https://img.shields.io/npm/v/wechaty-grpc?color=brightgreen&label=NPM&style=flat-square)](https://www.npmjs.com/package/wechaty-grpc)
+[![PyPI Version](https://img.shields.io/pypi/v/chatie-grpc?color=blue&label=PyPI&style=flat-square)](https://pypi.org/project/chatie-grpc/)
+[![Java Version](https://img.shields.io/maven-central/v/io.github.wechaty/grpc?label=Java&style=flat-square)](https://mvnrepository.com/artifact/io.github.wechaty/grpc)
+[![PHP Version](https://img.shields.io/packagist/v/wechaty/php-grpc?style=flat-square)](https://packagist.org/packages/wechaty/php-grpc)
+[![node](https://img.shields.io/node/v/wechaty.svg?maxAge=604800&label=Node.js&style=flat-square)](https://nodejs.org/)
+[![Python 3.7](https://img.shields.io/badge/python-3.7+-blue.svg?label=Python&style=flat-square)](https://www.python.org/downloads/release/python-370/)
+[![Go Version](https://img.shields.io/github/go-mod/go-version/wechaty/go-wechaty?style=flat-square)](https://pkg.go.dev/github.com/wechaty/grpc/go/wechaty)
+
+</div>
+
+<details open="open">
+<summary>Table of Contents</summary>
+<ol>
+<li>
+<a href="#About">About</a>
+</li>
+<li>
+<a href="#Usage">Usage</a>
+<ul>
+<li><a href="#Nodejs">Node.js</a></li>
+<li><a href="#Python">Python</a></li>
+<li><a href="#Go">Go</a></li>
+<li><a href="#Java">Java</a></li>
+<li><a href="#PHP">PHP</a></li>
+<li><a href="#CSharp">CSharp</a></li>
+</ul>
+</li>
+<li>
+<a href="#Development">Development</a>
+<ul>
+<li><a href="#Debug">Debug</a></li>
+<li><a href="#Build">Build</a></li>
+<li><a href="#Generate-Stubs">Generate Stubs</a></li>
+</ul>
+</li>
+<li><a href="#OpenAPI">OpenAPI</a></li>
+<li><a href="#gRPC-Web">gRPC Web</a></li>
+<li><a href="#Resources">Resources</a></li>
+<li><a href="#Contributing">Contributing</a></li>
+<li><a href="#Maintainer">Maintainer</a></li>
+<li><a href="#Copyright--License">Copyright & License</a></li>
+</ol>
+
+## About
+
+gRPC is a modern open-source high-performance Remote Procedure Call (RPC) framework that can run in any environment. It can efficiently connect services in and across data centers with pluggable support for load balancing, tracing, health checking, and authentication. It is also applicable in the last mile of distributed computing to connect devices, mobile applications, and browsers to backend services.
+
+## Usage
+
+### Node.js
+
+[wechaty-grpc@NPM](https://www.npmjs.com/package/wechaty-grpc)
+
+**Docs:**
+  
+- <https://paka.dev/npm/wechaty-grpc>
+- <https://wechaty.github.io/grpc/>
+
+**Maintainer:**
+
+- [@huan](https://github.com/huan) - Huan LI (李卓桓)
+
+### Python
+
+[chatie-grpc@PyPI](https://pypi.org/project/chatie-grpc)
+
+**Maintainer:**
+
+- [@wj-Mcat](https://github.com/wj-Mcat) - Jingjing WU (吴京京)
+
+### Go
+
+[github.com/wechaty/go-grpc](https://github.com/wechaty/go-grpc)
+
+**Maintainer:**
+
+- [@dchaofei](https://github.com/dchaofei) - Chaofei DING (丁超飞)
+
+### Java
+
+[https://mvnrepository.com/artifact/io.github.wechaty/grpc](https://mvnrepository.com/artifact/io.github.wechaty/grpc)
+
+**Maven:**
+
+```xml
+<dependency>
+    <groupId>io.github.wechaty</groupId>
+    <version>0.11.25</version>
+    <artifactId>grpc</artifactId>
+</dependency>
+```
+
+**Gradle:**
+
+```groovy
+compile 'io.github.wechaty:grpc:0.11.25'
+```
+
+**Maintainer:**
+
+- [@diaozxin007](https://github.com/diaozxin007) - Zhengxin DIAO (刁政欣)
+
+### PHP
+
+[github.com/wechaty/php-grpc](https://github.comwechaty/php-grpc)
+
+**Maintainer:**
+
+- [@zhangchunsheng](https://github.com/zhangchunsheng) - Chunsheng ZHANG (张春生)
+
+### CSharp
+
+[Wechaty.Grpc @ Nuget](https://www.nuget.org/packages/Wechaty.Grpc)
+
+**Maintainer:**
+
+- [@Darren](https://github.com/jesn) - Darren (郑波)
+
+## Development
+
+### Debug
+
+- [GUI Client for GRPC Services](https://github.com/uw-labs/bloomrpc) - BloomRPC aims to give the simplest and efficient developer experience for exploring and querying your GRPC services. (Inspired by Postman and GraphQL Playground)
+- [A gRPC CLI interface for easy testing against gRPC servers with Node.js REPL](https://github.com/njpatel/grpcc)
+
+```shell
+grpcc --proto ./service/myservice.proto --address 127.0.0.1:3466
+```
+
+### Build
+
+```shell
+./scripts/install-protoc.sh
+npm install
+```
+
+> <https://github.com/google/protobuf/releases/latest>
+
+### Generate Stubs
+
+```shell
+npm run generate
+```
+
+#### 1. JS for Protocol Buffer
+
+```shell
+protoc \
+  --js_out="import_style=commonjs,binary:${OUT_DIR}"
+```
+
+> <https://github.com/google/protobuf/releases/latest>
+
+#### 2. JS for gRPC Stubs
+
+```shell
+protoc \
+  --plugin="protoc-gen-grpc=`which grpc_tools_node_protoc_plugin`" \
+  --grpc_out="${OUT_DIR}"
+```
+
+> <https://www.npmjs.com/package/grpc-tools>
+
+#### 3. TypeScript Typing Definations for Protocol Buffer & gRPC Stubs
+
+```shell
+protoc \
+  --plugin="protoc-gen-grpc=node_modules/grpc_tools_node_protoc_ts/bin/protoc-gen-ts" \
+  --grpc_out="${OUT_DIR}"
+```
+
+> <https://github.com/agreatfool/grpc_tools_node_protoc_ts>
+
+#### 4. JS & TS for gRPC Web
+
+```shell
+protoc \
+  --plugin="protoc-gen-ts=node_modules/ts-protoc-gen/bin/protoc-gen-ts" \
+  --ts_out="service=true:${OUT_DIR}"
+```
+
+> <https://github.com/improbable-eng/ts-protoc-gen>
+
+### Naming conventions & Style Guide
+
+1. [Google Cloud APIs - Naming conventions](https://cloud.google.com/apis/design/naming_convention)
+1. [Protocol Buffers - Developer Guide - Style Guide](https://developers.google.com/protocol-buffers/docs/style)
+
+## OpenAPI
+
+Learn more about the RESTful API service for Wechaty from [Wechaty OpenAPI](https://github.com/wechaty/openapi).
+
+## gRPC Web
+
+- [gRPC-Web ReactJS client, Golang Server](https://github.com/longfellowone/grpcwebtest)
+
+## RESOURCES
+
+### Documentation
+
+- [Protocol Buffers Language Guide (proto3)](https://developers.google.com/protocol-buffers/docs/proto3)
+- [Google Protocol Buffers Style Guide](https://developers.google.com/protocol-buffers/docs/style)
+- [Protocol Buffers for TypeScript with Decorators](https://github.com/protobufjs/protobuf.js#using-decorators)
+- [Troubleshooting gRPC](https://github.com/grpc/grpc/blob/master/TROUBLESHOOTING.md)
+- [gRPC environment variables](https://github.com/grpc/grpc/blob/master/doc/environment_variables.md)
+- [How to Interact With and Debug a gRPC Server](https://medium.com/@EdgePress/how-to-interact-with-and-debug-a-grpc-server-c4bc30ddeb0b)
+
+### Links
+
+- [探讨gRPC的Node技术生态及实现工具](https://xenojoshua.com/2018/02/grpc-node-ecosystem/)
+- [gRPC Basics - Node.js](https://grpc.io/docs/tutorials/basic/node.html)
+- [Building a gRPC service with Node.js](https://codelabs.developers.google.com/codelabs/cloud-grpc/)
+- [gRPC in 3 minutes (Node.js)](https://github.com/grpc/grpc/tree/master/examples/node)
+- [Listen gRPC and HTTP requests on the same port](https://medium.com/@drgarcia1986/listen-grpc-and-http-requests-on-the-same-port-263c40cb45ff)
+- [gRPC to JSON proxy generator following the gRPC HTTP spec](https://github.com/grpc-ecosystem/grpc-gateway)
+- [如何在 Node.js 中更优雅地使用 gRPC：grpc-helper](https://github.com/xizhibei/blog/issues/86)
+- [Comparing OpenAPI With gRPC](https://dzone.com/articles/comparing-openapi-with-grpc)
+
+#### Protocol Buffer
+
+Thanks to the ecosystem of gRPC, we can generate OpenAPI Specification from our gRPC proto definitions automatically.
+
+We are using [gRPC to JSON proxy generator following the gRPC HTTP spec](https://github.com/grpc-ecosystem/grpc-gateway) as the OpenAPI Specification generator ([protoc-gen-openapiv2](https://github.com/grpc-ecosystem/grpc-gateway/tree/master/protoc-gen-openapiv2)), and using [Like grpc-gateway, but written in node and dynamic](https://github.com/konsumer/grpc-dynamic-gateway) project to serve an HTTP RESTful API to gRPC proxy.
+
+<div align="center"><a link="https://github.com/wechaty/openapi"><img src="https://raw.githubusercontent.com/wechaty/grpc/master/docs/images/grpc-gateway-architecture.svg" width="400" /><a></div>
+
+> Image credit: [gRPC Gateway](https://grpc-ecosystem.github.io/grpc-gateway/)
+
+Learn more about the RESTful API service for Wechaty from [Wechaty OpenAPI](https://github.com/wechaty/openapi).
+
+See also:
+
+- [AIP-4222 - Routing headers](https://google.aip.dev/client-libraries/4222)
+- [gRPC-Gateway Official Website](https://grpc-ecosystem.github.io/grpc-gateway/)
+
+## gRPC Web
+
+- [gRPC-Web ReactJS client, Golang Server](https://github.com/longfellowone/grpcwebtest)
+
+## Resources
+
+Check out [RESOURCES.md](RESOURCES.md) file for learning resources.
+
+## Guidelines
+
+- [Google Protocol Buffers Style Guide](https://developers.google.com/protocol-buffers/docs/style)
+- [Google Cloud API Naming Conventions](https://cloud.google.com/apis/design/naming_convention)
+- [Google Cloud Cloud API Design Guide](https://cloud.google.com/apis/design/)
+
+## Changelog
+
+### master v1.0 (Mar 14, 2022)
+
+1. v1.0 release
+1. add `post` event
+
+### v0.33 (Oct 18, 2021)
+
+- ~~[ ] Rename `ENUM` from `CONTACT_GENDER_MALE` to `MALE` ([#110](https://github.com/wechaty/grpc/issues/110))~~
+- [ ] Fix typos
+
+### v0.27
+
+1. ES Modules support
+1. Export generated protocol buffers class as `puppet`
+
+### v0.20 (Feb 21, 2021)
+
+1. Rename NPM module name from `@chatie/grpc` to `wechaty-grpc`
+1. Add OpenAPI annotations & generators for supporting <https://github.com/wechaty/openapi>
+1. Code clean.
+
+### v0.18 (Oct 15, 2020)
+
+- Add new `MessageFileStream` and `MessageImageStream` to replace the `MessageFile` and `MessageImage` method to avoid blocking nodejs event loop when sending large files ([#88](https://github.com/wechaty/grpc/pull/88)) by [@windmemory](https://github.com/windmemory)
+- Add new `MessageSendFileStream` to replace the `MessageSendFile` method to avoid blocking nodejs event loop when sending large files ([#89](https://github.com/wechaty/grpc/pull/89)) by [@windmemory](https://github.com/windmemory)
+
+### v0.17 (Aug 5, 2020)
+
+- Add PHH Support ([#76](https://github.com/wechaty/grpc/pull/76) [#78](https://github.com/wechaty/grpc/pull/78)) by [@zhangchunsheng](https://github.com/zhangchunsheng)
+- Publish PHP Module at <https://github.com/wechaty/php-grpc>
+
+### v0.13 (Apr 19, 2020)
+
+- Add Java Support ([#52](https://github.com/wechaty/grpc/issues/52) [#53](https://github.com/wechaty/grpc/issues/53) by [@diaozxin007](https://github.com/diaozxin007))
+- Publish Java Module at [Open Source Project Repository HostingOSSRH-56843 - Release the Chatie/grpc Java Client](https://issues.sonatype.org/browse/OSSRH-56843)
+
+### v0.11 (Apr 10, 2020)
+
+- Add Go Support ([#50](https://github.com/wechaty/grpc/issues/50) by [@dchaofei](https://github.com/dchaofei))
+- Publish Go Module at <github.com/wechaty/go-grpc>
+
+Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+See [CONTRIBUTING.md](http://github.com/wechaty/grpc/blob/master/CONTRIBUTING.md) for more details.
+
+## Releases
+
+Since its creation in 2016, a number of Wechaty versions have been released. For more information about the release history and the current stable version, you can read the [Wechaty release notes](https://github.com/Wechaty/wechaty/releases) on Github.
+
+## Contributors
+  
+<a href="https://github.com/wechaty/grpc/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=wechaty/grpc" />
+</a>
+
+Made with [contrib.rocks](https://contrib.rocks).
+
+## Maintainer
+
+Wechaty is maintained by [Huan](https://github.com/huan), [Rui](https://github.com/lijiarui), and a community of Open Source Contributors. We are always looking for people to join the Wechaty community to maintain the Wechaty codebase and documentation. You necessarily don't have to be a programmer to contribute to Wechaty. To get started contributing, you can read the [CONTRIBUTING.md](http://github.com/wechaty/grpc/blob/master/CONTRIBUTING.md).
+
+## Getting help
+
+Wechaty has a community of very helpful contributors on different platforms you can join to get help from. Before joining any of the communities, we recommend that you read our Code of conduct]o that you adhere to our community guidelines. A full list of the different Wechaty communities can be accessed from the [Wechaty community](https://wechaty.js.org/docs/community/) section of this documentation.
+
+## Copyright & License
+
+Wechaty is an [Open Source Project](https://opensource.com/resources/what-open-source). It is released under [Apache-2.0 license](https://github.com/wechaty/wechaty/blob/master/LICENSE) and the corresponding documentation is released under the [Creative Commons license](https://creativecommons.org/licenses/).

package/dist/cjs/commonjs/README.md

@@ -0,0 +1,15 @@
+# CommonJS Wrappers
+
+Huan(202108): CommonJS wrappers for workaround
+
+## package.json
+
+It must be exists because the ts-node will require this file for running under CommonJS mode.
+
+## `.cjs`
+
+`.cjs` is a file that contains CommonJS wrapper code.
+
+## `.cjs.d.ts`
+
+`.cjs.d.ts` is a file that contains the type definition of the CommonJS wrapper code.

package/dist/cjs/commonjs/code-root.cjs

@@ -0,0 +1,10 @@
+const path = require('path')
+
+const codeRoot = path.join(
+  __dirname,
+  '..',
+)
+
+module.exports = {
+  codeRoot,
+}

package/dist/cjs/commonjs/code-root.cjs.d.ts

@@ -0,0 +1 @@
+export declare const codeRoot: string

package/dist/cjs/commonjs/code-root.spec.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env -S ts-node --project tsconfig.cjs.json
+
+import { test } from 'tstest'
+
+import { codeRoot } from './code-root.cjs'
+
+test('CJS: codeRoot()', async t => {
+  t.ok(codeRoot, 'should exist codeRoot')
+})

package/dist/cjs/commonjs/generated/google.cjs

@@ -0,0 +1,9 @@
+const googleFileList = [
+  '../../out/google/api/health_check/v1/health_check_grpc_pb.js',
+  '../../out/google/api/health_check/v1/health_check_pb.js',
+]
+
+module.exports = googleFileList.reduce((acc, pkg) => ({
+  ...acc,
+  ...require(pkg),
+}), {}) // Huan(202108): must provide a `{}` as the initial value, or it will be `[]`

package/dist/cjs/commonjs/generated/google.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from '../../out/google/api/health_check/v1/health_check_grpc_pb.js'
+export * from '../../out/google/api/health_check/v1/health_check_pb.js'

package/dist/cjs/commonjs/generated/google.spec.ts

@@ -0,0 +1,13 @@
+#!/usr/bin/env -S ts-node --project tsconfig.cjs.json
+
+import { test } from 'tstest'
+
+import google from './google.cjs'
+
+test('CJS: HealthCheckResponse', async t => {
+  t.ok(google.HealthCheckResponse, 'should exists "HealthCheckResponse"')
+})
+
+test('CJS: ServingStatus.SERVING', async t => {
+  t.ok(google.HealthCheckResponse.ServingStatus.SERVING, 'should exists "ServingStatus.SERVING"')
+})

package/dist/cjs/commonjs/generated/puppet.cjs

@@ -0,0 +1,39 @@
+const puppetFileList = [
+  '../../out/wechaty/deprecated/file-box_pb.js',
+
+  '../../out/wechaty/puppet/base_pb.js',
+  '../../out/wechaty/puppet/contact_pb.js',
+  '../../out/wechaty/puppet/download-upload_pb.js',
+  '../../out/wechaty/puppet/event_pb.js',
+  '../../out/wechaty/puppet/friendship_pb.js',
+  '../../out/wechaty/puppet/location_pb.js',
+  '../../out/wechaty/puppet/message_pb.js',
+  '../../out/wechaty/puppet/mini-program_pb.js',
+  '../../out/wechaty/puppet/referrer_pb.js',
+  '../../out/wechaty/puppet/room_pb.js',
+  '../../out/wechaty/puppet/room-invitation_pb.js',
+  '../../out/wechaty/puppet/room-member_pb.js',
+  '../../out/wechaty/puppet/tag_pb.js',
+  '../../out/wechaty/puppet/url-link_pb.js',
+
+  '../../out/wechaty/puppet_grpc_pb.js',
+  '../../out/wechaty/puppet_pb.js',
+]
+
+/**
+ * Huan(202108):
+ *  if there's a "package.json" file in the `out/` directory,
+ *    then all the files in the `out/` directory will be treated as one module,
+ *    which means tht `require` each file under that directory will add methods to the same module.
+ */
+// for (const pkg of pkgs) {
+//   console.info('## pkg:', pkg)
+//   const module = require(pkg)
+//   console.info(Object.keys(module).length)
+//   // OOPS! The output number above will be keep increasing
+// }
+
+module.exports = puppetFileList.reduce((acc, pkg) => ({
+  ...acc,
+  ...require(pkg),
+}), {}) // Huan(202108): must provide a `{}` as the initial value, or it will be `[]`