util-helpers 5.2.0 → 5.2.1

package/esm/VERSION.js

@@ -1,4 +1,4 @@
-var VERSION = "5.2.0";
+var VERSION = "5.2.1";
 var VERSION$1 = VERSION;
 
 export { VERSION$1 as default };

package/esm/getFileType.js

@@ -3,9 +3,9 @@ import checkFileType from './checkFileType.js';
 import { isUploadFile } from './utils/file.util.js';
 
 var config = {
-    image: 'image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp',
+    image: 'image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp,.svg,.apng,.avif,.ico,.tif,.tiff',
     audio: 'audio/*,.mp3,.wav,.aac,.flac',
-    video: 'video/*,.mp4,.webm,.ogg',
+    video: 'video/*,.mp4,.webm,.ogg,.mov',
     pdf: 'application/pdf,.pdf',
     word: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document,.doc,.docx',
     excel: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.ms-excel,.xls,.xlsx'

package/esm/getMimeType.js

@@ -36,7 +36,7 @@ var mimeTypes = [
 ];
 function getMimeType(fileName) {
     var _a;
-    var ext = isString(fileName) ? nth(fileName.split('.'), -1) : '';
+    var ext = isString(fileName) && fileName.indexOf('.') > 0 ? nth(fileName.split('.'), -1) : '';
     return ext ? (_a = mimeTypes.find(function (item) { return item[1].includes(ext); })) === null || _a === void 0 ? void 0 : _a[0] : nativeUndefined;
 }
 

package/esm/utils/file.util.js

@@ -4,7 +4,7 @@ function testExt(name, ext) {
     return !!name && name.slice(-ext.length) === ext;
 }
 function isUploadFile(fileObj) {
-    if (isObjectLike(fileObj) && isString(fileObj.uid) && isString(fileObj.name)) {
+    if (isObjectLike(fileObj) && isString(fileObj.name)) {
         return true;
     }
     return false;

package/lib/VERSION.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var VERSION = "5.2.0";
+var VERSION = "5.2.1";
 var VERSION$1 = VERSION;
 
 module.exports = VERSION$1;

package/lib/getFileType.js

@@ -5,9 +5,9 @@ var checkFileType = require('./checkFileType.js');
 var file_util = require('./utils/file.util.js');
 
 var config = {
-    image: 'image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp',
+    image: 'image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp,.svg,.apng,.avif,.ico,.tif,.tiff',
     audio: 'audio/*,.mp3,.wav,.aac,.flac',
-    video: 'video/*,.mp4,.webm,.ogg',
+    video: 'video/*,.mp4,.webm,.ogg,.mov',
     pdf: 'application/pdf,.pdf',
     word: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document,.doc,.docx',
     excel: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.ms-excel,.xls,.xlsx'

package/lib/getMimeType.js

@@ -38,7 +38,7 @@ var mimeTypes = [
 ];
 function getMimeType(fileName) {
     var _a;
-    var ext = ut2.isString(fileName) ? ut2.nth(fileName.split('.'), -1) : '';
+    var ext = ut2.isString(fileName) && fileName.indexOf('.') > 0 ? ut2.nth(fileName.split('.'), -1) : '';
     return ext ? (_a = mimeTypes.find(function (item) { return item[1].includes(ext); })) === null || _a === void 0 ? void 0 : _a[0] : native.nativeUndefined;
 }
 

package/lib/utils/file.util.js

@@ -6,7 +6,7 @@ function testExt(name, ext) {
     return !!name && name.slice(-ext.length) === ext;
 }
 function isUploadFile(fileObj) {
-    if (ut2.isObjectLike(fileObj) && ut2.isString(fileObj.uid) && ut2.isString(fileObj.name)) {
+    if (ut2.isObjectLike(fileObj) && ut2.isString(fileObj.name)) {
         return true;
     }
     return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/AsyncMemo.d.ts

@@ -25,7 +25,7 @@ import { Cache, CacheOptions } from 'cache2';
 declare class AsyncMemo<DataType = any> {
     private promiseCache;
     /**
-     * cache2 实例，用于管理缓存
+     * @summary cache2 实例，用于管理缓存
      */
     cache: Cache<DataType>;
     constructor(options?: Partial<CacheOptions>);

package/types/VERSION.d.ts

@@ -1,6 +1,5 @@
 /**
- * util-helpers 版本号
- *
+ * @summary 版本号
  * @static
  * @since 4.18.0
  */

package/types/ajax.d.ts

@@ -49,8 +49,25 @@ type AjaxOptions = {
  * @since 4.16.0
  * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest | XMLHttpRequest}
  * @param {string} url 地址
- * @param {AjaxOptions} [options] 配置项
- * @returns {Promise<object>} XHR 事件对象
+ * @param {Object} [options] 配置项
+ * @param {string} [options.method="get"] 创建请求时使用的方法。默认 `'get'`。
+ * @param {boolean} [options.async=true] 是否异步执行操作。默认 `true`。
+ * @param {string|null} [options.user=null] 用户名，用于认证用途。默认 `null`。
+ * @param {string|null} [options.password=null] 密码，用于认证用途。默认 `null`。
+ * @param {Object} [options.headers] 自定义请求头。
+ * @param {string} [options.responseType] 响应类型。
+ * @param {number} [options.timeout] 请求超时的毫秒数。
+ * @param {boolean} [options.withCredentials=false] 跨域请求时是否需要使用凭证。默认 `false`。
+ * @param {*} [options.data=null] 请求体被发送的数据。默认 `null`。
+ * @param {function} [options.onReadyStateChange] 当 readyState 属性发生变化时触发。
+ * @param {function} [options.onLoadStart] 接收到响应数据时触发。
+ * @param {function} [options.onProgress] 请求接收到更多数据时，周期性地触发。
+ * @param {function} [options.onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时。
+ * @param {function} [options.onTimeout] 在预设时间内没有接收到响应时触发。
+ * @param {function} [options.onError] 当 request 遭遇错误时触发。
+ * @param {function} [options.onLoad] 请求成功完成时触发。
+ * @param {function} [options.onLoadEnd] 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)。
+ * @returns {Promise<object>} XHR 事件对象。
  * @example
  * ajax('/somefile').then(res=>{
  *   // do something

package/types/download.d.ts

@@ -10,24 +10,6 @@ type DownloadOptions = {
     transformRequest?: TransformRequest;
     transformResponse?: TransformResponse;
 };
-/**
- * @callback TransformRequest
- * @param {AjaxOptions} options ajax 配置项
- * @returns {AjaxOptions | Promise<AjaxOptions>}
- */
-/**
- * @callback TransformResponse
- * @param {Blob} res 响应的Blob对象。如果你通过 transformRequest 修改了 responseType ，该参数将是该类型响应值。
- * @returns {Blob | Promise<Blob>}
- */
-/**
- * @typedef {Object} DownloadOptions 下载配置项
- * @property {string} [fileName] 文件名称
- * @property {string} [type] MIME 类型
- * @property {'url'|'text'} [dataType] 手动设置数据类型，默认会根据传入的数据判断类型，主要是为了区分 url 和 text 。<br/>如果你要下载的文本是 url ，请设置 'text' ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
- * @property {TransformRequest} [transformRequest] 请求前触发，XHR 对象或配置调整
- * @property {TransformResponse} [transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
- */
 /**
  * 下载
  *
@@ -44,7 +26,12 @@ type DownloadOptions = {
  * @see {@link https://zh.wikipedia.org/wiki/多用途互聯網郵件擴展 | MIME}
  * @see {@link https://9ykc9s.csb.app/ | 在线示例}
  * @param {string|Blob|ArrayBuffer|TypedArray} data 字符串、blob数据或url地址
- * @param {string|DownloadOptions} [options] 文件名称 或 配置项
+ * @param {string|Object} [options] 文件名称 或 配置项。
+ * @param {string} [options.fileName] 文件名称。
+ * @param {string} [options.type] MIME 类型。
+ * @param {'url'|'text'} [options.dataType] 手动设置数据类型，主要是为了区分 `url` 和 `text`，默认会根据传入的数据判断类型。<br/>如果你要下载的文本是 `url` ，请设置 `'text'` ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
+ * @param {Function} [options.transformRequest] 请求前触发，XHR 对象或配置调整。
+ * @param {Function} [options.transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据。
  * @returns {Promise<void>}
  * @example
  * // 文本

package/types/getFileType.d.ts

@@ -1,6 +1,6 @@
 import { UploadFile } from './utils/file.util';
 /**
- * 获取文件类型。
+ * @summary 获取文件类型。
  *
  * @static
  * @alias module:Other.getFileType
@@ -16,6 +16,17 @@ import { UploadFile } from './utils/file.util';
  * getFileType(pdf); // 'pdf'
  * getFileType(jpeg); // 'image'
  *
+ * @description 内置文件类型和文件类型说明符
+ *
+ * | 类型 | 说明符 |
+ * |---|---|
+ * | `image` | `image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp,.svg,.apng,.avif,.ico,.tif,.tiff` |
+ * | `audio` | `audio/*,.mp3,.wav,.aac,.flac` |
+ * | `video` | `video/*,.mp4,.webm,.ogg,.mov` |
+ * | `pdf` | `application/pdf,.pdf` |
+ * | `word` | `application/vnd.openxmlformats-officedocument.wordprocessingml.document,.doc,.docx` |
+ * | `excel` | `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.ms-excel,.xls,.xlsx` |
+ *
  */
 declare function getFileType(file: File | UploadFile): "image" | "audio" | "video" | "pdf" | "word" | "excel" | undefined;
 export default getFileType;

package/types/getImageInfo.d.ts

@@ -18,13 +18,23 @@ import loadImageWithBlob from './loadImageWithBlob';
  * @static
  * @alias module:Other.getImageInfo
  * @since 4.20.0
- * @param {string | Blob} img 图片地址或 blob 对象
+ * @param {string | Blob} img 图片地址或 blob 对象。
  * @param {AjaxOptions} [ajaxOptions] ajax 请求配置项，当传入的图片为字符串时才会触发请求。
- * @returns {Promise<ImageInfo>} 图片信息
+ * @returns {Promise<ImageInfo>} 图片信息。
  * @example
  *
  * getImageInfo(file).then(imageInfo=>{
- *    // do something
+ *   console.log(imageInfo);
+ *   // {
+ *   //   width: 100,
+ *   //   height: 100,
+ *   //   contrast: '1:1',
+ *   //   measure: '100 × 100 px',
+ *   //   size: '11 B',
+ *   //   bytes: 11,
+ *   //   image: HTMLImageElement {},
+ *   //   blob: Blob {}
+ *   // }
  * });
  *
  * getImageInfo('https://dummyimage.com/200x300').then(imageInfo=>{

package/types/getMimeType.d.ts

@@ -1,7 +1,5 @@
 /**
- * 获取常用的 MIME 类型。
- *
- * 通过文件名后缀查找对于的 MIME 类型。
+ * @summary 获取常用的 MIME 类型。通过文件名后缀查找对应的 MIME 类型。
  *
  * @alias module:Other.getMimeType
  * @since 5.2.0
@@ -20,6 +18,45 @@
  *
  * // 不常用或未知类型
  * getMimeTye('xxx.ci'); // undefined
+ *
+ * // 非法文件名
+ * getMimeType('.zip'); // undefined
+ *
+ * @description 内置常用的 MIME 类型和文件名后缀映射
+ *
+ * | MIME 类型 | 文件名后缀 |
+ * |---|---|
+ * | `text/plain` | `txt` |
+ * | `text/css` | `css` |
+ * | `text/html` | `htm` `html` |
+ * | `text/javascript` | `js` `mjs` |
+ * | `text/csv` | `csv` |
+ * | `text/markdown` | `md` `markdown` |
+ * | `image/gif` | `gif` |
+ * | `image/jpeg` | `jpg` `jpeg` `jfif` `pjpeg` `pjp` |
+ * | `image/png` | `png` |
+ * | `image/svg+xml` | `svg` |
+ * | `image/webp` | `webp` |
+ * | `image/apng` | `apng` |
+ * | `image/avif` | `avif` |
+ * | `image/bmp` | `bmp` |
+ * | `image/x-icon` | `ico` `cur` |
+ * | `image/tiff` | `tif` `tiff` |
+ * | `application/xml` | `xml` |
+ * | `application/zip` | `zip` |
+ * | `application/pdf` | `pdf` |
+ * | `application/json` | `json` |
+ * | `application/yaml` | `yaml` `yml` |
+ * | `application/vnd.openxmlformats-officedocument.wordprocessingml.document` | `doc` `docx` |
+ * | `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` | `xls` `xlsx` |
+ * | `audio/mp3` | `mp3` |
+ * | `audio/wav` | `wav` |
+ * | `audio/aac` | `aac` |
+ * | `audio/flac` | `flac` |
+ * | `video/mp4` | `mp4` |
+ * | `video/ogg` | `ogg` |
+ * | `video/webm` | `webm` |
+ * | `video/quicktime` | `mov` |
  */
 declare function getMimeType(fileName: string): string | undefined;
 export default getMimeType;

package/types/loadImageWithBlob.d.ts

@@ -20,7 +20,8 @@ import getFileBlob from './getFileBlob';
  * @example
  *
  * loadImage(file).then(({image, blob})=>{
- *    // do something
+ *   console.log(image, blob);
+ *   // HTMLImageElement {} Blob {}
  * });
  *
  * loadImage('https://dummyimage.com/200x300').then(({image, blob})=>{

package/types/utils/file.util.d.ts

@@ -1,6 +1,5 @@
 export declare function testExt(name: string | undefined, ext: string): boolean;
 export type UploadFile = {
-    uid: string;
     name: string;
     type?: string;
     url?: string;