[pull] master from wechat-miniprogram:master

.eslintrc.js

@@ -0,0 +1,63 @@
+module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        project: './tsconfig.json'
+    },
+    plugins: [
+        '@typescript-eslint',
+    ],
+    rules: {
+        indent: ['error', 4],
+        'no-trailing-spaces': ['error'],
+        semi: ['off'],
+        '@typescript-eslint/semi': ['error', 'never'],
+        '@typescript-eslint/no-extra-semi': ['error'],
+        quotes: ['off'],
+        '@typescript-eslint/quotes': ['error', 'single'],
+        '@typescript-eslint/ban-ts-comment': ['off'],
+        '@typescript-eslint/adjacent-overload-signatures': ['error'],
+        '@typescript-eslint/ban-types': ['error', {
+            extendDefaults: true,
+            types: {
+                /**
+                 * we are using `{}` as noop
+                 * e.g. `type A<P> = B & (P extends Q ? C : {})`
+                 * will get `B & C` when `P extends Q` and `B` otherwise
+                 */
+                '{}': false,
+                /**
+                 * we actually need a type accepting any function-like value
+                 * e.g. `type Methods = Record<string, Function>`
+                 */
+                'Function': false,
+            }
+        }],
+        '@typescript-eslint/member-delimiter-style': ['error', {
+            multiline: {
+                delimiter: 'none',
+                requireLast: false,
+            },
+            singleline: {
+                delimiter: 'comma',
+                requireLast: false
+            }
+        }],
+        '@typescript-eslint/naming-convention': ['error', {
+            selector: 'enum',
+            format: ['PascalCase', 'UPPER_CASE'],
+            leadingUnderscore: 'forbid',
+            trailingUnderscore: 'forbid',
+        }, {
+            selector: 'typeLike',
+            format: ['PascalCase'],
+            leadingUnderscore: 'forbid',
+            trailingUnderscore: 'forbid',
+        }],
+        '@typescript-eslint/array-type': ['error', {
+            default: 'array-simple',
+            readonly: 'array-simple'
+        }],
+        '@typescript-eslint/no-unnecessary-qualifier': ['error'],
+    },
+}

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+    - push
+    - pull_request
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - uses: pnpm/action-setup@v4
+              name: Install pnpm
+              with:
+                version: latest
+                run_install: false
+
+            - name: Install Node.js
+              uses: actions/setup-node@v4
+              with:
+                node-version: lts/*
+                cache: 'pnpm'
+
+            - name: Install dependencies
+              run: pnpm install --frozen-lockfile
+
+            - name: Run test
+              run: npm run test

.npmrc

@@ -0,0 +1 @@
+registry=https://registry.npmjs.org

README-en.md

@@ -2,41 +2,64 @@
 
 > [中文版本](./README.md)
 
+[![Published on DefinitelyTyped](https://img.shields.io/npm/v/@types/wechat-miniprogram?label=%40types)](https://www.npmjs.com/package/@types/wechat-miniprogram)
 [![Published on NPM](https://img.shields.io/npm/v/miniprogram-api-typings.svg?style=flat)](https://www.npmjs.com/package/miniprogram-api-typings)
 [![MIT License](https://img.shields.io/github/license/wechat-miniprogram/api-typings.svg)](https://github.com/wechat-miniprogram/api-typings)
-[![Travis CI Test Status](https://travis-ci.org/wechat-miniprogram/api-typings.svg?branch=master)](https://travis-ci.org/wechat-miniprogram/api-typings)
+[![GitHub Actions Test Status](https://github.com/wechat-miniprogram/api-typings/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/wechat-miniprogram/api-typings/actions/workflows/test.yml)
 
 Type definitions for APIs of Wechat Mini Program in TypeScript
 
 ## Install
 
-Install by NPM:
+### By standalone npm package
+
 ```bash
-# install definitions for latest base library
 npm install miniprogram-api-typings
 ```
 
-or specify a base library version:
+Manually import it after installed:
 
-```bash
-# install definitions for base library version 2.4.1
-npm install [email protected]
-```
+- `import 'miniprogram-api-typings';`
+
+Or specify types in typescript config:
+
+- Specify `types: ["miniprogram-api-typings"]` in `tsconfig.json`
+
+Or reference by [Triple-Slash Directives](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html):
 
-## Versions
+- `/// <reference path="node_modules/miniprogram-api-typings/index.d.ts" />`
 
-Check out all available versions corresponding to base library version in [VERSIONS.md](https://github.com/wechat-miniprogram/api-typings/blob/master/VERSIONS.md)
+or:
+
+### By DefinitelyTyped
+
+```bash
+npm install @types/wechat-miniprogram
+```
 
 ## Changelog
 
 See [CHANGELOG.md](https://github.com/wechat-miniprogram/api-typings/blob/master/CHANGELOG.md) (Chinese only)
 
 ## Contribution
 
-Definitions of Wechat APIs (`lib.wx.api.d.ts`) are auto-generated together with our [documentations](https://developers.weixin.qq.com/miniprogram/dev/index.html), therefore PRs including that file will __not__ be merged. If you found some APIs defined wrongly, create an issue instead.
+Definitions of Wechat APIs (`lib.wx.api.d.ts`) are auto-generated together with our [documentations](https://developers.weixin.qq.com/miniprogram/en/dev/api/), therefore PRs including that file will __not__ be merged. If you found some APIs defined wrongly, create an issue instead.
 
 Both PR and issue are welcomed for definitions of pages (`Page`), custom components (`Component`) and other else, since they are written manually. Help us improve this definition if you have any bug reports or suggestions! Thanks for contributing!
 
+### Contributors
+
+- [Baran](https://github.com/baranwang)
+- [MinLiang Zeng](https://github.com/zenml/)
+- [Garfield Lee](https://github.com/Garfield550)
+- [Mr.Hope](https://github.com/Mister-Hope)
+- [chs97](https://github.com/chs97)
+- [Jelf](https://github.com/okxiaoliang4)
+- [xieyuhang](https://github.com/haiya6)
+- [苏杰豪](https://github.com/Megasu)
+- [Yang Mingshan](https://github.com/yangmingshan)
+- [lvzl](https://github.com/lv-z-l)
+
 ### Automated tests
 
 We use [`tsd`](https://github.com/SamVerschueren/tsd) to check if this definition is working properly. All test cases are under folder `test`.

README.md

@@ -2,40 +2,64 @@
 
 > [English version](./README-en.md)
 
+[![已在 DefinitelyTyped 发布](https://img.shields.io/npm/v/@types/wechat-miniprogram?label=%40types)](https://www.npmjs.com/package/@types/wechat-miniprogram)
 [![已在 NPM 发布](https://img.shields.io/npm/v/miniprogram-api-typings.svg?style=flat)](https://www.npmjs.com/package/miniprogram-api-typings)
 [![MIT 协议](https://img.shields.io/github/license/wechat-miniprogram/api-typings.svg)](https://github.com/wechat-miniprogram/api-typings)
-[![Travis CI 测试状况](https://travis-ci.org/wechat-miniprogram/api-typings.svg?branch=master)](https://travis-ci.org/wechat-miniprogram/api-typings)
+[![GitHub Actions 测试状况](https://github.com/wechat-miniprogram/api-typings/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/wechat-miniprogram/api-typings/actions/workflows/test.yml)
 
 微信小程序 API 的 TypeScript 类型定义文件
 
 ## 安装
 
-通过 npm 安装：
+### 通过独立 npm 包
+
 ```bash
-# 安装对应最新基础库的定义文件
 npm install miniprogram-api-typings
 ```
 
-或者通过版本号指定一个基础库版本：
-```bash
-# 安装对应基础库版本 2.4.1 的定义文件
-npm install [email protected]
-```
+安装后手动导入：
+
+- `import 'miniprogram-api-typings';`
+
+或者在 ts 配置中指定：
+
+- 在 `tsconfig.json` 中指定 `types: ["miniprogram-api-typings"]`
 
-## 版本
+或者通过 [三斜杠指令](https://www.tslang.cn/docs/handbook/triple-slash-directives.html) 引用：
 
-所有可用的版本和对应的基础库版本，参考 [VERSIONS.md](https://github.com/wechat-miniprogram/api-typings/blob/master/VERSIONS.md)
+- `/// <reference path="node_modules/miniprogram-api-typings/index.d.ts" />`
+
+或：
+
+### 通过 DefinitelyTyped
+
+```bash
+npm install @types/wechat-miniprogram
+```
 
 ## 更新日志
 
 参考 [CHANGELOG.md](https://github.com/wechat-miniprogram/api-typings/blob/master/CHANGELOG.md)
 
 ## 贡献
 
-API 的定义文件（`lib.wx.api.d.ts`）是随 [文档](https://developers.weixin.qq.com/miniprogram/dev/index.html) 一起自动生成的，如果发现了 API 接口的定义错误，请提一个 issue 给我们，关于 API 的 PR 将 __不会__ 被接受。
+API 的定义文件（`lib.wx.api.d.ts`）是随 [文档](https://developers.weixin.qq.com/miniprogram/dev/api/) 一起自动生成的，如果发现了 API 接口的定义错误，请提一个 issue 给我们，关于 API 的 PR 将 __不会__ 被接受。
 
 如果有针对页面（`Page`）、自定义组件（`Component`）等接口的 bug 和建议，欢迎 PR 或提一个 issue 给我们。非常感谢！
 
+### 贡献者
+
+- [Baran](https://github.com/baranwang)
+- [MinLiang Zeng](https://github.com/zenml/)
+- [Garfield Lee](https://github.com/Garfield550)
+- [Mr.Hope](https://github.com/Mister-Hope)
+- [chs97](https://github.com/chs97)
+- [Jelf](https://github.com/okxiaoliang4)
+- [xieyuhang](https://github.com/haiya6)
+- [苏杰豪](https://github.com/Megasu)
+- [Yang Mingshan](https://github.com/yangmingshan)
+- [lvzl](https://github.com/lv-z-l)
+
 ### 测试
 
 本定义文件使用 [`tsd`](https://github.com/SamVerschueren/tsd) 进行测试，所有的测试样例放在 `test` 目录下。