@umijs/plugins 4.0.0-beta.12 → 4.0.0-beta.16

package/dist/request.js

@@ -1,5 +1,301 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@umijs/utils");
+const path_1 = require("path");
 exports.default = (api) => {
-    api;
+    api.describe({
+        key: 'request',
+        config: {
+            schema: (joi) => {
+                return joi.object();
+            },
+        },
+        enableBy: api.EnableBy.config,
+    });
+    api.addRuntimePluginKey(() => ['request']);
+    const requestTpl = `
+import axios, {
+  type AxiosInstance,
+  type AxiosRequestConfig,
+  type AxiosResponse,
+} from '{{{axiosPath}}}';
+import useUmiRequest, { UseRequestProvider } from '{{{umiRequestPath}}}';
+import { message, notification } from '{{{antdPkg}}}';
+import { ApplyPluginsType } from 'umi';
+import { getPluginManager } from '../core/plugin';
+
+import {
+  BaseOptions,
+  BasePaginatedOptions,
+  BaseResult,
+  CombineService,
+  LoadMoreFormatReturn,
+  LoadMoreOptions,
+  LoadMoreOptionsWithFormat,
+  LoadMoreParams,
+  LoadMoreResult,
+  OptionsWithFormat,
+  PaginatedFormatReturn,
+  PaginatedOptionsWithFormat,
+  PaginatedParams,
+  PaginatedResult,
+} from '{{{umiRequestPath}}}/es/types';
+
+type ResultWithData< T = any > = { data?: T; [key: string]: any };
+
+function useRequest<
+  R = any,
+  P extends any[] = any,
+  U = any,
+  UU extends U = any,
+>(
+  service: CombineService<R, P>,
+  options: OptionsWithFormat<R, P, U, UU>,
+): BaseResult<U, P>;
+function useRequest<R extends ResultWithData = any, P extends any[] = any>(
+  service: CombineService<R, P>,
+  options?: BaseOptions<R['data'], P>,
+): BaseResult<R['data'], P>;
+function useRequest<R extends LoadMoreFormatReturn = any, RR = any>(
+  service: CombineService<RR, LoadMoreParams<R>>,
+  options: LoadMoreOptionsWithFormat<R, RR>,
+): LoadMoreResult<R>;
+function useRequest<
+  R extends ResultWithData<LoadMoreFormatReturn | any> = any,
+  RR extends R = any,
+>(
+  service: CombineService<R, LoadMoreParams<R['data']>>,
+  options: LoadMoreOptions<RR['data']>,
+): LoadMoreResult<R['data']>;
+
+function useRequest<R = any, Item = any, U extends Item = any>(
+  service: CombineService<R, PaginatedParams>,
+  options: PaginatedOptionsWithFormat<R, Item, U>,
+): PaginatedResult<Item>;
+function useRequest<Item = any, U extends Item = any>(
+  service: CombineService<
+    ResultWithData<PaginatedFormatReturn<Item>>,
+    PaginatedParams
+  >,
+  options: BasePaginatedOptions<U>,
+): PaginatedResult<Item>;
+function useRequest(service: any, options: any = {}) {
+  return useUmiRequest(service, {
+    formatResult: result => result?.data,
+    requestMethod: (requestOptions: any) => {
+      if (typeof requestOptions === 'string') {
+        return request(requestOptions);
+      }
+      if (typeof requestOptions === 'object') {
+        const { url, ...rest } = requestOptions;
+        return request(url, rest);
+      }
+      throw new Error('request options error');
+    },
+    ...options,
+  });
+}
+
+export interface RequestConfig extends AxiosRequestConfig {
+  errorConfig?: {
+    errorPage?: string;
+    adaptor?: IAdaptor; // adaptor 用以用户将不满足接口的后端数据修改成 errorInfo
+    errorHandler?: IErrorHandler;
+    defaultNoneResponseErrorMessage?: string;
+    defaultRequestErrorMessage?: string;
+  };
+  formatResultAdaptor?: IFormatResultAdaptor;
+}
+
+export enum ErrorShowType {
+  SILENT = 0,
+  WARN_MESSAGE = 1,
+  ERROR_MESSAGE = 2,
+  NOTIFICATION = 3,
+  REDIRECT = 9,
+}
+
+export interface IErrorInfo {
+  success: boolean;
+  data?: any;
+  errorCode?: string;
+  errorMessage?: string;
+  showType?: ErrorShowType;
+  traceId?: string;
+  host?: string;
+  [key: string]: any;
+}
+// resData 其实就是 response.data, response 则是 axios 的响应对象
+interface IAdaptor {
+  (resData: any, response: AxiosResponse): IErrorInfo;
+}
+
+export interface RequestError extends Error {
+  data?: any;
+  info?: IErrorInfo;
+}
+
+interface IRequest {
+  (
+    url: string,
+    opts: AxiosRequestConfig & { skipErrorHandler?: boolean },
+  ): Promise<AxiosResponse<any, any>>;
+}
+
+interface IErrorHandler {
+  (error: RequestError, opts: AxiosRequestConfig & { skipErrorHandler?: boolean }, config: RequestConfig): void;
+}
+
+interface IFormatResultAdaptor {
+  (res: AxiosResponse): any;
+}
+
+const defaultErrorHandler: IErrorHandler = (error, opts, config) => {
+  if (opts?.skipErrorHandler) throw error;
+  const { errorConfig } = config;
+  if (error.response) {
+    // 请求成功发出且服务器也响应了状态码，但状态代码超出了 2xx 的范围 或者 成功响应，success字段为false 由我们抛出的错误
+    let errorInfo: IErrorInfo | undefined;
+    // 不是我们的错误
+    if(error.name === 'ResponseError'){
+      const adaptor: IAdaptor =
+      errorConfig?.adaptor || ((errorData) => errorData);
+      errorInfo = adaptor(error.response.data, error.response);
+      error.info = errorInfo;
+      error.data = error.response.data;
+    }
+    errorInfo = error.info;
+    if (errorInfo) {
+      const { errorMessage, errorCode } = errorInfo;
+      switch (errorInfo.showType) {
+        case ErrorShowType.SILENT:
+          // do nothong
+          break;
+        case ErrorShowType.WARN_MESSAGE:
+          message.warn(errorMessage);
+          break;
+        case ErrorShowType.ERROR_MESSAGE:
+          message.error(errorMessage);
+          break;
+        case ErrorShowType.NOTIFICATION:
+          notification.open({ description: errorMessage, message: errorCode });
+          break;
+        case ErrorShowType.REDIRECT:
+          // TODO: redirect
+          break;
+        default:
+          message.error(errorMessage);
+      }
+    }
+  } else if (error.request) {
+    // 请求已经成功发起，但没有收到响应
+    // \`error.request\` 在浏览器中是 XMLHttpRequest 的实例，
+    // 而在node.js中是 http.ClientRequest 的实例
+    message.error(
+      errorConfig?.defaultNoneResponseErrorMessage ||
+        'None response! Please retry.',
+    );
+  } else {
+    // 发送请求时出了点问题
+    message.error(
+      errorConfig?.defaultRequestErrorMessage || 'Request error, please retry.',
+    );
+  }
+  throw error;
+};
+
+let requestInstance: AxiosInstance;
+let config: RequestConfig;
+const getConfig = (): RequestConfig => {
+  if (config) return config;
+  config = getPluginManager().applyPlugins({
+    key: 'request',
+    type: ApplyPluginsType.modify,
+    initialValue: {},
+  });
+  return config;
+};
+const getRequestInstance = (): AxiosInstance => {
+  if (requestInstance) return requestInstance;
+  const config = getConfig();
+  requestInstance = axios.create(config);
+
+  // 当响应的数据 success 是 false 的时候，抛出 error 以供 errorHandler 处理。
+  requestInstance.interceptors.response.use((response)=>{
+    const {data} = response;
+    const adaptor = config?.errorConfig?.adaptor || ((resData) => resData);
+    const errorInfo = adaptor(data,response);
+    if(errorInfo.success === false){
+      const error: RequestError = new Error(errorInfo.errorMessage);
+      error.name = 'BizError';
+      error.data = data;
+      error.info = errorInfo;
+      error.response = response;
+      throw error;
+    }
+    return response;
+  })
+  return requestInstance;
+};
+
+const request: IRequest = (url, opts) => {
+  const requestInstance = getRequestInstance();
+  const config = getConfig();
+  return new Promise((resolve, reject) => {
+    requestInstance
+      .request({ ...opts, url })
+      .then((res) => {
+        const formatResultAdaptor =
+          config?.formatResultAdaptor || ((res) => res.data);
+        resolve(formatResultAdaptor(res));
+      })
+      .catch((error) => {
+        try {
+          const handler =
+            config.errorConfig?.errorHandler || defaultErrorHandler;
+          handler(error, opts, config);
+        } catch (e) {
+          reject(e);
+        }
+      });
+  });
+};
+
+export {
+  useRequest,
+  UseRequestProvider,
+  AxiosRequestConfig,
+  request,
+  AxiosInstance,
+  AxiosResponse,
+};
+
+`;
+    api.onGenerateFiles(() => {
+        var _a;
+        const umiRequestPath = (0, path_1.dirname)(require.resolve('@ahooksjs/use-request/package.json'));
+        const axiosPath = (0, path_1.dirname)(require.resolve('axios/package.json'));
+        const antdPkg = 
+        // use path from antd plugin first
+        ((_a = api.appData.antd) === null || _a === void 0 ? void 0 : _a.pkgPath) ||
+            (0, path_1.dirname)(require.resolve('antd/package.json'));
+        api.writeTmpFile({
+            path: 'request.ts',
+            content: utils_1.Mustache.render(requestTpl, {
+                umiRequestPath,
+                axiosPath,
+                antdPkg,
+            }),
+        });
+        api.writeTmpFile({
+            path: 'index.ts',
+            content: `
+export {
+  useRequest,
+  UseRequestProvider,
+  request,
+} from './request';
+`,
+        });
+    });
 };

package/dist/utils/localeUtils.d.ts

@@ -0,0 +1,33 @@
+export declare type IAddAntdLocales = (args: {
+    lang: string;
+    country: string;
+}) => Promise<string[]>;
+export interface IGetLocaleFileListOpts {
+    localeFolder: string;
+    separator?: string;
+    absSrcPath?: string;
+    absPagesPath?: string;
+    addAntdLocales: IAddAntdLocales;
+    resolveKey: string;
+}
+/**
+ * 获取 moment 包的 locale 名称
+ * @param lang 语言
+ * @param country 国家
+ * @param resolveKey 用来resolve的key，moment 或者 dayjs，为了使 dayjs 可以替换 moment
+ */
+export declare const getMomentLocale: (lang: string, country: string, resolveKey: string) => {
+    momentLocale: string;
+};
+export declare const getAntdLocale: (lang: string, country: string) => string;
+export interface IGetLocaleFileListResult {
+    lang: string;
+    country: string;
+    name: string;
+    paths: string[];
+    antdLocale: string[];
+    momentLocale: string;
+}
+export declare const getLocaleList: (opts: IGetLocaleFileListOpts) => Promise<IGetLocaleFileListResult[]>;
+export declare const exactLocalePaths: (data: IGetLocaleFileListResult[]) => string[];
+export declare function isNeedPolyfill(targets?: {}): boolean;

package/dist/utils/localeUtils.js

@@ -0,0 +1,135 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNeedPolyfill = exports.exactLocalePaths = exports.getLocaleList = exports.getAntdLocale = exports.getMomentLocale = void 0;
+const utils_1 = require("@umijs/utils");
+const fs_1 = require("fs");
+const path_1 = require("path");
+/**
+ * 获取 moment 包的 locale 名称
+ * @param lang 语言
+ * @param country 国家
+ * @param resolveKey 用来resolve的key，moment 或者 dayjs，为了使 dayjs 可以替换 moment
+ */
+const getMomentLocale = (lang, country, resolveKey) => {
+    var _a, _b;
+    const momentLocation = require
+        .resolve(`${resolveKey}/locale/zh-cn`)
+        .replace(/zh\-cn\.js$/, '');
+    if ((0, fs_1.existsSync)((0, path_1.join)(momentLocation, `${lang}-${(_a = country === null || country === void 0 ? void 0 : country.toLocaleLowerCase) === null || _a === void 0 ? void 0 : _a.call(country)}.js`))) {
+        const momentLocale = `${lang}-${(_b = country === null || country === void 0 ? void 0 : country.toLocaleLowerCase) === null || _b === void 0 ? void 0 : _b.call(country)}`;
+        return {
+            momentLocale,
+        };
+    }
+    if ((0, fs_1.existsSync)((0, path_1.join)(momentLocation, `${lang}.js`))) {
+        return {
+            momentLocale: lang,
+        };
+    }
+    return { momentLocale: '' };
+};
+exports.getMomentLocale = getMomentLocale;
+const getAntdLocale = (lang, country) => `${lang}_${(country || lang).toLocaleUpperCase()}`;
+exports.getAntdLocale = getAntdLocale;
+/**
+ * 有些情况下可能项目包含的locale和antd的不匹配
+ * 这个方法用于检测
+ * @param localePath
+ * @returns
+ */
+const modulesHasLocale = (localePath) => {
+    try {
+        require.resolve(localePath);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+};
+const getLocaleList = (opts) => __awaiter(void 0, void 0, void 0, function* () {
+    const { localeFolder, separator = '-', absSrcPath = '', absPagesPath = '', addAntdLocales, resolveKey = 'moment', } = opts;
+    const localeFileMath = new RegExp(`^([a-z]{2})${separator}?([A-Z]{2})?\.(js|json|ts)$`);
+    const localeFiles = utils_1.glob
+        .sync('*.{ts,js,json}', {
+        cwd: (0, utils_1.winPath)((0, path_1.join)(absSrcPath, localeFolder)),
+    })
+        .map((name) => (0, utils_1.winPath)((0, path_1.join)(absSrcPath, localeFolder, name)))
+        .concat(utils_1.glob
+        .sync(`**/${localeFolder}/*.{ts,js,json}`, {
+        cwd: absPagesPath,
+    })
+        .map((name) => (0, utils_1.winPath)((0, path_1.join)(absPagesPath, name))))
+        .filter((p) => localeFileMath.test((0, path_1.basename)(p)) && (0, fs_1.existsSync)(p))
+        .map((fullName) => {
+        var _a, _b;
+        const fileName = (0, path_1.basename)(fullName);
+        const fileInfo = (_b = (_a = localeFileMath
+            .exec(fileName)) === null || _a === void 0 ? void 0 : _a.slice(1, 3)) === null || _b === void 0 ? void 0 : _b.filter(Boolean);
+        return {
+            name: (fileInfo || []).join(separator),
+            path: fullName,
+        };
+    });
+    const groups = utils_1.lodash.groupBy(localeFiles, 'name');
+    const promises = Object.keys(groups).map((name) => __awaiter(void 0, void 0, void 0, function* () {
+        const [lang, country = ''] = name.split(separator);
+        const { momentLocale } = (0, exports.getMomentLocale)(lang, country, resolveKey);
+        const antdLocale = utils_1.lodash
+            .uniq(yield addAntdLocales({ lang, country }))
+            .filter((localePath) => modulesHasLocale(localePath));
+        return {
+            lang,
+            name,
+            // react-intl Function.supportedLocalesOf
+            // Uncaught RangeError: Incorrect locale information provided
+            locale: name.split(separator).join('-'),
+            country,
+            antdLocale,
+            paths: groups[name].map((item) => (0, utils_1.winPath)(item.path)),
+            momentLocale,
+        };
+    }));
+    return Promise.all(promises);
+});
+exports.getLocaleList = getLocaleList;
+const exactLocalePaths = (data) => {
+    return utils_1.lodash.flatten(data.map((item) => item.paths));
+};
+exports.exactLocalePaths = exactLocalePaths;
+function isNeedPolyfill(targets = {}) {
+    // data come from https://caniuse.com/#search=intl
+    // you can find all browsers in https://github.com/browserslist/browserslist#browsers
+    const polyfillTargets = {
+        ie: 10,
+        firefox: 28,
+        chrome: 23,
+        safari: 9.1,
+        opera: 12.1,
+        ios: 9.3,
+        ios_saf: 9.3,
+        operamini: Infinity,
+        op_mini: Infinity,
+        android: 4.3,
+        blackberry: Infinity,
+        operamobile: 12.1,
+        op_mob: 12.1,
+        explorermobil: 10,
+        ie_mob: 10,
+        ucandroid: Infinity,
+    };
+    return (Object.keys(targets).find((key) => {
+        const lowKey = key.toLocaleLowerCase();
+        // @ts-ignore
+        return polyfillTargets[lowKey] && polyfillTargets[lowKey] >= targets[key];
+    }) !== undefined);
+}
+exports.isNeedPolyfill = isNeedPolyfill;

package/dist/utils/modelUtils.d.ts

@@ -0,0 +1,35 @@
+import * as t from '@umijs/bundler-utils/compiled/babel/types';
+import { IApi } from 'umi';
+interface IOpts {
+    contentTest?: (content: string) => Boolean;
+    astTest?: (opts: {
+        node: t.Node;
+        content: string;
+    }) => Boolean;
+}
+export declare class Model {
+    file: string;
+    namespace: string;
+    id: string;
+    exportName: string;
+    constructor(file: string, id: number);
+}
+export declare class ModelUtils {
+    api: IApi;
+    opts: IOpts;
+    count: number;
+    constructor(api: IApi | null, opts: IOpts);
+    getAllModels(opts: {
+        extraModels: string[];
+    }): Model[];
+    getModels(opts: {
+        base: string;
+        pattern?: string;
+    }): string[];
+    isModelValid(opts: {
+        content: string;
+        file: string;
+    }): boolean;
+    static getModelsContent(models: Model[]): string;
+}
+export {};

package/dist/utils/modelUtils.js

@@ -0,0 +1,145 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelUtils = exports.Model = void 0;
+const parser = __importStar(require("@umijs/bundler-utils/compiled/babel/parser"));
+const traverse_1 = __importDefault(require("@umijs/bundler-utils/compiled/babel/traverse"));
+const esbuild_1 = require("@umijs/bundler-utils/compiled/esbuild");
+const utils_1 = require("@umijs/utils");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const astUtils_1 = require("./astUtils");
+class Model {
+    constructor(file, id) {
+        let namespace;
+        let exportName;
+        const [_file, meta] = file.split('#');
+        if (meta) {
+            const metaObj = JSON.parse(meta);
+            namespace = metaObj.namespace;
+            exportName = metaObj.exportName;
+        }
+        this.file = _file;
+        this.id = `model_${id}`;
+        this.namespace = namespace || (0, path_1.basename)(file, (0, path_1.extname)(file));
+        this.exportName = exportName || 'default';
+    }
+}
+exports.Model = Model;
+class ModelUtils {
+    constructor(api, opts) {
+        this.opts = {};
+        this.count = 1;
+        this.api = api;
+        this.opts = opts;
+    }
+    getAllModels(opts) {
+        // reset count
+        this.count = 1;
+        return [
+            ...this.getModels({
+                base: (0, path_1.join)(this.api.paths.absSrcPath, 'models'),
+                pattern: '**/*.{ts,tsx,js,jsx}',
+            }),
+            ...this.getModels({
+                base: (0, path_1.join)(this.api.paths.absPagesPath),
+                pattern: '**/models/**/*.{ts,tsx,js,jsx}',
+            }),
+            ...this.getModels({
+                base: (0, path_1.join)(this.api.paths.absPagesPath),
+                pattern: '**/model.{ts,tsx,js,jsx}',
+            }),
+            ...opts.extraModels,
+        ].map((file) => {
+            return new Model(file, this.count++);
+        });
+    }
+    getModels(opts) {
+        return utils_1.glob
+            .sync(opts.pattern || '**/*.{ts,js}', {
+            cwd: opts.base,
+            absolute: true,
+        })
+            .map(utils_1.winPath)
+            .filter((file) => {
+            if (/\.d.ts$/.test(file))
+                return false;
+            if (/\.(test|e2e|spec).([jt])sx?$/.test(file))
+                return false;
+            const content = (0, fs_1.readFileSync)(file, 'utf-8');
+            return this.isModelValid({ content, file });
+        });
+    }
+    isModelValid(opts) {
+        const { file, content } = opts;
+        if (this.opts.contentTest && this.opts.contentTest(content)) {
+            return true;
+        }
+        // transform with esbuild first
+        // to reduce unexpected ast problem
+        const loader = (0, path_1.extname)(file).slice(1);
+        const result = (0, esbuild_1.transformSync)(content, {
+            loader,
+            sourcemap: false,
+            minify: false,
+        });
+        // transform with babel
+        let ret = false;
+        const ast = parser.parse(result.code, {
+            sourceType: 'module',
+            sourceFilename: file,
+            plugins: [],
+        });
+        (0, traverse_1.default)(ast, {
+            ExportDefaultDeclaration: (path) => {
+                let node = path.node.declaration;
+                node = (0, astUtils_1.getIdentifierDeclaration)(node, path);
+                if (this.opts.astTest && this.opts.astTest({ node, content })) {
+                    ret = true;
+                }
+            },
+        });
+        return ret;
+    }
+    static getModelsContent(models) {
+        const imports = [];
+        const modelProps = [];
+        models.forEach((model) => {
+            if (model.exportName !== 'default') {
+                imports.push(`import { ${model.exportName} as ${model.id} } from '${model.file}';`);
+            }
+            else {
+                imports.push(`import ${model.id} from '${model.file}';`);
+            }
+            modelProps.push(`${model.id}: { namespace: '${model.namespace}', model: ${model.id} },`);
+        });
+        return `
+${imports.join('\n')}
+
+export const models = {
+${modelProps.join('\n')}
+}`;
+    }
+}
+exports.ModelUtils = ModelUtils;

package/libs/dva.ts

@@ -0,0 +1,10 @@
+// @ts-ignore
+export { create, saga, utils } from 'dva-core';
+export {
+  connect,
+  Provider,
+  useDispatch,
+  useSelector,
+  useStore,
+} from 'react-redux';
+export { bindActionCreators } from 'redux';