@d-matrix/utils 1.2.6 → 1.4.0

package/dist/file.d.ts

@@ -0,0 +1,30 @@
+declare type FileURL = string;
+/**
+ * 转换BlobPart或者文件地址为图片对象
+ * @param file 传入文件 或者 url
+ * @returns 返回 一个图片详情对象
+ */
+export declare const toImage: (file: BlobPart | FileURL, options?: BlobPropertyBag | undefined) => Promise<HTMLImageElement>;
+export interface ImageSizeValidationResult {
+    isOk: boolean;
+    width: number;
+    height: number;
+}
+/**
+ * 图片宽，高校验
+ * @param file 传入文件 或者 url
+ * @param limitSize 限制宽度, 高度
+ * @returns isOK: 是否超出宽高; width, height: 图片的宽高
+ */
+export declare const validateImageSize: (file: BlobPart | FileURL, limitSize: {
+    width: number;
+    height: number;
+}, options?: BlobPropertyBag | undefined) => Promise<ImageSizeValidationResult>;
+/**
+ * 检测图片地址是否可用
+ * @param src 图片地址
+ * @param img HTMLImageElement
+ * @returns Promise<boolean>
+ */
+export declare function isImageExists(src: string, img?: HTMLImageElement): Promise<boolean>;
+export {};

package/dist/file.js

@@ -0,0 +1,110 @@
+"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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isImageExists = exports.validateImageSize = exports.toImage = void 0;
+/**
+ * 转换BlobPart或者文件地址为图片对象
+ * @param file 传入文件 或者 url
+ * @returns 返回 一个图片详情对象
+ */
+var toImage = function (file, options) {
+    return new Promise(function (resolve, reject) {
+        var image = new Image();
+        if (typeof file === 'string') {
+            image.src = file;
+        }
+        else {
+            var blob = URL.createObjectURL(new Blob([file], options));
+            image.src = blob;
+        }
+        // 如果有缓存，读缓存
+        if (image.complete) {
+            resolve(image);
+        }
+        else {
+            //否则加载图片
+            image.onload = function () {
+                resolve(image);
+                image.onload = null; // 避免重复加载
+            };
+            image.onerror = function () {
+                reject('图片加载失败');
+            };
+        }
+    });
+};
+exports.toImage = toImage;
+/**
+ * 图片宽，高校验
+ * @param file 传入文件 或者 url
+ * @param limitSize 限制宽度, 高度
+ * @returns isOK: 是否超出宽高; width, height: 图片的宽高
+ */
+var validateImageSize = function (file, limitSize, options) { return __awaiter(void 0, void 0, void 0, function () {
+    var image;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, exports.toImage(file, options)];
+            case 1:
+                image = _a.sent();
+                return [2 /*return*/, { isOk: image.width <= limitSize.width && image.height <= limitSize.height, width: image.width, height: image.height }];
+        }
+    });
+}); };
+exports.validateImageSize = validateImageSize;
+/**
+ * 检测图片地址是否可用
+ * @param src 图片地址
+ * @param img HTMLImageElement
+ * @returns Promise<boolean>
+ */
+function isImageExists(src, img) {
+    if (img === void 0) { img = new Image(); }
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (!src)
+                return [2 /*return*/, false];
+            return [2 /*return*/, new Promise(function (resolve) {
+                    img.src = src;
+                    img.onload = function () { return resolve(true); };
+                    img.onerror = function () { return resolve(false); };
+                })];
+        });
+    });
+}
+exports.isImageExists = isImageExists;

package/dist/index.d.ts

@@ -4,3 +4,5 @@ export * as dom from './dom';
 export * as date from './date';
 export * as types from './types';
 export * as algorithm from './algorithm';
+export * as file from './file';
+export * as support from './support';

package/dist/index.js

@@ -19,10 +19,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.algorithm = exports.types = exports.date = exports.dom = exports.react = exports.clipboard = void 0;
+exports.support = exports.file = exports.algorithm = exports.types = exports.date = exports.dom = exports.react = exports.clipboard = void 0;
 exports.clipboard = __importStar(require("./clipboard"));
 exports.react = __importStar(require("./react"));
 exports.dom = __importStar(require("./dom"));
 exports.date = __importStar(require("./date"));
 exports.types = __importStar(require("./types"));
 exports.algorithm = __importStar(require("./algorithm"));
+exports.file = __importStar(require("./file"));
+exports.support = __importStar(require("./support"));

package/dist/support.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 是否是浏览器环境
+ */
+export declare const isBrowserEnv: () => boolean;
+/**
+ * 是否支持WebSocket
+ */
+export declare const isWebSocket: () => boolean;
+/**
+ * 是否支持SharedWorker
+ */
+export declare const isSharedWorker: () => boolean;

package/dist/support.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSharedWorker = exports.isWebSocket = exports.isBrowserEnv = void 0;
+/**
+ * 是否是浏览器环境
+ */
+var isBrowserEnv = function () { return typeof window !== 'undefined'; };
+exports.isBrowserEnv = isBrowserEnv;
+/**
+ * 是否支持WebSocket
+ */
+var isWebSocket = function () { return typeof WebSocket !== 'undefined'; };
+exports.isWebSocket = isWebSocket;
+/**
+ * 是否支持SharedWorker
+ */
+var isSharedWorker = function () { return typeof SharedWorker !== 'undefined'; };
+exports.isSharedWorker = isSharedWorker;

package/dist/types.d.ts

@@ -1 +1,7 @@
+/** 指定的属性变为可选 */
 export declare type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/** 除了 K 的其他属性变成可选 */
+export declare type ExcludePickPartial<T, K extends keyof T> = Partial<Omit<T, K>> & Pick<T, K>;
+export declare type Undefinable<T> = {
+    [K in keyof T]: T[K] | undefined;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-matrix/utils",
-  "version": "1.2.6",
+  "version": "1.4.0",
   "description": "A dozen of utils for Front-End Development",
   "main": "dist/index.js",
   "scripts": {
@@ -8,7 +8,8 @@
     "prebuild": "npm run clean",
     "clean": "rimraf dist",
     "cy:open": "cypress open",
-    "cy:run": "cypress run"
+    "cy:run": "cypress run",
+    "test:tsd": "tsd"
   },
   "engines": {
     "node": ">=16.20.0"
@@ -18,9 +19,12 @@
     "url": "git+https://github.com/mrdulin/dm-utils.git"
   },
   "files": [
-    "dist"
+    "dist",
+    "readme.md"
+  ],
+  "keywords": [
+    "utils"
   ],
-  "keywords": [],
   "author": "Lin Du",
   "license": "MIT",
   "bugs": {
@@ -37,6 +41,7 @@
   "devDependencies": {
     "@vitejs/plugin-react": "^4.2.1",
     "cypress": "^13.6.6",
+    "expect-type": "^0.19.0",
     "rimraf": "^5.0.5",
     "vite": "^4.5.2"
   }

package/readme.md

@@ -12,7 +12,9 @@ A dozen of utils for Front-End Development
 - [dom](#dom)
 - [date](#date)
 - [types](#types)
-- [algorithm]($algorithm)
+- [algorithm](#algorithm)
+- [file](#file)
+- [support](#support)
 
 ### clipboard
 
@@ -91,10 +93,64 @@ type T0 = WithOptional<A, 'b' | 'c'>;  // { a: number; b?: number; c?: number }
 
 ### algorithm
 
-- `moveMulti = <T extends unknown>(arr: T[], indexes: number[], start: number): T[]`
+- `moveMulti<T extends unknown>(arr: T[], indexes: number[], start: number): T[]`
 
 移动多个元素到数组中指定的位置,用法,见[测试用例](tests/algorithm.cy.ts)
 
+### file
+
+- `toImage(file: BlobPart | FileURL, options?: BlobPropertyBag): Promise<HTMLImageElement>`
+
+转换BlobPart或者文件地址为图片对象
+
+- `validateImageSize(file: BlobPart | FileURL, limitSize: { width: number; height: number }, options?: BlobPropertyBag): Promise<ImageSizeValidationResult>`
+
+返回值:
+
+```ts
+interface ImageSizeValidationResult {
+  isOk: boolean;
+  width: number;
+  height: number;
+}
+```
+
+图片宽，高校验
+
+- `isImageExists(src: string, img: HTMLImageElement = new Image()): Promise<boolean>`
+
+检测图片地址是否可用
+
+```ts
+import { file } from '@d-matrix/utils';
+
+const url = 'https://picsum.photos/200/300';
+const res = await file.isImageExists(url);
+```
+
+传入HTML中已经存在的`img`元素
+
+```js
+import { file } from '@d-matrix/utils';
+
+const $img = document.getElementById('img');
+const res = await file.isImageExists(url, $img);
+```
+
+## support
+
+- `isBrowserEnv(): boolean`
+
+是否是浏览器环境
+
+- `isWebSocket(): boolean`
+
+是否支持WebSocket
+
+- `isSharedWorker(): boolean`
+
+是否支持SharedWorker
+
 ## 测试
 
 运行全部组件测试
@@ -109,6 +165,36 @@ npm run cy:run -- --component
 npm run cy:run -- --component --spec tests/date.cy.ts
 ```
 
+## 发布
+
+更新package version:
+
+```bash
+npm version <minor> or <major>...
+```
+
+构建:
+
+```bash
+npm build
+```
+
+发布：
+
+```bash
+npm publish --access public
+```
+
+镜像站查询版本与手动同步:
+
+[npm镜像站](https://npmmirror.com/package/@d-matrix/utils)
+
+通过`git log`命令获取changelogs，用于填写GitHub Release内容:
+
+```bash
+git log --oneline --decorate
+```
+
 ## 注意事项
 
 - [Before Publishing: Make Sure Your Package Installs and Works](https://docs.npmjs.com/cli/v10/using-npm/developers/#before-publishing-make-sure-your-package-installs-and-works)