### Install Husky

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/COMMIT_STANDARD.md

Steps to install the Husky package as a development dependency and initialize it in the project.

```shell
npm install husky --save-dev
npx husky-init
```

--------------------------------

### Install Commitlint and Conventional Config

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/COMMIT_STANDARD.md

Installs the Commitlint CLI and the conventional commit configuration package.

```shell
npm install --save-dev @commitlint/config-conventional @commitlint/cli
```

--------------------------------

### Test Commitlint Configuration

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/COMMIT_STANDARD.md

Commands to test the Commitlint configuration by comparing the last two commits or linting from standard input.

```shell
npx commitlint --from HEAD~1 --to HEAD --verbose
```

```shell
echo 'foo: bar' | npx commitlint
```

--------------------------------

### Starting Message Push Service Test

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Command to start the message push service test using ts-node. This is used to verify message handling and integration with WeChat public platform.

```bash
npx ts-node -T tests/e2e/wechat-app.main.ts
```

--------------------------------

### Configure Commitlint

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/COMMIT_STANDARD.md

Sets up the commitlint.config.js file to use the conventional commit configuration and defines custom rules.

```javascript
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'body-max-line-length': [2, 'always', 60],
  }
}
```

--------------------------------

### Starting Message Push Service Test

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Command to start the message push service test using ts-node. This is used to verify message handling and integration with WeChat public platform.

```bash
npx ts-node -T tests/e2e/wechat-app.main.ts
```

--------------------------------

### Git Commit Commands

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/COMMIT_STANDARD.md

Demonstrates common Git commands for committing changes, including committing specific files or all staged changes.

```shell
git commit path/to/file
```

```shell
git commit .
```

--------------------------------

### Install nest-wechat

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Installs the nest-wechat package using npm. This is the first step to integrate the module into a NestJS application.

```shell
npm i --save nest-wechat
```

--------------------------------

### Install nest-wechat

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Installs the nest-wechat package using npm. This is the first step to integrate the module into a NestJS application.

```shell
npm i --save nest-wechat
```

--------------------------------

### Commit Types Explained

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/COMMIT_STANDARD.md

Lists and explains the different types of commits recognized by the conventional commit standard, such as feat, fix, docs, and chore.

```text
+ ci: 改变CI配置文件和脚本
+ feat: 新增功能特性
+ fix: 修复BUG
+ docs: 添加修改文档
+ style: Changes that do not affect the meaning of the code
+ refactor: 代码重构重写
+ perf: 性能优化、体验优化
+ test: Adding missing tests or correcting existing tests
+ build: 改变影响项目build脚本的代码、配置等
+ chore: 改变构建流程、添加依懒、添加工具等
+ revert: 回滚版本
```

--------------------------------

### Add Commit Message Hook

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/COMMIT_STANDARD.md

Configures the commit-msg hook using Husky to run Commitlint for validating commit messages.

```shell
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
```

--------------------------------

### Environment Configuration for Testing

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Example `.env.test.local` file structure for configuring test environments. Includes settings for WeChat AppID, secret, JSSDK URL, token, AES key, and Redis connection details.

```config
TEST_APPID=your/test/appid
TEST_SECRET=your/test/secret
TEST_JSSDK_URL=https://your/website/url
TEST_TOKEN=your/token
TEST_AESKEY=your/aeskey

REDIS_HOST=your/redis/host
REDIS_PORT=6379
REDIS_PASSWORD=
REDIS_DB=0
REDIS_TTL=600
```

--------------------------------

### Environment Configuration for Testing

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Example `.env.test.local` file structure for configuring test environments. Includes settings for WeChat AppID, secret, JSSDK URL, token, AES key, and Redis connection details.

```config
TEST_APPID=your/test/appid
TEST_SECRET=your/test/secret
TEST_JSSDK_URL=https://your/website/url
TEST_TOKEN=your/token
TEST_AESKEY=your/aeskey

REDIS_HOST=your/redis/host
REDIS_PORT=6379
REDIS_PASSWORD=
REDIS_DB=0
REDIS_TTL=600
```

--------------------------------

### Commit Message Structure

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/COMMIT_STANDARD.md

Defines the standard format for commit messages, including required and optional sections like type, subject, body, and footer.

```text
<type>: <subject>

<body>

<footer>
```

--------------------------------

### Get WeChat Mini Program User OpenPID

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Retrieves the open PID for a plugin user. Requires a code and an access token. Returns a DefaultRequestResult with the openpid.

```typescript
public async getPluginOpenPId (code: string, accessToken: string): Promise<DefaultRequestResult & { openpid: string }>;

```

--------------------------------

### Get WeChat Mini Program User OpenPID

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Retrieves the open PID for a plugin user. Requires a code and an access token. Returns a DefaultRequestResult with the openpid.

```typescript
public async getPluginOpenPId (code: string, accessToken: string): Promise<DefaultRequestResult & { openpid: string }>;

```

--------------------------------

### Get WeChat Mini Program Unlimited QR Code

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Generates an unlimited QR code for a WeChat Mini Program. Requires GetUnlimitedQRCode parameters and an access token. Returns a result containing the image buffer.

```typescript
public getUnlimitedQRCode (params: GetUnlimitedQRCode, accessToken: string): Promise<DefaultRequestResult & { buffer: Buffer }>;

```

--------------------------------

### Get WeChat Mini Program Unlimited QR Code

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Generates an unlimited QR code for a WeChat Mini Program. Requires GetUnlimitedQRCode parameters and an access token. Returns a result containing the image buffer.

```typescript
public getUnlimitedQRCode (params: GetUnlimitedQRCode, accessToken: string): Promise<DefaultRequestResult & { buffer: Buffer }>;

```

--------------------------------

### Get WeChat Mini Program QR Code

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Generates a QR code for a WeChat Mini Program with specific parameters. Requires a QRCode object and an access token. Returns a result containing the image buffer and content type.

```typescript
public async getQRCode (params: QRCode, accessToken: string): Promise<DefaultRequestResult & { contentType: string, buffer: Buffer }>;

```

--------------------------------

### Configure WeChat Server Signature

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Express handler for checking server signature configuration. Takes Request and Response objects. Typically used within an Express route for initial server setup and validation.

```typescript
WeChatService.checkSignatureExpress (req: Request, res: Response);

```

```typescript
@Get('push')
async pushTest (@Req() req: Request, @Res() res: Response) {
  this.service.checkSignatureExpress(req, res);
}

```

--------------------------------

### Configure WeChat Server Signature

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Express handler for checking server signature configuration. Takes Request and Response objects. Typically used within an Express route for initial server setup and validation.

```typescript
WeChatService.checkSignatureExpress (req: Request, res: Response);

```

```typescript
@Get('push')
async pushTest (@Req() req: Request, @Res() res: Response) {
  this.service.checkSignatureExpress(req, res);
}

```

--------------------------------

### Get WeChat Mini Program QR Code

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Generates a QR code for a WeChat Mini Program with specific parameters. Requires a QRCode object and an access token. Returns a result containing the image buffer and content type.

```typescript
public async getQRCode (params: QRCode, accessToken: string): Promise<DefaultRequestResult & { contentType: string, buffer: Buffer }>;

```

--------------------------------

### Get WeChat Mini Program Access Token

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Retrieves an access token for WeChat Mini Program API calls. Requires optional appId/secret. Returns an AccessTokenResult containing the access token.

```typescript
public getAccessToken (appId?: string, secret?: string): Promise<AccessTokenResult>;

```

```typescript
const service = new WeChatService({ appId: 'your app id', secret: 'your secret'});
const res = await service.mp.getAccessToken();
console.log(res.data.access_token);

```

--------------------------------

### WeChat Official Account API: JS-SDK

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Covers JS-SDK related functionalities. `getJSApiTicket` retrieves a JSAPI ticket required for signing, and `jssdkSignature` generates the signature parameters needed for WeChat JS-SDK integration on webpages. Includes example responses and references.

```APIDOC
WeChatOfficialAccountAPI:
  getJSApiTicket(_appId?: string, _secret?: string): Promise<TicketResult>
    Retrieves the JSAPI ticket, used for generating signatures for WeChat JS-SDK.
    Parameters:
      _appId: Optional WeChat App ID.
      _secret: Optional WeChat App Secret.
    Returns:
      TicketResult: Object containing ticket, expires_in, errcode, and errmsg.
    Example Response:
      {
        "errcode": 0,
        "errmsg": "ok",
        "ticket": "bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
        "expires_in": 7200
      }
    Reference: https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#62

  jssdkSignature(url: string): Promise<SignatureResult>
  jssdkSignature(url: string, appId: string, secret:string): Promise<SignatureResult>
    Generates signature parameters for WeChat JS-SDK based on a given URL.
    Parameters:
      url: The URL for which to generate the signature.
      appId: Optional WeChat App ID.
      secret: Optional WeChat App Secret.
    Returns:
      SignatureResult: Object containing signature parameters like nonceStr, timestamp, signature, etc.
    Reference: https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#65
```

--------------------------------

### Get WeChat Mini Program Phone Number

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Retrieves the user's phone number using a code obtained from the Mini Program. Requires the code and an access token. The implementation details are not fully specified in the signature.

```javascript
public async getPhoneNumber (code: string, accessToken: string);

```

--------------------------------

### Get WeChat Mini Program Phone Number

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Retrieves the user's phone number using a code obtained from the Mini Program. Requires the code and an access token. The implementation details are not fully specified in the signature.

```javascript
public async getPhoneNumber (code: string, accessToken: string);

```

--------------------------------

### WeChat Official Account API: JS-SDK

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Covers JS-SDK related functionalities. `getJSApiTicket` retrieves a JSAPI ticket required for signing, and `jssdkSignature` generates the signature parameters needed for WeChat JS-SDK integration on webpages. Includes example responses and references.

```APIDOC
WeChatOfficialAccountAPI:
  getJSApiTicket(_appId?: string, _secret?: string): Promise<TicketResult>
    Retrieves the JSAPI ticket, used for generating signatures for WeChat JS-SDK.
    Parameters:
      _appId: Optional WeChat App ID.
      _secret: Optional WeChat App Secret.
    Returns:
      TicketResult: Object containing ticket, expires_in, errcode, and errmsg.
    Example Response:
      {
        "errcode": 0,
        "errmsg": "ok",
        "ticket": "bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
        "expires_in": 7200
      }
    Reference: https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#62

  jssdkSignature(url: string): Promise<SignatureResult>
  jssdkSignature(url: string, appId: string, secret:string): Promise<SignatureResult>
    Generates signature parameters for WeChat JS-SDK based on a given URL.
    Parameters:
      url: The URL for which to generate the signature.
      appId: Optional WeChat App ID.
      secret: Optional WeChat App Secret.
    Returns:
      SignatureResult: Object containing signature parameters like nonceStr, timestamp, signature, etc.
    Reference: https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#65
```

--------------------------------

### WeChat Official Account API: Access Token Management

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Provides methods for obtaining WeChat access tokens. `getAccountAccessToken` fetches the standard account access token, while `getStableAccessToken` retrieves a stable, long-lived token. Both include example responses for success and error cases.

```APIDOC
WeChatOfficialAccountAPI:
  getAccountAccessToken(_appId?: string, _secret?: string): Promise<AccountAccessTokenResult>
    Fetches the account access token for WeChat Official Accounts.
    Parameters:
      _appId: Optional WeChat App ID.
      _secret: Optional WeChat App Secret.
    Returns:
      AccountAccessTokenResult: Object containing access_token and expires_in.
    Example Success Response:
      {
        "access_token": "52_s0Mcl3E3DBKs12rthjxG8_DOvsIC4puV9A34WQR6Bhb_30TW9W9BjhUxDRkyph-hY9Ab2QS03Q8wZBe5UkA1k0q0hc17eUDZ7vAWItl4iahnhq_57dCoKc1dQ3AfiHUKGCCMJ2NcQ0BmbBRIKBEgAAAPGJ",
        "expires_in": 7200
      }
    Example Error Response:
      {
        "errcode": 40013,
        "errmsg": "invalid appid"
      }
    Reference: https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html

  getStableAccessToken(_appId?: string, _secret?: string, force = false): Promise<AccountAccessTokenResult>
    Fetches a stable, long-lived access token.
    Parameters:
      _appId: Optional WeChat App ID.
      _secret: Optional WeChat App Secret.
      force: Boolean to force refresh the token.
    Reference: https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/getStableAccessToken.html
```

--------------------------------

### Create WeChat Mini Program QR Code

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Creates a QR code for a WeChat Mini Program with specified parameters. Requires CreateQRCode parameters and an access token. Returns a result containing the image buffer and content type.

```typescript
public async createQRCode (params: CreateQRCode, accessToken: string): Promise<DefaultRequestResult & { contentType: string, buffer: Buffer }>;

```

--------------------------------

### Get WeChat QR Code via Ticket

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Retrieves a QR code image using a ticket. Requires a ticket string. Returns a Buffer representing the image.

```typescript
public showQRCode (ticket: string): Promis<Buffer>;

```

--------------------------------

### Get WeChat QR Code via Ticket

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Retrieves a QR code image using a ticket. Requires a ticket string. Returns a Buffer representing the image.

```typescript
public showQRCode (ticket: string): Promis<Buffer>;

```

--------------------------------

### Running E2E Tests

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Command to execute end-to-end tests for the project. Assumes test configurations are set up in the environment.

```shell
npm run test:e2e
```

--------------------------------

### Running Unit Tests

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Command to execute specific unit tests, targeting a particular file like `wechat.service.userinfo.spec.ts`.

```shell
npm run test wechat.service.userinfo.spec.ts
```

--------------------------------

### Running Unit Tests

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Command to execute specific unit tests, targeting a particular file like `wechat.service.userinfo.spec.ts`.

```shell
npm run test wechat.service.userinfo.spec.ts
```

--------------------------------

### Get WeChat Mini Program Access Token

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Retrieves an access token for WeChat Mini Program API calls. Requires optional appId/secret. Returns an AccessTokenResult containing the access token.

```typescript
public getAccessToken (appId?: string, secret?: string): Promise<AccessTokenResult>;

```

```typescript
const service = new WeChatService({ appId: 'your app id', secret: 'your secret'});
const res = await service.mp.getAccessToken();
console.log(res.data.access_token);

```

--------------------------------

### Create WeChat Mini Program QR Code

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Creates a QR code for a WeChat Mini Program with specified parameters. Requires CreateQRCode parameters and an access token. Returns a result containing the image buffer and content type.

```typescript
public async createQRCode (params: CreateQRCode, accessToken: string): Promise<DefaultRequestResult & { contentType: string, buffer: Buffer }>;

```

--------------------------------

### Running E2E Tests

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Command to execute end-to-end tests for the project. Assumes test configurations are set up in the environment.

```shell
npm run test:e2e
```

--------------------------------

### Query WeChat Mini Program RID Information

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Retrieves information associated with a given RID. Requires the RID string and an access token. Returns RidInfo.

```typescript
public async getRid (rid: string, accessToken: string): Promise<RidInfo>;

```

--------------------------------

### Query WeChat Mini Program URL Link

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Queries information about a URL link. Requires the urlLink string and an access token. Returns UrlLinkResult.

```typescript
public queryUrlLink (urlLink: string, accessToken: string): Promise<UrlLinkResult>;

```

--------------------------------

### Query WeChat Mini Program RID Information

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Retrieves information associated with a given RID. Requires the RID string and an access token. Returns RidInfo.

```typescript
public async getRid (rid: string, accessToken: string): Promise<RidInfo>;

```

--------------------------------

### Query WeChat Mini Program Scheme

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Queries information about a scheme code. Requires the scheme string and an access token. Returns scheme info and quota details.

```typescript
public async queryScheme (scheme: string, accessToken: string): Promise<DefaultRequestResult & { scheme_info: SchemeInfo, scheme_quota: SchemeQuota }>;

```

--------------------------------

### Query WeChat Mini Program URL Link

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Queries information about a URL link. Requires the urlLink string and an access token. Returns UrlLinkResult.

```typescript
public queryUrlLink (urlLink: string, accessToken: string): Promise<UrlLinkResult>;

```

--------------------------------

### ICache Interface Definition

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Defines the `ICache` interface, which custom cache adapters must implement. It includes methods for getting, setting, removing cache entries, and closing the cache connection. This allows for flexible caching strategies.

```typescript
/**
 * 缓存接口，需要自定义缓存，请实现该接口
 * 
 * cache interface, please implement this interface if you need.
 * 
 */
export interface ICache {
  get<T> (key: string): Promise<T>;
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  set (key: string, value: any): void;
  remove (key: string): boolean;
  close (): void;
}
```

--------------------------------

### WeChat Public Platform Message Push Configuration

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Configuration details for setting up message push notifications from the WeChat Public Platform. Includes the service URL and a verification token.

```APIDOC
URL: http://your/url/wechat/push, e.g., http://113.22.11.2:3001/wechat/push
Token: pamtest
```

--------------------------------

### Generate WeChat Mini Program Short Link

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Generates a short link for a WeChat Mini Program. Requires GenerateShortLink parameters and an access token. Returns the generated link.

```typescript
public generateShortLink (params: GenerateShortLink, accessToken: string): Promise<DefaultRequestResult & { link: string }>;

```

--------------------------------

### ICache Interface Definition

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Defines the `ICache` interface, which custom cache adapters must implement. It includes methods for getting, setting, removing cache entries, and closing the cache connection. This allows for flexible caching strategies.

```typescript
/**
 * 缓存接口，需要自定义缓存，请实现该接口
 * 
 * cache interface, please implement this interface if you need.
 * 
 */
export interface ICache {
  get<T> (key: string): Promise<T>;
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  set (key: string, value: any): void;
  remove (key: string): boolean;
  close (): void;
}
```

--------------------------------

### Query WeChat Mini Program Scheme

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Queries information about a scheme code. Requires the scheme string and an access token. Returns scheme info and quota details.

```typescript
public async queryScheme (scheme: string, accessToken: string): Promise<DefaultRequestResult & { scheme_info: SchemeInfo, scheme_quota: SchemeQuota }>;

```

--------------------------------

### Generate WeChat Mini Program Scheme

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Generates a scheme link for a WeChat Mini Program. Requires GenerateScheme parameters and an access token. Returns the generated openlink.

```typescript
public generateScheme (params: GenerateScheme, accessToken: string): Promise<DefaultRequestResult & { openlink: string >;

```

--------------------------------

### WeChat Public Platform Message Push Configuration

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Configuration details for setting up message push notifications from the WeChat Public Platform. Includes the service URL and a verification token.

```APIDOC
URL: http://your/url/wechat/push, e.g., http://113.22.11.2:3001/wechat/push
Token: pamtest
```

--------------------------------

### WeChat Mini Program APIs

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/_sidebar.md

APIs for WeChat Mini Programs, covering user authentication, session management, data retrieval, and mini program code management. Includes obtaining interface credentials, user info, login, and various code generation methods.

```APIDOC
WeChat Mini Program APIs:

Get Interface Call Credentials:
  - Purpose: Obtain access tokens for Mini Program API calls.
  - Parameters:
    - grant_type: client_credential
    - appid: Mini Program AppID
    - secret: Mini Program AppSecret
  - Returns: Access token, expires_in.
  - Related: Login Code2Session.

Query RID Information:
  - Purpose: Retrieve information related to a specific RID.

Get Plugin User OpenPID:
  - Purpose: Obtain the OpenPID for a plugin user.

Login Code2Session:
  - Purpose: Exchange a temporary code for a session key and user openid.
  - Parameters:
    - appid: Mini Program AppID
    - secret: Mini Program AppSecret
    - js_code: The temporary code obtained from the client.
    - grant_type: authorization_code
  - Returns: Session key, openid, unionid, errcode, errmsg.
  - Related: Get Interface Call Credentials.

Get User Phone Number:
  - Purpose: Obtain the user's encrypted phone number.
  - Parameters:
    - code: Code obtained from client-side component.
    - encrypted_data: Encrypted phone number data.
    - iv: Initialization vector.
  - Returns: Decrypted phone number.

Get Mini Program Code:
  - Purpose: Generate a Mini Program QR code for a specific page with parameters.
  - Parameters:
    - access_token: Valid access token.
    - path: Path of the Mini Program page.
    - width: QR code width.
    - auto_color: Whether to use auto color.
    - line_color: Line color.
    - background: Background color.
  - Returns: QR code image.
  - Related: Get Unlimited Mini Program Code, Get Mini Program QR Code.

Get Unlimited Mini Program Code:
  - Purpose: Generate a Mini Program QR code without limits on usage.
  - Parameters:
    - access_token: Valid access token.
    - scene: Scene parameter for the page.
    - page: Path of the Mini Program page.
    - check_path: Whether to check if the page exists.
  - Returns: QR code image.
  - Related: Get Mini Program Code.

Get Mini Program QR Code:
  - Purpose: Generate a Mini Program QR code for a specific page.
  - Related: Get Mini Program Code, Get Unlimited Mini Program Code.

Query Scheme Code:
  - Purpose: Query information about a scheme code.

Get Scheme Code:
  - Purpose: Generate a scheme code for deep linking.

Get NFC Mini Program Scheme:
  - Purpose: Generate a scheme code for NFC interactions.

Get URL Link:
  - Purpose: Generate a URL Link for Mini Programs.

Query URL Link:
  - Purpose: Query information about a URL Link.

Get Short Link:
  - Purpose: Generate a short link for Mini Programs.

Send Uniform Message:
  - Purpose: Send a unified message to a user.

Create activity_id:
  - Purpose: Create an activity ID for dynamic messages.

Modify Dynamic Message:
  - Purpose: Update a dynamic message.

Delete Template:
  - Purpose: Remove a template from the Mini Program.

Get Categories:
  - Purpose: Retrieve available categories for templates.

Get Keyword List:
  - Purpose: Fetch keywords associated with a category.

Get Public Templates in Category:
  - Purpose: Retrieve public templates within a specific category.

Get Personal Template List:
  - Purpose: Fetch the list of personal templates.

Send Subscription Message:
  - Purpose: Send subscription messages to users.
  - Parameters:
    - access_token: Valid access token.
    - touser: User's OpenID.
    - template_id: Template message ID.
    - data: Message content.
  - Related: Add Template.

Add Template:
  - Purpose: Add a template to the Mini Program.
  - Related: Send Subscription Message.
```

--------------------------------

### Generate WeChat Mini Program URL Link

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Generates a URL link for a WeChat Mini Program. Requires GenerateUrlLink parameters and an access token. Returns the generated url_link.

```typescript
public generateUrlLink (params: GenerateUrlLink, accessToken: string): Promise<DefaultRequestResult & { url_link: string }>;

```

--------------------------------

### WeChat Pay Partner Get User Invoice Title API

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Retrieves the invoice title information provided by a user for electronic invoicing. Requires user-specific parameters, service provider merchant ID, sub-merchant ID, and a serial number for certificate management.

```APIDOC
getUserTitleOfPartner (params: GetUserTitleParams, spMchId: string, subMchId: string, serialNo: string, privateKey: Buffer | string);
```

--------------------------------

### Generate WeChat Mini Program Short Link

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Generates a short link for a WeChat Mini Program. Requires GenerateShortLink parameters and an access token. Returns the generated link.

```typescript
public generateShortLink (params: GenerateShortLink, accessToken: string): Promise<DefaultRequestResult & { link: string }>;

```

--------------------------------

### WeChat Pay Partner Get User Invoice Title API

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Retrieves the invoice title information provided by a user for electronic invoicing. Requires user-specific parameters, service provider merchant ID, sub-merchant ID, and a serial number for certificate management.

```APIDOC
getUserTitleOfPartner (params: GetUserTitleParams, spMchId: string, subMchId: string, serialNo: string, privateKey: Buffer | string);
```

--------------------------------

### Generate WeChat Mini Program Scheme

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Generates a scheme link for a WeChat Mini Program. Requires GenerateScheme parameters and an access token. Returns the generated openlink.

```typescript
public generateScheme (params: GenerateScheme, accessToken: string): Promise<DefaultRequestResult & { openlink: string >;

```

--------------------------------

### WeChat Official Account API: Access Token Management

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Provides methods for obtaining WeChat access tokens. `getAccountAccessToken` fetches the standard account access token, while `getStableAccessToken` retrieves a stable, long-lived token. Both include example responses for success and error cases.

```APIDOC
WeChatOfficialAccountAPI:
  getAccountAccessToken(_appId?: string, _secret?: string): Promise<AccountAccessTokenResult>
    Fetches the account access token for WeChat Official Accounts.
    Parameters:
      _appId: Optional WeChat App ID.
      _secret: Optional WeChat App Secret.
    Returns:
      AccountAccessTokenResult: Object containing access_token and expires_in.
    Example Success Response:
      {
        "access_token": "52_s0Mcl3E3DBKs12rthjxG8_DOvsIC4puV9A34WQR6Bhb_30TW9W9BjhUxDRkyph-hY9Ab2QS03Q8wZBe5UkA1k0q0hc17eUDZ7vAWItl4iahnhq_57dCoKc1dQ3AfiHUKGCCMJ2NcQ0BmbBRIKBEgAAAPGJ",
        "expires_in": 7200
      }
    Example Error Response:
      {
        "errcode": 40013,
        "errmsg": "invalid appid"
      }
    Reference: https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html

  getStableAccessToken(_appId?: string, _secret?: string, force = false): Promise<AccountAccessTokenResult>
    Fetches a stable, long-lived access token.
    Parameters:
      _appId: Optional WeChat App ID.
      _secret: Optional WeChat App Secret.
      force: Boolean to force refresh the token.
    Reference: https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/getStableAccessToken.html
```

--------------------------------

### Utility Class Usage

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Demonstrates how to instantiate and use `WeChatService` directly as a utility class outside of the NestJS module system. It requires passing WeChat configuration options during instantiation.

```javascript
import { WeChatService } from 'nest-wechat';
const service = new WeChatService({ appId: 'your app id', secret: 'your secret'});
```

--------------------------------

### WeChat Pay Partner JSAPI Build Payment Parameters API

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Constructs the parameters necessary to invoke the WeChat Pay JSAPI payment interface in a mini-program or web environment. Requires the application ID, the pre-pay transaction ID obtained from placing an order, and the merchant's private key.

```APIDOC
buildJSAPIParameters (appId: string, prepayId: string, privateKey: Buffer | string): MiniProgramPaymentParameters;
```

--------------------------------

### WeChat Official Account API: Webpage Authorization

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Provides methods for WeChat webpage authorization. `getAccessTokenByCode` exchanges an authorization code for an access token, and `getUserInfo` retrieves user profile details using an access token and openid. Includes example request/response formats and reference links.

```APIDOC
WeChatOfficialAccountAPI:
  getAccessTokenByCode(code: string, _appId?: string, _secret?: string): Promise<UserAccessTokenResult>
    Exchanges an authorization code for a user access token.
    Parameters:
      code: The authorization code obtained from WeChat.
      _appId: Optional WeChat App ID.
      _secret: Optional WeChat App Secret.
    Returns:
      UserAccessTokenResult: Object containing access_token, expires_in, refresh_token, openid, and scope.
    Example Success Response:
      {
        "access_token":"ACCESS_TOKEN",
        "expires_in":7200,
        "refresh_token":"REFRESH_TOKEN",
        "openid":"OPENID",
        "scope":"SCOPE"
      }
    Example Error Response:
      {
          "errcode": 40029,
          "errmsg": "invalid code"
      }
    Reference: https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html

  getUserInfo(accessToken: string, openid: string, lang: 'zh_CN' | 'zh_TW' | 'en' = 'zh_CN'): Promise<UserInfoResult>
    Retrieves user information from WeChat using an access token and openid.
    Parameters:
      accessToken: The access token for authentication.
      openid: The user's unique openid.
      lang: The language for the returned user information (default: 'zh_CN').
    Returns:
      UserInfoResult: Object containing user details like nickname, sex, location, headimgurl, etc.
    Example Success Response:
      {
        "openid": "OPENID",
        "nickname": NICKNAME,
        "sex": 1,
        "province":"PROVINCE",
        "city":"CITY",
        "country":"COUNTRY",
        "headimgurl":"https://thirdwx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/46",
        "privilege":[ "PRIVILEGE1", "PRIVILEGE2" ],
        "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"
      }
    Example Error Response:
      {
        "errcode":40003,
        "errmsg":" invalid openid "
      }
```

--------------------------------

### Generate WeChat Mini Program URL Link

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Generates a URL link for a WeChat Mini Program. Requires GenerateUrlLink parameters and an access token. Returns the generated url_link.

```typescript
public generateUrlLink (params: GenerateUrlLink, accessToken: string): Promise<DefaultRequestResult & { url_link: string }>;

```

--------------------------------

### WeChat Official Account API: Webpage Authorization

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Provides methods for WeChat webpage authorization. `getAccessTokenByCode` exchanges an authorization code for an access token, and `getUserInfo` retrieves user profile details using an access token and openid. Includes example request/response formats and reference links.

```APIDOC
WeChatOfficialAccountAPI:
  getAccessTokenByCode(code: string, _appId?: string, _secret?: string): Promise<UserAccessTokenResult>
    Exchanges an authorization code for a user access token.
    Parameters:
      code: The authorization code obtained from WeChat.
      _appId: Optional WeChat App ID.
      _secret: Optional WeChat App Secret.
    Returns:
      UserAccessTokenResult: Object containing access_token, expires_in, refresh_token, openid, and scope.
    Example Success Response:
      {
        "access_token":"ACCESS_TOKEN",
        "expires_in":7200,
        "refresh_token":"REFRESH_TOKEN",
        "openid":"OPENID",
        "scope":"SCOPE"
      }
    Example Error Response:
      {
          "errcode": 40029,
          "errmsg": "invalid code"
      }
    Reference: https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html

  getUserInfo(accessToken: string, openid: string, lang: 'zh_CN' | 'zh_TW' | 'en' = 'zh_CN'): Promise<UserInfoResult>
    Retrieves user information from WeChat using an access token and openid.
    Parameters:
      accessToken: The access token for authentication.
      openid: The user's unique openid.
      lang: The language for the returned user information (default: 'zh_CN').
    Returns:
      UserInfoResult: Object containing user details like nickname, sex, location, headimgurl, etc.
    Example Success Response:
      {
        "openid": "OPENID",
        "nickname": NICKNAME,
        "sex": 1,
        "province":"PROVINCE",
        "city":"CITY",
        "country":"COUNTRY",
        "headimgurl":"https://thirdwx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/46",
        "privilege":[ "PRIVILEGE1", "PRIVILEGE2" ],
        "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"
      }
    Example Error Response:
      {
        "errcode":40003,
        "errmsg":" invalid openid "
      }
```

--------------------------------

### MessageCrypto Static Methods

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Detailed list of static methods available in the MessageCrypto class for cryptographic operations. Covers SHA1, MD5, AES key/IV generation, PKCS7 encoding/decoding, encryption/decryption, nonce generation, and message handling.

```APIDOC
MessageCrypto:
  sha1 (...args: string[]): string;
  md5 (text: string): string;
  getAESKey (encodingAESKey: string): Buffer;
  getAESKeyIV (aesKey: Buffer): Buffer;
  PKCS7Encoder (buff: Buffer): Buffer;
  PKCS7Decoder (buff: Buffer): Buffer;
  decrypt (aesKey: Buffer, iv: Buffer, str: string): string;
  encrypt (aesKey: Buffer, iv: Buffer, msg: string, appId: string): string;
  createNonceStr (length = 16): string;
  encryptMessage (appId: string, token: string, encodingAESKey: string, message: string, timestamp: string, nonce: string): string;
  decryptMessage (token: string, encodingAESKey: string, signature: string, timestamp: string, nonce: string, encryptXml: string);
  checkSignature (signature: string, timestamp: string, nonce: string, token: string);
```

--------------------------------

### Docsify Configuration

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/index.html

Configuration object for the Docsify documentation generator, setting up repository links, fallback languages, search functionality, and other display options.

```javascript
window.$docsify = {
  name: 'nest-wechat',
  repo: 'https://github.com/baaxl9vh/nest-wechat.git',
  fallbackLanguages: ['zh'],
  formatUpdated: '{MM}/{DD} {HH}:{mm}',
  notFoundPage: true,
  mergeNavbar: true,
  loadNavbar: true,
  loadFooter: true,
  loadSidebar: true,
  search: {
    maxAge: 86400000,
    paths: [],
    placeholder: {
      '/zh-cn/': '搜索',
      '/': 'Type to search'
    },
    noData: {
      '/zh-cn/': '找不到结果',
      '/': 'No Results'
    },
    depth: 2,
    hideOtherSidebarContent: false,
    namespace: 'website-1'
  }
};
```

--------------------------------

### Create WeChat QR Code with Parameters

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Generates a QR code with specified parameters for accounts. Requires an AccountCreateQRCode object and optional appId/secret. Returns AccountCreateQRCodeResult.

```typescript
public async createQRCode (data: AccountCreateQRCode, appId?: string, secret?: string): Promise<AccountCreateQRCodeResult>;

```

--------------------------------

### WeChat Pay Partner JSAPI Build Payment Parameters API

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Constructs the parameters necessary to invoke the WeChat Pay JSAPI payment interface in a mini-program or web environment. Requires the application ID, the pre-pay transaction ID obtained from placing an order, and the merchant's private key.

```APIDOC
buildJSAPIParameters (appId: string, prepayId: string, privateKey: Buffer | string): MiniProgramPaymentParameters;
```

--------------------------------

### NestJS Module Registration (forRootAsync method)

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/README.md

Shows how to register the WeChatModule asynchronously using `forRootAsync`. This method allows for deferred configuration, often reading credentials from environment variables via `ConfigModule` and injecting dependencies like `CACHE_MANAGER` for custom cache adapters.

```javascript
import { CACHE_MANAGER, Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { Cache } from 'cache-manager';
import { RedisCache, WeChatModule } from 'nest-wechat';

@Module({
  imports: [
    ConfigModule.forRoot({
      envFilePath: '.env.test.local',
    }),
    WeChatModule.forRootAsync({
      imports: [ConfigModule],
      inject: [ConfigService, CACHE_MANAGER],
      useFactory: (configService: ConfigService, cache: Cache) => ({
        appId: configService.get('WX_APPID'),
        secret: configService.get('WX_SECRET'),
        token: configService.get('WX_TOKEN'),
        encodingAESKey: configService.get('WX_AESKEY'),
        cacheAdapter: new RedisCache(cache),
        debug: true,
      }),
    }),
  ]
})
export class AppModule {
}
```

--------------------------------

### Create WeChat QR Code with Parameters

Source: https://github.com/baaxl9vh/nest-wechat/blob/main/docs/README.md

Generates a QR code with specified parameters for accounts. Requires an AccountCreateQRCode object and optional appId/secret. Returns AccountCreateQRCodeResult.

```typescript
public async createQRCode (data: AccountCreateQRCode, appId?: string, secret?: string): Promise<AccountCreateQRCodeResult>;

```