nest-wechat

To use mobile application features in a NestJS application, import and register the WeChatMobileModule in your root module.

import { Module } from '@nestjs/common';
import { WeChatMobileModule } from 'nest-wechat';

@Module({
  imports: [WeChatMobileModule.register()],
})
export class AppModule {
}

Install the package using npm to use it in your NestJS project or as a standalone utility.

npm i --save nest-wechat

To run tests, you must first create a .env.test.local file containing your test credentials and Redis configuration.

1. Configure Environment

Create .env.test.local with the following keys:

• TEST_APPID: Your test AppID
• TEST_SECRET: Your test Secret
• TEST_JSSDK_URL: Your website URL for JSSDK testing
• TEST_TOKEN: Your WeChat token
• TEST_AESKEY: Your WeChat AES key
• REDIS_HOST, REDIS_PORT, REDIS_PASSWORD, REDIS_DB: Redis connection details
• REDIS_TTL: Redis Time-To-Live

2. Execute Test Commands

Use the following commands to run different test suites:

# Run end-to-end tests
npm run test:e2e

# Run a specific unit test
npm run test wechat.service.userinfo.spec.ts

To enforce the commit message standard automatically, set up husky and commitlint using the following steps.

1. Install and initialize Husky

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

2. Add the commit-msg hook

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

3. Install commitlint and conventional configuration

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

4. Configure commitlint

Create a commitlint.config.js file to extend the conventional configuration:

echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

Alternatively, you can customize rules in commitlint.config.js:

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

The WeChatService uses an ICache implementation to store access_token and jsapi_ticket to avoid hitting WeChat API rate limits. By default, it uses MapCache, but you can provide your own implementation via the cacheAdapter property.

// Customizing the cache adapter
const myCache: ICache = { /* implementation */ };
wechatService.cacheAdapter = myCache;

The WeChatService is configured via WeChatModuleOptions. Key properties include:

• config: Configuration read/write properties.
• cacheAdapter: An object implementing ICache. Defaults to a Map-based implementation.

If you are not using NestJS, you can instantiate WeChatService directly as a utility class.

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

Methods for retrieving various types of access tokens for Official Accounts.

// Get standard account access token
public async getAccountAccessToken (_appId?: string, _secret?: string): Promise<AccountAccessTokenResult>;

// Get stable version access token
public async getStableAccessToken (_appId?: string, _secret?: string, force = false): Promise<AccountAccessTokenResult>;

// Get jsapi_ticket
public async getJSApiTicket (_appId?: string, _secret?: string): Promise<TicketResult>;

The pay object provides methods for Mini Program payment flows, including order creation, querying, closing, and refunding. Most methods require mchId, serialNo, and a privateKey (Buffer or string).

// Example: JSAPI Order Creation
pay.jsapi (order: TransactionOrder, serialNo: string, privateKey: Buffer | string): Promise<{prepay_id: string}>;

// Example: Build Mini Program Payment Parameters
pay.buildMiniProgramPayment (appId: string, prepayId: string, privateKey: Buffer | string): MiniProgramPaymentParameters;

// Example: Handle Payment Notification
pay.paidCallback (publicKey: Buffer | string, apiKey: string, req: Request, res: Response): Promise<Trade>;