element-pe 1.0.2 → 1.0.6

package/packages/utils/lib/props.d.ts

@@ -0,0 +1,35 @@
+import type { PropType } from 'vue';
+/**
+ * @description Build prop. It can better optimize prop types
+ * @description 生成 prop，能更好地优化类型
+ * @example
+  // limited options
+  // the type will be PropType<'light' | 'dark'>
+  buildProp({
+    type: String,
+    values: ['light', 'dark'],
+  } as const)
+  * @example
+  // limited options and other types
+  // the type will be PropType<'small' | 'medium' | number>
+  buildProp({
+    type: [String, Number],
+    values: ['small', 'medium'],
+    validator: (val: unknown): val is number => typeof val === 'number',
+  } as const)
+  @link for more explanation: https://github.com/element-plus/element-plus/pull/3341
+ */
+export declare function buildProp<T = any, R extends boolean = boolean, D extends T = T, C = never>({ values, required, default: defaultValue, type, validator, }?: {
+    values?: readonly T[];
+    required?: R;
+    default?: R extends true ? never : D extends Record<string, unknown> | Array<any> ? () => D : D;
+    type?: any;
+    validator?: ((val: any) => val is C) | ((val: any) => boolean);
+}): {
+    readonly type: PropType<T | C>;
+    readonly required: boolean;
+    readonly default: R extends true ? never : D extends any[] | Record<string, unknown> ? () => D : D;
+    readonly validator: (val: unknown) => boolean;
+};
+export declare function keyOf<T>(arr: T): (keyof T)[];
+export declare const componentSize: readonly ["large", "medium", "small", "mini"];

package/packages/utils/lib/props.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.componentSize = exports.keyOf = exports.buildProp = void 0;
+/**
+ * @description Build prop. It can better optimize prop types
+ * @description 生成 prop，能更好地优化类型
+ * @example
+  // limited options
+  // the type will be PropType<'light' | 'dark'>
+  buildProp({
+    type: String,
+    values: ['light', 'dark'],
+  } as const)
+  * @example
+  // limited options and other types
+  // the type will be PropType<'small' | 'medium' | number>
+  buildProp({
+    type: [String, Number],
+    values: ['small', 'medium'],
+    validator: (val: unknown): val is number => typeof val === 'number',
+  } as const)
+  @link for more explanation: https://github.com/element-plus/element-plus/pull/3341
+ */
+function buildProp({ values, required, default: defaultValue, type, validator, } = {}) {
+    return {
+        type: type,
+        required: !!required,
+        default: defaultValue,
+        validator: values || validator
+            ? (val) => {
+                let vaild = false;
+                if (values)
+                    vaild || (vaild = [...values, defaultValue].includes(val));
+                if (validator)
+                    vaild || (vaild = validator(val));
+                return vaild;
+            }
+            : undefined,
+    };
+}
+exports.buildProp = buildProp;
+function keyOf(arr) {
+    return Object.keys(arr);
+}
+exports.keyOf = keyOf;
+exports.componentSize = ['large', 'medium', 'small', 'mini'];

package/packages/utils/lib/resize-event.d.ts

@@ -1,8 +1,8 @@
 import ResizeObserver from 'resize-observer-polyfill';
 import type { CustomizedHTMLElement } from './types';
 export declare type ResizableElement = CustomizedHTMLElement<{
-    __resizeListeners__: Array<(...args: unknown[]) => unknown>;
-    __ro__: ResizeObserver;
+    __resizeListeners__?: Array<(...args: unknown[]) => unknown>;
+    __ro__?: ResizeObserver;
 }>;
 export declare const addResizeListener: (element: ResizableElement, fn: (...args: unknown[]) => unknown) => void;
 export declare const removeResizeListener: (element: ResizableElement, fn: (...args: unknown[]) => unknown) => void;

package/packages/utils/lib/resize-event.js

@@ -31,11 +31,12 @@ const addResizeListener = function (element, fn) {
 exports.addResizeListener = addResizeListener;
 /* istanbul ignore next */
 const removeResizeListener = function (element, fn) {
+    var _a;
     if (!element || !element.__resizeListeners__)
         return;
     element.__resizeListeners__.splice(element.__resizeListeners__.indexOf(fn), 1);
     if (!element.__resizeListeners__.length) {
-        element.__ro__.disconnect();
+        (_a = element.__ro__) === null || _a === void 0 ? void 0 : _a.disconnect();
     }
 };
 exports.removeResizeListener = removeResizeListener;

package/packages/utils/lib/util.d.ts

@@ -1,11 +1,6 @@
 import { camelize, capitalize, extend, hasOwn, isArray, isObject, isString, looseEqual } from '@vue/shared';
 import type { ComponentPublicInstance, CSSProperties, Ref } from 'vue';
-import type { AnyFunction, TimeoutHandle, Hash, Nullable } from './types';
-declare global {
-    interface Document {
-        documentMode?: any;
-    }
-}
+import type { AnyFunction, TimeoutHandle, Nullable } from './types';
 export declare const SCOPE = "Util";
 export declare function toObject<T>(arr: Array<T>): Record<string, T>;
 export declare const getValueByPath: (obj: any, paths?: string) => unknown;
@@ -21,11 +16,10 @@ export declare function getPropByPath(obj: any, path: string, strict: boolean):
 export declare const generateId: () => number;
 export declare const escapeRegexpString: (value?: string) => string;
 export declare const coerceTruthyValueToArray: (arr: any) => any[];
-export declare const isIE: () => boolean;
-export declare const isEdge: () => boolean;
 export declare const isFirefox: () => boolean;
 export declare const autoprefixer: (style: CSSProperties) => CSSProperties;
 export declare const kebabCase: (str: string) => string;
+export { isVNode } from 'vue';
 export { hasOwn, isObject, isArray, isString, capitalize, camelize, looseEqual, extend, };
 export declare const isBool: (val: unknown) => boolean;
 export declare const isNumber: (val: unknown) => boolean;
@@ -37,12 +31,8 @@ export declare const clearTimer: (timer: Ref<TimeoutHandle>) => void;
  * @param max {number}
  */
 export declare function getRandomInt(max: number): number;
-export declare function entries<T>(obj: Hash<T>): [string, T][];
 export declare function isUndefined(val: any): val is undefined;
-export { isVNode } from 'vue';
 export declare function useGlobalConfig(): any;
-export declare const arrayFindIndex: <T = any>(arr: T[], pred: (args: T) => boolean) => number;
-export declare const arrayFind: <T>(arr: T[], pred: (args: T) => boolean) => T;
 export declare function isEmpty(val: unknown): boolean;
 export declare function arrayFlat(arr: unknown[]): any;
 export declare function deduplicate<T>(arr: T[]): T[];

package/packages/utils/lib/util.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.refAttacher = exports.isEqualWithFunction = exports.addUnit = exports.$ = exports.deduplicate = exports.arrayFlat = exports.isEmpty = exports.arrayFind = exports.arrayFindIndex = exports.useGlobalConfig = exports.isVNode = exports.isUndefined = exports.entries = exports.getRandomInt = exports.clearTimer = exports.rafThrottle = exports.isHTMLElement = exports.isNumber = exports.isBool = exports.extend = exports.looseEqual = exports.camelize = exports.capitalize = exports.isString = exports.isArray = exports.isObject = exports.hasOwn = exports.kebabCase = exports.autoprefixer = exports.isFirefox = exports.isEdge = exports.isIE = exports.coerceTruthyValueToArray = exports.escapeRegexpString = exports.generateId = exports.getPropByPath = exports.getValueByPath = exports.toObject = exports.SCOPE = void 0;
+exports.refAttacher = exports.isEqualWithFunction = exports.addUnit = exports.$ = exports.deduplicate = exports.arrayFlat = exports.isEmpty = exports.useGlobalConfig = exports.isUndefined = exports.getRandomInt = exports.clearTimer = exports.rafThrottle = exports.isHTMLElement = exports.isNumber = exports.isBool = exports.extend = exports.looseEqual = exports.camelize = exports.capitalize = exports.isString = exports.isArray = exports.isObject = exports.hasOwn = exports.isVNode = exports.kebabCase = exports.autoprefixer = exports.isFirefox = exports.coerceTruthyValueToArray = exports.escapeRegexpString = exports.generateId = exports.getPropByPath = exports.getValueByPath = exports.toObject = exports.SCOPE = void 0;
 const vue_1 = require("vue");
 const shared_1 = require("@vue/shared");
 Object.defineProperty(exports, "camelize", { enumerable: true, get: function () { return shared_1.camelize; } });
@@ -38,28 +38,37 @@ const getValueByPath = (obj, paths = '') => {
 exports.getValueByPath = getValueByPath;
 function getPropByPath(obj, path, strict) {
     let tempObj = obj;
-    path = path.replace(/\[(\w+)\]/g, '.$1');
-    path = path.replace(/^\./, '');
-    const keyArr = path.split('.');
-    let i = 0;
-    for (i; i < keyArr.length - 1; i++) {
-        if (!tempObj && !strict)
-            break;
-        const key = keyArr[i];
-        if (key in tempObj) {
-            tempObj = tempObj[key];
-        }
-        else {
-            if (strict) {
-                throw new Error('please transfer a valid prop path to form item!');
+    let key, value;
+    if (obj && (0, shared_1.hasOwn)(obj, path)) {
+        key = path;
+        value = tempObj === null || tempObj === void 0 ? void 0 : tempObj[path];
+    }
+    else {
+        path = path.replace(/\[(\w+)\]/g, '.$1');
+        path = path.replace(/^\./, '');
+        const keyArr = path.split('.');
+        let i = 0;
+        for (i; i < keyArr.length - 1; i++) {
+            if (!tempObj && !strict)
+                break;
+            const key = keyArr[i];
+            if (key in tempObj) {
+                tempObj = tempObj[key];
+            }
+            else {
+                if (strict) {
+                    throw new Error('please transfer a valid prop path to form item!');
+                }
+                break;
             }
-            break;
         }
+        key = keyArr[i];
+        value = tempObj === null || tempObj === void 0 ? void 0 : tempObj[keyArr[i]];
     }
     return {
         o: tempObj,
-        k: keyArr[i],
-        v: tempObj === null || tempObj === void 0 ? void 0 : tempObj[keyArr[i]],
+        k: key,
+        v: value,
     };
 }
 exports.getPropByPath = getPropByPath;
@@ -82,14 +91,9 @@ const coerceTruthyValueToArray = (arr) => {
     return Array.isArray(arr) ? arr : [arr];
 };
 exports.coerceTruthyValueToArray = coerceTruthyValueToArray;
-const isIE = function () {
-    return !isServer_1.default && !isNaN(Number(document.documentMode));
-};
-exports.isIE = isIE;
-const isEdge = function () {
-    return !isServer_1.default && navigator.userAgent.indexOf('Edge') > -1;
-};
-exports.isEdge = isEdge;
+// drop IE and (Edge < 79) support
+// export const isIE
+// export const isEdge
 const isFirefox = function () {
     return !isServer_1.default && !!window.navigator.userAgent.match(/firefox/i);
 };
@@ -109,6 +113,9 @@ const autoprefixer = function (style) {
 };
 exports.autoprefixer = autoprefixer;
 exports.kebabCase = shared_1.hyphenate;
+// reexport from lodash & vue shared
+var vue_2 = require("vue");
+Object.defineProperty(exports, "isVNode", { enumerable: true, get: function () { return vue_2.isVNode; } });
 const isBool = (val) => typeof val === 'boolean';
 exports.isBool = isBool;
 const isNumber = (val) => typeof val === 'number';
@@ -141,16 +148,10 @@ function getRandomInt(max) {
     return Math.floor(Math.random() * Math.floor(max));
 }
 exports.getRandomInt = getRandomInt;
-function entries(obj) {
-    return Object.keys(obj).map((key) => [key, obj[key]]);
-}
-exports.entries = entries;
 function isUndefined(val) {
     return val === undefined;
 }
 exports.isUndefined = isUndefined;
-var vue_2 = require("vue");
-Object.defineProperty(exports, "isVNode", { enumerable: true, get: function () { return vue_2.isVNode; } });
 function useGlobalConfig() {
     const vm = (0, vue_1.getCurrentInstance)();
     if ('$ELEMENT' in vm.proxy) {
@@ -159,14 +160,6 @@ function useGlobalConfig() {
     return {};
 }
 exports.useGlobalConfig = useGlobalConfig;
-const arrayFindIndex = function (arr, pred) {
-    return arr.findIndex(pred);
-};
-exports.arrayFindIndex = arrayFindIndex;
-const arrayFind = function (arr, pred) {
-    return arr.find(pred);
-};
-exports.arrayFind = arrayFind;
 function isEmpty(val) {
     if ((!val && val !== 0) ||
         ((0, shared_1.isArray)(val) && !val.length) ||
@@ -201,9 +194,7 @@ function addUnit(value) {
     else if ((0, exports.isNumber)(value)) {
         return value + 'px';
     }
-    if (process.env.NODE_ENV === 'development') {
-        (0, error_1.warn)(exports.SCOPE, 'binding value must be a string or number');
-    }
+    (0, error_1.debugWarn)(exports.SCOPE, 'binding value must be a string or number');
     return '';
 }
 exports.addUnit = addUnit;

package/packages/utils/lib/vnode.js

@@ -77,7 +77,7 @@ exports.renderBlock = renderBlock;
  */
 const getNormalizedProps = (node) => {
     if (!(0, vue_1.isVNode)(node)) {
-        (0, error_1.warn)(exports.SCOPE, 'value must be a VNode');
+        (0, error_1.debugWarn)(exports.SCOPE, 'value must be a VNode');
         return;
     }
     const raw = node.props || {};

package/packages/utils/lib/with-install.d.ts

@@ -1,3 +1,2 @@
 import type { SFCWithInstall } from './types';
-declare const _default: <T>(component: T) => SFCWithInstall<T>;
-export default _default;
+export declare const withInstall: <T, E extends Record<string, any>>(main: T, extra?: E) => SFCWithInstall<T> & E;

package/packages/utils/lib/with-install.js

@@ -1,10 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/* istanbul ignore next */
-exports.default = (component) => {
+exports.withInstall = void 0;
+const withInstall = (main, extra) => {
     ;
-    component.install = (app) => {
-        app.component(component.name, component);
+    main.install = (app) => {
+        for (const comp of [main, ...Object.values(extra !== null && extra !== void 0 ? extra : {})]) {
+            app.component(comp.name, comp);
+        }
     };
-    return component;
+    if (extra) {
+        for (const [key, comp] of Object.entries(extra)) {
+            ;
+            main[key] = comp;
+        }
+    }
+    return main;
 };
+exports.withInstall = withInstall;

package/packages/utils/props.ts

@@ -1,11 +1,14 @@
-import mapValues from 'lodash/mapValues'
-import { debugWarn } from './error'
+import { warn } from 'vue'
+import { isObject } from '@vue/shared'
+import fromPairs from 'lodash/fromPairs'
 import type { ExtractPropTypes, PropType } from '@vue/runtime-core'
 import type { Mutable } from './types'
 
 const wrapperKey = Symbol()
 export type PropWrapper<T> = { [wrapperKey]: T }
 
+export const propKey = Symbol()
+
 type ResolveProp<T> = ExtractPropTypes<{
   key: { type: T; required: true }
 }>['key']
@@ -18,7 +21,9 @@ type ResolvePropTypeWithReadonly<T> = Readonly<T> extends Readonly<
   ? ResolvePropType<A[]>
   : ResolvePropType<T>
 
-type BuildPropOption<T, D, R, V, C> = {
+type IfUnknown<T, V> = [unknown] extends [T] ? V : T
+
+export type BuildPropOption<T, D extends BuildPropType<T, V, C>, R, V, C> = {
   type?: T
   values?: readonly V[]
   required?: R
@@ -26,13 +31,11 @@ type BuildPropOption<T, D, R, V, C> = {
     ? never
     : D extends Record<string, unknown> | Array<any>
     ? () => D
-    : D
+    : (() => D) | D
   validator?: ((val: any) => val is C) | ((val: any) => boolean)
 }
 
-type IfUnknown<T, V> = [unknown] extends T ? V : T
-
-type BuildPropType<T, V, C> =
+type _BuildPropType<T, V, C> =
   | (T extends PropWrapper<unknown>
       ? T[typeof wrapperKey]
       : [V] extends [never]
@@ -40,24 +43,38 @@ type BuildPropType<T, V, C> =
       : never)
   | V
   | C
+export type BuildPropType<T, V, C> = _BuildPropType<
+  IfUnknown<T, never>,
+  IfUnknown<V, never>,
+  IfUnknown<C, never>
+>
+
+type _BuildPropDefault<T, D> = [T] extends [
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  Record<string, unknown> | Array<any> | Function
+]
+  ? D
+  : D extends () => T
+  ? ReturnType<D>
+  : D
 
-type BuildPropDefault<D, R> = R extends true
+export type BuildPropDefault<T, D, R> = R extends true
   ? { readonly default?: undefined }
   : {
       readonly default: Exclude<D, undefined> extends never
         ? undefined
-        : Exclude<
-            D extends Record<string, unknown> | Array<any> ? () => D : D,
-            undefined
-          >
+        : Exclude<_BuildPropDefault<T, D>, undefined>
     }
-type BuildPropReturn<T, D, R, V, C> = {
-  readonly type: PropType<
-    BuildPropType<IfUnknown<T, never>, IfUnknown<V, never>, IfUnknown<C, never>>
-  >
+export type BuildPropReturn<T, D, R, V, C> = {
+  readonly type: PropType<BuildPropType<T, V, C>>
   readonly required: IfUnknown<R, false>
   readonly validator: ((val: unknown) => boolean) | undefined
-} & BuildPropDefault<IfUnknown<D, never>, IfUnknown<R, false>>
+  [propKey]: true
+} & BuildPropDefault<
+  BuildPropType<T, V, C>,
+  IfUnknown<D, never>,
+  IfUnknown<R, false>
+>
 
 /**
  * @description Build prop. It can better optimize prop types
@@ -81,15 +98,17 @@ type BuildPropReturn<T, D, R, V, C> = {
  */
 export function buildProp<
   T = never,
-  D extends
-    | (T extends PropWrapper<any>
-        ? T[typeof wrapperKey]
-        : ResolvePropTypeWithReadonly<T>)
-    | V = never,
+  D extends BuildPropType<T, V, C> = never,
   R extends boolean = false,
   V = never,
   C = never
->(option: BuildPropOption<T, D, R, V, C> = {}) {
+>(
+  option: BuildPropOption<T, D, R, V, C>,
+  key?: string
+): BuildPropReturn<T, D, R, V, C> {
+  // filter native prop type and nested prop, e.g `null`, `undefined` (from `buildProps`)
+  if (!isObject(option) || !!option[propKey]) return option as any
+
   const { values, required, default: defaultValue, type, validator } = option
 
   const _validator =
@@ -105,11 +124,15 @@ export function buildProp<
           if (validator) valid ||= validator(val)
 
           if (!valid && allowedValues.length > 0) {
-            debugWarn(
-              `Vue warn`,
-              `Invalid prop: Expected one of (${allowedValues.join(
-                ', '
-              )}), got value ${val}`
+            const allowValuesText = [...new Set(allowedValues)]
+              .map((value) => JSON.stringify(value))
+              .join(', ')
+            warn(
+              `Invalid prop: validation failed${
+                key ? ` for prop "${key}"` : ''
+              }. Expected one of [${allowValuesText}], got value ${JSON.stringify(
+                val
+              )}.`
             )
           }
           return valid
@@ -117,27 +140,62 @@ export function buildProp<
       : undefined
 
   return {
-    type: (type as any)?.[wrapperKey] || type,
+    type:
+      typeof type === 'object' &&
+      Object.getOwnPropertySymbols(type).includes(wrapperKey)
+        ? type[wrapperKey]
+        : type,
     required: !!required,
     default: defaultValue,
     validator: _validator,
+    [propKey]: true,
   } as unknown as BuildPropReturn<T, D, R, V, C>
 }
 
+type NativePropType = [
+  ((...args: any) => any) | { new (...args: any): any } | undefined | null
+]
+
 export const buildProps = <
-  O extends Record<string, BuildPropOption<any, any, any, any, any>>
+  O extends {
+    [K in keyof O]: O[K] extends BuildPropReturn<any, any, any, any, any>
+      ? O[K]
+      : [O[K]] extends NativePropType
+      ? O[K]
+      : O[K] extends BuildPropOption<
+          infer T,
+          infer D,
+          infer R,
+          infer V,
+          infer C
+        >
+      ? D extends BuildPropType<T, V, C>
+        ? BuildPropOption<T, D, R, V, C>
+        : never
+      : never
+  }
 >(
-  options: O
+  props: O
 ) =>
-  mapValues(options, (option) => buildProp(option)) as unknown as {
-    [K in keyof O]: O[K] extends BuildPropOption<
-      infer T,
-      infer D,
-      infer R,
-      infer V,
-      infer C
-    >
-      ? BuildPropReturn<T, D, R, V, C>
+  fromPairs(
+    Object.entries(props).map(([key, option]) => [
+      key,
+      buildProp(option as any, key),
+    ])
+  ) as unknown as {
+    [K in keyof O]: O[K] extends { [propKey]: boolean }
+      ? O[K]
+      : [O[K]] extends NativePropType
+      ? O[K]
+      : O[K] extends BuildPropOption<
+          infer T,
+          // eslint-disable-next-line @typescript-eslint/no-unused-vars
+          infer _D,
+          infer R,
+          infer V,
+          infer C
+        >
+      ? BuildPropReturn<T, O[K]['default'], R, V, C>
       : never
   }