Commit 2d73f11e authored by Aivs's avatar Aivs

feat:项目初始化

parent a709186d
Pipeline #198 failed with stages
MIT License
Copyright (c) 2021 Haixiang
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# wecom-sidebar
# wecom-sidebar-react-tpl
企业微信侧边栏前端开发模板
## 功能
- [x] 一份 [企业侧边栏客户端](https://open.work.weixin.qq.com/api/doc/90001/90144/90545) 模板
- [x] `wx.agentConfig`, `wx.config`, `wx.invoke` 函数封装
- [x] 侧边栏重定向获取用户身份 `checkRedirect`,以及 JsSDK 的初始化步骤 `initSdk`
- [x] Mock 侧边栏 JsSdk,**使其可以在浏览器上直接调试!**
- [X] TS 支持
- [x] React Router 的示例
## 基础配置
启动项目需要用到 `agentId``corpId`,需要创建 `src/_config.ts`(目前已隐藏),示例
```ts
// src/_config.ts
const config = {
// 在 https://work.weixin.qq.com/wework_admin/frame#profile 这里可以找到
corpId: '你的企业ID',
// 在 https://work.weixin.qq.com/wework_admin/frame#apps 里的自建应用里可以找到
agentId: '自建应用的AgentId'
}
export default config
```
## 代理配置
代理配置这里需要用到 [Whistle](https://wproxy.org/whistle/) 这个代理工具,请在 [这篇教程](https://wproxy.org/whistle/install.html) 里先安装 Whistle,
然后再在 [这篇教程](http://wproxy.org/whistle/webui/https.html) 中正确安装 HTTPS 证书(用于代理 HTTPS 流量),两个步骤请一定要正确执行!
然后在 whistle 中添加以下的代理配置,将后端路由传向本地
```
# 代理前端(侧边栏页面代理到本地的 3000 端口),这里要改为你自己配置H5的地址就好
//service-xxx-yyy.gz.apigw.tencentcs.com http://127.0.0.1:3000
# 代理后端(后端模板的 baseURL 该模板写死为 backend.com,这里代理到本地的 5000 端口)
//backend.com http://127.0.0.1:5000
```
## Mock
**此功能可以使得你在浏览器上直接调试侧边栏应用!**
**在浏览器模式下,会 Mock `jsSdk`,默认回调为空函数,并打上对应日志。你也可以在 `src/mock.ts` 下可以添加对 `wx.fn` 和 `wx.invoke` 这些函数的 Mock 值以及 Mock 函数。**
**如果你不想将 Mock 写死在项目上,你也可以利用 [Whistle 预先注入全局 JS](https://wproxy.org/whistle/rules/jsPrepend.html),以此在全局注入对应的 Mock 值和回调函数。**
Whistle 的 `Rules` 可以写成:
```
# 代理前端(侧边栏页面代理到本地的 3000 端口),这里要改为你自己配置H5的地址就好
//service-xxx-yyy.gz.apigw.tencentcs.com http://127.0.0.1:3000
# 代理后端(后端模板的 baseURL 该模板写死为 backend.com,这里代理到本地的 5000 端口)
//backend.com http://127.0.0.1:5000
# 全局注入 mock.js
//service-xxx-yyy.gz.apigw.tencentcs.com jsPrepend://{mock.js}
```
然后在 Whistle 页面的 `Values` (输入 http://127.0.0.1:8899/#values 可见) 中会自动生成一个 `mock.js`,再在里面添加如下代码:
```js
// Mock 当前用户 Id
window.mockUserId = 'xxx'
// 可在这里自由 mock wx.invoke 的内容
window.invokeResMock = {
'getCurExternalContact': {
userId: 'xxxxx'
},
}
// 可在这里自由 wx.fn 的内容
window.wxResMock = {
'agentConfig': () => {
console.log('mock agent config')
},
}
```
这里对应的 Mock 关系 Mapper 有 `wxResMock``invokeResMock` 分别对 `wx.fn``wx.invoke('api', callback')` 两种调用方式进行 Mock。
## 启动
启动项目
```bash
npm run start
```
## 更多
* 侧边栏的 Node 端开发模板(Express)可以看 [wecom-sidebar-express-tpl](https://github.com/wecom-sidebar/wecom-sidebar-express-tpl)
* 侧边栏的微前端开发模式(Qiankun)可以看 [weccom-sidebar-qiankun-tpl](https://github.com/wecom-sidebar/wecom-sidebar-qiankun-tpl)
'use strict';
const fs = require('fs');
const path = require('path');
const paths = require('./paths');
// Make sure that including paths.js after env.js will read .env variables.
delete require.cache[require.resolve('./paths')];
const NODE_ENV = process.env.NODE_ENV;
if (!NODE_ENV) {
throw new Error(
'The NODE_ENV environment variable is required but was not specified.'
);
}
// https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use
const dotenvFiles = [
`${paths.dotenv}.${NODE_ENV}.local`,
// Don't include `.env.local` for `test` environment
// since normally you expect tests to produce the same
// results for everyone
NODE_ENV !== 'test' && `${paths.dotenv}.local`,
`${paths.dotenv}.${NODE_ENV}`,
paths.dotenv,
].filter(Boolean);
// Load environment variables from .env* files. Suppress warnings using silent
// if this file is missing. dotenv will never modify any environment variables
// that have already been set. Variable expansion is supported in .env files.
// https://github.com/motdotla/dotenv
// https://github.com/motdotla/dotenv-expand
dotenvFiles.forEach(dotenvFile => {
if (fs.existsSync(dotenvFile)) {
require('dotenv-expand')(
require('dotenv').config({
path: dotenvFile,
})
);
}
});
// We support resolving modules according to `NODE_PATH`.
// This lets you use absolute paths in imports inside large monorepos:
// https://github.com/facebook/create-react-app/issues/253.
// It works similar to `NODE_PATH` in Node itself:
// https://nodejs.org/api/modules.html#modules_loading_from_the_global_folders
// Note that unlike in Node, only *relative* paths from `NODE_PATH` are honored.
// Otherwise, we risk importing Node.js core modules into an app instead of webpack shims.
// https://github.com/facebook/create-react-app/issues/1023#issuecomment-265344421
// We also resolve them to make sure all tools using them work consistently.
const appDirectory = fs.realpathSync(process.cwd());
process.env.NODE_PATH = (process.env.NODE_PATH || '')
.split(path.delimiter)
.filter(folder => folder && !path.isAbsolute(folder))
.map(folder => path.resolve(appDirectory, folder))
.join(path.delimiter);
// Grab NODE_ENV and REACT_APP_* environment variables and prepare them to be
// injected into the application via DefinePlugin in webpack configuration.
const REACT_APP = /^REACT_APP_/i;
function getClientEnvironment(publicUrl) {
const raw = Object.keys(process.env)
.filter(key => REACT_APP.test(key))
.reduce(
(env, key) => {
env[key] = process.env[key];
return env;
},
{
// Useful for determining whether we’re running in production mode.
// Most importantly, it switches React into the correct mode.
NODE_ENV: process.env.NODE_ENV || 'development',
// Useful for resolving the correct path to static assets in `public`.
// For example, <img src={process.env.PUBLIC_URL + '/img/logo.png'} />.
// This should only be used as an escape hatch. Normally you would put
// images into the `src` and `import` them in code to get their paths.
PUBLIC_URL: publicUrl,
// We support configuring the sockjs pathname during development.
// These settings let a developer run multiple simultaneous projects.
// They are used as the connection `hostname`, `pathname` and `port`
// in webpackHotDevClient. They are used as the `sockHost`, `sockPath`
// and `sockPort` options in webpack-dev-server.
WDS_SOCKET_HOST: process.env.WDS_SOCKET_HOST,
WDS_SOCKET_PATH: process.env.WDS_SOCKET_PATH,
WDS_SOCKET_PORT: process.env.WDS_SOCKET_PORT,
// Whether or not react-refresh is enabled.
// react-refresh is not 100% stable at this time,
// which is why it's disabled by default.
// It is defined here so it is available in the webpackHotDevClient.
FAST_REFRESH: process.env.FAST_REFRESH !== 'false',
}
);
// Stringify all values so we can feed into webpack DefinePlugin
const stringified = {
'process.env': Object.keys(raw).reduce((env, key) => {
env[key] = JSON.stringify(raw[key]);
return env;
}, {}),
};
return { raw, stringified };
}
module.exports = getClientEnvironment;
'use strict';
const fs = require('fs');
const path = require('path');
const crypto = require('crypto');
const chalk = require('react-dev-utils/chalk');
const paths = require('./paths');
// Ensure the certificate and key provided are valid and if not
// throw an easy to debug error
function validateKeyAndCerts({ cert, key, keyFile, crtFile }) {
let encrypted;
try {
// publicEncrypt will throw an error with an invalid cert
encrypted = crypto.publicEncrypt(cert, Buffer.from('test'));
} catch (err) {
throw new Error(
`The certificate "${chalk.yellow(crtFile)}" is invalid.\n${err.message}`
);
}
try {
// privateDecrypt will throw an error with an invalid key
crypto.privateDecrypt(key, encrypted);
} catch (err) {
throw new Error(
`The certificate key "${chalk.yellow(keyFile)}" is invalid.\n${
err.message
}`
);
}
}
// Read file and throw an error if it doesn't exist
function readEnvFile(file, type) {
if (!fs.existsSync(file)) {
throw new Error(
`You specified ${chalk.cyan(
type
)} in your env, but the file "${chalk.yellow(file)}" can't be found.`
);
}
return fs.readFileSync(file);
}
// Get the https config
// Return cert files if provided in env, otherwise just true or false
function getHttpsConfig() {
const { SSL_CRT_FILE, SSL_KEY_FILE, HTTPS } = process.env;
const isHttps = HTTPS === 'true';
if (isHttps && SSL_CRT_FILE && SSL_KEY_FILE) {
const crtFile = path.resolve(paths.appPath, SSL_CRT_FILE);
const keyFile = path.resolve(paths.appPath, SSL_KEY_FILE);
const config = {
cert: readEnvFile(crtFile, 'SSL_CRT_FILE'),
key: readEnvFile(keyFile, 'SSL_KEY_FILE'),
};
validateKeyAndCerts({ ...config, keyFile, crtFile });
return config;
}
return isHttps;
}
module.exports = getHttpsConfig;
'use strict';
const babelJest = require('babel-jest');
const hasJsxRuntime = (() => {
if (process.env.DISABLE_NEW_JSX_TRANSFORM === 'true') {
return false;
}
try {
require.resolve('react/jsx-runtime');
return true;
} catch (e) {
return false;
}
})();
module.exports = babelJest.createTransformer({
presets: [
[
require.resolve('babel-preset-react-app'),
{
runtime: hasJsxRuntime ? 'automatic' : 'classic',
},
],
],
babelrc: false,
configFile: false,
});
'use strict';
// This is a custom Jest transformer turning style imports into empty objects.
// http://facebook.github.io/jest/docs/en/webpack.html
module.exports = {
process() {
return 'module.exports = {};';
},
getCacheKey() {
// The output is always the same.
return 'cssTransform';
},
};
'use strict';
const path = require('path');
const camelcase = require('camelcase');
// This is a custom Jest transformer turning file imports into filenames.
// http://facebook.github.io/jest/docs/en/webpack.html
module.exports = {
process(src, filename) {
const assetFilename = JSON.stringify(path.basename(filename));
if (filename.match(/\.svg$/)) {
// Based on how SVGR generates a component name:
// https://github.com/smooth-code/svgr/blob/01b194cf967347d43d4cbe6b434404731b87cf27/packages/core/src/state.js#L6
const pascalCaseFilename = camelcase(path.parse(filename).name, {
pascalCase: true,
});
const componentName = `Svg${pascalCaseFilename}`;
return `const React = require('react');
module.exports = {
__esModule: true,
default: ${assetFilename},
ReactComponent: React.forwardRef(function ${componentName}(props, ref) {
return {
$$typeof: Symbol.for('react.element'),
type: 'svg',
ref: ref,
key: null,
props: Object.assign({}, props, {
children: ${assetFilename}
})
};
}),
};`;
}
return `module.exports = ${assetFilename};`;
},
};
'use strict';
const fs = require('fs');
const path = require('path');
const paths = require('./paths');
const chalk = require('react-dev-utils/chalk');
const resolve = require('resolve');
/**
* Get additional module paths based on the baseUrl of a compilerOptions object.
*
* @param {Object} options
*/
function getAdditionalModulePaths(options = {}) {
const baseUrl = options.baseUrl;
if (!baseUrl) {
return '';
}
const baseUrlResolved = path.resolve(paths.appPath, baseUrl);
// We don't need to do anything if `baseUrl` is set to `node_modules`. This is
// the default behavior.
if (path.relative(paths.appNodeModules, baseUrlResolved) === '') {
return null;
}
// Allow the user set the `baseUrl` to `appSrc`.
if (path.relative(paths.appSrc, baseUrlResolved) === '') {
return [paths.appSrc];
}
// If the path is equal to the root directory we ignore it here.
// We don't want to allow importing from the root directly as source files are
// not transpiled outside of `src`. We do allow importing them with the
// absolute path (e.g. `src/Components/Button.js`) but we set that up with
// an alias.
if (path.relative(paths.appPath, baseUrlResolved) === '') {
return null;
}
// Otherwise, throw an error.
throw new Error(
chalk.red.bold(
"Your project's `baseUrl` can only be set to `src` or `node_modules`." +
' Create React App does not support other values at this time.'
)
);
}
/**
* Get webpack aliases based on the baseUrl of a compilerOptions object.
*
* @param {*} options
*/
function getWebpackAliases(options = {}) {
const baseUrl = options.baseUrl;
if (!baseUrl) {
return {};
}
const baseUrlResolved = path.resolve(paths.appPath, baseUrl);
if (path.relative(paths.appPath, baseUrlResolved) === '') {
return {
src: paths.appSrc,
};
}
}
/**
* Get jest aliases based on the baseUrl of a compilerOptions object.
*
* @param {*} options
*/
function getJestAliases(options = {}) {
const baseUrl = options.baseUrl;
if (!baseUrl) {
return {};
}
const baseUrlResolved = path.resolve(paths.appPath, baseUrl);
if (path.relative(paths.appPath, baseUrlResolved) === '') {
return {
'^src/(.*)$': '<rootDir>/src/$1',
};
}
}
function getModules() {
// Check if TypeScript is setup
const hasTsConfig = fs.existsSync(paths.appTsConfig);
const hasJsConfig = fs.existsSync(paths.appJsConfig);
if (hasTsConfig && hasJsConfig) {
throw new Error(
'You have both a tsconfig.json and a jsconfig.json. If you are using TypeScript please remove your jsconfig.json file.'
);
}
let config;
// If there's a tsconfig.json we assume it's a
// TypeScript project and set up the config
// based on tsconfig.json
if (hasTsConfig) {
const ts = require(resolve.sync('typescript', {
basedir: paths.appNodeModules,
}));
config = ts.readConfigFile(paths.appTsConfig, ts.sys.readFile).config;
// Otherwise we'll check if there is jsconfig.json
// for non TS projects.
} else if (hasJsConfig) {
config = require(paths.appJsConfig);
}
config = config || {};
const options = config.compilerOptions || {};
const additionalModulePaths = getAdditionalModulePaths(options);
return {
additionalModulePaths: additionalModulePaths,
webpackAliases: getWebpackAliases(options),
jestAliases: getJestAliases(options),
hasTsConfig,
};
}
module.exports = getModules();
'use strict';
const path = require('path');
const fs = require('fs');
const getPublicUrlOrPath = require('react-dev-utils/getPublicUrlOrPath');
// Make sure any symlinks in the project folder are resolved:
// https://github.com/facebook/create-react-app/issues/637
const appDirectory = fs.realpathSync(process.cwd());
const resolveApp = relativePath => path.resolve(appDirectory, relativePath);
// We use `PUBLIC_URL` environment variable or "homepage" field to infer
// "public path" at which the app is served.
// webpack needs to know it to put the right <script> hrefs into HTML even in
// single-page apps that may serve index.html for nested URLs like /todos/42.
// We can't use a relative path in HTML because we don't want to load something
// like /todos/42/static/js/bundle.7289d.js. We have to know the root.
const publicUrlOrPath = getPublicUrlOrPath(
process.env.NODE_ENV === 'development',
require(resolveApp('package.json')).homepage,
process.env.PUBLIC_URL
);
const buildPath = process.env.BUILD_PATH || 'build';
const moduleFileExtensions = [
'web.mjs',
'mjs',
'web.js',
'js',
'web.ts',
'ts',
'web.tsx',
'tsx',
'json',
'web.jsx',
'jsx',
];
// Resolve file paths in the same order as webpack
const resolveModule = (resolveFn, filePath) => {
const extension = moduleFileExtensions.find(extension =>
fs.existsSync(resolveFn(`${filePath}.${extension}`))
);
if (extension) {
return resolveFn(`${filePath}.${extension}`);
}
return resolveFn(`${filePath}.js`);
};
// config after eject: we're in ./config/
module.exports = {
dotenv: resolveApp('.env'),
appPath: resolveApp('.'),
appBuild: resolveApp(buildPath),
appPublic: resolveApp('public'),
appHtml: resolveApp('public/index.html'),
appIndexJs: resolveModule(resolveApp, 'src/index'),
appPackageJson: resolveApp('package.json'),
appSrc: resolveApp('src'),
appTsConfig: resolveApp('tsconfig.json'),
appJsConfig: resolveApp('jsconfig.json'),
yarnLockFile: resolveApp('yarn.lock'),
testsSetup: resolveModule(resolveApp, 'src/setupTests'),
proxySetup: resolveApp('src/setupProxy.js'),
appNodeModules: resolveApp('node_modules'),
swSrc: resolveModule(resolveApp, 'src/service-worker'),
publicUrlOrPath,
};
module.exports.moduleFileExtensions = moduleFileExtensions;
'use strict';
const { resolveModuleName } = require('ts-pnp');
exports.resolveModuleName = (
typescript,
moduleName,
containingFile,
compilerOptions,
resolutionHost
) => {
return resolveModuleName(
moduleName,
containingFile,
compilerOptions,
resolutionHost,
typescript.resolveModuleName
);
};
exports.resolveTypeReferenceDirective = (
typescript,
moduleName,
containingFile,
compilerOptions,
resolutionHost
) => {
return resolveModuleName(
moduleName,
containingFile,
compilerOptions,
resolutionHost,
typescript.resolveTypeReferenceDirective
);
};
'use strict';
const fs = require('fs');
const path = require('path');
const webpack = require('webpack');
const resolve = require('resolve');
const PnpWebpackPlugin = require('pnp-webpack-plugin');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const CaseSensitivePathsPlugin = require('case-sensitive-paths-webpack-plugin');
const InlineChunkHtmlPlugin = require('react-dev-utils/InlineChunkHtmlPlugin');
const TerserPlugin = require('terser-webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
const safePostCssParser = require('postcss-safe-parser');
const ManifestPlugin = require('webpack-manifest-plugin');
const InterpolateHtmlPlugin = require('react-dev-utils/InterpolateHtmlPlugin');
const WorkboxWebpackPlugin = require('workbox-webpack-plugin');
const WatchMissingNodeModulesPlugin = require('react-dev-utils/WatchMissingNodeModulesPlugin');
const ModuleScopePlugin = require('react-dev-utils/ModuleScopePlugin');
const getCSSModuleLocalIdent = require('react-dev-utils/getCSSModuleLocalIdent');
const ESLintPlugin = require('eslint-webpack-plugin');
const paths = require('./paths');
const modules = require('./modules');
const getClientEnvironment = require('./env');
const ModuleNotFoundPlugin = require('react-dev-utils/ModuleNotFoundPlugin');
const ForkTsCheckerWebpackPlugin = require('react-dev-utils/ForkTsCheckerWebpackPlugin');
const typescriptFormatter = require('react-dev-utils/typescriptFormatter');
const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
const postcssNormalize = require('postcss-normalize');
const appPackageJson = require(paths.appPackageJson);
// Source maps are resource heavy and can cause out of memory issue for large source files.
const shouldUseSourceMap = process.env.GENERATE_SOURCEMAP !== 'false';
const webpackDevClientEntry = require.resolve(
'react-dev-utils/webpackHotDevClient'
);
const reactRefreshOverlayEntry = require.resolve(
'react-dev-utils/refreshOverlayInterop'
);
// Some apps do not need the benefits of saving a web request, so not inlining the chunk
// makes for a smoother build process.
const shouldInlineRuntimeChunk = process.env.INLINE_RUNTIME_CHUNK !== 'false';
const emitErrorsAsWarnings = process.env.ESLINT_NO_DEV_ERRORS === 'true';
const disableESLintPlugin = process.env.DISABLE_ESLINT_PLUGIN === 'true';
const imageInlineSizeLimit = parseInt(
process.env.IMAGE_INLINE_SIZE_LIMIT || '10000'
);
// Check if TypeScript is setup
const useTypeScript = fs.existsSync(paths.appTsConfig);
// Get the path to the uncompiled service worker (if it exists).
const swSrc = paths.swSrc;
// style files regexes
const cssRegex = /\.css$/;
const cssModuleRegex = /\.module\.css$/;
const sassRegex = /\.(scss|sass)$/;
const sassModuleRegex = /\.module\.(scss|sass)$/;
const hasJsxRuntime = (() => {
if (process.env.DISABLE_NEW_JSX_TRANSFORM === 'true') {
return false;
}
try {
require.resolve('react/jsx-runtime');
return true;
} catch (e) {
return false;
}
})();
// This is the production and development configuration.
// It is focused on developer experience, fast rebuilds, and a minimal bundle.
module.exports = function (webpackEnv) {
const isEnvDevelopment = webpackEnv === 'development';
const isEnvProduction = webpackEnv === 'production';
// Variable used for enabling profiling in Production
// passed into alias object. Uses a flag if passed into the build command
const isEnvProductionProfile =
isEnvProduction && process.argv.includes('--profile');
// We will provide `paths.publicUrlOrPath` to our app
// as %PUBLIC_URL% in `index.html` and `process.env.PUBLIC_URL` in JavaScript.
// Omit trailing slash as %PUBLIC_URL%/xyz looks better than %PUBLIC_URL%xyz.
// Get environment variables to inject into our app.
const env = getClientEnvironment(paths.publicUrlOrPath.slice(0, -1));
const shouldUseReactRefresh = env.raw.FAST_REFRESH;
// common function to get style loaders
const getStyleLoaders = (cssOptions, preProcessor) => {
const loaders = [
isEnvDevelopment && require.resolve('style-loader'),
isEnvProduction && {
loader: MiniCssExtractPlugin.loader,
// css is located in `static/css`, use '../../' to locate index.html folder
// in production `paths.publicUrlOrPath` can be a relative path
options: paths.publicUrlOrPath.startsWith('.')
? { publicPath: '../../' }
: {},
},
{
loader: require.resolve('css-loader'),
options: cssOptions,
},
{
// Options for PostCSS as we reference these options twice
// Adds vendor prefixing based on your specified browser support in
// package.json
loader: require.resolve('postcss-loader'),
options: {
// Necessary for external CSS imports to work
// https://github.com/facebook/create-react-app/issues/2677
ident: 'postcss',
plugins: () => [
require('postcss-flexbugs-fixes'),
require('postcss-preset-env')({
autoprefixer: {
flexbox: 'no-2009',
},
stage: 3,
}),
// Adds PostCSS Normalize as the reset css with default options,
// so that it honors browserslist config in package.json
// which in turn let's users customize the target behavior as per their needs.
postcssNormalize(),
],
sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment,
},
},
].filter(Boolean);
if (preProcessor) {
loaders.push(
{
loader: require.resolve('resolve-url-loader'),
options: {
sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment,
root: paths.appSrc,
},
},
{
loader: require.resolve(preProcessor),
options: {
sourceMap: true,
},
}
);
}
return loaders;
};
return {
mode: isEnvProduction ? 'production' : isEnvDevelopment && 'development',
// Stop compilation early in production
bail: isEnvProduction,
devtool: isEnvProduction
? shouldUseSourceMap
? 'source-map'
: false
: isEnvDevelopment && 'cheap-module-source-map',
// These are the "entry points" to our application.
// This means they will be the "root" imports that are included in JS bundle.
entry:
isEnvDevelopment && !shouldUseReactRefresh
? [
// Include an alternative client for WebpackDevServer. A client's job is to
// connect to WebpackDevServer by a socket and get notified about changes.
// When you save a file, the client will either apply hot updates (in case
// of CSS changes), or refresh the page (in case of JS changes). When you
// make a syntax error, this client will display a syntax error overlay.
// Note: instead of the default WebpackDevServer client, we use a custom one
// to bring better experience for Create React App users. You can replace
// the line below with these two lines if you prefer the stock client:
//
// require.resolve('webpack-dev-server/client') + '?/',
// require.resolve('webpack/hot/dev-server'),
//
// When using the experimental react-refresh integration,
// the webpack plugin takes care of injecting the dev client for us.
webpackDevClientEntry,
// Finally, this is your app's code:
paths.appIndexJs,
// We include the app code last so that if there is a runtime error during
// initialization, it doesn't blow up the WebpackDevServer client, and
// changing JS code would still trigger a refresh.
]
: paths.appIndexJs,
output: {
// The build folder.
path: isEnvProduction ? paths.appBuild : undefined,
// Add /* filename */ comments to generated require()s in the output.
pathinfo: isEnvDevelopment,
// There will be one main bundle, and one file per asynchronous chunk.
// In development, it does not produce real files.
filename: isEnvProduction
? 'static/js/[name].[contenthash:8].js'
: isEnvDevelopment && 'static/js/bundle.js',
// TODO: remove this when upgrading to webpack 5
futureEmitAssets: true,
// There are also additional JS chunk files if you use code splitting.
chunkFilename: isEnvProduction
? 'static/js/[name].[contenthash:8].chunk.js'
: isEnvDevelopment && 'static/js/[name].chunk.js',
// webpack uses `publicPath` to determine where the app is being served from.
// It requires a trailing slash, or the file assets will get an incorrect path.
// We inferred the "public path" (such as / or /my-project) from homepage.
publicPath: paths.publicUrlOrPath,
// Point sourcemap entries to original disk location (format as URL on Windows)
devtoolModuleFilenameTemplate: isEnvProduction
? info =>
path
.relative(paths.appSrc, info.absoluteResourcePath)
.replace(/\\/g, '/')
: isEnvDevelopment &&
(info => path.resolve(info.absoluteResourcePath).replace(/\\/g, '/')),
// Prevents conflicts when multiple webpack runtimes (from different apps)
// are used on the same page.
jsonpFunction: `webpackJsonp${appPackageJson.name}`,
// this defaults to 'window', but by setting it to 'this' then
// module chunks which are built will work in web workers as well.
globalObject: 'this',
},
optimization: {
minimize: isEnvProduction,
minimizer: [
// This is only used in production mode
new TerserPlugin({
terserOptions: {
parse: {
// We want terser to parse ecma 8 code. However, we don't want it
// to apply any minification steps that turns valid ecma 5 code
// into invalid ecma 5 code. This is why the 'compress' and 'output'
// sections only apply transformations that are ecma 5 safe
// https://github.com/facebook/create-react-app/pull/4234
ecma: 8,
},
compress: {
ecma: 5,
warnings: false,
// Disabled because of an issue with Uglify breaking seemingly valid code:
// https://github.com/facebook/create-react-app/issues/2376
// Pending further investigation:
// https://github.com/mishoo/UglifyJS2/issues/2011
comparisons: false,
// Disabled because of an issue with Terser breaking valid code:
// https://github.com/facebook/create-react-app/issues/5250
// Pending further investigation:
// https://github.com/terser-js/terser/issues/120
inline: 2,
},
mangle: {
safari10: true,
},
// Added for profiling in devtools
keep_classnames: isEnvProductionProfile,
keep_fnames: isEnvProductionProfile,
output: {
ecma: 5,
comments: false,
// Turned on because emoji and regex is not minified properly using default
// https://github.com/facebook/create-react-app/issues/2488
ascii_only: true,
},
},
sourceMap: shouldUseSourceMap,
}),
// This is only used in production mode
new OptimizeCSSAssetsPlugin({
cssProcessorOptions: {
parser: safePostCssParser,
map: shouldUseSourceMap
? {
// `inline: false` forces the sourcemap to be output into a
// separate file
inline: false,
// `annotation: true` appends the sourceMappingURL to the end of
// the css file, helping the browser find the sourcemap
annotation: true,
}
: false,
},
cssProcessorPluginOptions: {
preset: ['default', { minifyFontValues: { removeQuotes: false } }],
},
}),
],
// Automatically split vendor and commons
// https://twitter.com/wSokra/status/969633336732905474
// https://medium.com/webpack/webpack-4-code-splitting-chunk-graph-and-the-splitchunks-optimization-be739a861366
splitChunks: {
chunks: 'all',
name: isEnvDevelopment,
},
// Keep the runtime chunk separated to enable long term caching
// https://twitter.com/wSokra/status/969679223278505985
// https://github.com/facebook/create-react-app/issues/5358
runtimeChunk: {
name: entrypoint => `runtime-${entrypoint.name}`,
},
},
resolve: {
// This allows you to set a fallback for where webpack should look for modules.
// We placed these paths second because we want `node_modules` to "win"
// if there are any conflicts. This matches Node resolution mechanism.
// https://github.com/facebook/create-react-app/issues/253
modules: ['node_modules', paths.appNodeModules].concat(
modules.additionalModulePaths || []
),
// These are the reasonable defaults supported by the Node ecosystem.
// We also include JSX as a common component filename extension to support
// some tools, although we do not recommend using it, see:
// https://github.com/facebook/create-react-app/issues/290
// `web` extension prefixes have been added for better support
// for React Native Web.
extensions: paths.moduleFileExtensions
.map(ext => `.${ext}`)
.filter(ext => useTypeScript || !ext.includes('ts')),
alias: {
// Support React Native Web
// https://www.smashingmagazine.com/2016/08/a-glimpse-into-the-future-with-react-native-for-web/
'react-native': 'react-native-web',
// Allows for better profiling with ReactDevTools
...(isEnvProductionProfile && {
'react-dom$': 'react-dom/profiling',
'scheduler/tracing': 'scheduler/tracing-profiling',
}),
...(modules.webpackAliases || {}),
},
plugins: [
// Adds support for installing with Plug'n'Play, leading to faster installs and adding
// guards against forgotten dependencies and such.
PnpWebpackPlugin,
// Prevents users from importing files from outside of src/ (or node_modules/).
// This often causes confusion because we only process files within src/ with babel.
// To fix this, we prevent you from importing files out of src/ -- if you'd like to,
// please link the files into your node_modules/ and let module-resolution kick in.
// Make sure your source files are compiled, as they will not be processed in any way.
new ModuleScopePlugin(paths.appSrc, [
paths.appPackageJson,
reactRefreshOverlayEntry,
]),
],
},
resolveLoader: {
plugins: [
// Also related to Plug'n'Play, but this time it tells webpack to load its loaders
// from the current package.
PnpWebpackPlugin.moduleLoader(module),
],
},
module: {
strictExportPresence: true,
rules: [
// Disable require.ensure as it's not a standard language feature.
{ parser: { requireEnsure: false } },
{
// "oneOf" will traverse all following loaders until one will
// match the requirements. When no loader matches it will fall
// back to the "file" loader at the end of the loader list.
oneOf: [
// TODO: Merge this config once `image/avif` is in the mime-db
// https://github.com/jshttp/mime-db
{
test: [/\.avif$/],
loader: require.resolve('url-loader'),
options: {
limit: imageInlineSizeLimit,
mimetype: 'image/avif',
name: 'static/media/[name].[hash:8].[ext]',
},
},
// "url" loader works like "file" loader except that it embeds assets
// smaller than specified limit in bytes as data URLs to avoid requests.
// A missing `test` is equivalent to a match.
{
test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/],
loader: require.resolve('url-loader'),
options: {
limit: imageInlineSizeLimit,
name: 'static/media/[name].[hash:8].[ext]',
},
},
// Process application JS with Babel.
// The preset includes JSX, Flow, TypeScript, and some ESnext features.
{
test: /\.(js|mjs|jsx|ts|tsx)$/,
include: paths.appSrc,
loader: require.resolve('babel-loader'),
options: {
customize: require.resolve(
'babel-preset-react-app/webpack-overrides'
),
presets: [
[
require.resolve('babel-preset-react-app'),
{
runtime: hasJsxRuntime ? 'automatic' : 'classic',
},
],
],
plugins: [
[
require.resolve('babel-plugin-named-asset-import'),
{
loaderMap: {
svg: {
ReactComponent:
'@svgr/webpack?-svgo,+titleProp,+ref![path]',
},
},
},
],
isEnvDevelopment &&
shouldUseReactRefresh &&
require.resolve('react-refresh/babel'),
].filter(Boolean),
// This is a feature of `babel-loader` for webpack (not Babel itself).
// It enables caching results in ./node_modules/.cache/babel-loader/
// directory for faster rebuilds.
cacheDirectory: true,
// See #6846 for context on why cacheCompression is disabled
cacheCompression: false,
compact: isEnvProduction,
},
},
// Process any JS outside of the app with Babel.
// Unlike the application JS, we only compile the standard ES features.
{
test: /\.(js|mjs)$/,
exclude: /@babel(?:\/|\\{1,2})runtime/,
loader: require.resolve('babel-loader'),
options: {
babelrc: false,
configFile: false,
compact: false,
presets: [
[
require.resolve('babel-preset-react-app/dependencies'),
{ helpers: true },
],
],
cacheDirectory: true,
// See #6846 for context on why cacheCompression is disabled
cacheCompression: false,
// Babel sourcemaps are needed for debugging into node_modules
// code. Without the options below, debuggers like VSCode
// show incorrect code and set breakpoints on the wrong lines.
sourceMaps: shouldUseSourceMap,
inputSourceMap: shouldUseSourceMap,
},
},
// "postcss" loader applies autoprefixer to our CSS.
// "css" loader resolves paths in CSS and adds assets as dependencies.
// "style" loader turns CSS into JS modules that inject <style> tags.
// In production, we use MiniCSSExtractPlugin to extract that CSS
// to a file, but in development "style" loader enables hot editing
// of CSS.
// By default we support CSS Modules with the extension .module.css
{
test: cssRegex,
exclude: cssModuleRegex,
use: getStyleLoaders({
importLoaders: 1,
sourceMap: isEnvProduction
? shouldUseSourceMap
: isEnvDevelopment,
}),
// Don't consider CSS imports dead code even if the
// containing package claims to have no side effects.
// Remove this when webpack adds a warning or an error for this.
// See https://github.com/webpack/webpack/issues/6571
sideEffects: true,
},
// Adds support for CSS Modules (https://github.com/css-modules/css-modules)
// using the extension .module.css
{
test: cssModuleRegex,
use: getStyleLoaders({
importLoaders: 1,
sourceMap: isEnvProduction
? shouldUseSourceMap
: isEnvDevelopment,
modules: {
getLocalIdent: getCSSModuleLocalIdent,
},
}),
},
// Opt-in support for SASS (using .scss or .sass extensions).
// By default we support SASS Modules with the
// extensions .module.scss or .module.sass
{
test: sassRegex,
exclude: sassModuleRegex,
use: getStyleLoaders(
{
importLoaders: 3,
sourceMap: isEnvProduction
? shouldUseSourceMap
: isEnvDevelopment,
},
'sass-loader'
),
// Don't consider CSS imports dead code even if the
// containing package claims to have no side effects.
// Remove this when webpack adds a warning or an error for this.
// See https://github.com/webpack/webpack/issues/6571
sideEffects: true,
},
// Adds support for CSS Modules, but using SASS
// using the extension .module.scss or .module.sass
{
test: sassModuleRegex,
use: getStyleLoaders(
{
importLoaders: 3,
sourceMap: isEnvProduction
? shouldUseSourceMap
: isEnvDevelopment,
modules: {
getLocalIdent: getCSSModuleLocalIdent,
},
},
'sass-loader'
),
},
// "file" loader makes sure those assets get served by WebpackDevServer.
// When you `import` an asset, you get its (virtual) filename.
// In production, they would get copied to the `build` folder.
// This loader doesn't use a "test" so it will catch all modules
// that fall through the other loaders.
{
loader: require.resolve('file-loader'),
// Exclude `js` files to keep "css" loader working as it injects
// its runtime that would otherwise be processed through "file" loader.
// Also exclude `html` and `json` extensions so they get processed
// by webpacks internal loaders.
exclude: [/\.(js|mjs|jsx|ts|tsx)$/, /\.html$/, /\.json$/],
options: {
name: 'static/media/[name].[hash:8].[ext]',
},
},
// ** STOP ** Are you adding a new loader?
// Make sure to add the new loader(s) before the "file" loader.
],
},
],
},
plugins: [
// Generates an `index.html` file with the <script> injected.
new HtmlWebpackPlugin(
Object.assign(
{},
{
inject: true,
template: paths.appHtml,
},
isEnvProduction
? {
minify: {
removeComments: true,
collapseWhitespace: true,
removeRedundantAttributes: true,
useShortDoctype: true,
removeEmptyAttributes: true,
removeStyleLinkTypeAttributes: true,
keepClosingSlash: true,
minifyJS: true,
minifyCSS: true,
minifyURLs: true,
},
}
: undefined
)
),
// Inlines the webpack runtime script. This script is too small to warrant
// a network request.
// https://github.com/facebook/create-react-app/issues/5358
isEnvProduction &&
shouldInlineRuntimeChunk &&
new InlineChunkHtmlPlugin(HtmlWebpackPlugin, [/runtime-.+[.]js/]),
// Makes some environment variables available in index.html.
// The public URL is available as %PUBLIC_URL% in index.html, e.g.:
// <link rel="icon" href="%PUBLIC_URL%/favicon.ico">
// It will be an empty string unless you specify "homepage"
// in `package.json`, in which case it will be the pathname of that URL.
new InterpolateHtmlPlugin(HtmlWebpackPlugin, env.raw),
// This gives some necessary context to module not found errors, such as
// the requesting resource.
new ModuleNotFoundPlugin(paths.appPath),
// Makes some environment variables available to the JS code, for example:
// if (process.env.NODE_ENV === 'production') { ... }. See `./env.js`.
// It is absolutely essential that NODE_ENV is set to production
// during a production build.
// Otherwise React will be compiled in the very slow development mode.
new webpack.DefinePlugin(env.stringified),
// This is necessary to emit hot updates (CSS and Fast Refresh):
isEnvDevelopment && new webpack.HotModuleReplacementPlugin(),
// Experimental hot reloading for React .
// https://github.com/facebook/react/tree/master/packages/react-refresh
isEnvDevelopment &&
shouldUseReactRefresh &&
new ReactRefreshWebpackPlugin({
overlay: {
entry: webpackDevClientEntry,
// The expected exports are slightly different from what the overlay exports,
// so an interop is included here to enable feedback on module-level errors.
module: reactRefreshOverlayEntry,
// Since we ship a custom dev client and overlay integration,
// the bundled socket handling logic can be eliminated.
sockIntegration: false,
},
}),
// Watcher doesn't work well if you mistype casing in a path so we use
// a plugin that prints an error when you attempt to do this.
// See https://github.com/facebook/create-react-app/issues/240
isEnvDevelopment && new CaseSensitivePathsPlugin(),
// If you require a missing module and then `npm install` it, you still have
// to restart the development server for webpack to discover it. This plugin
// makes the discovery automatic so you don't have to restart.
// See https://github.com/facebook/create-react-app/issues/186
isEnvDevelopment &&
new WatchMissingNodeModulesPlugin(paths.appNodeModules),
isEnvProduction &&
new MiniCssExtractPlugin({
// Options similar to the same options in webpackOptions.output
// both options are optional
filename: 'static/css/[name].[contenthash:8].css',
chunkFilename: 'static/css/[name].[contenthash:8].chunk.css',
}),
// Generate an asset manifest file with the following content:
// - "files" key: Mapping of all asset filenames to their corresponding
// output file so that tools can pick it up without having to parse
// `index.html`
// - "entrypoints" key: Array of files which are included in `index.html`,
// can be used to reconstruct the HTML if necessary
new ManifestPlugin({
fileName: 'asset-manifest.json',
publicPath: paths.publicUrlOrPath,
generate: (seed, files, entrypoints) => {
const manifestFiles = files.reduce((manifest, file) => {
manifest[file.name] = file.path;
return manifest;
}, seed);
const entrypointFiles = entrypoints.main.filter(
fileName => !fileName.endsWith('.map')
);
return {
files: manifestFiles,
entrypoints: entrypointFiles,
};
},
}),
// Moment.js is an extremely popular library that bundles large locale files
// by default due to how webpack interprets its code. This is a practical
// solution that requires the user to opt into importing specific locales.
// https://github.com/jmblog/how-to-optimize-momentjs-with-webpack
// You can remove this if you don't use Moment.js:
new webpack.IgnorePlugin(/^\.\/locale$/, /moment$/),
// Generate a service worker script that will precache, and keep up to date,
// the HTML & assets that are part of the webpack build.
isEnvProduction &&
fs.existsSync(swSrc) &&
new WorkboxWebpackPlugin.InjectManifest({
swSrc,
dontCacheBustURLsMatching: /\.[0-9a-f]{8}\./,
exclude: [/\.map$/, /asset-manifest\.json$/, /LICENSE/],
// Bump up the default maximum size (2mb) that's precached,
// to make lazy-loading failure scenarios less likely.
// See https://github.com/cra-template/pwa/issues/13#issuecomment-722667270
maximumFileSizeToCacheInBytes: 5 * 1024 * 1024,
}),
// TypeScript type checking
useTypeScript &&
new ForkTsCheckerWebpackPlugin({
typescript: resolve.sync('typescript', {
basedir: paths.appNodeModules,
}),
async: isEnvDevelopment,
checkSyntacticErrors: true,
resolveModuleNameModule: process.versions.pnp
? `${__dirname}/pnpTs.js`
: undefined,
resolveTypeReferenceDirectiveModule: process.versions.pnp
? `${__dirname}/pnpTs.js`
: undefined,
tsconfig: paths.appTsConfig,
reportFiles: [
// This one is specifically to match during CI tests,
// as micromatch doesn't match
// '../cra-template-typescript/template/src/App.tsx'
// otherwise.
'../**/src/**/*.{ts,tsx}',
'**/src/**/*.{ts,tsx}',
'!**/src/**/__tests__/**',
'!**/src/**/?(*.)(spec|test).*',
'!**/src/setupProxy.*',
'!**/src/setupTests.*',
],
silent: true,
// The formatter is invoked directly in WebpackDevServerUtils during development
formatter: isEnvProduction ? typescriptFormatter : undefined,
}),
!disableESLintPlugin &&
new ESLintPlugin({
// Plugin options
extensions: ['js', 'mjs', 'jsx', 'ts', 'tsx'],
formatter: require.resolve('react-dev-utils/eslintFormatter'),
eslintPath: require.resolve('eslint'),
failOnError: !(isEnvDevelopment && emitErrorsAsWarnings),
context: paths.appSrc,
cache: true,
cacheLocation: path.resolve(
paths.appNodeModules,
'.cache/.eslintcache'
),
// ESLint class options
cwd: paths.appPath,
resolvePluginsRelativeTo: __dirname,
baseConfig: {
extends: [require.resolve('eslint-config-react-app/base')],
rules: {
...(!hasJsxRuntime && {
'react/react-in-jsx-scope': 'error',
}),
},
},
}),
].filter(Boolean),
// Some libraries import Node modules but don't use them in the browser.
// Tell webpack to provide empty mocks for them so importing them works.
node: {
module: 'empty',
dgram: 'empty',
dns: 'mock',
fs: 'empty',
http2: 'empty',
net: 'empty',
tls: 'empty',
child_process: 'empty',
},
// Turn off performance processing because we utilize
// our own hints via the FileSizeReporter
performance: false,
};
};
'use strict';
const fs = require('fs');
const errorOverlayMiddleware = require('react-dev-utils/errorOverlayMiddleware');
const evalSourceMapMiddleware = require('react-dev-utils/evalSourceMapMiddleware');
const noopServiceWorkerMiddleware = require('react-dev-utils/noopServiceWorkerMiddleware');
const ignoredFiles = require('react-dev-utils/ignoredFiles');
const redirectServedPath = require('react-dev-utils/redirectServedPathMiddleware');
const paths = require('./paths');
const getHttpsConfig = require('./getHttpsConfig');
const host = process.env.HOST || '0.0.0.0';
const sockHost = process.env.WDS_SOCKET_HOST;
const sockPath = process.env.WDS_SOCKET_PATH; // default: '/sockjs-node'
const sockPort = process.env.WDS_SOCKET_PORT;
module.exports = function (proxy, allowedHost) {
return {
// WebpackDevServer 2.4.3 introduced a security fix that prevents remote
// websites from potentially accessing local content through DNS rebinding:
// https://github.com/webpack/webpack-dev-server/issues/887
// https://medium.com/webpack/webpack-dev-server-middleware-security-issues-1489d950874a
// However, it made several existing use cases such as development in cloud
// environment or subdomains in development significantly more complicated:
// https://github.com/facebook/create-react-app/issues/2271
// https://github.com/facebook/create-react-app/issues/2233
// While we're investigating better solutions, for now we will take a
// compromise. Since our WDS configuration only serves files in the `public`
// folder we won't consider accessing them a vulnerability. However, if you
// use the `proxy` feature, it gets more dangerous because it can expose
// remote code execution vulnerabilities in backends like Django and Rails.
// So we will disable the host check normally, but enable it if you have
// specified the `proxy` setting. Finally, we let you override it if you
// really know what you're doing with a special environment variable.
disableHostCheck:
!proxy || process.env.DANGEROUSLY_DISABLE_HOST_CHECK === 'true',
// Enable gzip compression of generated files.
compress: true,
// Silence WebpackDevServer's own logs since they're generally not useful.
// It will still show compile warnings and errors with this setting.
clientLogLevel: 'none',
// By default WebpackDevServer serves physical files from current directory
// in addition to all the virtual build products that it serves from memory.
// This is confusing because those files won’t automatically be available in
// production build folder unless we copy them. However, copying the whole
// project directory is dangerous because we may expose sensitive files.
// Instead, we establish a convention that only files in `public` directory
// get served. Our build script will copy `public` into the `build` folder.
// In `index.html`, you can get URL of `public` folder with %PUBLIC_URL%:
// <link rel="icon" href="%PUBLIC_URL%/favicon.ico">
// In JavaScript code, you can access it with `process.env.PUBLIC_URL`.
// Note that we only recommend to use `public` folder as an escape hatch
// for files like `favicon.ico`, `manifest.json`, and libraries that are
// for some reason broken when imported through webpack. If you just want to
// use an image, put it in `src` and `import` it from JavaScript instead.
contentBase: paths.appPublic,
contentBasePublicPath: paths.publicUrlOrPath,
// By default files from `contentBase` will not trigger a page reload.
watchContentBase: true,
// Enable hot reloading server. It will provide WDS_SOCKET_PATH endpoint
// for the WebpackDevServer client so it can learn when the files were
// updated. The WebpackDevServer client is included as an entry point
// in the webpack development configuration. Note that only changes
// to CSS are currently hot reloaded. JS changes will refresh the browser.
hot: true,
// Use 'ws' instead of 'sockjs-node' on server since we're using native
// websockets in `webpackHotDevClient`.
transportMode: 'ws',
// Prevent a WS client from getting injected as we're already including
// `webpackHotDevClient`.
injectClient: false,
// Enable custom sockjs pathname for websocket connection to hot reloading server.
// Enable custom sockjs hostname, pathname and port for websocket connection
// to hot reloading server.
sockHost,
sockPath,
sockPort,
// It is important to tell WebpackDevServer to use the same "publicPath" path as
// we specified in the webpack config. When homepage is '.', default to serving
// from the root.
// remove last slash so user can land on `/test` instead of `/test/`
publicPath: paths.publicUrlOrPath.slice(0, -1),
// WebpackDevServer is noisy by default so we emit custom message instead
// by listening to the compiler events with `compiler.hooks[...].tap` calls above.
quiet: true,
// Reportedly, this avoids CPU overload on some systems.
// https://github.com/facebook/create-react-app/issues/293
// src/node_modules is not ignored to support absolute imports
// https://github.com/facebook/create-react-app/issues/1065
watchOptions: {
ignored: ignoredFiles(paths.appSrc),
},
https: getHttpsConfig(),
host,
overlay: false,
historyApiFallback: {
// Paths with dots should still use the history fallback.
// See https://github.com/facebook/create-react-app/issues/387.
disableDotRule: true,
index: paths.publicUrlOrPath,
},
public: allowedHost,
// `proxy` is run between `before` and `after` `webpack-dev-server` hooks
proxy,
before(app, server) {
// Keep `evalSourceMapMiddleware` and `errorOverlayMiddleware`
// middlewares before `redirectServedPath` otherwise will not have any effect
// This lets us fetch source contents from webpack for the error overlay
app.use(evalSourceMapMiddleware(server));
// This lets us open files from the runtime error overlay.
app.use(errorOverlayMiddleware());
if (fs.existsSync(paths.proxySetup)) {
// This registers user provided middleware for proxy reasons
require(paths.proxySetup)(app);
}
},
after(app) {
// Redirect to `PUBLIC_URL` or `homepage` from `package.json` if url not match
app.use(redirectServedPath(paths.publicUrlOrPath));
// This service worker file is effectively a 'no-op' that will reset any
// previous service worker registered for the same host:port combination.
// We do this in development to avoid hitting the production cache if
// it used the same host and port.
// https://github.com/facebook/create-react-app/issues/2272#issuecomment-302832432
app.use(noopServiceWorkerMiddleware(paths.publicUrlOrPath));
},
};
};
{
"name": "wecom-sidebar",
"version": "0.1.0",
"private": true,
"dependencies": {
"@ant-design/icons": "^4.7.0",
"@babel/core": "7.12.3",
"@pmmmwh/react-refresh-webpack-plugin": "0.4.3",
"@svgr/webpack": "5.5.0",
"@testing-library/jest-dom": "^5.11.9",
"@testing-library/react": "^11.2.5",
"@testing-library/user-event": "^12.8.1",
"@types/jest": "^26.0.20",
"@types/node": "^12.20.4",
"@types/react": "^17.0.3",
"@types/react-dom": "^17.0.2",
"@typescript-eslint/eslint-plugin": "^4.5.0",
"@typescript-eslint/parser": "^4.5.0",
"antd": "^4.16.13",
"axios": "^0.21.1",
"babel-eslint": "^10.1.0",
"babel-jest": "^26.6.0",
"babel-loader": "8.1.0",
"babel-plugin-named-asset-import": "^0.3.7",
"babel-preset-react-app": "^10.0.0",
"bfj": "^7.0.2",
"camelcase": "^6.1.0",
"case-sensitive-paths-webpack-plugin": "2.3.0",
"compare-versions": "^3.6.0",
"css-loader": "4.3.0",
"dotenv": "8.2.0",
"dotenv-expand": "5.1.0",
"eslint": "^7.11.0",
"eslint-config-react-app": "^6.0.0",
"eslint-plugin-flowtype": "^5.2.0",
"eslint-plugin-import": "^2.22.1",
"eslint-plugin-jest": "^24.1.0",
"eslint-plugin-jsx-a11y": "^6.3.1",
"eslint-plugin-react": "^7.21.5",
"eslint-plugin-react-hooks": "^4.2.0",
"eslint-plugin-testing-library": "^3.9.2",
"eslint-webpack-plugin": "^2.5.2",
"file-loader": "6.1.1",
"fs-extra": "^9.0.1",
"html-webpack-plugin": "4.5.0",
"identity-obj-proxy": "3.0.0",
"jest": "26.6.0",
"jest-circus": "26.6.0",
"jest-resolve": "26.6.0",
"jest-watch-typeahead": "0.6.1",
"js-cookie": "^2.2.1",
"mini-css-extract-plugin": "0.11.3",
"optimize-css-assets-webpack-plugin": "5.0.4",
"pnp-webpack-plugin": "1.6.4",
"postcss-flexbugs-fixes": "4.2.1",
"postcss-loader": "3.0.0",
"postcss-normalize": "8.0.1",
"postcss-preset-env": "6.7.0",
"postcss-safe-parser": "5.0.2",
"prompts": "2.4.0",
"qs": "^6.9.6",
"react": "^17.0.1",
"react-app-polyfill": "^2.0.0",
"react-dev-utils": "^11.0.3",
"react-dom": "^17.0.1",
"react-refresh": "^0.8.3",
"react-router-dom": "^5.3.0",
"resolve": "1.18.1",
"resolve-url-loader": "^3.1.2",
"sass-loader": "^10.0.5",
"semver": "7.3.2",
"style-loader": "1.3.0",
"terser-webpack-plugin": "4.2.3",
"ts-pnp": "1.2.0",
"typescript": "^4.2.3",
"url-loader": "4.1.1",
"webpack": "4.44.2",
"webpack-dev-server": "3.11.1",
"webpack-manifest-plugin": "2.2.0",
"workbox-webpack-plugin": "5.1.4"
},
"scripts": {
"start": "BROWSER=none node scripts/start.js",
"build": "node scripts/build.js",
"test": "node scripts/test.js"
},
"eslintConfig": {
"extends": [
"react-app",
"react-app/jest"
],
"rules":{
"jsx-a11y/anchor-is-valid":"off"
}
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"devDependencies": {
"@types/js-cookie": "^2.2.6",
"@types/qs": "^6.9.6",
"@types/react-router-dom": "^5.3.1",
"@types/sha1": "^1.1.2"
},
"jest": {
"roots": [
"<rootDir>/src"
],
"collectCoverageFrom": [
"src/**/*.{js,jsx,ts,tsx}",
"!src/**/*.d.ts"
],
"setupFiles": [
"react-app-polyfill/jsdom"
],
"setupFilesAfterEnv": [],
"testMatch": [
"<rootDir>/src/**/__tests__/**/*.{js,jsx,ts,tsx}",
"<rootDir>/src/**/*.{spec,test}.{js,jsx,ts,tsx}"
],
"testEnvironment": "jsdom",
"testRunner": "/Users/mac/work/wecom-sidebar-react-tpl-main/node_modules/jest-circus/runner.js",
"transform": {
"^.+\\.(js|jsx|mjs|cjs|ts|tsx)$": "<rootDir>/config/jest/babelTransform.js",
"^.+\\.css$": "<rootDir>/config/jest/cssTransform.js",
"^(?!.*\\.(js|jsx|mjs|cjs|ts|tsx|css|json)$)": "<rootDir>/config/jest/fileTransform.js"
},
"transformIgnorePatterns": [
"[/\\\\]node_modules[/\\\\].+\\.(js|jsx|mjs|cjs|ts|tsx)$",
"^.+\\.module\\.(css|sass|scss)$"
],
"modulePaths": [],
"moduleNameMapper": {
"^react-native$": "react-native-web",
"^.+\\.module\\.(css|sass|scss)$": "identity-obj-proxy"
},
"moduleFileExtensions": [
"web.js",
"js",
"web.ts",
"ts",
"web.tsx",
"tsx",
"json",
"web.jsx",
"jsx",
"node"
],
"watchPlugins": [
"jest-watch-typeahead/filename",
"jest-watch-typeahead/testname"
],
"resetMocks": true
},
"babel": {
"presets": [
"react-app"
]
}
}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Web site created using create-react-app"
/>
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
<!--
manifest.json provides metadata used when your web app is installed on a
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>企业微信侧边栏开发模板</title>
<script src="https://res.wx.qq.com/open/js/jweixin-1.2.0.js"></script>
<script src="https://open.work.weixin.qq.com/wwopen/js/jwxwork-1.0.0.js"></script>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>
{
"short_name": "React App",
"name": "Create React App Sample",
"icons": [
{
"src": "favicon.ico",
"sizes": "64x64 32x32 24x24 16x16",
"type": "image/x-icon"
},
{
"src": "logo192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "logo512.png",
"type": "image/png",
"sizes": "512x512"
}
],
"start_url": ".",
"display": "standalone",
"theme_color": "#000000",
"background_color": "#ffffff"
}
# https://www.robotstxt.org/robotstxt.html
User-agent: *
Disallow:
'use strict';
// Do this as the first thing so that any code reading it knows the right env.
process.env.BABEL_ENV = 'production';
process.env.NODE_ENV = 'production';
// Makes the script crash on unhandled rejections instead of silently
// ignoring them. In the future, promise rejections that are not handled will
// terminate the Node.js process with a non-zero exit code.
process.on('unhandledRejection', err => {
throw err;
});
// Ensure environment variables are read.
require('../config/env');
const path = require('path');
const chalk = require('react-dev-utils/chalk');
const fs = require('fs-extra');
const bfj = require('bfj');
const webpack = require('webpack');
const configFactory = require('../config/webpack.config');
const paths = require('../config/paths');
const checkRequiredFiles = require('react-dev-utils/checkRequiredFiles');
const formatWebpackMessages = require('react-dev-utils/formatWebpackMessages');
const printHostingInstructions = require('react-dev-utils/printHostingInstructions');
const FileSizeReporter = require('react-dev-utils/FileSizeReporter');
const printBuildError = require('react-dev-utils/printBuildError');
const measureFileSizesBeforeBuild =
FileSizeReporter.measureFileSizesBeforeBuild;
const printFileSizesAfterBuild = FileSizeReporter.printFileSizesAfterBuild;
const useYarn = fs.existsSync(paths.yarnLockFile);
// These sizes are pretty large. We'll warn for bundles exceeding them.
const WARN_AFTER_BUNDLE_GZIP_SIZE = 512 * 1024;
const WARN_AFTER_CHUNK_GZIP_SIZE = 1024 * 1024;
const isInteractive = process.stdout.isTTY;
// Warn and crash if required files are missing
if (!checkRequiredFiles([paths.appHtml, paths.appIndexJs])) {
process.exit(1);
}
const argv = process.argv.slice(2);
const writeStatsJson = argv.indexOf('--stats') !== -1;
// Generate configuration
const config = configFactory('production');
// We require that you explicitly set browsers and do not fall back to
// browserslist defaults.
const { checkBrowsers } = require('react-dev-utils/browsersHelper');
checkBrowsers(paths.appPath, isInteractive)
.then(() => {
// First, read the current file sizes in build directory.
// This lets us display how much they changed later.
return measureFileSizesBeforeBuild(paths.appBuild);
})
.then(previousFileSizes => {
// Remove all content but keep the directory so that
// if you're in it, you don't end up in Trash
fs.emptyDirSync(paths.appBuild);
// Merge with the public folder
copyPublicFolder();
// Start the webpack build
return build(previousFileSizes);
})
.then(
({ stats, previousFileSizes, warnings }) => {
if (warnings.length) {
console.log(chalk.yellow('Compiled with warnings.\n'));
console.log(warnings.join('\n\n'));
console.log(
'\nSearch for the ' +
chalk.underline(chalk.yellow('keywords')) +
' to learn more about each warning.'
);
console.log(
'To ignore, add ' +
chalk.cyan('// eslint-disable-next-line') +
' to the line before.\n'
);
} else {
console.log(chalk.green('Compiled successfully.\n'));
}
console.log('File sizes after gzip:\n');
printFileSizesAfterBuild(
stats,
previousFileSizes,
paths.appBuild,
WARN_AFTER_BUNDLE_GZIP_SIZE,
WARN_AFTER_CHUNK_GZIP_SIZE
);
console.log();
const appPackage = require(paths.appPackageJson);
const publicUrl = paths.publicUrlOrPath;
const publicPath = config.output.publicPath;
const buildFolder = path.relative(process.cwd(), paths.appBuild);
printHostingInstructions(
appPackage,
publicUrl,
publicPath,
buildFolder,
useYarn
);
},
err => {
const tscCompileOnError = process.env.TSC_COMPILE_ON_ERROR === 'true';
if (tscCompileOnError) {
console.log(
chalk.yellow(
'Compiled with the following type errors (you may want to check these before deploying your app):\n'
)
);
printBuildError(err);
} else {
console.log(chalk.red('Failed to compile.\n'));
printBuildError(err);
process.exit(1);
}
}
)
.catch(err => {
if (err && err.message) {
console.log(err.message);
}
process.exit(1);
});
// Create the production build and print the deployment instructions.
function build(previousFileSizes) {
console.log('Creating an optimized production build...');
const compiler = webpack(config);
return new Promise((resolve, reject) => {
compiler.run((err, stats) => {
let messages;
if (err) {
if (!err.message) {
return reject(err);
}
let errMessage = err.message;
// Add additional information for postcss errors
if (Object.prototype.hasOwnProperty.call(err, 'postcssNode')) {
errMessage +=
'\nCompileError: Begins at CSS selector ' +
err['postcssNode'].selector;
}
messages = formatWebpackMessages({
errors: [errMessage],
warnings: [],
});
} else {
messages = formatWebpackMessages(
stats.toJson({ all: false, warnings: true, errors: true })
);
}
if (messages.errors.length) {
// Only keep the first error. Others are often indicative
// of the same problem, but confuse the reader with noise.
if (messages.errors.length > 1) {
messages.errors.length = 1;
}
return reject(new Error(messages.errors.join('\n\n')));
}
if (
process.env.CI &&
(typeof process.env.CI !== 'string' ||
process.env.CI.toLowerCase() !== 'false') &&
messages.warnings.length
) {
console.log(
chalk.yellow(
'\nTreating warnings as errors because process.env.CI = true.\n' +
'Most CI servers set it automatically.\n'
)
);
return reject(new Error(messages.warnings.join('\n\n')));
}
const resolveArgs = {
stats,
previousFileSizes,
warnings: messages.warnings,
};
if (writeStatsJson) {
return bfj
.write(paths.appBuild + '/bundle-stats.json', stats.toJson())
.then(() => resolve(resolveArgs))
.catch(error => reject(new Error(error)));
}
return resolve(resolveArgs);
});
});
}
function copyPublicFolder() {
fs.copySync(paths.appPublic, paths.appBuild, {
dereference: true,
filter: file => file !== paths.appHtml,
});
}
'use strict';
// Do this as the first thing so that any code reading it knows the right env.
process.env.BABEL_ENV = 'development';
process.env.NODE_ENV = 'development';
// Makes the script crash on unhandled rejections instead of silently
// ignoring them. In the future, promise rejections that are not handled will
// terminate the Node.js process with a non-zero exit code.
process.on('unhandledRejection', err => {
throw err;
});
// Ensure environment variables are read.
require('../config/env');
const fs = require('fs');
const chalk = require('react-dev-utils/chalk');
const webpack = require('webpack');
const WebpackDevServer = require('webpack-dev-server');
const clearConsole = require('react-dev-utils/clearConsole');
const checkRequiredFiles = require('react-dev-utils/checkRequiredFiles');
const {
choosePort,
createCompiler,
prepareProxy,
prepareUrls,
} = require('react-dev-utils/WebpackDevServerUtils');
const openBrowser = require('react-dev-utils/openBrowser');
const semver = require('semver');
const paths = require('../config/paths');
const configFactory = require('../config/webpack.config');
const createDevServerConfig = require('../config/webpackDevServer.config');
const getClientEnvironment = require('../config/env');
const react = require(require.resolve('react', { paths: [paths.appPath] }));
const env = getClientEnvironment(paths.publicUrlOrPath.slice(0, -1));
const useYarn = fs.existsSync(paths.yarnLockFile);
const isInteractive = process.stdout.isTTY;
// Warn and crash if required files are missing
if (!checkRequiredFiles([paths.appHtml, paths.appIndexJs])) {
process.exit(1);
}
// Tools like Cloud9 rely on this.
const DEFAULT_PORT = parseInt(process.env.PORT, 10) || 3000;
const HOST = process.env.HOST || '0.0.0.0';
if (process.env.HOST) {
console.log(
chalk.cyan(
`Attempting to bind to HOST environment variable: ${chalk.yellow(
chalk.bold(process.env.HOST)
)}`
)
);
console.log(
`If this was unintentional, check that you haven't mistakenly set it in your shell.`
);
console.log(
`Learn more here: ${chalk.yellow('https://cra.link/advanced-config')}`
);
console.log();
}
// We require that you explicitly set browsers and do not fall back to
// browserslist defaults.
const { checkBrowsers } = require('react-dev-utils/browsersHelper');
checkBrowsers(paths.appPath, isInteractive)
.then(() => {
// We attempt to use the default port but if it is busy, we offer the user to
// run on a different port. `choosePort()` Promise resolves to the next free port.
return choosePort(HOST, DEFAULT_PORT);
})
.then(port => {
if (port == null) {
// We have not found a port.
return;
}
const config = configFactory('development');
const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
const appName = require(paths.appPackageJson).name;
const useTypeScript = fs.existsSync(paths.appTsConfig);
const tscCompileOnError = process.env.TSC_COMPILE_ON_ERROR === 'true';
const urls = prepareUrls(
protocol,
HOST,
port,
paths.publicUrlOrPath.slice(0, -1)
);
const devSocket = {
warnings: warnings =>
devServer.sockWrite(devServer.sockets, 'warnings', warnings),
errors: errors =>
devServer.sockWrite(devServer.sockets, 'errors', errors),
};
// Create a webpack compiler that is configured with custom messages.
const compiler = createCompiler({
appName,
config,
devSocket,
urls,
useYarn,
useTypeScript,
tscCompileOnError,
webpack,
});
// Load proxy config
const proxySetting = require(paths.appPackageJson).proxy;
const proxyConfig = prepareProxy(
proxySetting,
paths.appPublic,
paths.publicUrlOrPath
);
// Serve webpack assets generated by the compiler over a web server.
const serverConfig = createDevServerConfig(
proxyConfig,
urls.lanUrlForConfig
);
const devServer = new WebpackDevServer(compiler, serverConfig);
// Launch WebpackDevServer.
devServer.listen(port, HOST, err => {
if (err) {
return console.log(err);
}
if (isInteractive) {
clearConsole();
}
if (env.raw.FAST_REFRESH && semver.lt(react.version, '16.10.0')) {
console.log(
chalk.yellow(
`Fast Refresh requires React 16.10 or higher. You are using React ${react.version}.`
)
);
}
console.log(chalk.cyan('Starting the development server...\n'));
openBrowser(urls.localUrlForBrowser);
});
['SIGINT', 'SIGTERM'].forEach(function (sig) {
process.on(sig, function () {
devServer.close();
process.exit();
});
});
if (process.env.CI !== 'true') {
// Gracefully exit when stdin ends
process.stdin.on('end', function () {
devServer.close();
process.exit();
});
}
})
.catch(err => {
if (err && err.message) {
console.log(err.message);
}
process.exit(1);
});
'use strict';
// Do this as the first thing so that any code reading it knows the right env.
process.env.BABEL_ENV = 'test';
process.env.NODE_ENV = 'test';
process.env.PUBLIC_URL = '';
// Makes the script crash on unhandled rejections instead of silently
// ignoring them. In the future, promise rejections that are not handled will
// terminate the Node.js process with a non-zero exit code.
process.on('unhandledRejection', err => {
throw err;
});
// Ensure environment variables are read.
require('../config/env');
const jest = require('jest');
const execSync = require('child_process').execSync;
let argv = process.argv.slice(2);
function isInGitRepository() {
try {
execSync('git rev-parse --is-inside-work-tree', { stdio: 'ignore' });
return true;
} catch (e) {
return false;
}
}
function isInMercurialRepository() {
try {
execSync('hg --cwd . root', { stdio: 'ignore' });
return true;
} catch (e) {
return false;
}
}
// Watch unless on CI or explicitly running all tests
if (
!process.env.CI &&
argv.indexOf('--watchAll') === -1 &&
argv.indexOf('--watchAll=false') === -1
) {
// https://github.com/facebook/create-react-app/issues/5210
const hasSourceControl = isInGitRepository() || isInMercurialRepository();
argv.push(hasSourceControl ? '--watch' : '--watchAll');
}
jest.run(argv);
import React, {FC} from 'react'
import {HashRouter} from "react-router-dom";
import Nav from "./components/Nav";
import RouterConfig from "./components/RouterConfig";
const App: FC = () => {
return (
<HashRouter>
<Nav/>
<RouterConfig />
</HashRouter>
);
}
export default App;
interface Response {
errcode: number; // 错误码
errmsg: string; // 错误信息
}
interface UserResponse extends Response {
userid: string; // 成员UserID
name: string; // 成员名称
gender: 0 | 1 | 2; // 性别。0表示未定义,1表示男性,2表示女性
qr_code: string; // 员工个人二维码,扫描可添加为外部联系人
thumb_avatar: string; // 头像缩略图url
}
interface ExternalUserResponse extends Response {
external_contact: {
external_userid: string // 外部联系人 Id
name: string // 名字
avatar: string // 头像
corp_name: string // 公司名
corp_full_name: string // 公司全名
type: 1 | 2, // 外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户
gender: 0 | 1 | 2 // 性别。0表示未定义,1表示男性,2表示女性
}
}
interface AuthResponse extends Response {
UserId: string // 自己 userId
DeviceId: string
}
interface TicketRes {
meta: {
nonceStr: string,
timestamp: number,
url: string,
},
app: {
ticket: string,
expires: number,
signature: string,
},
corp: {
ticket: string,
expires: number,
signature: string,
},
}
interface Member {
userid: string // 成员 userId
type: 1 | 2 // 外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户
join_time: number // 加群时间
join_scene: 1 | 2 | 3 // 怎么加群的
}
interface ExternalChatResponse extends Response {
group_chat: {
chat_id: string // 群 Id
name: string // 群名
owner: string // 群主 userId
create_time: number // 创建时间
notice: string // 公告
member_list: Member[] // 成员列表
}
}
import axios from 'axios'
// 后端地址
// const baseURL = 'http://192.168.30.239:5000'
const baseURL = 'https://base.exploring.cn/wecom-server'
// 创建 axios 实例
const api = axios.create({
baseURL,
proxy: false,
})
// 根据 userId 获取 user 信息
export const fetchUser = async (userId: string) => {
const response = await api.get<UserResponse>('/api/qywx-proxy/user/get', {
params: {
userid: userId,
}
});
return response.data
}
// 根据 externalUserId 获取 externalUser 信息
export const fetchExternalUser = async (externalUserId: string, cursor?: string) => {
const response = await api.get<ExternalUserResponse>('/api/qywx-proxy/externalcontact/get', {
params: {
external_userid: externalUserId,
cursor
}
})
return response.data.external_contact
}
// 根据 externalChatId 获取 chat 信息
export const fetchExternalChat = async (externalChatId: string) => {
const response = await api.get<ExternalChatResponse>('/api/qywx-proxy/externalcontact/groupchat/get', {
params: {
chat_id: externalChatId,
need_name : 1
}
})
return response.data.group_chat
}
// 根据 code 换取 userId,作为用户身份验证
export const fetchUserId = async (code: string) => {
const response = await api.get<AuthResponse>('/api/qywx-proxy/user/getuserinfo', {
params: {
code
}
})
return response.data.UserId;
}
// 获取签名
export const fetchSignatures = async () => {
const response = await api.get<TicketRes>('/api/qywx-utils/signatures', {
params: {
url: window.location.href
}
})
return response.data;
}
export default api
import React, {FC} from "react";
import {Menu} from "antd";
import {HomeOutlined, SettingOutlined, UsergroupAddOutlined, UserOutlined} from "@ant-design/icons";
import {Link} from "react-router-dom";
const Nav: FC = () => {
return (
<Menu mode="horizontal">
<Menu.Item key="home" icon={<HomeOutlined/>}>
<Link to="/">首页</Link>
</Menu.Item>
<Menu.Item key="actions" icon={<SettingOutlined/>}>
<Link to="/actions">操作</Link>
</Menu.Item>
<Menu.Item key="externalUser" icon={<UserOutlined />}>
<Link to="/external-user"></Link>
</Menu.Item>
<Menu.Item key="externalChat" icon={<UsergroupAddOutlined />}>
<Link to="/external-chat"></Link>
</Menu.Item>
</Menu>
)
}
export default Nav;
import React, {FC} from "react";
import {Route, Switch} from "react-router-dom";
import Home from "../pages/Home";
import Actions from "../pages/Actions";
import ExternalUser from "../pages/ExternalUser";
import ExternalChat from "../pages/ExternalChat";
const RouterConfig: FC = () => {
return (
<Switch>
<Route exact path="/">
<Home/>
</Route>
<Route path="/actions">
<Actions/>
</Route>
<Route path="/external-user">
<ExternalUser/>
</Route>
<Route path="/external-chat">
<ExternalChat/>
</Route>
</Switch>
)
}
export default RouterConfig;
import React from 'react'
import ReactDOM from 'react-dom'
import { ConfigProvider} from 'antd';
// 由于 antd 组件的默认文案是英文,所以需要修改为中文
import zhCN from 'antd/lib/locale/zh_CN';
import App from './App'
import {fetchUserId, fetchSignatures} from './api'
import config from './_config'
import {invokeResMock, mockUserId, wxResMock} from "./mock";
import {checkRedirect, createJsSdk, initSdk} from "./lib";
import 'antd/dist/antd.css';
export const jsSdk = createJsSdk(wxResMock, invokeResMock);
const AppWrapper = (
<ConfigProvider locale={zhCN}>
<App />
</ConfigProvider>
)
// ReactDOM.render(AppWrapper, document.getElementById('root'))
checkRedirect(config, fetchUserId, mockUserId)
.then(() => initSdk(config, fetchSignatures))
.then(() => ReactDOM.render(AppWrapper, document.getElementById('root')))
import checkRedirect from "./utils/checkRedirect";
import initSdk from "./utils/initSdk";
import createJsSdk from "./utils/createJsSdk";
export {
createJsSdk,
checkRedirect,
initSdk,
}
const apis: wx.Api[] = [
'sendChatMessage',
'onMenuShareAppMessage',
'onMenuShareWechat',
'onMenuShareTimeline',
'startRecord',
'stopRecord',
'onVoiceRecordEnd',
'playVoice',
'pauseVoice',
'stopVoice',
'onVoicePlayEnd',
'uploadVoice',
'downloadVoice',
'previewImage',
'uploadImage',
'downloadImage',
'getLocalImgData',
'getNetworkType',
'onNetworkStatusChange',
'openLocation',
'getLocation',
'startAutoLBS',
'stopAutoLBS',
'onLocationChange',
'onHistoryBack',
'hideOptionMenu',
'showOptionMenu',
'hideMenuItems',
'showMenuItems',
'hideAllNonBaseMenuItem',
'showAllNonBaseMenuItem',
'openDefaultBrowser',
'scanQRCode',
'selectEnterpriseContact',
'openEnterpriseChat',
'selectExternalContact',
'getCurExternalContact',
'openUserProfile',
'shareAppMessage',
'shareWechatMessage',
'startWifi',
'stopWifi',
'connectWifi',
'getWifiList',
'onGetWifiList',
'onWifiConnected',
'getConnectedWifi',
'setClipboardData',
'wwapp.getOpenData',
'wwapp.initWwOpenData',
'getCurExternalChat',
];
export default apis;
import compareVersions from 'compare-versions'
/**
* jssdk 的 config 函数的封装
* @param setting
*/
const config = (setting: wx.ConfigParams): Promise<wx.WxFnCallbackRes | null> => {
return new Promise((resolve) => {
wx.config({ ...setting });
wx.ready(() => resolve(null));
});
};
/**
* jssdk 的 agentConfig 函数封装
* @param agentSetting
*/
const agentConfig = (agentSetting: Omit<wx.AgentConfigParams, 'success' | 'fail'>): Promise<wx.WxFnCallbackRes> => {
return new Promise((resolve, reject) => {
wx.agentConfig({
...agentSetting,
success: resolve,
fail: reject,
});
});
};
/**
* 根据 userAgent 检查当前企业微信版本号是否 < 3.0.24
*/
const checkDeprecated = async (): Promise<boolean> => {
const DEPRECATED_VERSION = '3.0.24'
const versionRegexp = /wxwork\/([\d.]+)/;
const versionResult = navigator.userAgent.match(versionRegexp);
if (!versionResult || versionResult.length < 2) {
return true;
}
const [, version] = versionResult;
// version < DEPRECATED_VERSION ?
return compareVersions(version, DEPRECATED_VERSION) === -1
};
/**
* 通用调用企业微信 SDK 的函数
* @param apiName api 名称
* @param params 传入参数
*/
const invoke = <Res = { hasError: boolean }>(apiName: wx.Api, params = {}) => {
return new Promise<wx.WxInvokeCallbackRes & Res>((resolve) => {
wx.invoke<Res>(apiName, params, res => {
const hasError = res.err_msg !== `${apiName}:ok`
if (hasError) {
// 错误日志
console.error(apiName, params, res);
}
resolve({ ...res, hasError })
});
});
};
const _jsSdk = {
checkDeprecated,
config,
agentConfig,
invoke,
};
export type JsSDK = typeof _jsSdk;
export default _jsSdk;
declare namespace wx {
// 所有 wx.invoke 的 api 名
type Api =
| 'getOpenData'
| 'getContext'
| 'onMenuShareAppMessage'
| 'sendChatMessage'
| 'onMenuShareWechat'
| 'onMenuShareTimeline'
| 'startRecord'
| 'stopRecord'
| 'onVoiceRecordEnd'
| 'playVoice'
| 'pauseVoice'
| 'stopVoice'
| 'onVoicePlayEnd'
| 'uploadVoice'
| 'downloadVoice'
| 'chooseImage'
| 'previewImage'
| 'uploadImage'
| 'downloadImage'
| 'getLocalImgData'
| 'getNetworkType'
| 'onNetworkStatusChange'
| 'openLocation'
| 'getLocation'
| 'startAutoLBS'
| 'stopAutoLBS'
| 'onLocationChange'
| 'onHistoryBack'
| 'hideOptionMenu'
| 'showOptionMenu'
| 'hideMenuItems'
| 'showMenuItems'
| 'hideAllNonBaseMenuItem'
| 'showAllNonBaseMenuItem'
| 'closeWindow'
| 'openDefaultBrowser'
| 'scanQRCode'
| 'selectEnterpriseContact'
| 'openEnterpriseChat'
| 'chooseInvoice'
| 'selectExternalContact'
| 'getCurExternalContact'
| 'openUserProfile'
| 'shareAppMessage'
| 'shareWechatMessage'
| 'startWifi'
| 'stopWifi'
| 'connectWifi'
| 'getWifiList'
| 'onGetWifiList'
| 'onWifiConnected'
| 'getConnectedWifi'
| 'setClipboardData'
| 'wwapp.getOpenData'
| 'wwapp.initWwOpenData'
| 'getCurExternalChat'
| 'createSchoolPayment'
| 'startMeeting'
| 'startLiving'
| 'replayLiving'
| 'downloadLivingReplay'
/**
* 所有企业微信 SDK 的回调返回类型
* 类型为对象,其中除了每个接口本身返回的数据之外,还有一个通用属性errMsg,其值格式如下:
* 调用成功时:”xxx:ok” ,其中xxx为调用的接口名
* 用户取消时:”xxx:cancel”,其中xxx为调用的接口名
* 调用失败时:其值为具体错误信息
*/
interface WxFnCallbackRes {
errMsg: string;
}
interface WxInvokeCallbackRes {
err_msg: string;
}
// 企业微信发送消息的格式
interface TextMessage {
msgtype: 'text',
text: {
content: string; // 文本内容
}
}
interface ImageMessage {
msgtype: 'image',
image: {
mediaid: string, //图片的素材id
}
}
interface VideoMessage {
msgtype: 'video',
video: {
mediaid: string, //视频的素材id
}
}
interface FileMessage {
msgtype: 'file';
file: {
mediaid: string, //文件的素材id
}
}
interface NewsMessage {
msgtype: 'news';
news: {
link: string, //H5消息页面url 必填
title: string, //H5消息标题
desc: string, //H5消息摘要
imgUrl: string, //H5消息封面图片URL
}
}
interface MiniProgramMessage {
msgtype: 'miniprogram';
miniprogram: {
appid: string,//小程序的appid
title: string, //小程序消息的title
imgUrl: string,//小程序消息的封面图。必须带http或者https协议头,否则报错 $apiName$:fail invalid imgUrl
page: string, //小程序消息打开后的路径,注意要以.html作为后缀,否则在微信端打开会提示找不到页面
}
}
interface LinkMessage {
msgtype: 'link',
link: {
title?: string;
desc?: string;
url: string;
imgUrl?: string;
}
}
type Message =
TextMessage
| ImageMessage
| VideoMessage
| FileMessage
| NewsMessage
| MiniProgramMessage
| LinkMessage
// 分享内容
interface ShareContent {
title: string, // 分享标题
desc: string, // 分享描述
link: string, // 分享链接
imgUrl: string // 分享封面
}
// 参与会话的互联企业成员
interface CorpGroupUserId {
corpId: string, // 企业CORPID
userId?: string, // 成员ID,仅自建应用使用
openUserId?: string // 成员OPEN_USERID,仅第三方应用使用
}
// 所有企业微信 SDK 的回调函数
type WxFnCallback<ExtraRes = {}> = (res: WxFnCallbackRes & ExtraRes) => void;
type WxInvokeCallback<ExtraRes = {}> = (res: WxInvokeCallbackRes & ExtraRes) => void;
// 通用 WxFn 的参数
interface WxFnCommonParams<SuccessRes = {}, FailRes = {}, CompleteRes = {}> {
success?: WxFnCallback<SuccessRes>;
fail?: WxFnCallback<FailRes>;
complete?: WxFnCallback<CompleteRes>;
}
// wx.fn 的通用传参
interface CommonParams extends WxFnCommonParams {
cancel?: Function;
trigger?: Function;
}
// 判断当前客户端版本是否支持指定JS接口
interface checkJsApiParams {
jsApiList: Api[]; // 需要检测的JS接口列表
// 以键值对的形式返回,可用的api值true,不可用为false
// 如:{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}
success?: WxInvokeCallback<{
checkResult: { [api in Api]: boolean },
errMsg: string;
}>
}
declare function checkJsApi(params: checkJsApiParams);
/**
* 所有需要使用JS-SDK的页面必须先注入配置信息,否则将无法调用(同一个url仅需调用一次,
* 对于变化url的SPA(single-page application)的web app可在每次url变化时进行调用)
* 详见:https://work.weixin.qq.com/api/doc/90000/90136/90514
*/
interface ConfigParams extends CommonParams {
beta: boolean; // 必须这么写,否则wx.invoke调用形式的jsapi会有问题
debug: boolean; // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
appId: string; // 必填,企业微信的corpID
timestamp: number; // 必填,生成签名的时间戳
nonceStr: string; // 必填,生成签名的随机串
signature: string; // 必填,签名,见 附录-JS-SDK使用权限签名算法
jsApiList: Api[]; // 必填,需要使用的JS接口列表,凡是要调用的接口都需要传进来
}
declare function config(configParams: ConfigParams);
// 通过ready接口处理成功验证
declare function ready(callback: () => void);
// 通过error接口处理失败验证
declare function error(callback: WxFnCallback);
/**
* config注入的是企业的身份与权限,而agentConfig注入的是应用的身份与权限。
* 尤其是当调用者为第三方服务商时,通过config无法准确区分出调用者是哪个第三方应用,
* 而在部分场景下,又必须严谨区分出第三方应用的身份,此时即需要通过agentConfig来注入应用的身份信息。
* 详见:https://work.weixin.qq.com/api/doc/90000/90136/90515
*/
interface AgentConfigParams extends CommonParams {
corpid: string; // 必填,企业微信的corpid,必须与当前登录的企业一致
agentid: string; // 必填,企业微信的应用id (e.g. 1000247)
timestamp: number; // 必填,生成签名的时间戳
nonceStr: string; // 必填,生成签名的随机串
signature: string; // 必填,签名,见附录-JS-SDK使用权限签名算法
jsApiList: API[]; // 必填
}
declare function agentConfig(agentConfigParams: AgentConfigParams);
// 打开会话,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93231
declare function openEnterpriseChat(params: WxFnCommonParams & {
// 注意:userIds和externalUserIds至少选填一个。内部群最多2000人;外部群最多500人;如果有微信联系人,最多40人
userIds: string, //参与会话的企业成员列表,格式为userid1;userid2;...,用分号隔开。
externalUserIds: string, // 参与会话的外部联系人列表,格式为userId1;userId2;…,用分号隔开。
groupName: string, // 会话名称。单聊时该参数传入空字符串""即可。
chatId: string, // 若要打开已有会话,需指定此参数。如果是新建会话,chatId必须为空串
success?: WxInvokeCallback<{ chatId: string }>
});
// 以下接口详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90523
// 获取“转发”按钮点击状态及自定义分享内容接口,
declare function onMenuShareAppMessage(params: WxFnCommonParams & ShareContent & {
success?: () => void; // 用户确认分享后执行的回调函数
cancel?: () => void; // 用户取消分享后执行的回调函数
})
// 获取“微信”按钮点击状态及自定义分享内容接口
declare function onMenuShareWechat(params: WxFnCommonParams & ShareContent & {
success?: () => void; // 用户确认分享后执行的回调函数
cancel?: () => void; // 用户取消分享后执行的回调函数
})
// 获取“分享到朋友圈”按钮点击状态及自定义分享内容接口
declare function onMenuShareTimeline(params: WxFnCommonParams & Omit<ShareContent, 'desc'> & {
success?: () => void; // 用户确认分享后执行的回调函数
cancel?: () => void; // 用户取消分享后执行的回调函数
})
// 以下界面 API 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90524
// 监听页面返回事件
declare function onHistoryBack(callback: Function);
// 隐藏右上角菜单接口
declare function hideOptionMenu();
// 显示右上角菜单接口
declare function showOptionMenu();
// 关闭当前网页窗口接口
declare function closeWindow();
// 批量隐藏功能按钮接口
type MenuItem =
'menuItem:setFont'
| 'menuItem:refresh'
| 'menuItem:share:appMessage'
| 'menuItem:share:wechat'
| 'menuItem:favorite'
| 'menuItem:copyUrl'
| 'menuItem:openWithSafari'
| 'menuItem:share:email'
// 批量隐藏功能按钮接口
declare function hideMenuItems(params: {
menuList: MenuItem[] // 要隐藏的菜单项
})
// 批量显示功能按钮接口
declare function showMenuItems(params: {
menuList: MenuItem[] // 要显示的菜单项
})
// 隐藏所有非基础按钮接口
declare function hideAllNonBaseMenuItem();
// 显示所有功能按钮接口
declare function showAllNonBaseMenuItem();
// 用户截屏事件
declare function onUserCaptureScreen(callback: Function);
// 企业微信扫一扫
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90526
declare function scanQRCode(params: WxFnCommonParams & {
desc: string,
needResult: 0 | 1, // 默认为0,扫描结果由企业微信处理,1则直接返回扫描结果,
scanType: string[], // 可以指定扫二维码还是条形码(一维码),默认二者都有
})
// 以下 API 为图像接口,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90528
// 获取本地图片接口
declare function getLocalImgData(params: WxFnCommonParams & {
localId: string, // 图片的localID
success?: WxFnCallback<{
localData: string // base64 数据
}>
})
// 拍照或从手机相册中选图接口
declare function chooseImage(params: WxFnCommonParams & {
count: number, // 默认9
sizeType: Array<'original' | 'compressed'>, // 可以指定是原图还是压缩图,默认二者都有
sourceType: Array<'album', 'camera'>, // 可以指定来源是相册还是相机,默认二者都有
defaultCameraMode: 'normal' | 'batch', //表示进入拍照界面的默认模式,目前有normal与batch两种选择,normal表示普通单拍模式,batch表示连拍模式,不传该参数则为normal模式。从3.0.26版本开始支持front和batch_front两种值,其中front表示默认为前置摄像头单拍模式,batch_front表示默认为前置摄像头连拍模式。(注:用户进入拍照界面仍然可自由切换两种模式)
isSaveToAlbum: 0 | 1, //整型值,0表示拍照时不保存到系统相册,1表示自动保存,默认值是1
success?: WxFnCallback<{
// 返回选定照片的本地ID列表,
// andriod中localId可以作为img标签的src属性显示图片;
// iOS应当使用 getLocalImgData 获取图片base64数据,从而用于img标签的显示(在img标签内使用 wx.chooseImage 的 localid 显示可能会不成功)
localIds: string[]
}>
})
// 预览图片接口
declare function previewImage(params: {
current: string, // 当前显示图片的http链接
urls: string[] // 需要预览的图片http链接列表
})
// 上传图片接口
declare function uploadImage(params: WxFnCommonParams & {
localId: string, // 需要上传的图片的本地ID,由chooseImage接口获得
isShowProgressTips: 0 | 1, // 默认为1,显示进度提示
success?: WxFnCallback<{
serverId: string; // 返回图片的服务器端ID
}>
})
// 下载图片接口
declare function downloadImage(params: WxFnCommonParams & {
serverId: string, // 需要下载的图片的服务器端ID,由uploadImage接口获得
isShowProgressTips: 0 | 1, // 默认为1,显示进度提示
success?: WxFnCallback<{
localId: string; // 返回图片下载后的本地ID
}>
})
// 以下为音频接口,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90529
// 开始录音接口
declare function startRecord();
// 停止录音接口
declare function stopRecord(params: WxFnCommonParams & {
success?: WxFnCallback<{ localId: string }>
})
// 监听录音自动停止接口
declare function onVoiceRecordEnd(params: WxFnCommonParams & {
complete?: WxFnCallback<{ localId: string }>
})
// 播放语音接口
declare function playVoice(params: {
localId: '' // 需要播放的音频的本地ID,由stopRecord接口获得
})
// 暂停播放接口
declare function pauseVoice(params: {
localId: '' // 需要暂停的音频的本地ID,由stopRecord接口获得
})
// 停止播放接口
declare function stopVoice(params: {
localId: string // 需要停止的音频的本地ID,由stopRecord接口获得
})
// 监听语音播放完毕接口
declare function onVoicePlayEnd(params: WxFnCommonParams & {
success?: WxFnCallback<{
localId: string; // 返回音频的本地ID
}>
})
// 上传语音接口
declare function uploadVoice(params: WxFnCommonParams & {
localId: string, // 需要上传的音频的本地ID,由stopRecord接口获得
isShowProgressTips: 0 | 1, // 默认为1,显示进度提示
success?: WxFnCallback<{
serverId: string; // 返回音频的服务器端ID
}>
})
// 下载语音接口
declare function downloadVoice(params: WxFnCommonParams & {
serverId: string, // 需要下载的音频的服务器端ID,由uploadVoice接口获得
isShowProgressTips: 0 | 1, // 默认为1,显示进度提示
success?: WxFnCallback<{
localId: string; // 返回音频的本地ID
}>
})
// 语音转文字接口
declare function translateVoice(params: WxFnCommonParams & {
localId: string, // 需要识别的音频的本地Id,由录音相关接口获得,音频时长不能超过60秒
isShowProgressTips: 0 | 1, // 默认为1,显示进度提示
success?: WxFnCallback<{
translateResult: any; // 语音识别的结果
}>
})
// 以下为文件接口,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90530
declare function previewFile(params: {
url: string, // 需要预览文件的地址(必填,可以使用相对路径)
name: string, // 需要预览文件的文件名,必须有带文件格式的后缀,例如.doc(不填的话取url的最后部分,最后部分是个包含格式后缀的文件名)
size: number // 需要预览文件的字节大小(必填,而且大小必须正确,否则会打开失败)
})
// 以下为 Wi-Fi 接口,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90532
// 打开 Wi-Fi 模块
declare function startWifi(params: WxFnCommonParams)
// 关闭 Wi-Fi 模块
declare function stopWifi(params: WxFnCommonParams)
// 连接 Wi-Fi
declare function connectWifi(params: WxFnCommonParams & {
SSID: string, // 设备SSID
BSSID?: string, // 设备BSSID
password?: string, // 设备密码
})
// 获取 Wi-Fi 列表
declare function getWifiList(params: WxFnCommonParams)
// 监听获取到 Wi-Fi 列表事件
interface WifiInfo {
SSID: string; // Wi-Fi SSID
BSSID: string, // Wi-Fi BSSID
secure: boolean, // Wi-Fi 是否安全
signalStrength: number; // Wi-Fi 信号强度
}
declare function onGetWifiList(callback: WxFnCallback<{
wifiList: WifiInfo[]
}>)
// 监听连接上 Wi-Fi 的事件
declare function onWifiConnected(callback: WxFnCallback<{
wifi: WifiInfo;
}>)
// 获取已连接中的 Wi-Fi 信息
declare function getConnectedWifi(params: WxFnCommonParams & {
success?: WxFnCallback<{
wifi: WifiInfo;
}>
})
// 以下为蓝牙接口列表
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90533
interface BluetoothInfo {
discovering: boolean; // 是否正在搜索设备
available: boolean; // 蓝牙适配器是否可用
}
interface BluetoothDevice {
name?: string; // 蓝牙设备名称,某些设备可能没有
deviceId: string; // 用于区分设备的 id
RSSI: number; // 当前蓝牙设备的信号强度
advertisData: ArrayBuffer; // 当前蓝牙设备的广播数据段中的ManufacturerData数据段
advertisServiceUUIDs: string[]; // 当前蓝牙设备的广播数据段中的ServiceUUIDs数据段
localName: string; // 当前蓝牙设备的广播数据段中的LocalName数据段
serviceData: ArrayBuffer; // 当前蓝牙设备的广播数据段中的ServiceData数据段
}
// 初始化蓝牙模块
declare function openBluetoothAdapter(params: WxFnCommonParams);
// 关闭蓝牙模块,使其进入未初始化状态。
declare function closeBluetoothAdapter(params: WxFnCommonParams);
// 获取本机蓝牙适配器状态
declare function getBluetoothAdapterState(params: WxFnCommonParams & {
success?: WxFnCallback<BluetoothInfo>
})
// 监听蓝牙适配器状态变化事件
declare function onBluetoothAdapterStateChange(callback: (bluetoothInfo: BluetoothInfo) => void);
// 开始搜寻附近的蓝牙外围设备
declare function startBluetoothDevicesDiscovery(params: WxFnCommonParams & {
services?: string[] // 蓝牙设备主 service 的 uuid 列表
allowDuplicatesKey?: boolean; // 是否允许重复上报同一设备, 如果允许重复上报,则onDeviceFound 方法会多次上报同一设备,但是 RSSI 值会有不同
interval?: number; // 上报设备的间隔,默认为0,意思是找到新设备立即上报,否则根据传入的间隔上报
})
// 停止搜寻附近的蓝牙外围设备
declare function stopBluetoothDevicesDiscovery(params: WxFnCommonParams);
// 获取在蓝牙模块生效期间所有已发现的蓝牙设备,包括已经和本机处于连接状态的设备
declare function getBluetoothDevices(params: WxFnCommonParams & {
success: WxFnCallback<{
devices: BluetoothDevice[] // uuid 对应的的已连接设备列表
}>
})
// 监听寻找到新设备的事件
declare function onBluetoothDeviceFound(callback: (devices: BluetoothDevice[]) => void);
// 根据 uuid 获取处于已连接状态的设备
declare function getConnectedBluetoothDevices(params: WxFnCommonParams & {
services: string[]; // 蓝牙设备主 service 的 uuid 列表
success: WxFnCallback<{
devices: Array<Pick<BluetoothDevice, 'name' | 'deviceId'>> // 搜索到的设备列表
}>
});
// 连接低功耗蓝牙设备
declare function createBLEConnection(params: WxFnCommonParams & {
deviceId: string; // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接
})
// 断开与低功耗蓝牙设备的连接
declare function closeBLEConnection(params: WxFnCommonParams & {
deviceId: string; // 蓝牙设备 id,参考 getDevices 接口
})
// 监听低功耗蓝牙连接状态的改变事件
declare function onBLEConnectionStateChange(callback: (res: {
deviceId: string; // 蓝牙设备 id,参考 device 对象
connected: boolean; // 连接目前的状态
}) => void)
// 获取蓝牙设备所有 service(服务)
declare function getBLEDeviceServices(params: WxFnCommonParams & {
deviceId: string; // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接
success?: WxFnCallback<{
services: {
uuid: string; // 蓝牙设备服务的 uuid
isPrimary: boolean // 该服务是否为主服务
}
}>
})
// 获取蓝牙设备某个服务中的所有 characteristic(特征值)
interface BLEDeviceCharacteristics{
uuid: string;
properties: {
read: boolean; // 该特征值是否支持 read 操作
write: boolean; // 该特征值是否支持 write 操作
notify: boolean; // 该特征值是否支持 notify 操作
indicate: boolean; // 该特征值是否支持 indicate 操作
}
}
declare function getBLEDeviceCharacteristics(params: WxFnCommonParams & {
deviceId: string; // 蓝牙设备 id,参考 getDevices 接口
serviceId: string; // 蓝牙服务 uuid
success?: WxFnCallback<{
characteristics: BLEDeviceCharacteristics[];
}>
})
// 监听变化
declare function onBLECharacteristicValueChange(callback: (res: {
deviceId: string; // 蓝牙设备 id,参考 device 对象
serviceId: string; // 特征值所属服务 uuid
characteristicId: string; // 特征值 uuid
value: ArrayBuffer; // 特征值最新的值 (注意:vConsole 无法打印出 ArrayBuffer 类型数据)
}) => void);
// 读取低功耗蓝牙设备的特征值的二进制数据值。
declare function readBLECharacteristicValue(params: WxFnCommonParams & {
// 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 [**new**]
deviceId: string,
// 这里的 serviceId 需要在上面的 getBLEDeviceServices 接口中获取
serviceId: string,
// 这里的 characteristicId 需要在上面的 getBLEDeviceCharacteristics 接口中获取
characteristicId: string,
});
// 向低功耗蓝牙设备特征值中写入二进制数据
declare function writeBLECharacteristicValue(params: {
// 这里的 deviceId 需要在上面的 getBluetoothDevices 或 onBluetoothDeviceFound 接口中获取
deviceId: string,
// 这里的 serviceId 需要在上面的 getBLEDeviceServices 接口中获取
serviceId: string,
// 这里的 characteristicId 需要在上面的 getBLEDeviceCharacteristics 接口中获取
characteristicId: string,
// 这里的value是ArrayBuffer类型
value: ArrayBuffer,
})
// 启用低功耗蓝牙设备特征值变化时的 notify 功能,订阅特征值
declare function notifyBLECharacteristicValueChange(params: {
state: boolean, // 启用 notify 功能
// 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接
deviceId: string,
// 这里的 serviceId 需要在上面的 getBLEDeviceServices 接口中获取
serviceId: string,
// 这里的 characteristicId 需要在上面的 getBLEDeviceCharacteristics 接口中获取
characteristicId: string,
})
// 以下为 iBeacon 的接口,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90534
interface Beacon {
uuid: string; // iBeacon 设备广播的 uuid
major: string; // iBeacon 设备的主 id
minor: string; // iBeacon 设备的次 id
proximity: number; // 表示设备距离的枚举值
accuracy: number; // iBeacon 设备的距离
rssi: number; // 表示设备的信号强度
}
// 开始搜索附近的iBeacon设备
declare function startBeaconDiscovery(params: WxFnCommonParams & {
uuids: StringArray; // iBeacon设备广播的 uuids
})
// 停止搜索附近的iBeacon设备
declare function stopBeaconDiscovery(params: WxFnCommonParams);
// 获取所有已搜索到的iBeacon设备
declare function getBeacons(params: WxFnCommonParams & {
success?: WxFnCallback<{
beacons: Beacon[]; // 当前搜寻到的所有 iBeacon 设备列表
}>
});
// 监听 iBeacon 设备的更新事件
declare function onBeaconUpdate(callback: (res: {
beacons: Beacon[]
}) => void);
// 监听 iBeacon 的服务变化
declare function onBeaconServiceChange(callback: (res: {
available: boolean; // 服务目前是否可用
discovering: boolean; // 目前是否处于搜索状态
}) => void);
// 以下为剪贴板接口,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90535
// 设置系统剪贴板的内容
declare function setClipboardData(params: WxFnCommonParams & {
data: string; // 剪贴板的内容
})
// 获取系统剪贴板内容
declare function getClipboardData(params: WxFnCommonParams & {
success?: WxFnCallback<{
data: string; // 剪贴板的内容
}>
})
// 以下为网络状态的接口,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90536
// 获取网络状态接口
declare function getNetworkType(params: WxFnCommonParams & {
success?: WxFnCallback<{
isConnected: boolean; // 当前是否有网络连接
networkType: 'wifi' | '2g' | '3g' | '4g' | 'none' | 'unknown'
}>
})
// 以下为地理位置的接口,详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90537
// 使用企业微信内置地图查看位置接口
declare function openLocation(params: {
latitude: number, // 纬度,浮点数,范围为90 ~ -90
longitude: number, // 经度,浮点数,范围为180 ~ -180。
name: string, // 位置名
address: string, // 地址详情说明
scale: number, // 地图缩放级别,整形值,范围从1~28。默认为16
})
// 获取地理位置接口
declare function getLocation(params: WxFnCommonParams & {
type: 'wgs84' | 'gcj02', // 默认为wgs84的gps坐标,如果要返回直接给openLocation用的火星坐标,可传入'gcj02'
success?: WxFnCallback<{
latitude: number; // 纬度,浮点数,范围为90 ~ -90
longitude: number; // 经度,浮点数,范围为180 ~ -180。
speed: number; // 速度,以米/每秒计
accuracy: number; // 位置精度
}>
})
// 监听地理位置变化
declare function onLocationChange(callback: (res: {
latitude: number; // 纬度,浮点数,范围为90 ~ -90
longitude: number; // 经度,浮点数,范围为180 ~ -180。
speed: number; // 速度,以米/每秒计
accuracy: number; // 位置精度
}) => void)
// invoke ----------------------------------------------------------------------
// SDK 调用函数
declare function invoke<ExtraRes = {}>(
apiName: Api,
params: Object,
callback: WxInvokeCallback<ExtraRes>
);
// 获取进入H5页面的入口环境
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94326
declare function invoke(api: 'getContext', {}, callback: WxInvokeCallback<{
entry: 'normal' | 'contact_profile' | 'single_chat_tools' | 'group_chat_tools' | 'chat_attachment'; // 返回进入H5页面的入口类型
shareTicket: string; // 可用于调用getShareInfo接口
}>);
// 选人接口
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/91819
declare function invoke(
api: 'selectEnterpriseContact',
params: {
fromDepartmentId: -1 | 0,// 必填,表示打开的通讯录从指定的部门开始展示,-1表示自己所在部门开始, 0表示从最上层开始
mode: 'single' | 'multi',// 必填,选择模式,single表示单选,multi表示多选
type: string[],// 必填,选择限制类型,指定department、user中的一个或者多个
selectedDepartmentIds?: string[],// 非必填,已选部门ID列表。用于多次选人时可重入,single模式下请勿填入多个id
selectedUserIds?: string[]// 非必填,已选用户ID列表。用于多次选人时可重入,single模式下请勿填入多个id
},
callback: WxInvokeCallbackRes<{
result: string | {
departmentList: {
id: string; // 已选的单个部门ID
name: string; // 已选的单个部门名称
}[]; // 已选的部门列表
userList: {
id: string; // 已选的单个成员ID
name: string; // 已选的单个成员名称
avatar: string; // 已选的单个成员头像
}[] // 已选的用户
}
}>
)
// 打开个人信息页接口
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/91822
declare function invoke(
api: 'openUserProfile',
params: {
type: 1 | 2, // 1表示该userid是企业成员,2表示该userid是外部联系人
userid: string // 可以是企业成员,也可以是外部联系人
},
callback: WxInvokeCallbackRes
)
// 企业互联选人接口
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94364
declare function invoke(
api: 'selectCorpGroupContact',
params: {
fromDepartmentId: -1 | 0;// 必填,表示打开的通讯录从指定的部门开始展示,-1表示打开的通讯录从自己所在部门开始展示, 0表示从最上层开始。移动端,当需要展开的部门不在应用可见范围内,则从应用的可见范围开始展开。
mode: 'single' | 'multi';// 必填,选择模式,single表示单选,multi表示多选
type: string[],// 必填,选择限制类型,指定department、user中的一个或者多个
selectedDepartmentIds?: string[],// 非必填,已选部门ID列表。用于多次选人时可重入
selectedUserIds?: string[],// 非必填,仅自建应用使用,第三方应用会忽略该字段,已选用户ID列表。用于多次选人时可重入
selectedOpenUserIds?: string[],// 非必填,仅第三方应用使用,自建应用会忽略该字段,已选用户ID列表。用于多次选人时可重入
selectedCorpGroupDepartmentIds?: { // 非必填,已选企业互联部门ID列表。用于多次选人时可重入
corpId: string; // 企业CORPID
departmentId: string; // 部门ID
}[];
selectedCorpGroupUserIds?: CorpGroupUserId[] // 非必填,已选企业互联用户ID列表。用于多次选人时可重入
},
callback: WxInvokeCallback<{
result: string | {
departmentList: {
id: string; // 已选的单个部门ID
}[];
userList: {
id: string; // 已选的单个成员ID,仅自建应用返回
openUserId: string // 已选的单个成员ID,仅第三方应用返回
}[];
corpGroupDepartmentList: {
corpId: string; // 企业CORPID
id: string; // 已选的单个部门ID
}[];
corpGroupUserList: {
corpId: string; // 企业CORPID
id: string; // 已选的单个成员ID,仅自建应用返回
openUserId: string; // 已选的单个成员ID,仅第三方应用返回
}[];
}
}>
)
// 返回ticket的选人接口
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94516
declare function invoke(
api: 'selectPrivilegedContact',
params: {
fromDepartmentId: -1 | 0,// 必填,表示打开的通讯录从指定的部门开始展示,-1表示自己所在部门开始, 0表示从最上层开始
mode: 'multi' | 'single',// 必填,选择模式,single表示单选,multi表示多选
selectedContextContact?: 1 | 0 // 是否勾选当前环境的参与者。1表示是,0表示否。
selectedOpenUserIds?: string[], // 非必填,已选用户OpenID列表。single模式忽略该参数。
selectedTickets?: string[] // 非必填,已选ticket列表。single模式忽略该参数
},
callback: WxInvokeCallback<{
userList?: { // 已选的成员列表
openUserId: string; // 成员openUserId
}[];
selectedTicket: string; // 已选的集合Ticket
expiresIn: number; // ticket有效期
selectedUserCount: number; // 用户选中的用户个数
}>
)
// 认领老师班级
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94546
declare function invoke(
api: 'claimClassAdmin',
params: {},
callback: WxInvokeCallback<{
departmentIds: string[]; // 认领的班级部门id列表
}>
)
// 变更群成员
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93232
declare function invoke(
api: 'updateEnterpriseChat',
params: {
chatId: string; // 通过企业微信创建群聊接口返回的chatId
userIdsToAdd: string; // 参与会话的企业成员列表,格式为userid1;userid2;...,用分号隔开。
},
callback: WxInvokeCallback
)
// 隐藏聊天附件栏的发送按钮
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94355
declare function invoke(
api: 'hideChatAttachmentMenu',
params: {
menuList: string[] // 要隐藏的菜单项,sendMessage。即附件栏底部发送按钮。
},
callback: WxInvokeCallback
)
// 分享消息到当前会话
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94354
interface SendChatMessageCommonParams {
enterChat: boolean, // 为true时表示发送完成之后顺便进入会话,仅移动端3.1.10及以上版本支持该字段
}
declare function invoke(api: 'sendChatMessage', params: TextMessage & SendChatMessageCommonParams, callback: WxInvokeCallback)
declare function invoke(api: 'sendChatMessage', params: ImageMessage & SendChatMessageCommonParams, callback: WxInvokeCallback)
declare function invoke(api: 'sendChatMessage', params: VideoMessage & SendChatMessageCommonParams, callback: WxInvokeCallback)
declare function invoke(api: 'sendChatMessage', params: FileMessage & SendChatMessageCommonParams, callback: WxInvokeCallback)
declare function invoke(api: 'sendChatMessage', params: NewsMessage & SendChatMessageCommonParams, callback: WxInvokeCallback)
declare function invoke(api: 'sendChatMessage', params: MiniProgramMessage & SendChatMessageCommonParams, callback: WxInvokeCallback)
// 创建群聊并发送消息
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94517
declare function invoke(
api: 'createChatWithMsg',
params: {
selectedOpenUserIds?: string[],
selectedTickets?: string[],
chatName?: string,
msg: LinkMessage
},
callback: WxInvokeCallback<{
chatId: string; // 新建的会话ID,当会话为单聊时不返回此字段
}>
)
// 打开已有群聊并发送消息
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94518
declare function invoke(
api: 'openExistedChatWithMsg',
params: {
chatId: string,
msg?: LinkMessage,
},
callback: WxInvokeCallback
)
// 私密消息
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94495
declare function invoke(
api: 'setShareAttr',
params: {
withShareTicket?: boolean,
state?: string;
},
callback: WxInvokeCallback
)
declare function invoke(
api: 'getShareInfo',
params: {
shareTicket: string;
},
callback: WxInvokeCallback<{
encryptedData: string; // 转发信息的加密数据
iv: string; // 加密算法的初始向量
}>
)
// 创建企业互联会话
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94547
declare function invoke(
api: 'createCorpGroupChat',
params: {
groupName: string, // 必填,会话名称。单聊时该参数传入空字符串""即可。
userIds?: string[], //参与会话的企业成员列表,仅自建应用使用,第三方应用会忽略该字段
openUserIds?: string[],// 参与会话的企业成员列表,仅第三方应用使用,自建应用会忽略该字段
corpGroupUserIds?: CorpGroupUserId[] // 非必填, 参与会话的互联企业成员列表
},
callback: WxInvokeCallback
)
// 变更企业互联群成员
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94548
declare function invoke(
api: 'updateCorpGroupChat',
params: {
chatId: string, //通过企业微信创建群聊接口返回的chatId
userIdsToAdd?: string[], //新增的企业成员列表,仅自建应用使用,第三方应用会忽略该字段
openUserIdsToAdd?: string[],// 新增的企业成员列表,仅第三方应用使用,自建应用会忽略该字段
corpGroupUserIdsToAdd?: CorpGroupUserId[]; // 非必填, 参与会话的互联企业成员列表
},
callback: WxInvokeCallback
)
// 外部联系人选人接口
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/91823
declare function invoke(
api: 'selectExternalContact',
params: {
filterType: 0 | 1, //0表示展示全部外部联系人列表,1表示仅展示未曾选择过的外部联系人。默认值为0;除了0与1,其他值非法。在企业微信2.4.22及以后版本支持该参数
},
callback: WxInvokeCallback<{
userIds: string[]; // 一堆外部联系人 id
}>
)
// 打开个人信息页接口
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/91824
declare function invoke(
api: 'openUserProfile',
params: {
type: 1 | 2, //1表示该userid是企业成员,2表示该userid是外部联系人
userid: string //可以是企业成员,也可以是外部联系人
},
callback: WxInvokeCallback
)
// 获取当前外部联系人userid
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/91825
declare function invoke(
api: 'getCurExternalContact',
params: {},
callback: WxInvokeCallback<{
userId: string; // 外部联系人 id
}>
)
// 获取当前客户群的群ID
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/92675
declare function invoke(
api: 'getCurExternalChat',
params: {},
callback: WxInvokeCallback<{
chatId: string; // 外部联系群 id
}>
)
// 群发消息给客户
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93562
declare function invoke(
api: 'shareToExternalContact',
params: {
text: {
content: string, // 文本内容
};
attachments?: Array<ImageMessage | VideoMessage | LinkMessage | MiniProgramMessage | FileMessage>;
},
callback: WxInvokeCallback
)
// 群发消息到客户群
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93563
declare function invoke(
api: 'shareToExternalChat',
params: {
text: {
content: string, // 文本内容
};
attachments?: Array<ImageMessage | VideoMessage | LinkMessage | MiniProgramMessage | FileMessage>;
},
callback: WxInvokeCallback
)
// 进入添加客户界面
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93235
declare function invoke(api: 'navigateToAddCustomer', params: {}, callback: WxInvokeCallback);
// 发表内容到客户朋友圈
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94958
declare function invoke(
api: 'shareToExternalMoments',
params: {
text: {
content: string, // 文本内容
};
attachments?: Array<ImageMessage | VideoMessage | LinkMessage | MiniProgramMessage | FileMessage>;
},
callback: WxInvokeCallback
)
// 设置朋友圈封面与签名
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94959
declare function invoke(
api: 'updateMomentsSetting',
params: {
signature?: string, // 个性签名
imgUrl?: string // 封面url
},
callback: WxInvokeCallback
)
// 进入微信客服消息界面
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/94870
declare function invoke(
api: 'navigateToKfChat',
params: {
openKfId: string; // 客服帐号ID
externalUserId?: string; // 微信客户ID,若没指定,则跳转到客服帐号的消息列表界面
},
callback: WxInvokeCallback
)
// 创建立即会议
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93830
declare function invoke(
api: 'startMeeting',
params: {
meetingType: 1, // 会议类型。0-语音会议;1-视频会议
theme?: string, // 会议主题。最多20个UTF-8字符
attendees?: string[], // 参会人员,内部同事列表。系统会忽略不合法的ID
externalAttendees?: string[], // 参会人员,外部联系列表。要求与发起人必须是好友关系。系统会忽略不合法的ID
deviceSns?: string[], // 设备序列号列表。支持添加已绑定的硬件设备。Mac端不支持
},
callback: WxInvokeCallback<{ meetingId: string }>
)
// 进入会议
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93831
declare function invoke(
api: 'startMeeting',
params: {
meetingId: string; // 会议 Id
},
callback: WxInvokeCallback<{ meetingId: string }>
)
// 创建直播
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93832
declare function invoke(
api: 'startLiving',
params: {
liveType: 0 | 1 | 2 | 3; // 直播类型,0-通用直播;1-企业培训;2-大班课;3-小班课。 Mac端只支持通用直播
theme?: string; // 直播主题。最多20个UTF-8字符
},
callback: WxInvokeCallback<{ livingId: string }>
)
// 进入直播
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93833
declare function invoke(
api: 'startLiving',
params: {
livingId: string; // 直播 Id
},
callback: WxInvokeCallback<{ livingId: string }>
)
// 观看直播回放
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93835
declare function invoke(
api: 'replayLiving',
params: {
livingId: string; // 直播 Id
},
callback: WxInvokeCallback
)
// 下载直播回放
declare function invoke(
api: 'downloadLivingReplay',
params: {
livingId: string; // 直播 Id
},
callback: WxInvokeCallback
)
// 发起班级收款
declare function invoke(
api: 'createSchoolPayment',
params: {
projectName?: string; // 收款项目名称
amount?: number; // 收款金额,每个学生需付费的金额,单位为分
payers?: {
students: string[], //需要收款的学生列表
departments: number[], //需要收款的家校通讯录部门列表、支持班级,年级,校区
}
},
callback: WxInvokeCallback<{ paymentId: string }>
)
// 自定义转发到会话
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90523
declare function invoke(api: 'shareAppMessage', params: ShareContent, callback: WxInvokeCallback);
// 自定义转发到微信
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90523
declare function invoke(api: 'shareWechatMessage', params: ShareContent, callback: WxInvokeCallback);
// 打开系统默认浏览器
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90524
declare function invoke(
api: 'openDefaultBrowser',
params: {
url: string; // 在默认浏览器打开redirect_uri,并附加code参数;也可以直接指定要打开的url,此时不会附带上code参数。
},
callback: WxInvokeCallback
)
// 拉起电子发票列表
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/90526
declare function invoke(
api: 'chooseInvoice',
params: {
timestamp: string, // 卡券签名时间戳
nonceStr: string, // 卡券签名随机串
signType: string, // 签名方式,默认 'SHA1'
cardSign: string, // 卡券签名
},
callback: WxInvokeCallback<{
choose_invoice_info: {
card_id: string;
encrypt_code: string;
app_id: string;
}
}>
)
// 跳转到小程序
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/93114
declare function invoke(
api: 'launchMiniprogram',
params: {
appid: string, // 需跳转的小程序appid
path?: string, // 所需跳转的小程序内页面路径及参数。非必填
},
callback: WxInvokeCallback
)
// 打开持续定位接口
declare function invoke(
api: 'startAutoLBS',
params: {
type: 'gcj02' | 'wgs84', // wgs84是gps坐标,gcj02是火星坐标
},
callback: WxInvokeCallback
)
// 进入应用客服会话
// 详见:https://open.work.weixin.qq.com/api/doc/90001/90144/95181
declare function invoke(api: 'openThirdAppServiceChat', params: {}, callback: WxInvokeCallback);
}
import {JsSDK} from "./index";
// 假值
const fakeValue: Record<string, any> = {
number: 0,
string: '',
object: {},
};
// 根据外部判断是否为 mock 环境
const isWindowMock = window.isMock === true;
// 根据宿主环境判断是否要 mock
const isHostMock = navigator.userAgent.toLowerCase().includes('chrome')
&& !navigator.userAgent.toLowerCase().includes('wxwork')
// 是否为 mock 环境
export const isMock = isWindowMock || isHostMock;
/**
* 生成 mock 函数
* @param apiName api 调用名
* @param mockMap mock 的映射关系表
*/
const createMockFn = (apiName: keyof JsSDK, mockMap: any) => {
return async (...args: any) => {
const isInvoke = apiName === 'invoke';
// 获取对应的 mock 返回
const mockRes = isInvoke ? mockMap[args[0]] : mockMap[apiName];
// 生成 mock 返回
const result = typeof mockRes === 'function' ? mockRes(...args) : mockRes
// 日志
if (apiName === 'invoke') {
console.log('wx.invoke 调用', args[0], '参数', args[1], '返回值', result);
} else {
console.log('JSSDK调用', apiName, '参数', args, '返回值', result);
}
return result;
}
}
/**
* Mock企业微信 SDK,可以在浏览器下不调用 Sdk
*/
export const mockJsSdk = (originalJsSdk: JsSDK, wxResMock: Partial<JsSDK>, invokeMockRes: any) => {
// @ts-ignore 这里要生成 JsSDK 所以要 ignore ts 的报错
const newJsSdk: JsSDK = {};
Object.entries(originalJsSdk).forEach(entry => {
const [key, originalValue] = entry as [keyof JsSDK, any];
const originalValueType = typeof originalValue;
const mockRes = wxResMock[key];
// 特殊处理 invoke
if (key === 'invoke') {
newJsSdk.invoke = createMockFn(key, invokeMockRes)
return;
}
if (originalValueType === 'function') {
// mock 函数
newJsSdk[key] = createMockFn(key, wxResMock);
} else {
// 使用 mock 值
newJsSdk[key] = mockRes || fakeValue[originalValueType] || null;
}
});
return newJsSdk;
};
import Cookies from 'js-cookie'
import qs from 'qs'
import {Config} from "./initSdk"
import {isMock} from "../jsSdk/utils";
type GetUserId = (code: string) => Promise<string>
/**
* 获取重定位的 OAuth 路径
* @returns {string}
*/
const generateOAuthUrl = (config: Config) => {
const [redirectUri] = window.location.href.split('#');
const searchObj = {
appid: config.corpId,
redirect_uri: encodeURIComponent(redirectUri),
response_type: 'code',
scope: 'snsapi_base',
agentid: config.agentId,
state: 'A1',
};
const search = Object.entries(searchObj)
.map(entry => {
const [key, value] = entry;
return `${key}=${value}`;
})
.join('&');
return `https://open.weixin.qq.com/connect/oauth2/authorize?${search}#wechat_redirect`;
};
/**
* 判断当前网页是否需要重定向
*/
const checkRedirect = async (config: Config, getUserId: GetUserId, mockUserId?: string) => {
if (isMock) {
// 使用 mock 的 userId
if (mockUserId) {
Cookies.set('userId', mockUserId);
}
return ;
}
const userId = Cookies.get('userId')
const unAuth = !userId || userId === 'undefined' || userId === 'null'
const codeExist = window.location.search.includes('code');
// 判断是否需要重定向
if (unAuth && !codeExist) {
window.location.replace(generateOAuthUrl(config));
}
// 判断是否需要重新获取 userId
if (unAuth) {
const code = qs.parse(window.location.search.slice(1)).code as string
const newUserId = await getUserId(code)
Cookies.set('userId', newUserId)
}
};
export default checkRedirect
import {isMock, mockJsSdk} from "../jsSdk/utils";
import _jsSdk from "../jsSdk";
/**
* 生成 jssdk 的函数
* @param wxResMock wx.fn 的 mock 映射关系
* @param invokeResMock wx.invoke 的 mock 映射关系
*/
const createJsSdk = (wxResMock?: Record<string, any>, invokeResMock?: Record<string, any>) => {
return isMock ? mockJsSdk(_jsSdk, wxResMock || {}, invokeResMock || {}) : _jsSdk;
}
export default createJsSdk
import apis from '../jsSdk/apis';
import {jsSdk} from "../../index";
export interface Config {
corpId: string;
agentId: string;
}
export type GetSignatures = () => Promise<TicketRes>
/**
* 初始化企业微信 SDK 库
* config: 基础信息配置
* getSignatures: 获取签名函数
*/
const initSdk = async (config: Config, getSignatures: GetSignatures) => {
const { corpId, agentId } = config;
// 获取 ticket
const signaturesRes = await getSignatures();
const agentConfigRes = await jsSdk.agentConfig({
corpid: corpId,
agentid: agentId,
timestamp: signaturesRes.meta.timestamp,
nonceStr: signaturesRes.meta.nonceStr,
signature: signaturesRes.app.signature,
jsApiList: apis,
}).catch(e => {
console.error(e)
});
console.log('agentConfig res', agentConfigRes);
wx.error(console.error);
};
export default initSdk
// Mock 当前用户 Id
export const mockUserId = window.mockUserId || 'YanHaiXiang';
// 可在这里自由 mock wx.invoke 的内容
export const invokeResMock: Record<string, any> = window.invokeResMock || {
'getCurExternalContact': {
userId: 'wmuUG7CQAAOrCCMkA8cqcCm1wJrJAD6A'
},
}
// 可在这里自由 wx.fn 的内容
export const wxResMock: Record<string, any> = window.wxResMock || {
'agentConfig': () => {
console.log('mock agent config')
},
}
import * as React from 'react'
import {useCallback, useState} from 'react'
import {jsSdk} from "../index";
import {Button, Input} from "antd";
const {TextArea} = Input
const Actions: React.FC = () => {
const [msg, setMsg] = useState<string>('')
const sendMsg = useCallback(async () => {
if (!msg) alert('消息不能为空')
await jsSdk.invoke('sendChatMessage', {
msgtype: 'text',
text: {
content: msg
}
});
}, [msg])
return (
<div>
<h2>功能</h2>
<TextArea style={{width: '100%', marginBottom: 8}} value={msg} onChange={e => setMsg(e.target.value)}/>
<Button block type="primary" onClick={sendMsg}>
发送
</Button>
</div>
)
}
export default Actions
import * as React from 'react'
import {useEffect, useState} from 'react'
import {fetchExternalChat} from '../api'
import {jsSdk} from "../index";
import {Spin} from "antd";
const ExternalChat: React.FC = () => {
const [loading, setLoading] = useState<boolean>()
const [externalChat, setExternalChat] = useState<ExternalChatResponse['group_chat'] | void>()
const getExternalChatInfo = async () => {
const res = await jsSdk.invoke<{chatId?: string}>('getCurExternalChat', {})
if (!res || !res.chatId) return
console.log('外部联系群 ID', res.chatId);
const chatInfo = await fetchExternalChat(res.chatId || '').catch(e => console.error(e))
setExternalChat(chatInfo)
}
useEffect(() => {
getExternalChatInfo()
.finally(() => setLoading(false))
}, [])
const openUserProfile = (userId: string, type: 1 | 2) => {
return jsSdk.invoke('openUserProfile', {
userid: userId,
type,
})
}
return (
<Spin spinning={loading}>
<div>
<h2>外部联系群</h2>
{externalChat ? (
<div>
<p>群名: {externalChat.name}</p>
<p>群主: {externalChat.owner}</p>
<p>群公告: {externalChat.notice}</p>
<p>群成员: </p>
<ul>
{externalChat.member_list.map(m => (
<li key={m.userid}>
<a href="" onClick={() => openUserProfile(m.userid, m.type)}>
{m.userid}
</a>
</li>
))}
</ul>
</div>
) : <p>找不到外部联系群</p>}
</div>
</Spin>
)
}
export default ExternalChat
import * as React from 'react'
import {useEffect, useState} from 'react'
import {fetchExternalUser} from '../api'
import {jsSdk} from "../index";
import {Button, message, Spin} from "antd";
// 性别Map
const genderMap = ['未定义', '男', '女']
const ExternalUser: React.FC = () => {
const [loading, setLoading] = useState<boolean>(true)
const [externalUser, setExternalUser] = useState<ExternalUserResponse['external_contact'] | void>()
const getExternalUserInfo = async () => {
const res = await jsSdk.invoke<{ userId?: string }>('getCurExternalContact', {})
if (!res || !res.userId) return
console.log('外部联系人 ID', res.userId);
const userInfo = await fetchExternalUser(res.userId).catch(e => console.error(e))
setExternalUser(userInfo)
}
useEffect(() => {
getExternalUserInfo()
.finally(() => setLoading(false))
}, [])
const openUserProfile = () => {
if (!externalUser) {
return message.warn('找不到外部联系人');
}
return jsSdk.invoke('openUserProfile', {
userid: externalUser.external_userid,
type: externalUser.type
})
}
return (
<Spin spinning={loading}>
<div>
<h2>外部联系人</h2>
{externalUser ? (
<div>
<img width="48" src={externalUser.avatar} alt="头像"/>
<p>ID: {externalUser.external_userid}</p>
<p>姓名: {externalUser.name}@{externalUser.corp_name}</p>
<p>姓别: {genderMap[externalUser.gender]}</p>
<Button type="primary" size="small" onClick={openUserProfile}>
查看详情
</Button>
</div>
) : <p>找不到外部联系人</p>}
</div>
</Spin>
)
}
export default ExternalUser
import React, {FC, useEffect, useState} from "react";
import Cookies from "js-cookie";
import {fetchUser} from "../api";
import {Spin} from "antd";
const Home: FC = () => {
const [loading, setLoading] = useState<boolean>(false);
const [user, setUser] = useState<UserResponse>();
// 获取当前外部联系人信息
const getUserInfo = async () => {
setLoading(true);
const userId = Cookies.get('userId')
const userInfo = await fetchUser(userId || '')
setUser(userInfo)
setLoading(false)
}
useEffect(() => {
getUserInfo().then()
}, [])
return (
<Spin spinning={loading}>
<div>
<h1>欢迎回来,{user ? user.name : ''}</h1>
</div>
</Spin>
)
}
export default Home;
/// <reference types="node" />
/// <reference types="react" />
/// <reference types="react-dom" />
declare namespace NodeJS {
interface ProcessEnv {
readonly NODE_ENV: 'development' | 'production' | 'test';
readonly PUBLIC_URL: string;
}
}
declare module '*.avif' {
const src: string;
export default src;
}
declare module '*.bmp' {
const src: string;
export default src;
}
declare module '*.gif' {
const src: string;
export default src;
}
declare module '*.jpg' {
const src: string;
export default src;
}
declare module '*.jpeg' {
const src: string;
export default src;
}
declare module '*.png' {
const src: string;
export default src;
}
declare module '*.webp' {
const src: string;
export default src;
}
declare module '*.svg' {
import * as React from 'react';
export const ReactComponent: React.FunctionComponent<React.SVGProps<
SVGSVGElement
> & { title?: string }>;
const src: string;
export default src;
}
declare module '*.module.css' {
const classes: { readonly [key: string]: string };
export default classes;
}
declare module '*.module.scss' {
const classes: { readonly [key: string]: string };
export default classes;
}
declare module '*.module.sass' {
const classes: { readonly [key: string]: string };
export default classes;
}
import {JsSDK} from "./lib/jsSdk";
declare global {
interface Window {
// 外部控制是否为 mock
isMock?: boolean;
// mock userId
mockUserId: string,
// wx.invoke 里的 Mock 关系表,apiName -> result
invokeResMock?: Partial<JsSDK>;
// 企业微信的 JsSdk 的 Mock 关系表,fnName -> result
wxResMock?: Partial<JsSDK>;
}
}
{
"compilerOptions": {
"target": "es5",
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"module": "esnext",
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react-jsx"
},
"include": [
"src"
]
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment